阿里巴巴Java开发手册

Posted 2020-10-08

一，命名风格

1，（强制）类的命名使用驼峰命名，DO（表名的数据对象），DTO（页面数据传输对象），VO（展示对象），可以以上的结尾，可以不遵守驼峰规则。（POJO是以上的统称）

2，（强制）抽象类使用Abstract开头，异常类使用Exception结尾，测试类使用Test结尾，枚举类使用Enum结尾。

3，（强制）所有的布尔类型的变量，都不加is，否则某些框架会有序列化的错误。

4，（强制）包名统一使用小写，包名使用单数形式。

5，（强制）杜绝不规范的缩写，比如condition简写成condi，降低了可读性。

6，（强制）尽量达到代码字解释目标，不要使用int a这样的变量名

7，（推荐）如果使用了设计模式，可以将设计模式名称放到命名中，增加可读性，比如OrderFactory，ResourceObserver

8，（强制）接口类中的方法，不加任何的修饰符，例如void f();不要public等修饰。

9，（推荐）service/DAO中方法命名规则：获得单个对象使用get前缀，获得多个对象使用list前缀，统计方法使用count前缀，插入的方法使用save/insert做前缀，删除使用remove/delete做前缀，修改使用update做前缀。

二，常量定义

1，（强制）不允许任何未定义的常量出现在代码中，比如未定义的字符串或者数字，“id_”，999等。

2，（强制）长整型的变量使用大写L不适用小写l，避免l和1混淆。比如使用Long a = 2L；不适用Long b = 2l；

3，（推荐）定义变量的类使用五层分开：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

4，（推荐）如果变量值仅在一个范围内变化，且带着名称之外的延伸属性，定义为枚举类型。