开发手册|Java后端开发规范重点条目整理

Ps：部分熟知的开发规范未收录在本文中！

一、编程规约

1.1 命名风格

代码中的命名严禁使用拼音与英文混合的方式
alibaba / taobao / youku / hangzhou 等国际通用的名称可视同英文

类名使用大驼峰的形式命名，例如 UpperCameCase
方法、参数与变量使用小驼峰的形式命名，例如 lowerCamelCase
常量命名全部大写且单词间使用下划线隔开，力求语义表达完整清楚，例如 MAX_STOCK_COUNT
杜绝完全不规范的缩写，避免词不达义
为了达到见名知意，命名时尽量使用完整的单词组合来表达其意

如果模块、接口、类、方法使用了设计模式，应在命名时体现出具体模式，有利于阅读者快速理解架构设计理念
public class OrderFactory / public class LoginProxy / public class ResourceObserver

接口类中的方法和属性不要加任何修饰符号（ public 也不要加，接口类中的访问修饰符默认就是 public ），保持代码的简洁性，并加上有效的 Javadoc（文档注释）。尽量不要在接口里定义变量，如果一定要定义变量，必须是与接口方法相关的，并且是整个应用的基础常量

各层命名规约：
Service / DAO 层方法命名规约如下。
获取单个对象的方法用 get 作为前缀
获取多个对象的方法用 list 作为前缀
获取统计值的方法用 count 作为前缀
插入的方法用 save / insert 作为前缀
删除的方法用 remove / delete 作为前缀

领域模型命名规约如下。
数据对象：xxxDO，xxx 为数据表名
数据传输对象：xxxDTO，xxx 为业务领域相关的名称
展示对象：xxxVo，xxx 一般为网页名称
POJO是 DO / DTO / BO / VO 的统称，禁止命名成 xxxPOJO

1.2 常量定义

不允许任何魔法值（即未经预先定义的常量）直接出现在代码中
long 或者 Long 初始赋值时，使用大写的 L，不能是小写的 l。小写 l 容易跟数字 1 混淆，造成误解
不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护

1.3 代码格式

大括号的使用约定。如果大括号内为空，则简洁地写成 { } 即可，不需要换行；如果是非空代码块，则：
左大括号前不换行
左大括号后换行
右大括号前换行
右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行

慢速更新中……