第三天：第1章 编程规约 （1.4 OOP规约）

今天看了一看 1.4 OOP规约，这个内容有一些十分值得记录并应用到编程中。推荐看 5 6 8 15 17 20

1、【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，造成无谓增加编译器解析成本，直接用类名来访问即可。

理解：这里具体原因我不知道，但是我有印象说对象直接访问类属性，编译器会将对象转化为类，然后去访问类属性。这里有了解的同学可以留言评论。

2、【强制】所有的复写方法，必须加@Override注解

说明：getObject() 与 get0bject()的问题。一个是字母O，一个是数字0，加@Override可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

理解：关于重写重载，记住一个关键词，方法签名。方法签名包括 方法名称及形参。

重载：方法签名一定要不同，返回参数及修饰符无所谓。

重写：跟父类一模一样就好，修饰符可以向上扩展。

3、【强制】相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。

说明：可变参数必须放置在参数列表的最后（建议工程师们尽量不用可变参数编程）

理解：

可变参数的机制是通过先创建一个数组，数组的大小为在调用位置所传递的参数数量，然后将参数值传到数组中，最后将数组传递给方法

4、【强制】对外部正在调用或者二方库依赖的接口，不允许修改方法签名，以避免对接口调用方产生影响。若接口过时，必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。

理解：主要是说给SDK开发的。配合 5 看。

5、【强制】不能使用过时的类

说明：java.net.URLDecoder中的方法decode（String encodeStr）已经过时，应该使用双参数decode（String source，String encode）。接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么

理解：接口提供方写说明，接口调用方看原因。

6、【强制】Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。

正例："test".equals(object);

反例：object.equals("test");

说明：推荐使用 java.util.Objects#equals（JDK7引入的工具类）。

理解：直接代码，另外这个工具类需要 最小SDK版本为 19，也就是API 4.4。

boolean equals = Objects.equals("a", "b");

7、【强制】所有相同类型的包装类对象之间值的比较，全部使用equals方法。

说明：对于Inerger var = ? 在 -128 ~ 127 范围内的赋值，Integer对象实在IntegerCache.cache中产生的，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，且不会复用已有对象。这是一个大坑，推荐使用equals方法进行判断

理解：自动装箱自动拆箱，记住 -128 ~ 127 即可。同时记住，包装类对象使用equals。

8、关于基本数据类型与包装数据类型的使用标准如下：

1）【强制】所有的POJO类属性必须使用包装数据类型。

2）【强制】RPC方法的返回值和参数必须使用包装数据类型。

3）【推荐】所有的局部变量使用基本数据类型。

说明：POJO 类属性没有初值，是要提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。

正例：数据库的查询结果可能是null，因为自动拆箱，所以用基本数据类型接收有NPE风险。

反例：比如显示成交总额涨跌情况，即正负X%，X为基本数据类型，调用的RPC服务在调用不成功时，返回的是默认值，页面显示为0%，这是不合理的，因该显示成中画线。所以包装数据类型的null值，能够表示额外的信息，如：远程调用失败，异常退出。

理解：楼主对这一条的理解很是深刻。因为楼主有个项目是股票类APP，那么显示 0% 和 中画线 （即 “ -- ”） 是很不同的概念。如 涨幅 0% 和 涨幅 -- 。这个意思肯定是不同的。

简单举个例子：

public static Integer num;

可能我们一般都写成了 int，但是这里强制写成 Integer，为的就是提醒使用者在使用时需要显式赋值，或者判 null 。

如果写成了 int，初始化值就成了0，那么使用者就不知道 0 是正常赋值还是初始化值，导致混乱。

9、【强制】在定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。

反例：POJO类的gmtCreate默认值为 new Date();，但是这个属性在数据提取时并没有置入具体值，在更新其他字段时又附带更新了此字段，导致创建时间被修改成当前时间。

理解：比如数据库里面，一个字段保存创建时间，那么初始化时，字段保存时间如 10:00 或者 时间戳 xxxxx，那么当你在 10:20更新其他字段时，附带更新了此字段，那么它的值就会变成10:20 或者 其对应的时间戳。

这里我个人的其他理解是，不要对值进行初始化赋值。

private List dataList = new ArrayList();

在需要时判空，然后 new 出来。

10、【强制】当序列化类新增属性时，请不要修改 serialVersionUID字段，以避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。

说明：注意serialVersionUID不一致会抛出序列化运行时异常。

理解：这个一般也没人去修改。

11、【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。

理解：这个很好理解，比如自定义控件会经常用到。initView，initLayout这一类的名称，传递参数即可。

12、【强制】POJO类必须写toString方法。在使用IDE中的工具 source > generate toString时，如果继承了另一个POJO类，注意在前面加一下 super.toString。

说明：在方法执行抛出异常时，可以直接调用POJO的toString（）方法打印其属性值，便于排查问题。

理解：这个就很有必要了，可以直接用AS自动生成 toString。快捷键 Alt + Ins

public class Teacher {
    private int age;
    private String name;

