Files
nocobase/命名规范.md
2026-05-20 14:07:46 +08:00

2.6 KiB
Raw Blame History

命名规范

一、数据源

  1. 数据表标识沿用样例数据表users/roles格式采用英文复数形式涉及多个单词时全部小写且单词间用下划线_分隔,规则为 “除最后一个单词外,其余单词用单数,最后一个单词用复数”。
  2. 数据表字段标识采用驼峰命名法示例aaaBbbCcc,且单数
  3. 关系字段:名称标识与目标数据表保持一致,标识格式为驼峰形式。
  4. 选项值(下拉菜单 / 单选 / 复选):必须使用英文,禁止使用中文;格式为小写且单词间用下划线_分隔。
  5. 日期时间类型:统一使用不含时区的类型。
  6. 日期时间显示:勾选显示时间,若有特殊展示要求,可在页面层进行微调。
  7. 多对多关系表:名称为A表名称与B表名称映射、标识为A表标识_B表标识_mappings,预置字段只保留创建日期最后修改日期
A表a_table
B表b_table

多对多关系表:
名称A表与B表映射
标识a_table_b_table_mappings

二、文件管理器

  1. 标题格式:文件管理器类型服务端上传S3/OSS/COS客户端上传S3 - 数据表标识(数据表字段名遵循 “除最后一个单词外其余用单数、最后一个单词用复数” 规则,单词间用连字符(-)分隔) - 数据表字段名(数据表字段名小写,单词间用连字符(-)分隔)
  2. 存储空间标识格式:数据表标识(数据表字段名遵循 “除最后一个单词外其余用单数、最后一个单词用复数” 规则单词间用下划线_分隔 _ 数据表字段名数据表字段名小写单词间用下划线_分隔
  3. 路径格式:数据表标识(数据表字段名遵循 “除最后一个单词外其余用单数、最后一个单词用复数” 规则,单词间用连字符(-)分隔)/ 数据表字段名(数据表字段名小写,单词间用连字符(-)分隔)
  4. 重命名v2版本开始无特殊要求时随机字符串
  5. 文件大小限制:无特殊要求时,统一限制为1GB
  6. 必须要指定文件类型MIME 格式),否则无法限定文件格式,且与数据表附件字段的MIME 类型保持一致,因为数据表附件字段的MIME 类型为前端表单验证。

三、变量和密钥

  1. 名称格式:大写且单词间用下划线_

四、页面

  1. 没有特殊要求时,所有的 列表 / 卡片 等数据按 最后修改日期 降序排序