阿里巴巴Java开发手册

时间:2022-02-24 03:25:31

一,命名风格

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,(推荐)如果变量值仅在一个范围内变化,且带着名称之外的延伸属性,定义为枚举类型。


三,代码格式

1,(强制)if/for/while/switch/do等关键字和括号之间必须有空格

2,(强制)// 注释之间必须有一个空格

3,(强制)方法参数在定义和传入时,多个参数逗号后边必须加空格。


四,OOP规约

1,(强制)避免通过一个类的对象引用访问此类的静态方法或静态方法,直接用类名来访问

2,(强制)重写的方法都加上@Override

3,(强制)相同参数类型,相同业务含义,才可以使用可变参数,避免使用object做可变参数。

4,(强制)不能使用过时的类和方法,过时的类和方法必须注明替代方法

5,(强制)Object的equals方法容易造成空指针,使用"test".equals(object)不使用object.equals("test")

6,(强制)Integer在-128至127之内和基本数据类型是相同的,Integer的比较必须使用equals比较

7,(强制)所有的POJO,方法的接收参数返回值都是用包装数据类型,局部变量使用基本数据类型。

8,(强制)POJO中不设定任何属性的默认值,可能引起不必要的问题

9,(强制)构造方法中禁止加入任何的业务逻辑,如果有初始化逻辑,请放在init方法中

10,(强制)POJO类必须写toString方法。

15,(推荐)当一个类多个构造方法,或者多个重载方法,必须按顺序放置一起,方便阅读。

16,(推荐)类内的方法定义顺序:公有方法或保护方法>私有方法>getter/setter

17,(推荐)getter/setter中不增加业务逻辑

18,(推荐)慎用Object的clone方法来拷贝对象,因为默认是浅拷贝。