表设计规约

基于Excel表设计管理（推荐）

基于Excel统一管理表设计具有操作简单、集合参考、易于版本控制及简单代码生成等特点，有较好的使用基础，建议使用。这里简单介绍一下建表过程中的一些流程和注意事项。

• 建表规约请参考，DB规约

• 建表Excel按照微服务进行划分，一个微服务一个Excel文件
  

• Excel模板中有一些常用的字段建议，建表需要用到时请查看
  

• 存在外键关系的字段，需要在备注中注明对应的表及字段
  

• 存在需要用值集的字段，需要在备注中注明对应值集，字段名尽量与值集对应，以_CODE结尾
  
  注意： 值集具体命名规范请查看设置命令规约

• 附件处理注意事项
  1、技术设计时，表中有附件相关字段，需要指定表对应的功能名称：服务名-功能名如spfm-comp
  
  2、开发上传附件时，需指定文件路径，应使用此功能名作为根目录。前端开发时咨询后端用哪个功能名，附件上传API需要指定清楚
  
  3、附件大小限制涉及多层次说明：

  1 单个文件最大大小限制（服务器设置控制）
  2 平台总附件大小限制\租户总附件大小限制（上传API控制
  3 不同文件类型最大大小限制（上传API控制）

4、删除附件所在行时需注意，删除API中要调用删除附件API

5、附件相关表字段有两种：

1 单附件字段用XXX_URL，存储文件路径，可以解析出文件名
2 多附件字段用ATTACHMENT_UUID，存储关联附件表的ATTACHMENT_UUID，可以通过ATTACHMENT_UUID找到对应的多个文件

基于StarUML表设计管理

这里简要介绍使用StarUML建实体模型并转换成表设计，具体的细节规范，请参考前一小结。

1、首先下载StarUML并安装，下载地址。官方参考文档：StarUML

2、启动进入页面后默认是UML类图的界面，在工程上右键选择ER Diagram创建ER画图。

3、在左边点击Entity，中间创建实体表，添加表名、字段、字段类型等，也可以在右边实体属性里设置，在Documentation里填写备注信息。

4、因为StartUML不支持索引、默认值、主键自增长的设置，为了使用StartUML数据导出工具，需要在Documentation中添加一些特殊信息。
① 设置索引

• 唯一索引：U_INDEX_indexName(column1,column2,…)
• 普通索引：N_INDEX_indexName(column1,column2,…)

② 设置默认值

• 格式：DEFAULT[val], val是默认值。生成SQL时将直接读取默认值，不做任何转换
• 字符型默认值：DEFAULT[‘NEW’]
• 数字型默认值：DEFAULT[0]

③ 设置自增长主键

• 首先，需要将Column标记为primaryKey。然后，在字段的在Documentation属性中配置AUTO_INCREMENT表示自增长

5、保存到本地，使用StartUML数据导出工具导出数据。

• 导出Mysql DDL语句

• 导出JavaBean

• 导出Markdown

• 导出Liquibase Groovy脚本

6、DEMO：demo.mdj，由于hugo将md转为html，所以将后缀加了_，去掉即可。