栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

API 增删改查命名规范

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

API 增删改查命名规范

常用的增删改查命名规约

阿里命名规范

Service/Dao 层命名规约
  1. 获取单个对象的方法用 get 做前缀。
  2. 获取多个对象的方法用 list 做前缀。
  3. 获取统计值的方法用 count 做前缀。
  4. 插入的方法用 save(推荐)或 insert 做前缀。
  5. 删除的方法用 remove(推荐)或 delete 做前缀。
  6. 修改的方法用 update 做前缀。
领域模型命名规约
  1. 数据对象:xxxDO,xxx 即为数据表名。
  2. 数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
  3. 展示对象:xxxVO,xxx 一般为网页名称。
  4. POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。

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

Controller/API 层命名规范
  1. create 普通的新增接口方法命名或前缀命名
  2. delete 普通的删除接口方法命名或前缀命名
  3. modify 普通的修改接口方法命名或前缀命名
  4. detail 普通的详情接口方法命名或前缀命名
  5. pageQuery 普通的分页查询接口方法命名或前缀命名
  6. selector 普通的下拉列表接口方法命名或前缀命名
Service/Dao 层命名规范

正常情况下,以Controller层方法名保持一致

领域模型层命名规范
  1. 请求对象/数据传输对象:xxxDTO,xxx 即为实体类名实体类名+操作描述名, 例如UserCreateDTO
    原因: 以实体类名做前缀, 可以提高IDEA代码提示的效率
  2. 响应对象/展示对象:xxxVO, xxx 即为实体类名实体类名+操作描述名, 例如UserDetailVO
    原因: 以实体类名做前缀, 可以提高IDEA代码提示的效率
  3. POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。
小结

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

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/1036221.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号