数据库设计规范参考手册

数据库设计规范参考手册

概述

该手册所设计的数据表结构，需要配置代码生成工具，才能发挥它的作用。

因为工具中定义了一些特殊的语法，用于生成特定的功能。

数据表结构示例

规范

一、命名规则

1、数据库的名称通常为项目名称，纯小写字符；

2、数据表、字段的命名使用下划线命名法，并且全部为小写；由于不同的数据库可能是表名、字段字大小写敏感的，为了避免这种麻烦，所以统一为小写；

3、数据类型也全部为小写

4、字段长度，像 bigint、int等类型有默认的长度，所以可以不用填写；varchar 等需要指定长度，但不需要括号；decimal 这种自定义小数点前后位数的，需要带括号；

5、名称，字段的中文名称，不要包含标点符号；

6、允许空值，可填写的值可以为：不为空、Y、N，不填写默认允许空值；

7、主／外／约：主键／外键／约束，代码生成工具会根据这里的值在建表时生成对应的主键、外键或约束；

8、备注：备注里可以包含很多内容，也有特殊的用法，参考下面的特殊语法说明；

二、特殊语法

1、主键字段需要自增功能，需要在备注中填写“自增”；

2、备注字段不同功能使用分号分隔（字段的中文名称和备注其实都是保存在数据表的备注里的，所以用分号分隔）；

3、一些特殊功能的定义目前使用类HTML标签的形式；例如：<tree><listAllTree>；这种不需要分号分隔；

4、<tree> <tree=treeTableName> 标签作用、使用方法

  ※ 作用：此标签指定后台管理页面左侧是否要显示树

  ※ 用法：此标签添加到数据表的注释中

  ①  <tree> 不指定表名，表示左侧的树显示本表的数据；

  ②  <tree=treeTableName> 指定表名，左侧的树显示指定表的数据；

    注意：参数值为实体类类名，第一个字母小写。而不是数据表的名称格式。

5、<listAllTree> <listAllTree=treeTextName=treeCodeName> 标签作用、使用方法

※ 作用：此标签指定 Controller、Mobile、Manager 等层是否需要添加 listAllTree 接口、方法

 ※ 用法：此标签添加到数据表的注释中

  ①  listAllTree=树节点文本字段=树节点代码字段， 不指定参数，则使用默认值，即表名+Name、表名+Code；

        例如：表名为：group，那么treeTextName=groupName，treeCodeName=groupCode

  ②  指定参数，第一个参数为treeTextName，只指定一个即认为是treeTextName，第二个参数是treeCodeName；

    注意：参数值为实体类的属性名格式，而不是数据表中的字段名格式。

6、

本文地址：https://www.jianshu.com/p/ae3a4b221c99