阿里巴巴开发规范文档解读（二）：常量定义、代码格式、OOP规约

与第一部分相比，这部分有较少的个人见解，算是开发文档的阉割版，整理了一些需要使用到的规范，放弃了一些常用、熟悉的规范。

二、常量定义

1.不允许任何魔法数值(未经预先定义的常量)出现在代码中

反例 ； 
	int priceTable[] = new int[16]； //ERROR：这个16究竟有何含义呢？
正例 ： 
	static final int PRICE_TABLE_MAX = 16； //带名字
	int price Table[] = new int [PRICE_TABLE_MAX]； //名字的含义是很清楚的

2.不要使用一个大而全的常量维护所有常量，按常量的功能进行归类，分开维护。

例如：连接mongo数据库使用的连接名、字段名等使用一个 MongoDBConstants
	  对于异常报的各种错误码可使用 ExceptionConstants

三、代码格式

1.if、for、switch、do、while等保留字与括号之间必须加空格

反例：if(a > 9)...
正例：if (a > 9)...

2.注释的双斜线与注释之间有且仅有一个空格

正例：
// 这是示例注释，请注意在双斜线之后有一个空格
String cs = "";

3.不同逻辑、不同语义、不同业务的代码之间插入一个空格分开来以提升可读性，没有必要查多行空格

四、OOP规约

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

解读：如果使用一个类(类名为B)的静态方法(public static methodA())，直接使用B.methodB()即可，
	而不是使用 B b = new B(); b.methodB();

2.方法覆写使用@Override注解

例：impl实现Service，所有方法都使用@Override注解

3.可变参数：必须放在参数列表最后

例： public User getUsers(String type, Integer... ids)

4.接口过时必须加@Deprecated注解，并说明新服务是什么

5.基本数据类型和包装类型

i.所有POJO类属性必须使用包装数据类型
ii.RPC方法的返回值必须使用包装数据类型
iii.所有的局部变量使用基本数据类型

6.序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败

7.构造方法里边禁止加入任何业务逻辑，如果有初始化逻辑，放在init方法中

8.POJO类必须写toString方法。因为现在都引用了lombok，可以使用@ToString注解

9.类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter方法

10.谨慎使用object的Clone方法

11.类成员与方法访问控制从严：

成员变量：
1） 类非static成员变量并且与子类共享，必须是protected; 
	类成员变量(static OR 非static)且仅在本类使用，必须是private。
理解：
	i.这个protected使用场景很少，但是使用出来绝对是亮点。在model中，所有字段都有set、get方法，因此model很少用到protected，且由于封装特性，几乎都是private。
	ii.例：在一些service中使用mongoDB，是逃不脱使用MongoOperation或者MongoTemplate，因此我们可以在基类中定义 @Autowired private MongoTempate mongoTemplate;
2） 若是static成员变量，必须考虑是否为final。
方法：
3） 如果不允许外部直接通过new来创建对象，那么构造方法必须是private。 
4） 工具类不允许有public或default构造方法
	i.工具类里面的方法全部都是static的，它的构造方法必须是private的,这样可以通过 类名.方法名 调用方法。
	ii.使用private修饰构造方法时，这个类不能被实例化(无法通过new或者反射创建对象)，也不能被继承，因此避免了创建多余的对象。
	iii.一般的model是需要使用new来直接创建对象的，因此它的构造方法并不是private的。	
6） 类成员方法只供类内部调用，必须是private。 
7） 类成员方法只对继承类公开，那么限制为protected。