    @Override
    public String toString() {
        return "Teacher{" +
                "age=" + age +
                ", name='" + name + '\'' +
                '}';
    }
}

13、【推荐】当使用索引访问用String的split方法得到的数组时，需要在最后一个分隔符后做有无内容的检查， 否则会有抛IndexOutOfBoundsException风险。

说明：

String str = "a,b,c,,";
String[] ary = str.split(",");
// 预期大于3，结果是3
System.out.println(ary.length);

理解：如图，总感觉开发用到的情况很少，看我标记的地方，看示例

http://tool.oschina.net/apidocs/apidoc?api=jdk-zh

split

public String[] split(String regex,
                      int limit)
根据匹配给定的 正则表达式来拆分此字符串。
此方法返回的数组包含此字符串的子字符串，每个子字符串都由另一个匹配给定表达式的子字符串终止，或者由此字符串末尾终止。数组中的子字符串按它们在此字符串中出现的顺序排列。如果表达式不匹配输入的任何部分，那么所得数组只具有一个元素，即此字符串。

limit 参数控制模式应用的次数，因此影响所得数组的长度。如果该限制 n 大于 0，则模式将被最多应用 n - 1 次，数组的长度将不会大于 n，而且数组的最后一项将包含所有超出最后匹配的定界符的输入。如果 n 为非正，那么模式将被应用尽可能多的次数，而且数组可以是任何长度。如果 n 为 0，那么模式将被应用尽可能多的次数，数组可以是任何长度，并且结尾空字符串将被丢弃。

例如，字符串 "boo:and:foo" 使用这些参数可生成以下结果：

Regex	Limit	结果
:	2	{ "boo", "and:foo" }
:	5	{ "boo", "and", "foo" }
:	-2	{ "boo", "and", "foo" }
o	5	{ "b", "", ":and:f", "", "" }
o	-2	{ "b", "", ":and:f", "", "" }
o	0	{ "b", "", ":and:f" }
调用此方法的 str.split(regex, n) 形式与以下表达式产生的结果完全相同：

Pattern. compile ( regex ). split ( str ,  n )
参数：
regex - 定界正则表达式
limit - 结果阈值，如上所述
返回：
字符串数组，它是根据给定正则表达式的匹配拆分此字符串确定的
抛出：
PatternSyntaxException - 如果正则表达式的语法无效
从以下版本开始：
1.4
另请参见：
Pattern

o -2 { "b", "", ":and:f", "", "" } 主要看这个

14、【推荐】当一个类有多个构造方法，或者多个同名方法时，这些方法应该按顺序放置在一起，便于阅读，此条规则优化与本节第15条规则

15、【推荐】类内方法定义顺序是：公有方法或保护方法 > 私有方法 > getter /  setter 方法。

说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只有子类关心，但也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要关心，是一个黑盒实现；因为承载的信息价值较低，所有Service 和DAO的 getter / setter 方法放在类体最后。

理解：非常好的分类归纳。非常有利于代码逻辑层次，另外一定要注意注释写法。形参 返回参数 说明等。

16、【推荐】在setter方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在 getter / setter 方法中，不要增加业务逻辑，否则会增加排查问题的难度。

反例：

public Integer getData() {
    if (condition) {
        return this.data + 100;
    } else {
        return this.data - 100;
    }
}

理解：开发中谁干这事谁傻。

17、【推荐】在循环体内，字符串的连接方式使用StringBuilder的append方法进行扩展。

说明：反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，然后进行append操作，最后通过 toString方法返回String对象，造成内存资源浪费。

反例：

String str = "start";
for (int i = 0; i < 100; i++) {
    str = str + "hello";
}

理解：这个从说明来看，阿里程序员从反编译的字节码看，字符串的拼接实际上经历了， new StringBuilder，append，toString 三个操作，如果循环 100次，就表示 new 了 100 次StringBuilder 。对于这一点，开发中倒是没见过，涨知识了。

18、【推荐】final可以声明类、成员变量、方法及本地变量，下列情况使用final关键字：

1）不允许被继承的类，如：String 类

2）不允许修改引用的域对象，如：POJO类的域变量

3）不允许被重写的方法，如：POJO类的Setter方法

4）不允许运行过程中重新赋值的局部变量

5）避免上下文重复使用一个变量，使用final描述可以强制重新定义一个变量，方便更好地进行重构

理解：SDK开发用的更多一些。平常开发，一般常量或者局部变量扩大作用域，如匿名内部类使用局部变量。

19、【推荐】慎用Object的clone方法来拷贝对象。

说明：对象的clone方法默认是浅拷贝，若想实现深拷贝，需要重写clone方法来实现属性对象的拷贝。

20、【推荐】类成员与方法访问控制从严：

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的成员变量，删除时手心不得冒点汗吗？变量像自己的小孩，应尽量让它在自己的视线范围内。变量作用域太大，如果任其无限制地到处跑，你会担心的。

理解：这个没啥可说的，开发习惯，必须遵守。