API 增删改查命名规范

常用的增删改查命名规约

阿里命名规范

Service/Dao 层命名规约

1. 获取单个对象的方法用get做前缀。
2. 获取多个对象的方法用list做前缀。
3. 获取统计值的方法用count做前缀。
4. 返回布尔值的方法用is做前缀
5. 插入的方法用save（推荐）或insert做前缀。
6. 删除的方法用remove（推荐）或delete做前缀。
7. 修改的方法用update做前缀。

领域模型命名规约

1. 数据对象：xxxDO，xxx 即为数据表名。
2. 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
3. 展示对象：xxxVO，xxx 一般为网页名称。
4. POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

自定义命名规范(个人喜好使用规范)

Controller/API 层命名规范

1. create 普通的新增接口方法命名或前缀命名
2. delete 普通的删除接口方法命名或前缀命名
3. change 普通的修改接口方法命名或前缀命名
4. detail 普通的详情接口方法命名或前缀命名
5. search 普通的分页查询接口方法命名或前缀命名
6. listQuery 普通的列表查询接口方法命名或前缀命名
7. selector 普通的下拉列表接口方法命名或前缀命名

Service/Dao 层命名规范

一般情况下，以Controller层方法命名保持一致

领域模型层命名规范

1. 请求对象/数据传输对象：xxxDTO，xxx 即为实体类名或实体类名+操作描述名, 例如UserCreateDTO。
   原因: 以实体类名做前缀, 可以提高IDEA代码提示检索的效率
2. 响应对象/展示对象：xxxVO， xxx 即为实体类名或实体类名+操作描述名, 例如UserDetailVO。
   原因: 以实体类名做前缀, 可以提高IDEA代码提示检索的效率
3. POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。
4. 使用范围: DTO > VO, VO只用作响应对象, DTO既可以是请求对象, 又可以是响应对象

小结

如果有更好的建议或问题请评论点出或联系我更改, 谢谢!