NocoBase数据表设计最佳实践：关系定义与索引优化

NocoBase作为极易扩展的无代码/低代码开发平台，其数据表设计直接影响系统性能与扩展性。本文将从关系定义、索引优化两大核心维度，结合官方示例与源码实践，提供可落地的设计指南。

关系定义：从基础关联到树形结构

一对一与一对多关系设计

基础关联关系通过belongsTo和hasMany实现，如产品与分类的一对多关系：

// 示例代码结构
db.collection({
  name: 'products',
  fields: [
    { type: 'belongsTo', name: 'category', target: 'categories', foreignKey: 'categoryId' }
  ]
});

db.collection({
  name: 'categories',
  fields: [
    { type: 'hasMany', name: 'products', target: 'products', foreignKey: 'categoryId' }
  ]
});

外键字段需显式定义，推荐使用{关联名}Id命名规范（如categoryId），相关实现可参考packages/core/database/src/collection.ts。

树形结构的四种实现方案

NocoBase提供完整的树形数据建模支持，官方示例examples/database/collections/tree/包含四种实现：

邻接表（Adjacency List）

适合层级不深的菜单、评论等场景，通过自关联实现：

// [adjacency-list.ts](https://gitcode.com/GitHub_Trending/no/nocobase/blob/bcfd929c7b0038f1f1f04fde48c961e51ab6edbb/examples/database/collections/tree/adjacency-list.ts?utm_source=gitcode_repo_files)
db.collection({
  name: 'categories',
  tree: 'adjacency-list',
  fields: [
    { type: 'belongsTo', name: 'parent', target: 'categories', foreignKey: 'parentId' },
    { type: 'hasMany', name: 'children', target: 'categories', foreignKey: 'parentId' }
  ]
});

优势：结构简单，插入方便；局限：多级查询需递归，性能较差。

嵌套集（Nested Set）

通过左右值编码实现树形结构，适合频繁查询层级的场景：

// [nested-set.ts](https://gitcode.com/GitHub_Trending/no/nocobase/blob/bcfd929c7b0038f1f1f04fde48c961e51ab6edbb/examples/database/collections/tree/nested-set.ts?utm_source=gitcode_repo_files)
db.collection({
  name: 'categories',
  tree: 'nested-set',
  fields: [
    { type: 'integer', name: 'lft' },
    { type: 'integer', name: 'rgt' },
    { type: 'integer', name: 'depth' }
  ]
});

优势：单次查询获取整棵树；局限：插入节点需重构左右值。

多对多关系最佳实践

多对多关系通过中间表实现，推荐使用belongsToMany关联：

// 用户与角色的多对多关联
db.collection({
  name: 'users',
  fields: [
    { 
      type: 'belongsToMany', 
      name: 'roles', 
      target: 'roles',
      through: 'user_roles', // 中间表
      foreignKey: 'userId',
      otherKey: 'roleId'
    }
  ]
});

中间表字段需添加联合索引，相关索引规则可参考packages/core/database/src/collection.ts。

索引优化：提升查询性能的核心策略

必建索引的三大场景

1. 外键字段：所有foreignKey自动创建索引，如categoryId
2. 查询过滤字段：状态、类型等高频筛选字段
3. 排序字段：列表页默认排序字段

复合索引设计原则

复合索引需遵循"最左前缀匹配"原则，如订单表查询频繁使用status+createdAt组合条件：

// 复合索引定义示例
db.collection({
  name: 'orders',
  indexes: [
    { fields: ['status', 'createdAt'], name: 'idx_status_createdAt' }
  ]
});

索引选择性分析可参考packages/core/database/src/collection.ts中的索引自动优化逻辑。

索引失效的常见陷阱

1. 避免在索引字段使用函数，如DATE(createdAt) = '2023-01-01'
2. 避免使用NOT IN、!=等操作符
3. 复合索引中不要包含过长文本字段

高级实践：树形结构性能对比

四种树形结构查询性能测试

操作场景	邻接表	嵌套集	物化路径	闭包表
单节点查询	⭐⭐⭐⭐⭐	⭐⭐⭐⭐⭐	⭐⭐⭐⭐⭐	⭐⭐⭐⭐⭐
子树查询	⭐⭐	⭐⭐⭐⭐⭐	⭐⭐⭐⭐	⭐⭐⭐⭐⭐
节点插入	⭐⭐⭐⭐⭐	⭐⭐	⭐⭐⭐	⭐⭐⭐⭐
节点删除	⭐⭐⭐⭐	⭐⭐	⭐⭐⭐	⭐⭐⭐⭐

树形结构选择建议

• 层级固定的分类体系：邻接表（adjacency-list.ts）
• 频繁查询整棵树：嵌套集（nested-set.ts）
• 路径查询频繁：物化路径（materialized-path.ts）
• 复杂权限树：闭包表（closure-table.ts）

设计工具与自动化校验

数据库设计工具推荐

NocoBase Admin提供可视化数据表设计界面，支持实时生成ER图。设计完成后，可通过CLI命令同步结构：

# 同步数据表结构
yarn nocobase db:migrate

设计规范自动化校验

通过插件机制实现设计规范自动检查，如：

• 外键命名规范校验
• 索引冗余检测
• 字段类型合理性检查

相关插件开发可参考plugins/validation/目录结构。

总结与最佳实践清单

1. 关系定义

   • 基础关联使用belongsTo/hasMany
   • 多对多必须显式指定中间表
   • 树形结构优先选择闭包表或嵌套集

2. 索引优化

   • 外键自动索引不可删除
   • 单表索引不超过5个
   • 复合索引字段顺序按查询频率排列

3. 性能监控

   • 定期分析慢查询日志
   • 使用NocoBase性能分析插件
   • 大表分表策略参考examples/database/

完整设计示例可参考官方示例库examples/database/，更多数据库核心实现请查阅NocoBase数据库模块源码。