- 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成 本,直接用类名来访问即可。
理解:最常见的像我们的工具类里会定义很多的时间日期或者正则校验等方法,或者像我们的常量类里的常量,我们只需要用类名直接访问就好了,不需要实例化类,然后通过对象访问。
- 【强制】所有的覆写方法,必须加@Override 注解。
说明:getObject()与 get0bject()的问题。一个是字母的 O,一个是数字的 0,加@Override 可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名(方法名和形参列表共同组成**方法签名**)进行修改,其实现类会马上编译报错。
理解:这样加上注解更清晰明了。
- 【强制】相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object。
说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)
正例:public User getUsers(String type, Integer... ids) {...}
理解:Python可变参数使用比较常见,不过我们还是尽量不要采用可变参数吧,这样让方法更明确。
- 【强制】外部正在调用或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产生影响。接口过时必须加@Deprecated 注解,并清晰地说明采用的新接口或者新服务是什么。
理解:被别的应用使用的接口,不要修改方法名或参数,过时不再建议使用的接口加@Deprecated 注解明确标识出来,并指出代替方案。简单来讲就是,若某类或某方法加上该注解之后,表示此方法或类不再建议使用,调用时也会出现删除线,但并不代表不能用,只是说,不推荐使用,因为还有更好的方法可以调用。
- 【强制】不能使用过时的类或方法。
说明:java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时,应 该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口, 那么有义务同时提供新的接口;作为调用方来说,有义务去考证过时方法的新实现是什么。
理解:这个好,尤其对一些第三方的包里的方法,如果有新的我们就用新的吧。
- 【强制】Object 的 equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用 equals。
正例:"test".equals(object);
反例:object.equals("test");
说明:推荐使用 java.util.Objects#equals(JDK7 引入的工具类)
理解:用Objects.equals(a,b),这里a,b类型要保证一致,否则可能出现你不希望的结果。
- 【强制】所有的相同类型的包装类对象之间值的比较,全部使用 equals 方法比较。
说明:对于 Integer var = ? 在-128 至 127 范围内的赋值,Integer 对象是在IntegerCache.cache 产生,会复用已有对象,这个区间内的 Integer 值可以直接使用==进行 判断,但是这个区间之外的所有数据,都会在堆上产生,并不会复用已有对象,这是一个大坑, 推荐使用 equals 方法进行判断。
理解:关于数值比较还真的容易出错。java中一个Integer 与 int比较,先将Integer转换成int类型,再做值比较。还有与Integer类似的是Long,它也有一个缓存,在区间[-128,127]范围内获取缓存的值,而Long与long比较的时候先转换成long类型再做值的比较。Double类型,它没有缓存,但是当Double与double比较的时候会先转换成double类型,再做值的比较。所以,所有包装类型进行值的比较时(不管地址),采用equals进行比较肯定是不会错的。
==参见详细例子说明==
- 关于基本数据类型与包装数据类型的使用标准如下:
1) 【强制】所有的 POJO 类属性必须使用包装数据类型。
2) 【强制】RPC 方法的返回值和参数必须使用包装数据类型。
3) 【推荐】所有的局部变量使用基本数据类型。
说明:POJO 类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何 NPE(NullPointerException的简称,也就是空指针异常) 问题,或者入库检查,都由使用者来保证。
正例:数据库的查询结果可能是 null,因为自动拆箱,用基本数据类型接收有 NPE 风险。
反例:比如显示成交总额涨跌情况,即正负 x%,x 为基本数据类型,调用的 RPC(远程过程调用) 服务,调用 不成功时,返回的是默认值,页面显示为 0%,这是不合理的,应该显示成中划线。所以包装 数据类型的 null 值,能够表示额外的信息,如:远程调用失败,异常退出。
理解:RPC(远程过程调用)的主要依赖技术是序列化、反序列化和传输协议,JAVA里对应的就是对象的序列化、反序列化以及序列化后数据的传输。所以RPC方法的返回值和参数必须使用包装数据类型,否则不能序列化。局部变量不涉及传输问题,比较和计算等都是直接使用值,基本类型最方便也最高效。
- 【强制】定义 DO/DTO/VO 等 POJO 类时,不要设定任何属性默认值。
反例:POJO 类的 gmtCreate 默认值为 new Date();但是这个属性在数据提取时并没有置入具体值,在更新其它字段时又附带更新了此字段,导致创建时间被修改成当前时间。
理解:目前平台生成的POJO都是满足这个要求的,我们不需要修改。
- 【强制】序列化类新增属性时,请不要修改 serialVersionUID 字段,避免反序列失败;如果完全不兼容升级,避免反序列化混乱,那么请修改 serialVersionUID 值。
说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。
理解:serialVersionUID是Java为每个序列化类产生的版本标识:版本相同,相互之间则可序列化和反序列化;版本不同,反序列化时会抛出InvalidClassException。因不同的jdk编译很可能会生成不同的serialVersionUID默认值,通常需要显式指定,如1L。
==关于序列化参见==
- 【强制】构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在 init 方法中。
理解:使用构造方法创建对象,就像新生儿,不需要他懂什么:)
- 【强制】POJO 类必须写 toString 方法。使用 IDE 的中工具:source> generate toString 时,如果继承了另一个 POJO 类,注意在前面加一下 super.toString。
说明:在方法执行抛出异常时,可以直接调用 POJO 的 toString()方法打印其属性值,便于排查问题。
理解:这确实是一个排查bug的好方法,目前平台里生成的POJO类并不会直接生成toString方法,为了调试方便,可以添加进来。
- 【推荐】使用索引访问用 String 的 split 方法得到的数组时,需做最后一个分隔符后有无内容的检查,否则会有抛 IndexOutOfBoundsException 的风险。
说明: String str = "a,b,c,,";
String[] ary1 = str.split(","); // 预期大于 3,结果是 3
String[] ary2 = str.split(",",-1); // 不忽略任何一个分隔符,长度是5
// 最前面的和末尾的分隔符全部都忽略,apache commons
String[] ary3 = StringUtils.split(str,",");
System.out.println(ary1.length);
System.out.println(ary2.length);
System.out.println(ary3.length);
理解:如果字符串不是固定的,首先要做非空校验,然后再根据需要采用适当的split分割方法。
- 【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起, 便于阅读,此条规则优先于第 15 条规则。
理解:这个可以有,起码方便查找和调用。
- 【推荐】 类内方法定义顺序依次是:公有方法或保护方法 > 私有方法 > getter/setter 方法。
说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好;保护方法虽然只是子类 关心,也可能是“模板设计模式”下的核心方法;而私有方法外部一般不需要特别关心,是一个 黑盒实现;因为承载的信息价值较低,所有 Service 和 DAO 的 getter/setter 方法放在类的最后。
理解:目前我们的类中是符合该规则的。
- 【推荐】setter 方法中,参数名称与类成员变量名称一致,this.成员名 = 参数名。在 getter/setter 方法中,不要增加业务逻辑,增加排查问题的难度。
反例: public Integer getData() {
if (true) {
return this.data + 100;
} else {
return this.data - 100;
}
}
理解:目前我们的POJO类我们是不做修改的,符合这个要求。
- 【推荐】循环体内,字符串的连接方式,使用 StringBuilder 的 append 方法进行扩展。
说明:反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象,然后进行 append 操作,最后通过 toString 方法返回 String 对象,造成内存资源浪费。
反例: String str = "start";
for (int i = 0; i < 100; i++) {
str = str + "hello";
}
理解:循环中,要么用StringBuffer、要么用StringBuilder的append方法进行扩展。
- 【推荐】final 可以声明类、成员变量、方法、以及本地变量,下列情况使用 final 关键字:
1) 不允许被继承的类,如:String 类。
2) 不允许修改引用的域对象,如:POJO 类的域变量。
3) 不允许被重写的方法,如:POJO 类的 setter 方法。
4) 不允许运行过程中重新赋值的局部变量。
5) 避免上下文重复使用一个变量,使用 final 描述可以强制重新定义一个变量,方便更好地进行重构。
理解:目前我们常量类、工具类中用的比较多。
- 【推荐】慎用 Object 的 clone 方法来拷贝对象。
说明:对象的 clone 方法默认是浅拷贝,若想实现深拷贝需要重写 clone 方法实现属性对象的拷贝。
理解:平时用的不多,在一些比较底层或设计模式中会用到。
== 参见java深浅拷贝及其实现方式==
- 【推荐】类成员与方法访问控制从严:
1) 如果不允许外部直接通过 new 来创建对象,那么构造方法必须是 private。
2) 工具类不允许有 public 或 default 构造方法。
3) 类非 static 成员变量并且与子类共享,必须是 protected。
4) 类非 static 成员变量并且仅在本类使用,必须是 private。
5) 类 static 成员变量如果仅在本类使用,必须是 private。
6) 若是 static 成员变量,必须考虑是否为 final。
7) 类成员方法只供类内部调用,必须是 private。
8) 类成员方法只对继承类公开,那么限制为 protected。
说明:任何类、方法、参数、变量,严控访问范围。过于宽泛的访问范围,不利于模块解耦。
思考:如果是一个 private 的方法,想删除就删除,可是一个 public 的 service 方法,或者 一个 public 的成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视线内,变量作用域太大,无限制的到处跑,那么你会担心的。
理解:我们尽量学着遵守吧,对自己提高很有必要。