开发规范

数据库设计规范

表设计规范

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

字段长度规则

名称类类型长度备注
编码类varchar100
账号类varchar100如email,username
状态类varchar5如订单状态等
名称类varchar200中文名称,如产品名
手机电话varchar20
描述简介varchar500
网址类varchar500如url
时间类timestamp

URL和方法命名规范

RESTFUL URL命名规范

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

CRUD 简单 URI:

方法URL功能
GET/users获取用户列表
GET/users/1获取 id 为 1 的用户
POST/users创建一个用户
PUT/users/1替换 id 为 1 的用户
PATCH/users/1修改 id 为 1 的用户
DELETE/users/1删除 id 为 1 的用户

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

方法URL功能
GET/users/1/products获取 Id 为 1 用户下的产品列表
GET/users/1/products/2获取 Id 为 1 用户下 Id 为 2 的产品
POST/users/1/products在 Id 为 1 用户下,创建一个产品
PUT/users/1/products/2在 Id 为 1 用户下,替换 Id 为 2 的产品
PATCH/users/1/products/2修改 Id 为 1 的用户下 Id 为 2 的产品
DELETE/users/1/products/2删除 Id 为 1 的用户下 Id 为 2 的产品

方法命名规范

Mapper

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

操作例子备注
增加insert/add
删除delete
修改update
查询query
搜索search

Service

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

操作例子备注
增加add
获取get获取到单条记录
删除remove/delete
更新update更新存在的记录
保存save更新,不存在则新增
查询query根据id等简单条件查询
搜索search根据时间范围或模糊搜索

Rest

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

操作例子备注
增加add
获取get获取到单条记录
删除remove/delete
更新update更新存在的记录
保存save更新,不存在则新增
查询query根据id等简单条件查询
搜索search根据时间范围或模糊搜索
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值