转载: https://github.com/alibaba/p3c
1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成
本,直接用类名来访问即可。
2. 【强制】所有的覆写方法,必须加@Override 注解。
- 说明:getObject()与 get0bject()的问题。一个是字母的 O,一个是数字的 0,加@Override 可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错。
3. 【强制】相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object。
- 说明:可变参数必须放置在参数列表的最后。(建议开发者尽量不用可变参数编程)
正例:public List<User> listUsers(String type, Long… ids) {…}
4. 【强制】外部正在调用或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产生影响。
- 接口过时必须加@Deprecated 注解,并清晰地说明采用的新接口或者新服务是什么。
5. 【强制】不能使用过时的类或方法。
说明:java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时,应该使用双参数decode(String source, String encode)。
接口提供方既然明确是过时接口,那么有义务同时提供新的接口;
作为调用方来说,有义务去考证过时方法的新实现是什么。
6. 【强制】Object 的 equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用 equals。
正例:“test”.equals(object);
反例:object.equals(“test”);
说明:推荐使用 JDK7 引入的工具类 java.util.Objects#equals(Object a, Object b)
7. 【强制】所有整型包装类对象之间值的比较,全部使用 equals 方法比较。
8. 【强制】任何货币金额,均以最小货币单位且整型类型来进行存储。
9. 【强制】浮点数之间的等值判断,基本数据类型不能用==来比较,包装数据类型不能用 equals来判断。
10.【强制】如上所示 BigDecimal 的等值比较应使用 compareTo()方法,而不是 equals()方法。
- 说明:equals()方法会比较值和精度(1.0 与 1.00 返回结果为 false),而 compareTo()则会忽略精度。
11.【强制】定义数据对象 DO 类时,属性类型要与数据库字段类型相匹配。
12.【强制】禁止使用构造方法 BigDecimal(double)的方式把 double 值转化为 BigDecimal 对象。
说明:BigDecimal(double)存在精度损失风险,在精确计算或值比较的场景中可能会导致业务逻辑异常。
如:BigDecimal g = new BigDecimal(0.1F); 实际的存储值为:0.10000000149
正例:优先推荐入参为 String 的构造方法,或使用 BigDecimal 的 valueOf 方法,此方法内部其实执行了Double 的 toString,而 Double 的 toString 按 double 的实际能表达的精度对尾数进行了截断。
$$
BigDecimal recommend1 = new BigDecimal(“0.1”); BigDecimal recommend2 = BigDecimal.valueOf(0.1);
$$
13.关于基本数据类型与包装数据类型的使用标准如下:
【强制】所有的 POJO 类属性必须使用包装数据类型。
【强制】RPC 方法的返回值和参数必须使用包装数据类型。
【推荐】所有的局部变量使用基本数据类型。
说明:POJO 类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何 NPE 问题,或者入库检查,都由使用者来保证。
正例:数据库的查询结果可能是 null,因为自动拆箱,用基本数据类型接收有 NPE 风险。
反例:某业务的交易报表上显示成交总额涨跌情况,即正负 x%,x 为基本数据类型,调用的 RPC 服务,调用不成功时,返回的是默认值,页面显示为 0%,这是不合理的,应该显示成中划线-。
所以包装数据类型的 null 值,能够表示额外的信息,如:远程调用失败,异常退出。
14.【强制】定义 DO/DTO/VO 等 POJO 类时,不要设定任何属性默认值。
- 反例:POJO 类的 createTime 默认值为 new Date(),但是这个属性在数据提取时并没有置入具体值,在更新其它字段时又附带更新了此字段,导致创建时间被修改成当前时间。
16.【强制】构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在 init 方法中。
17.【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具:source> generate toString
时,如果继承了另一个 POJO 类,注意在前面加一下 super.toString。 说明:在方法执行抛出异常时,可以直接调用 POJO 的 toString()方法打印其属性值,便于排查问题。
23.【推荐】循环体内,字符串的连接方式,使用 StringBuilder 的 append 方法进行扩展。
说明:下例中,反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象,然后进行 append 操作,最后通过 toString 方法返回 String 对象,造成内存资源浪费。
24.【推荐】final 可以声明类、成员变量、方法、以及本地变量,下列情况使用 final 关键字:
不允许被继承的类,如:String 类。
不允许修改引用的域对象,如:POJO 类的域变量。
不允许被覆写的方法,如:POJO 类的 setter 方法。
不允许运行过程中重新赋值的局部变量。
避免上下文重复使用一个变量,使用 final 关键字可以强制重新定义一个变量,方便更好地进行重构。
25.【推荐】慎用 Object 的 clone 方法来拷贝对象。
- 说明:对象 clone 方法默认是浅拷贝,若想实现深拷贝,需覆写 clone 方法实现域对象的深度遍历式拷贝。
26.【推荐】类成员与方法访问控制从严:
如果不允许外部直接通过 new 来创建对象,那么构造方法必须是 private。
工具类不允许有 public 或 default 构造方法。
类非 static 成员变量并且与子类共享,必须是 protected。
类非 static 成员变量并且仅在本类使用,必须是 private。
类 static 成员变量如果仅在本类使用,必须是 private。
若是 static 成员变量,考虑是否为 final。
类成员方法只供类内部调用,必须是 private。
类成员方法只对继承类公开,那么限制为 protected。