OOP规约
-
【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用类名来访问即可。
所以静态方法直接调用,不要new 对象.静态方法(). 甚至工具类就不应该写 public的构造函数,或者写一个private的构造函数避免其它人通过构造函数new对象来调用工具方法 -
【强制】所有的覆写方法,必须加@Override 注解。(原来实现类 不加注解编译也不会报错)
反例:getObject()与 get0bject()的问题。一个是字母的 O,一个是数字的 0,加@Override可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错。 -
【强制】不能使用过时的类或方法。
-
【强制】Object 的 equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals。
因为null.equals()方法时会空指针。这个真的要注意,平时真的经常会遇到。
正例: "test".equals(object);
反例: object.equals("test"); -
【强制】所有的相同类型的包装类对象之间值的比较,全部使用 equals 方法比较。 比如 Integer 超过127之后,用等号就无法比较大小了,只能用equals,则是准确的
Integer index1=200;
Integer index2=200;
// 输出false
System.out.println(index1==index2);
- 【强制】关于基本数据类型与包装数据类型的使用标准如下:
1) 所有的 POJO 类属性必须使用包装数据类型。(防止数据库中返回null值而抛异常)
2) RPC 方法的返回值和参数必须使用包装数据类型。(防止远程调用中返回null值而抛异常)
3) 所有的局部变量【推荐】使用基本数据类型。
说明:POJO 类属性没有初值是ᨀ醒使用者在需要使用时,必须自己显式地进行赋值,任何NPE 问题,或者入库检查,都由使用者来保证。
正例:数据库的查询结果可能是 null,因为自动拆箱,用基本数据类型接收有 NPE 风险。
反例:比如显示成交总额涨跌情况,即正负 x%,x 为基本数据类型,调用的 RPC 服务,调用不成功时,返回的是默认值,页面显示:0%,这是不合理的,应该显示成中划线-。所以包装数据类型的 null 值,能够表示额外的信息,如:远程调用失败,异常退出。
使用包装类的好处:
- 可以额外的存储null值,这样就不容易空指针
- null值可以额外的表示一些信息
-
【强制】构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在 init 方法中。
-
【推荐】类成员与方法访问控制从严:
1) 如果不允许外部直接通过 new 来创建对象,那么构造方法必须是 private。
2) 工具类不允许有 public 或 default 构造方法。(避免外部通过new 来调用工具方法)
3) 类非 static 成员变量并且与子类共享,必须是 protected。
4) 类非 static 成员变量并且仅在本类使用,必须是 private。
5) 类 static 成员变量如果仅在本类使用,必须是 private。
6) 若是 static 成员变量,必须考虑是否为 final。
7) 类成员方法只供类内部调用,必须是 private。
8) 类成员方法只对继承类公开,那么限制为 protected。
说明:任何类、方法、参数、变量,严控访问范围。过宽泛的访问范围,不利于模块解耦。
思考:如果是一个 private 的方法,想删除就删除,可是一个 public 的 Service 方法,或者一个 public 的成员变量,删除一下,不得手心冒点汗吗?
变量像自己的小孩,尽量在自己的视线内,变量作用域太大,如果无限制的到处跑,那么你会担心的。
缩小代码的访问范围,提升可控性。
- 【推荐】setter 方法中,参数名称与类成员变量名称一致,this.成员名=参数名。在getter/setter 方法中,尽量不要增加业务逻辑,增加排查问题的难度。
反例:
public Integer getData(){
if(true) {
return data + 100;
} else {
return data - 100;
}
}
- 【推荐】循环体内,字符串的联接方式,使用 StringBuilder 的 append 方法进行扩展。String 拼接的时候重点注意啊。很容易写出垃圾代码。
反例:
String str = "start";
for(int i=0; i<100; i++){
str = str + "hello";
}
说明:反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象,然后进行
append 操作,最后通过 toString 方法返回 String 对象,造成内存资源浪费。
网友评论