后端开发规范
默认规约
与阿里巴巴java规约一致,如果有需要,可以在idea中以及类似ide中下载对应的阿里巴巴规约
Java开发手册(华山版).pdf
规范扩展
- 类名使用 UpperCamelCase 风格:第一个词的首字母,以及后面每个词的首字母都大写
- 方法名使用lowerCamelCase风格:第一个词的首字母小写,后面每个词的首字母大写。
- 常量命名全部大写,单词间用下划线隔开。
- 控制器需以:Controller结尾,例如:GoodsController。
- 业务层需以Service结尾,例如:GoodsService。
- Mapper需以Mapper结尾,例如:GoodsMapper。
类注释模板
/ * {类内容} * * @author {作者} * @since {date} {time} */
- 业务层需以Service结尾,例如:GoodsService。
- Mapper需以Mapper结尾,例如:GoodsMapper。
- 模型命名规范
- 在entity.dos 目录下的类,即为数据库模型,默认无后缀命名,例如Goods
- 在entity.vos 目录下的类,即为响应数据模型,默认后缀VO命名,例如GoodsVO,通常情况用于服务端给前端的响应
- 在entity.dto 目录下的类,即为传递数据模型,默认后缀DTO命名,例如GoodsDTO,通常情况用于前后端,或者服务于服务之间交互的数据模型
- 控制器明明规范
- 店铺端API,控制器以
- StoreController 结尾
- 运营后台端API,控制器以
- ManagerController结尾
- 用户端端API,控制器以
- BuyerController结尾
版权声明:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符,请将相关资料发送至xkadmin@xkablog.com进行投诉反馈,一经查实,立即处理!
转载请注明出处,原文链接:https://www.xkablog.com/hd-java/3909.html