《阿里巴巴开发手册》读书笔记(一)

6. 【强制】抽象类命名使用 Abstract Base 开头 异常类命名使用 Exception 结尾 测试类

命名以它要测试的类的名称开始,以 Test 结尾。


8. 【强制】 POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。
反例: 定义为基本数据类型 boolean isSuccess的属性,它的方法也是 isSuccess()RPC
框架在反向解析的时候, 以为对应的属性名称是 success,导致属性获取不到,进而抛出异

常。


11. 【推荐】如果使用到了设计模式,建议在类名中体现出具体模式。
说明: 将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。
正例: public class OrderFactory;
public class LoginProxy;

public class ResourceObserver;


12. 【推荐】接口类中的方法和属性不要加任何修饰符号public 也不要加,保持代码的简洁
性,并加上有效的
Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是
与接口方法相关,并且是整个应用的基础常量。
正例: 接口方法签名: void f();
接口基础常量表示: String COMPANY = "alibaba";
反例: 接口方法定义: public abstract void f();
说明: JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默

认实现。


15. 【参考】各层命名规约:
A) Service/DAO 层方法命名规约
1获取单个对象的方法用 get 做前缀。
2获取多个对象的方法用 list 做前缀。
3获取统计值的方法用 count 做前缀。
4插入的方法用 save推荐insert 做前缀。
5删除的方法用 remove推荐delete 做前缀。
6修改的方法用 update 做前缀。
B) 领域模型命名规约
1数据对象: xxxDOxxx 即为数据表名。
2数据传输对象: xxxDTOxxx 为业务领域相关的名称。
3展示对象: xxxVOxxx 一般为网页名称。

4POJO DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO


2.11. 【强制】不允许出现任何魔法值即未经定义的常量直接出现在代码中。
反例: String key="Id#taobao_"+tradeId

cache.put(key, value);


2.55. 【推荐】如果变量值仅在一个范围内变化用 Enum 类。如果还带有名称之外的延伸属性,必须
使用
Enum 类,下面正例中的数字就是延伸信息,表示星期几。
正例: public Enum{ MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5),
SATURDAY(6), SUNDAY(7);}


3.55. 【强制】 缩进采用 4 个空格,禁止使用 tab 字符。
说明: 如果使用 tab 缩进,必须设置 1 tab 4 个空格。 IDEA 设置 tab 4 个空格时,

请勿勾选 Use tab character;而在 eclipse 中,必须勾选 insert spaces for tabs


3.66. 【强制】单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:
1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。
2运算符与下文一起换行。
3方法调用的点符号与下文一起换行。
4在多个参数超长,逗号后进行换行。
5在括号前不要换行,见反例。
正例:
StringBuffer sb = new StringBuffer();
//超过 120 个字符的情况下,换行缩进 4 个空格,并且方法前的点符号一起换行
sb.append("zi").append("xin")...
        .append("huang")...
        .append("huang")...
        .append("huang");


3.88. 【强制】 IDE text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式,
不要使用
windows 格式。


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


4.33. 【强制】相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object
说明: 可变参数必须放置在参数列表的最后。 提倡同学们尽量不用可变参数编程
正例: public User getUsers(String type, Integer... ids)


4.44. 【强制】对外暴露的接口签名,原则上不允许修改方法签名,避免对接口调用方产生影响。接
口过时必须加@
Deprecated 注解,并清晰地说明采用的新接口或者新服务是什么。


4.55. 【强制】不能使用过时的类或方法====》本人注:本条已在java10中得到禁止,否则后果很严重


4.77. 【强制】所有的相同类型的包装类对象之间值的比较,全部使用 equals 方法比较。
说明: 对于 Integer var=?-128 127 之间的赋值, Integer 对象是在
IntegerCache.cache 产生,会复用已有对象,这个区间内的 Integer 值可以直接使用==进行
判断,但是这个区间之外的所有数据,都会在堆上产生,并不会复用已有对象,这是一个大坑,

推荐使用 equals 方法进行判断。


4.88. 【强制】关于基本数据类型与包装数据类型的使用标准如下:
1所有的 POJO 类属性必须使用包装数据类型。
2RPC 方法的返回值和参数必须使用包装数据类型。
3所有的局部变量【推荐】 使用基本数据类型。
说明: POJO 类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何
NPE 问题,或者入库检查,都由使用者来保证。
正例: 数据库的查询结果可能是 null,因为自动拆箱,用基本数据类型接收有 NPE 风险。
反例: 比如显示成交总额涨跌情况,即正负 x%x 为基本数据类型,调用的 RPC 服务,调用
不成功时,返回的是默认值,页面显示:
0%,这是不合理的,应该显示成中划线-。所以包装
数据类型的
null 值,能够表示额外的信息, 如:远程调用失败,异常退出。





Guess you like

Origin http://43.154.161.224:23101/article/api/json?id=325849294&siteId=291194637