数据库设计规范

表设计规范

1、表名全部小写，单词间通过'_'间隔

2、主键命名为'id'，pg库类型为serial自增长主键，会默认创建名为[表名_id_seq]的序列

3、必须包含4个审计字段且不能为空。created_time、updated_time、created_by、updated_by。

4、关键词要求大写，使用IDE如idea进行格式化

5、常量枚举全部用大写

外键及索引命名规范

1、唯一索引：ux_表名_索引字段。如：ux_resource_code

2、普通索引：ix_表名_索引字段。如：ix_role_name

3、外键命名：fk_表名_字段名。如：fk_orders_product_id

字段长度规则

URL和方法命名规范

RESTFUL URL命名规范

API URI design API URI 设计最重要的一个原则： nouns (not verbs!) ，名词（而不是动词）。

CRUD 简单 URI：

上面是对某一种资源进行操作的 URI，那如果是有关联的资源，或者称为级联的资源，该如何设计 URI 呢？比如某一用户下的产品：

方法命名规范

Mapper

简单的CRUD请按如下规则命名

Service

简单的CRUD请按如下规则命名，其它操作请按业务动作命名，使用动词

Rest

简单的CRUD请按如下规则命名，其它操作请按业务动作命名，使用动词