会当凌绝顶，一览众山小。阿里王子经过一年的修炼，阿里王子自编的《Java 开发手册》泰山版于 4.22 正式发布。按照 1.60 版本总结
一、 编程规约
(一) 命名风格
- 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。 反例：_name / name / n a m e / n a m e / n a m e name / name_ / name name/name/name / name。
- 【强制】类名使用UpperCamelCase风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID等。
正例：ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion
反例：forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion - 接口和实现类的命名有两套规则：
（1）【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
正例：CacheServiceImpl实现CacheService接口。
（ 2）【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able的形容词）。
正例：AbstractTranslator实现 Translatable接口。 - 【参考】各层命名规约：
（A) Service/DAO层方法命名规约
（1） 获取单个对象的方法用get做前缀。
（2） 获取多个对象的方法用list做前缀，复数结尾，如：listObjects。
（3） 获取统计值的方法用count做前缀。
（4） 插入的方法用save/insert做前缀。
（5） 删除的方法用remove/delete做前缀。 6） 修改的方法用update做前缀。
（B) 领域模型命名规约
（1） 数据对象：xxxDO，xxx即为数据表名。
（2） 数据传输对象：xxxDTO，xxx为业务领域相关的名称。
（3） 展示对象：xxxVO，xxx一般为网页名称。
（4） POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。
(二) 常量定义
- 【强制】在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字
混淆，造成误解。
说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2。
(三) 代码格式
- 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。 （这一点有点疑惑为什么必须加空格隔开，各位大牛们可否解答一波？？）
- 【强制】任何二目、三目运算符的左右两边都需要加一个空格。
说明：包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
代码规范参考：
public static void main(String[] args) {
// 缩进 4 个空格
String say = "hello";
// 运算符的左右必须有一个空格
int flag = 0;
// 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不需要空格
if (flag == 0) {
System.out.println(say);
}
// 左大括号前加空格且不换行；左大括号后换行
if (flag == 1) {
System.out.println("world");
// 右大括号前换行，右大括号后有 else，不用换行
} else {
System.out.println("ok");
// 在右大括号后直接结束，则必须换行
}
}
- 【强制】注释的双斜线与注释内容之间有且仅有一个空格。
正例：
// 这是示例注释，请注意在双斜线之后有一个空格
String commentString = new String() - 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
（1）第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
（2）运算符与下文一起换行。
（3）方法调用的点符号与下文一起换行。
（4）方法调用中的多个参数需要换行时，在逗号后进行。
（5）在括号前不要换行，见反例。
正例：
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下，换行缩进 4 个空格，并且方法前的点号一起换行
sb.append("zi").append("xin")...
.append("huang")...
.append("huang")...
.append("huang");
反例：
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下，不要在括号前换行
sb.append("you").append("are")...append
("lucky");
// 参数很多的方法调用可能超过 120 个字符，逗号后才是换行处
method(args1, args2, args3, ...
, argsX);
- 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
正例：下例中实参的 args1，后边必须要有一个空格。
method(args1, args2, args3); - 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要
使用 Windows 格式。 - 【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。
说明：任何情形，没有必要插入多个空行进行隔开。
(四) OOP 规约
- 【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@ Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。
@Deprecated 表示此方法已废弃、暂时可用，但以后此类或方法都不会再更新、后期可能会删除，建议后来人不要调用此方法。
Java 9 中注解增加了两个新元素：since 和 forRemoval。
since: 指定已注解的API元素已被弃用的版本。
forRemoval: 表示在将来的既定版本中会被删除，应该迁移 API。
如：@Deprecated(since = “1.2”, forRemoval = true)
例：
- 【强制】不能使用过时的类或方法。
说明：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 引入的工具类）。 - 【强制】所有整型包装类对象之间值的比较，全部使用 equals 方法比较。
说明：对于 Integer var = ? 在-128 至 127 之间的赋值，Integer 对象是在 IntegerCache.cache 产生，
会复用已有对象，这个区间内的 Integer 值可以直接使用==进行判断，但是这个区间之外的所有数据，都
会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断 - 【强制】定义数据对象 DO 类时，属性类型要与数据库字段类型相匹配。
正例：数据库字段的 bigint 必须与类属性的 Long 类型相对应。
反例：某个案例的数据库表 id 字段定义类型 bigint unsigned，实际类对象属性为 Integer，随着 id 越来
越大，超过 Integer 的表示范围而溢出成为负数。 - 【强制】禁止使用构造方法 BigDecimal(double) 的方式把 double 值转化为 BigDecimal 对象。
说明：BigDecimal(double)存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常。
如：BigDecimal g = new BigDecimal(0.1f); 实际的存储值为：0.10000000149
正例：优先推荐入参为 String 的构造方法，或使用 BigDecimal 的 valueOf 方法，此方法内部其实执行了
Double 的 toString，而 Double 的 toString 按 double 的实际能表达的精度对尾数进行了截断。
BigDecimal recommend1 = new BigDecimal(“0.1”);
BigDecimal recommend2 = BigDecimal.valueOf(0.1); - 关于基本数据类型与包装数据类型的使用标准如下：
（1） 【强制】所有的 POJO 类属性必须使用包装数据类型。
（2） 【强制】RPC 方法的返回值和参数必须使用包装数据类型。
（3） 【推荐】所有的局部变量使用基本数据类型。
说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何 NPE 问题，或
者入库检查，都由使用者来保证。
正例：数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。
反例：某业务的交易报表上显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的 RPC 服务，调
用不成功时，返回的是默认值，页面显示为 0%，这是不合理的，应该显示成中划线-。所以包装数据类型
的 null 值，能够表示额外的信息，如：远程调用失败，异常退出。 - 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
反例：POJO 类的 createTime 默认值为 new Date()，但是这个属性在数据提取时并没有置入具体值，在
更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。 - 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。
- 【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具：source> generate toString
时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。
说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排查问题。 - 【强制】禁止在 POJO 类中，同时存在对应属性 xxx 的 isXxx()和 getXxx()方法。
说明：框架在调用属性 xxx 的提取方法时，并不能确定哪个方法一定是被优先调用到，神坑之一。 - 【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容
的检查，否则会有抛 IndexOutOfBoundsException 的风险。
说明：
String str = “a,b,c,”;
String[] ary = str.split(",");
// 预期大于 3，结果是 3
System.out.println(ary.length); - 【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。
说明：下例中，反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，然后进行 append
操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。
反例：
String str = “start”;
for (int i = 0; i < 100; i++) {
str = str + “hello”;
} - 【推荐】类成员与方法访问控制从严：
（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 成员方法或成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。
（五）日期时间
- 【强制】获取当前毫秒数：System.currentTimeMillis(); 而不是 new Date().getTime()。
说明：如果想获取更加精确的纳秒级时间值，使用 System.nanoTime 的方式。在 JDK8 中，针对统计时间
等场景，推荐使用 Instant 类。 - 【强制】不允许在程序任何地方中使用：1）java.sql.Date 2）java.sql.Time 3）
java.sql.Timestamp。
说明：第 1 个不记录时间，getHours()抛出异常；第 2 个不记录日期，getYear()抛出异常；第 3 个在构造
方法 super((time/1000)*1000)，fastTime 和 nanos 分开存储秒和纳秒信息。
反例： java.util.Date.after(Date)进行时间比较时，当入参是 java.sql.Timestamp 时，会触发 JDK
BUG(JDK9 已修复)，可能导致比较时的意外结果。 - 【强制】不要在程序中写死一年为 365 天，避免在公历闰年时出现日期转换错误或程序逻辑错误。
正例：
// 获取今年的天数
int daysOfThisYear = LocalDate.now().lengthOfYear();
// 获取指定某年的天数
LocalDate.of(2011, 1, 1).lengthOfYear();
反例：
// 第一种情况：在闰年 366 天时，出现数组越界异常
int[] dayArray = new int[365];
// 第二种情况：一年有效期的会员制，今年 1 月 26 日注册，硬编码 365 返回的却是 1 月 25 日
Calendar calendar = Calendar.getInstance();
calendar.set(2020, 1, 26);
calendar.add(Calendar.DATE, 365);
百度云连接点这里
提取码：6666
2105
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
