java-coding-standards

# 编程规约 一、编程规约 (一) 命名 风格 1.【强 制】 所有编程相关的命名均不能以 下划线或美元符号 开始 ，也不能以 下划线或美元符号 结束 。 反例 ：_name / __name / $Object / name_ / name$ / Object$ 2.【强制】 所有编程相关的命名严禁使用拼音与英文混合的方式 ，更不允许直接使用中文的方式 。 说明 ：正确的英文拼写和语法可以让阅读者易于理解 ，避免歧义。注意 ，即使纯拼音命名方式也要避免采用 。 正例 ：ali / alibaba / taobao / kaikeba / aliyun / youku / hangzhou 等国际通用的名称 ，可视同英文。 反例 ：DaZhePromotion 【打折】 / getPingfenByName() 【评分】 / String fw【福娃 】/ int 变量名 = 3 3.【强制】 代码和注释中都要避免使用任何 人类 语言 中的种族歧视性 或侮辱性 词语 。 正例： blockList / allowList / secondary 反例 ：blackList / whiteList / slave / SB / WTF 4.【强制】 类名使用 UpperCamelCase 风格 ，以下情形例外： DO / PO / DTO / BO / VO / UID 等。 正例： ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion 反例： forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion 5.【强制】 方法名 、参数名 、成员变量 、局部变量都统一使用 lowerCamelCase 风格 。 正例 ：localValue / getHttpMessage() / inputUserId 6.【强制】 常量命名应该全部大写 ，单词间用下划线隔开 ，力求语义表达完整清楚 ，不要嫌名字长 。 正例 ：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME 反例 ：MAX_COUNT / EXPIRED_TIME 7.【强制 】抽象类命名使用 Abstract 或Base 开头 ；异 常类命名使用 Exception 结尾 ，测试 类命名以它要 测试的类的名称开始 ，以Test 结尾 。 8.【强制】 类型与中括号紧挨相连来定义数组 。 正例 ：定义整形数组 int[] arrayDemo 。 反例 ：在main 参数中 ，使用 String args[] 来定义 。 9.【强制】 POJO 类中的任何布尔类型的变量 ，都不要加 is前缀 ，否则部分框架解析会引起序列 化错误 。 说明 ：本文 MySQL 规约中的建表约定第 1条，表达是与否的变量采用 is_xxx 的命名方式 ，所以需要在 <resultMap> 设置从 is_xxx 到xxx的映射关系 。 反例 ：定义为 布尔 类型 Boolean isDeleted 的字段 ，它的 getter 方法也是 isDeleted() ，部分 框架在反向解析时 ，“误以 为”对应的 字段 名称是 deleted ，导致 字段 获取不到 ，得到意料之外的结果或 抛出异常 。 10.【强制】 包名统一使用小写 ，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数 形 式，但是类名如果有复数含义 ，类名可以使用复数形式 。 正例 ：应用工具类包名为 com.alibaba.ei.kunlun.aap.util ；类名为 MessageUtils （此规则参考 spring 的框架结构） 。 11.【强制】 避免在子父类的成员变量之间 、或者不同代码块 的局部变量之间采用完全相同的命名 ，使可理 解性降低 。 版本号 制定团 队 更新日 期 备注 1.7.1 全球 Java 社区开发者 2022.02.03 黄山 版，新增 11条新规约。 Java开发手册 （黄山版） 2/51 说明 ：子类 、父类成员变量名相同 ，即使是 public 也是能够通过编译 ，而局部变量在同一方法内的不同代码块中同名 也是合法的 ，但是要避免使用。对于非 setter / getter 的参数名称也要避免与成员变量名称相同 。 反例 ： public class ConfusingName { protected int stock ; protected String alibaba ; // 非setter/getter 的参数名 称，不允许与本类成员变量同名 public void access (String alibaba ) { if (condition ) { final int money = 666; // ... } for (int i = 0; i < 10; i++) { // 在同一方法体中 ，不允许与其它代 码块中的 money 命名相同 final int money = 15978 ; // ... } } } class Son extends ConfusingName { // 不允许与父类的成员变量名称相同 private int stock ; } 12.【强制】 杜绝完全不规范的 英文 缩写 ，避免望文不知义 。 反例 ：AbstractClass “缩写 ”成AbsClass ；condition“ 缩写 ”成condi ；Function “缩写 ”成Fu，此类随意缩写 严重降低了代码的可阅读性 。 13.【推荐】 为了达到代码自解释的目标 ，任何自定义编程元素在命名时 ，使用完整的单词组合来表达 。 正例 ：在JDK 中，对某个对象引用的 volatile 字段进行原子更新的类名为 AtomicReferenceFieldUpdater 。 反例 ：常见的方法内变量为 int a; 的定义方式 。 14.【推荐】 在常量与变量命名时 ，表示类型的名词放在词尾 ，以提升辨识度 。 正例 ：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT 反例 ：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD 15.【推荐】 如果模块 、接口 、类、方法使用了设计模式 ，在命名时 要体现出具体模式 。 说明： 将设计模式体现在名字中 ，有利于阅读者快速理解架构设计思想 。 正例 ： public class OrderFactory; public class LoginProxy; public class ResourceObserver; 16.【推荐】 接口类中的方法和属性不要加任何修饰符号（ public 也不要加） ，保持代码的简洁性 ，并加上 有效的 Javadoc 注释。尽量不要在接口里定义 常量 ，如果一定要定义 ，最好 确定 该常量 与接口 的方法 相关 ，并且是整个应用的基础常量 。 正例 ：接口方法签名 void commit() ; 接口基础常量 String COMPANY = "alibaba "; 反例 ：接口方法定义 public abstract void commit (); 说明 ：JDK8 中接口允许有默认实现 ，那么这个 default 方法 ，是对所有实现类都有价值的默认实现。 Java开发手册 （黄山版） 3/51 17.接口和实现类的 命名有两套规则 ： 1）【强制】 对于 Service 和DAO 类，基于 SOA 的理念 ，暴露出来的服务一定是接口 ，内部的实现类用 Impl 的后缀 与接口区别 。 正例 ：CacheServiceImpl 实现 CacheService 接口 。 2）【推荐】 如果是形容能力的接口名称 ，取对应的形容词为接口名（通常是 –able 结尾 的形容词 ）。 正例 ：AbstractTranslator 实现 Translatable 。 18.【参考】 枚举类名带上 Enum 后缀 ，枚举成员名称需要全大写 ，单词间用下划线隔开 。 说明 ：枚举其实就是特殊的常量类 ，且构造方法被默认强制是私有 。 正例 ：枚举名字为 ProcessStatusEnum 的成员名称 ：SUCCESS / UNKNOWN_REASON 19.【参考 】各层命名规约 ： 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 。 (二) 常量定义 1.【强制 】不允许任何魔法值（即未经预先定义的常量 ）直 接出现在代码中 。 反例 ： // 开发者 A定义了缓存的 key。 String key = "Id#taobao_ " + tradeId; cache. put(key, value); // 开发者 B使用缓存时 直接复制 少了下划线，即 key 是"Id#taobao" + tradeId ，导致出现故障 。 String key = "Id#taobao " + tradeId; cache. get(key); 2.【强制】 long 或Long 赋值时 ，数值后使用大写 L，不能是小写 l，小写容易跟数字混淆 ，造成误解 。 说明： public static final Long NUM = 2l; 写的是数字的 21，还是 Long 型的 2？ 3.【强制】 浮点数类型的数值后缀统一为大写的 D或F。 正例 ：public static final double HEIGHT = 175.5D ; public static final float WEIGHT = 150.3F ; 4.【推荐】 不要使用一个常量类维护所有常量 ，要按常量功能进行归类 ，分开维护 。 说明 ：大而全的常量类 ，杂乱无章 ，使用查找功能才能定位到 要修改的常量 ，不利于理解 ，也不利于维护 。 正例 ：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 SystemConfigConsts 下。 5.【推荐】 常量的复用层次有五层：跨应用共享常量 、应用内共享常量 、子工程内共享常量 、包内共享常 量、类内共享常量。 1）跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。 2）应用内共享常量：放置在一方库中，通常是子模块中的 constant 目录下。 Java开发手册 （黄山版） 4/51 反例 ：易懂 常量也要统一定义成应用内共享常量 ，两个程序员 在两个类中分别定义了表示“是”的 常量： 类A中：public static final String YES = "yes"; 类B中：public static final String YES = "y"; A.YES.equals(B.YES) ，预期是 true ，但实际返回为 false ，导致线上问题 。 3）子工程内部共享常量 ：即在当前子工程的 constant 目录下。 4）包内共享常量：即在当前包下单独的 constant 目录下。 5）类内共享常量 ：直接在类内部 private static final 定义。 6.【推 荐】 如果变量值仅在一个固定范围内变化用 enum 类型来定义 。 说明 ：如果存在名称之外的延伸属性应使用 enum 类型 ，下面正例中的数字就是延伸信息 ，表示一年中的第几个季节 。 正例 ： public enum SeasonEnum { SPRING (1), SUMMER (2), AUTUMN (3), WINTER (4); private int seq; SeasonEnum (int seq) { this.seq = seq; } public int getSeq () { retur n seq; } } (三) 代码 格式 1.【强制】 如果大括号内为空，简洁地写成 {}即可，大括号中间无需换行和空格 ；如果是非空代码块 ，则： 1）左大括号前不换行 。 2）左大括号后换行。 3）右大括号前换行 。 4）右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。 2.【强制】 左小括号和右边相邻字符之间不 需要 空格 ；右小括号和左边相邻字符之间也不 需要 空格；而左大 括号前需要加空格 。详见第 5条下方正例提示 。 反例 ：if(空格 a == b空格) 3.【强制】 if / for / while / switch / do等保留字与左右括号之间都必须加空格 。 4.【强制】 任何二目 、三目运算符的左右两边都需要加一个空格 。 说明 ：包括赋值运算符 =、逻辑运算符 &&、加减乘除符号等 。 5.【强制】 采用 4个空格缩进 ，禁止使用 Tab 字符 。 说明 ：如使用 Tab 缩进 ，必须设置 1个Tab 为4个空格 。IDEA 设置 Tab 为4个空格时 ，请勿勾选 Use tab character ； 而在 Eclipse 中，找到 tab policy 设置为 Spaces only ，Tab size：4，最后 必须勾选 insert spaces for tabs 正例 ：（涉及 上述中的 1-5点） public static void main (String[] args) { // 缩进 4个空格 String say = "hello" ; // 运算符 的左右必须有一个空格 int flag = 0; // 关键词 if与括号之间必须有一个空格 ，括号内的 f与左括号 ，0与右括号不需要空格 if (flag == 0) { System .out.println (say); Java开发手册 （黄山版） 5/51 } // 左大括号前加空格 且不换行 ；左大括号后换行 if (flag == 1) { System .out.println ("world" ); // 右大括号前换行 ，右大括号后有 else ，不用换行 } else { System .out.println ("ok"); // 在右大括号后直接结束，则必须换行 } } 6.【强制】 注释的双斜线与注释内容之间有且仅有一个空格 。 正例 ： // 这是示例注释，请注意在双斜线之后有一个空格 String commentString = new String ("demo "); 7.【强制】 在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开 。 正例 ： double first = 3.2D; int second = (int)first + 2; 8.【强制】 单行字符数限制不超过 120 个，超出需要换行 ，换行时遵循如下原则 ： 1）第二行相对第一行缩进 4个空格 ，从第三行开始 ，不再继续缩进 ，参考示例 。 2）运算符与下文一起换行。 3）方法调用的点符号与下文一起换行 。 4）方法调用中的多个参数需要换行时，在逗号后进行。 5）在括号前不要换行 ，见反例 。 正例 ： StringBuilder builder = new StringBuilder (); // 超过 120 个字符的情况下 ，换行缩进 4个空格，并且方法前的点号一起换行 builder .append("yang" ).append ("hao" )... .append ("chen" )... .append ("chen" )... .append ("chen"); 反例 ： StringBuilder builder = new StringBuilder (); // 超过 120 个字符的情况 下，不要在括号前换行 builder .append("you" ).append ("are" )...append ("lucky" ); // 参数很多的方法调用可能超过 120 个字符 ，逗号后才是换行处 method (args1 , args2 , args3 , ... , argsX); 9.【强制】 方法参数在定义和传入时 ，多个参数逗号后面必须加空格 。 正例 ：下例中实参的 args1 逗号 后边必须要有一个空格 。 method(args1, args2, args3); 10.【强制】 IDE 的text file encoding 设置为 UTF-8；IDE 中文件的换行符使用 Unix 格式，不要使用 Windows 格式 。 11.【推荐】 单个方法 的总行数不超过 80行。 说明 ：除注释之外的方法签名 、左右大括号 、方法内代码 、空行 、回车及任何不可见字符的总行数不超过 80行。 Java开发手册 （黄山版） 6/51 正例 ：代码逻辑分清红花和绿叶 ，个性和共性，绿叶逻辑单独出来成为额外方法，使主干代码更加晰 ；共性逻辑抽取 成为共性方法 ，便于复用和维护。 12.【推荐】 没有必要增加若干空格来使变量的赋值等号与上 一行对应位置的等号对齐 。 正例 ： int one = 1; long two = 2L; float three = 3F; StringBuilder builder = new StringBuilder (); 说明 ：增加 builder 这个变量，如果需要对齐，则给 one、two 、three 都要增加几个空格，在变量比较多的情况下，是 非常累赘的事情 。 13.【推荐】 不同逻辑 、不同语义 、不同业务的代码之间插入一个空行 ，分隔开来以提升可读性 。 说明 ：任何情形 ，没有必要插入 多个空行 进行隔开 。 (四) OOP 规约 1.【强制】 避免通过 一个类的对象引用访问此类的静态变量或静态方法 ，无谓增加编译器解析成 本，直接用 类名 来访问即可 。 2.【强制】 所有的覆写方法 ，必须加 @Override 注解 。 说明 ：getObject() 与get0bject() 的问题 。一个是字母的 O，一个是数字的 0，加 @Override 可以准确判断是否覆盖 成功 。另外 ，如果在抽象类中对方法签名进行修改 ，其实现类会马上编译报错 。 3.【强制】 相同参数类型 ，相同业务含义 ，才可以使用的可变参数 ，参数类型 避免 定义为 Object 。 说明 ：可变参数必须放置在参数列表的最后。（建议开发者尽量不用可变参数编程） 正例 ：public List<User> listUsers(String type, Long... ids) {...} 4.【强制】 外部正在调用 的接口 或者二方库依赖的接口 ，不允许修改 方法签名 ，避免对接口调用方产生影 响。接口过时必须加 @Deprecated 注解 ，并清晰地说明采用的新接口或者新服务是什么 。 5.【强制】 不能使用过时的类或方法 。 说明 ：java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时 ，应该使用双参数 decode(String source, String encode) 。接口提供方既然明确是过时接口 ，那么有义务同时提供新的接口；作为调用 方来说 ，有义务去考证过时方法的新实现是什么 。 6.【强制】 Object 的equals 方法容易抛空指针异常 ，应使用常量或确定有值的对象来调用 equals 。 正例 ："test".equals( param ); 反例 ：param .equals("test"); 说明 ：推荐使用 JDK7 引入的工具类 java.util.Objects#equals(Object a, Object b) 7.【强制】 所有整型包装类对象之间 值的比较 ，全部使用 equals 方法比较 。 说明 ：对于 Integer var = ? 在 -128 至127 之间的赋值 ，Integer 对象是在 IntegerCache.cache 产生 ，会复用已有对 象，这个区间内的 Integer 值可以直接使用 == 进行判断 ，但是这个区间之外的所有数据 ，都会在堆上产生 ，并不会复 用已有对象 ，这是一个大坑 ，推荐使用 equals 方法进行判断 。 8.【强制】 任何货币金额 ，均以 最小货币单位 且为整型类型进行存储 。 9.【强制】 浮点数之间的等值判断 ，基本数据类型不能 使用 == 进行 比较 ，包装数据类型不能 使用equals 进行 判断 。 说明 ：浮点数采用 “尾数+阶码 ”的编码方式 ，类似于科学计数法的 “有效数字 +指数 ”的表示方式 。二进制无法精确表 示大部分的十进制小数 ，具体原理参考 《码出高效》 。 反例 ： Java开发手册 （黄山版） 7/51 float a = 1.0F - 0.9F; float b = 0.9F - 0.8F; if (a == b) { // 预期进入此代码块 ，执行其它业务逻辑 // 但事实 上a == b的结果为 false } Float x = Float .valueOf (a); Float y = Float .valueOf (b); if (x.equals (y)) { // 预期进入此代码块 ，执行其它业务逻辑 // 但事实上 equals 的结果 为false } 正例 ： (1)指定一个误差范围 ，两个浮点数的差值在此 范围之内 ，则认为是相等的 。 float a = 1.0F - 0.9F; float b = 0.9F - 0.8F; float diff = 1e-6F; if (Math .abs(a - b) < diff) { System .out.println ("true" ); } (2)使用 BigD ecimal 来定义值 ，再进行浮点数的运算操作 。 BigDecimal a = new BigDecimal ("1.0" ); BigDecimal b = new BigDecimal ("0.9" ); BigDecimal c = new BigDecimal ("0.8" ); BigDecimal x = a.subtract (b); BigDecimal y = b.subtract (c); if (x.compareTo (y) == 0) { System .out.println ("true" ); } 10.【强制】 BigDecimal 的等值比较应使用 compareTo() 方法 ，而不是 equals() 方法 。 说明 ：equals() 方法会比较值和精度 （1.0 与 1.00 返回结果为 false ），而compareTo() 则会忽略精度。 11.【强制】 定义数据对象 DO 类时 ，属性类型要与数据库字段类型相匹配 。 正例 ：数据库字段的 bigint 必须与类属性的 Long 类型相对应 。 反例 ：某业务的数据库表 id字段定义类型 为bigint unsigned ，实际类对象属性为 Integer ，随着 id越来越大 ， 超过 Integer 的表示范围而溢出成为负数 ，此时数据库 id不支持存入负数抛出异常产生 线上 故障。 12.【强制】 禁止使用构造方法 BigDecimal(double) 的方式把 double 值转化为 BigDecimal 对象 。 说明 ：BigDecimal(double) 存在精度损失风险 ，在精确计算或值比较的场景中可能会导致业务逻辑异常 。 如： BigDecimal g = new BigDecimal(0.1 F)；实际的存储值为： 0.100000001490116119384765625 正例 ：优先推荐入参为 String 的构造方法 ，或使用 BigDecimal 的valueOf 方法 ，此方法内部其实执行了 Double 的 toStrin g，而Double 的toString 按double 的实际能表达的精度对尾数进行了截 断。 BigDecimal recommend1 = new BigDecimal ("0.1" ); BigDecimal recommend2 = BigDecimal .valueOf (0.1); 13.关于基本数据类 型与包装数据类型的使用标准如下 ： 1）【强制】 所有的 POJO 类属性必须使用包装数据类型 。 2）【强制】 RPC 方法的返回值和参数必须使用包装数据类型 。 3）【推荐】 所有的局部变量使用基本数据类型 。 Java开发手册 （黄山版） 8/51 说明 ：POJO 类属性没有初值是提醒使用者在需要使用时 ，必须自己显式地进行赋值 ，任何 NPE 问题 ，或者入库检查 ， 都由使用者来保证 。 正例 ：数据库的查询结果可能是 null，因为自动拆箱 ，用基本数据类型接收有 NPE 风险 。 反例 ：某业务的交易报表上显示成交总额涨跌情况 ，即正负 x%，x为基本数据类型 ，调用的 RPC 服务 ，调用不成功时 ， 返回的是默认值 ，页面显示为 0%，这是不合理的 ，应该显示成中划线 -。所以包装数据类型的 null 值，能够表示额外的 信息 ，如：远程调用失败 ，异常退出 。 14.【强制】 定义 DO / PO / DTO / VO等POJO 类时 ，不要设定任何属性 默认值 。 反例 ：某业务的 DO 的create Time 默认值为 new Date() ；但是这个属性在数据提取时并没有置入具体值 ，在更新其 它字段时又附带更新了此字段 ，导致创建时间被修改成当前时间 。 15.【强制】 序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败 ；如 果完全不兼 容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。 说明 ：注意 serialVersionUID 不一致会抛出序列化运行时异常 。 16.【强制】 构造方法里面禁止加入任何业务逻辑 ，如果有初始化逻辑 ，请放在 init方法中 。 17.【强制】 POJO 类必须写 toString 方法 。使用 IDE 中的工具 source > generate toString 时，如果继 承了另一个 POJO 类，注意在前面加一下 super.toString ()。 说明 ：在方法执行抛出异常时 ，可以直接调用 POJO 的toString() 方法打印其属性值 ，便于排查问题 。 18.【强制】 禁止在 POJO 类中 ，同时存 在对应属性 xxx的isXxx() 和getXxx() 方法 。 说明 ：框架在调用属性 xxx的提取方法时 ，并不能确定哪个方法一定是被优先调用到 ，神坑之一 。 19.【推荐】 使用索引访问用 String 的split 方法得到的 数组时 ，需做最后一个分隔符后有无内容的检查 ， 否则会有抛 IndexOutOfBoundsException 的风险 。 说明 ： String str = "a,b,c,," ; String [] ary = str.split(","); // 预期大于 3，结果 等于 3 System .out.println (ary.length ); 20.【推荐】 当一个类有多个构造方法 ，或者多个同名方法 ，这些方法应该按顺序放置在一起 ，便于阅读 ， 此条规则优先于下一条 。 正例 ： public int method (int param) ; protected double method (int param1, int param2) ; private void method (); 21.【推荐】 类内方法定义的顺序依次是 ：公 有方法或保护方法 > 私有方法 > getter / setter 方法 。 说明 ：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是 “模板设 计模式 ”下的核心方法 ；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有 Service 和DAO 的getter / setter 方法放在类体最后 。 22.【推荐】 setter 方法中 ，参数名称与类成员变量名称一致 ，this. 成员名 =参数名 。在getter / setter 方 法中 ，不要增加业务逻辑 ，增加排查问题的难度 。 反例 ： public Integer getData () { if (condition ) { return this.data + 100; } else { return this.data - 100; Java开发手册 （黄山版） 9/51 } } 23.【推荐】 循环体内 ，字符串的连接方式 ，使用 StringBuilder 的append 方法进行扩展 。 反例 ： String str = "start" ; for (int i = 0; i < 100; i++) { str = str + "hello" ; } 说明 ：反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，然后进行 append 操作，最后通过 toString () 返回 String 对象，造成内存资源浪费 。 24.【推荐】 final 可以声明类 、成员变量 、方法 、以及本地变量 ，下列情况使用 final 关键字 ： 1）不允许被继承的类 ，如：String 类。 2）不允许修改引用的域对象 ，如：POJO 类的域变量。 3）不允许被覆写的方法 ，如：POJO 类的 setter 方法。 4）不允许运行过程中重新赋值的局部变量。 5）避免上下文重复使用一个变量 ，使用 final 关键字可以强制重新定义一个变量 ，方便更好地进行重构。 25.【推荐】 慎用 Object 的clone 方法来拷贝对象 。 说明 ：对象 clone 方法默认是浅拷贝 ，若想实现深拷贝需覆写 clone 方法实现域对象的深度遍历式拷贝 。 26.【推荐】 类成员与方法访问控制从严 ： 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 成员方法或成员变量 ，删除一下 ，不得手心冒点汗吗 ？ 变量像自己的小孩 ，尽量在自己的视线内 ，变量作用域太大 ，无限制的到处跑 ，那么你会担心的 。 (五) 日期时间 1.【强制】 日期格式化时 ，传入 patter n中表示年份统一使用小写的 y。 说明 ：日期格式化时 ，yyyy 表示当天所在的年 ，而大写的 YYYY 代表是 week in which year （JDK7 之后引入的概念 ）， 意思是当天所在的周属于的年份 ，一周从周日开始 ，周六结束 ，只要本周跨年 ，返回的 YYYY 就是下一年 。 正例 ：表示日期和时间的格式如下所示： new SimpleDateFormat("yyyy -MM-dd HH:mm:ss") 反例 ：某程序员 因使用 YYYY/MM/dd 进行日期格式化 ，2017/12/31 执行结果为 2018/12/31 ，造成 线上 故障 。 2.【强制】 在日期格式中分清楚大写的 M和小写的 m，大写的 H和小写的 h分别指代 的意义 。 说明： 日期格式中的这两对字母表意如下： 1）表示月份是大写的 M 2）表示分钟则是小写的 m 3）24小时制的是大写的 H 4）12小时制的则是小写的 h Java开发手册 （黄山版） 10/51 3.【强制】 获取当前毫秒数： System.currentTimeMillis() ；而不是 new Date().getTime() 。 说明： 获取纳秒级时间， 则使用 System.nanoTime 的方式。在 JDK8 中，针对统计时间等场景，推荐使用 Instant 类。 4.【强制】 不允许在程序任何地方中使用 ：1）java.sql.Date 2）java.sql.Time 3）java.sql.Timestamp 。 说明 ：第1个不记录时间 ，getHours() 抛出异常 ；第2个不记录日期 ，getYear() 抛出异常 ；第3个在构造方法 super((time / 1000) * 1000) ，在Timestamp 属性 fastTime 和nanos 分别存储秒和纳秒信息 。 反例 ：java.util.Date.after(Date) 进行时间比较时 ，当入参是 java.sql.Timestamp 时，会触发 JDK BUG （JDK9 已修 复），可能导致比较时的意外结果 。 5.【强制】 禁止 在程序中写死一年为 365 天，避免在公历闰年时出现日 期转换错误或程序逻辑错误 。 正例 ： // 获取今年的天数 int daysOfThisYear = LocalDate .now().lengthOfYear (); // 获取指 定某年的天数 LocalDate .of(2011 , 1, 1).lengthOfYear (); 反例 ： // 第一种情况 ：在闰年 366 天时 ，出现数组越界异常 int[] dayArray = new int[365]; // 第二种情况 ：一年有效期的会员制 ，2020 年1月26日注册 ，硬编码 365 返回的却是 2021 年1月25日 Calendar calendar = Calendar .getInstance (); calendar .set(2020 , 1, 26); calendar .add(Calendar .DATE , 365); 6.【推荐】 避免公历 闰年2月问题 。闰年的 2月份有 29天，一年后的那一天不可能是 2月29日。 7.【推荐】 使用枚举值来指代月份 。如果使用数字 ，注意 Date ，Calendar 等日期相关类的月份 month 取 值范围从 0到11之间 。 说明 ：参考 JDK 原生注释 ，Month value is 0 -based. e.g., 0 for January. 正例 ：Calendar.JANUARY ，Calendar.FEBRUARY ，Calendar.MARCH 等来指代相应月份来进行传参或比较 。 (六) 集合处理 1.【强制】 关于 hashCode 和equals 的处理 ，遵循如下规则 ： 1）只要覆写 equals ，就必须覆写 hashCode 。 2）因为 Set存储的是不重复的对象 ，依据 hashCode 和equals 进行判断 ，所以 Set存储的对象必须覆写这两种方法 。 3）如果自定义对象作为 Map 的键 ，那么必须覆写 hashCode 和equals 。 说明 ：String 因为覆写了 hashCode 和equals 方法 ，所以可以愉快地将 String 对象作为 key 来使用 。 2.【强制】 判断所有集 合内部的元素是否为空 ，使用 isEmpty() 方法 ，而不是 size() == 0的方式 。 说明： 在某些集合中 ，前者的时间复杂度为 O(1) ，而且可读性更好。 正例 ： Map< String , Object > map = new HashMap <>(16); if (map.isEmpty ()) { System.out. println ("no element in this map." ); } 3.【强制】 在使用 java.util.stream.Collectors 类的 toMap() 方法转为 Map 集合时 ，一定要使用参数类型 为BinaryOperator ，参数 名为mergeFunction 的方法 ，否则当出现相同 key 时会抛出 IllegalStateException 异常 。 说明 ：参数 mergeFunction 的作用是当出现 key 重复时 ，自定义对 value 的处理策略 。 正例 ： Java开发手册 （黄山版） 11/51 List<Pair<String , Double >> pairArrayList = new ArrayList <>(3); pairArrayList .add(new Pair<>("version" , 12.10 )); pairArrayList .add(new Pair<>("version" , 12.19 )); pairArrayList .add(new Pair<>("version" , 6.28)); // 生成的 map 集合中只有一个键值对 ：{version=6.28} Map<String , Double > map = pairArrayList .stream () .collect (Collectors .toMap (Pair::getKey , Pair::getValue , (v1, v2) -> v2)); 反例 ： String [] departments = new String []{"RDC", "RDC", "KKB"}; // 抛出 IllegalStateEx ception 异常 Map<Integer , String > map = Arrays .stream (departments ) .collect (Collectors .toMap (String ::hashCode , str -> str)); 4.【强制】 在使用 java.util.stream.Colle ctors 类的 toMap() 方法转为 Map 集合时 ，一定要注意当 value 为null 时会抛 NPE 异常 。 说明 ：在java.util.HashMap 的merge 方法里会进行如下的判断 ： if (value == null || remappingFunction == null) throw new NullPointerException (); 反例 ： List<Pair<String , Double >> pairArrayList = new ArrayList <>(2); pairArrayList .add(new Pair<>("version1" , 8.3)); pairArrayList .add(new Pair<>("version2" , null)); // 抛出 NullPointerExcept ion异常 Map<String , Double > map = pairArrayList .stream () .collect (Collectors .toMap (Pair::getKey , Pair::getValue , (v1, v2) -> v2)); 5.【强制】 ArrayList 的subList 结果不可强转成 ArrayList ，否则会抛出 ClassCastException 异常： java.util.RandomAccessSubList cannot be cast to java.util.ArrayList 。 说明 ：subList() 返回的是 ArrayList 的内部类 SubList ，并不是 ArrayList 本身 ，而是 ArrayList 的一个视图 ，对于 SubList 的所有操作最终会反映到原列表上 。 6.【强制】 使用 Map 的方法 keySet() / value s() / entrySet() 返回集合对象时 ，不可以对其进行添加元素 操作 ，否则会抛出 UnsupportedOperationException 异常 。 7.【强制】 Collections 类返回的对象 ，如：emptyList() / singletonList() 等都是 immutable list，不可 对其进行添加或者删除元素的操作 。 反例 ：如果查询无结果 ，返回 Collections.emptyList() 空集合对象 ，调用方一旦 在返回的集合中 进行了添加元素的操 作，就会触发 UnsupportedOperationException 异常 。 8.【强制】 在subList 场景中 ，高度注意 对父集合元素的增加或删除 ，均会导致子列表的遍历 、增加 、删 除产 生ConcurrentModificationException 异常 。 说明 ：抽查表明 ，90% 的程序员 对此知识点都有错误的认知。 9.【强制】 使用集合转数组的方法 ，必须使用集合的 toArray(T[] array) ，传入的是类型完全一致 、长度为 0的空数组 。 反例 ：直接使用 toArray 无参方法存在问题 ，此方法返回值只能是 Object[] 类，若强转其它类型数组将出现 ClassCastException 错误 。 正例 ： List<String > list = new ArrayList <>(2); Java开发手册 （黄山版） 12/51 list.add("guan"); list.add("bao" ); String [] array = list.toArray (new String [0]); 说明 ：使用 toArray 带参方法 ，数组空间大小的 length ： 1）等于 0，动态创建与 size 相同的数组 ，性能最好 。 2）大于 0但小于 size，重新创建大小等于 size 的数组 ，增加 GC负担 。 3）等于 size ，在高并发情况下 ，数组创建完成之后 ，size 正在变大的情况下 ，负面影响与 2相同 。 4）大于 size ，空间浪费 ，且在 size 处插入 null 值，存在 NPE 隐患 。 10.【强制】 使用 Collection 接口任何实现类的 addAll() 方法时 ，要对输入的集合参数进行 NPE 判断 。 说明 ：在ArrayList#addAll 方法的第一行代码即 Object[] a = c.toArray() ；其中 c为输入集合参数 ，如果为 null， 则直接抛出异常 。 11.【强制】 使用工具类 Arrays.asList() 把数组转换成集合时 ，不能使用其修改集合相关的方法 ，它的 add / remove / clear 方法会抛出 UnsupportedOperationException 异常 。 说明 ：asList 的返回对象是一个 Arrays 内部类 ，并没有实现集合的修改方法 。Arrays.asList 体现的是适配器模式 ，只 是转换接口 ，后台的数据仍是数组 。 String[] str = new String[]{ "yang ", "guan ", "bao" }; List list = Arrays.asList(str); 第一种情况 ：list.add("yangguanbao") ; 运行时异常。 第二种情况 ：str[0] = "change" ; list中的元素 也会随之修改 ，反之亦然。 12.【强制】 泛型通配符 <? extends T>来接收返回的数据 ，此写法的泛型集合不能使用 add 方法 ， 而<? super T>不能使用 get 方法 ，两者在接口调用赋值的场景中容易出错 。 说明 ：扩展说一下 PECS(Producer Extends Consumer Super) 原则 ，即频繁往外读取内容的 ，适合用 <? extends T>，经常往里插入的 ，适合用 <? super T> 13.【强制】 在无泛型限制定义的集合赋值给泛型限制的集合时 ，在使用集合元素时 ，需要进行 instanceof 判断 ，避免抛出 ClassCastException 异常 。 说明 ：毕竟泛型是在 JDK5 后才出现 ，考虑到向前兼容 ，编译器是允许非泛型集合与泛型集合互相赋值 。 反例 ： List<String > generics = null; List notGenerics = new ArrayList (10); notGen erics.add(new Object ()); notGen erics.add(new Integer (1)); generics = notGenerics ; // 此处抛出 ClassCastExcept ion异常 String string = generics .get(0); 14.【强制】 不要在 foreach 循环里进行元素的 remove / add 操作 。remove 元素请使用 iterator 方式 ， 如果并发操作 ，需要对 iterator 对象加锁 。 正例 ： List<String > list = new ArrayList <>(); list.add("1"); list.add("2"); Iterator<String > iterator = list.iterator (); while (iterator .hasNext ()) { String item = iterator .next(); if (删除元素的条件 ) { iterator .remove(); } Java开发手册 （黄山版） 13/51 } 反例 ： for (String item : list) { if ("1".equals (item)) { list.remove (item); } } 说明： 反例中 的执行结果肯定会出乎大家的意料 ，那么试一下把 “1” 换成 “2” 会是同样的结果吗？ 15.【强制】 在JDK7 版本及以上 ，Comparator 实现类要满足如下三个条件 ，不然 Arrays.sort ， Collections.sort 会抛 IllegalArgumentException 异常 。 说明 ：三个条件如下 1）x，y的比较结果和 y，x的比较结果相反。 2）x > y，y > z，则x > z。 3）x = y，则x，z比较结果和 y，z比较结果相同。 反例 ：下例中没有处理相等的情况 ，交换两个对象判断结果并不互反 ，不符合第一个条件 ，在实际使用中可能会出现异 常。 new Comparator <Student >() { @Override public int compare (Student o1, Student o2) { return o1.getId () > o2.getId () ? 1 : -1; } }; 16.【推荐】 泛型集合使用时 ，在JDK7 及以上 ，使用 diamond 语法或全省略 。 说明： 菱形泛型 ，即diamond ，直接使用 <>来指代前边已经指定的类型 。 正例 ： // diamond 方式 ，即<>