1. Service/Controller层方法命名规范
- 获取单个对象的方法用 get前缀。
- 获取多个对象的方法用 list 做前缀,复数形式结尾如:listObjects。
- 获取统计值的方法用 count 做前缀。
- 插入的方法用 add 做前缀。
- 删除的方法用 remove 做前缀。
- 修改的方法用 set/modify 做前缀。
2. Mapper层方法命名规范
- 获取对象方法以select做前缀
- 更新的方法一update做前缀
- 删除的方法以delete做前缀
- 插入的方法一insert做前缀
之所以要将视图控制层,代码逻辑层 与 数据交互层命名方法分开是为了将数据的处理逻辑层与数据获取层区分开来,数据交互层不需要考虑业务的场景,主要关注与纯粹的数据获取,相对于业务更偏向于数据库,所以我们以sql中的关键字来表示具体的操作,也给人一种mapper层直接操做数据库的观感,而控制层与逻辑层与业务息息相关,更偏向于人的思想,应使用人的常用操作思想。
3. 领域模型命名规约
- 数据对象:xxxDO,xxx 即为数据表名。
- 数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
- 展示对象:xxxVO,xxx 一般为网页名称。
- POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。