Java 开发手册（嵩山版）

1. 命名风格

【强制】类名使用UpperCamelCase风格，但以下情形例外:DO/BO/DTO/VO/AO/ PO / UID 等。

• 正例：ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion
• 反例：forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion

【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

• 正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
• 反例：MAX_COUNT / EXPIRED_TIME

【强制】抽象类命名用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始，以Test结尾。

【强制】POJO类中的任何布尔类型的变量，都不要加is前缀，否则部分框架解析会引起序列化错误。

• 反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，框架在反向解析的时候，「误以为」对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。

【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度

• 正例：tartTime / workQueue / nameList / TERMINATED_THREAD_COUNT
• 反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

【参考】各层命名规约:

Service/DAO 层方法命名规约

1. 获取单个对象的方法用 get 做前缀。
2. 获取多个对象的方法用 list 做前缀，复数结尾，如:：istObjects。
3. 获取统计值的方法用 count 做前缀。
4. 插入的方法用 save/insert做前缀。
5. 删除的方法用 remove/delete做前缀。
6. 修改的方法用 update 做前缀。

领域模型命名规约

1. 数据对象:xxxDO，xxx 即为数据表名。
2. 数据传输对象:xxxDTO，xxx 为业务领域相关的名称。
3. 展示对象:xxxVO，xxx 一般为网页名称。
4. POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中

【强制】在long或者Long赋值时，数值后使用大写字母L，不能是小写字母l，小写容易跟 数字混淆，造成误解。

【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。

• 正例:缓存相关常量放在类 CacheConsts 下;系统配置相关常量放在类 SystemConfigConsts 下。

【强制】如果是大括号内为空，则简洁地写成{}即可

【强制】采用 4 个空格缩进，禁止使用 Tab 字符。

说明：如果使用 Tab 缩进，必须设置 1 个 Tab 为 4 个空格。IDEA 设置 Tab 为 4 个空格时，请勿勾选 Use tab character 。

【推荐】单个方法的总行数不超过 80 行。

• 说明：除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过 80 行。
• 正例：代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法，使主干代码更加清晰;共性逻辑抽取成为共性方法，便于复用和维护。

【强制】接口过时必须加 @Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么

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

• 推荐使用 JDK7 引入的工具类 java.util.Objects#equals(Object a, Object b)

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

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

  【强制】任何货币金额，均以最小货币单位且整型类型来进行存储。

  【强制】浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用 equals 来判断。

• 说明：浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小数，具体原理参考《码出高效》

• 反例：

  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 b = 0.9F - 0.8F; float diff = 1e-6F;
  if (Math.abs(a - b) < diff) { 
    System.out.println("true");
  }
  // (2) 使用 BigDecimal 来定义值，再进行浮点数的运算操作。
  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");
  }

  【强制】如上所示 BigDecimal 的等值比较应使用 compareTo() 方法，而不是 equals() 方法。

• 说明：equals()方法会比较值和精度(1.0 与 1.00 返回结果为 false)，而 compareTo() 则会忽略精度。

  【强制】定义数据对象 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);

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

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

• 【强制】RPC 方法的返回值和参数必须使用包装数据类型。
• 【推荐】所有的局部变量使用基本数据类型。

包装数据类型 的 null 值，能够表示额外的信息，如:远程调用失败，异常退出。

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

【强制】POJO 类必须写 toString 方法。

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

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

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

  2. 日期时间

  【强制】日期格式化时，传入 pattern 中表示年份统一使用小写的 y。

• 说明:日期格式化时，yyyy 表示当天所在的年，而大写的 YYYY 代表是 week in which year(JDK7 之后 引入的概念)，意思是当天所在的周属于的年份，一周从周日开始，周六结束，只要本周跨年，返回的 YYYY就是下一年。正例:表示日期和时间的格式如下所示: new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")

  【强制】在日期格式中分清楚大写的M和小写的m，大写的H和小写的h分别指代的意义。

• 表示月份是大写的 M;

• 表示分钟则是小写的 m;
• 24 小时制的是大写的 H;

• 12 小时制的则是小写的 h。

  【强制】获取当前毫秒数: System.currentTimeMillis(); 而不是 new Date().getTime()；

• 更加精确的纳秒级时间值，使用 System.nanoTime 的方式。在 JDK8 中，针对统计时间 等场景，推荐使用 Instant 类。

  【强制】一年天数不要写死。

• 获取今年的天数：int daysOfThisYear = LocalDate.now().lengthOfYear();

  3. 集合处理

  【强制】关于hashCode和equals的处理，遵循如下规则:

1. 只要覆写 equals，就必须覆写 hashCode。
2. 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须覆写 这两种方法。
3. 如果自定义对象作为 Map 的键，那么必须覆写 hashCode 和 equals。

• 说明：String 因为覆写了 hashCode 和 equals 方法，所以可以愉快地将 String 对象作为 key 来使用。

  【强制】在使用 java.util.stream.Collectors 类的 toMap() 方法转为 Map 集合时，一定要使用含有参数类型为 BinaryOperator，参数名为 mergefunction 的方法，否则当出现相同 key 值时会抛出 Illegalstateexception 异常。

• 说明: 参数 mergeFunction 的作用是当出现 key 重复时，自定义对 value 的处理策略。

• 正例：

  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<String, Double> map = pairArrayList.stream().collect(
    // 生成的 map 集合中只有一个键值对:{version=6.28}
    Collectors.toMap(Pair::getKey, Pair::getValue, (v1, v2) -> v2)
  );

• 反例:

  String[] departments = new String[] {"iERP", "iERP", "EIBU"};
  // 抛出 IllegalStateException 异常
  Map<Integer, String> map = Arrays.stream(departments).collect(Collectors.toMap(String::hashCode, str -> str));

  【强制】使用Map的方法 keySet()/values()/entrySet() 返回集合对象时，不可以对其进行添 加元素操作，否则会抛出 UnsupportedOperationException 异常。

  【强制】Collections 类返回的对象，如：emptylist () / singletonlist（）等都是 immutable list 不可对其进行添加或者删除元素的操作。

• 反例：如果查询无结果，返回 Collections. EmptyList 空集合对象，调用方一旦进行了添加元素的操作，就会触发 Unsupported Operationexception 异常。
  

  【强制】使用集合转数组的方法必须使用集合的 toarray(TO array），传入的是类型完全致、长度为 0 的空数组

• 反例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object 类，若强转其它类型数组将出现 ClassCastexception 错误。

• 正例：

  List<String> list = new ArrayList<>(2); 
  list.add("guan");
  list.add("bao");
  String[] array = list.toArray(new String[0]);

• 说明：使用 toArray 带参方法，数组空间大小的 length

  • 等于 0, 动态创建与 size 相同的数组，性能最好。
  • 大于 0 但小于 size，重新创建大小等于 size 的数组，增加 GC 负担
  • 等于 size，在高并发情况下，数组创建完成之后，size 正在变大的情況下，负面影响与 2 相同
  • 大于 size，空间浪费，且在 size 处插入 nul 值，存在 NPE 隐患。
    

    【强制】在使用 Collection 接口任何实现类的 addAll() 方法时，都要对输入的集合参数进行 NPE 判断。

• 说明：在 ArrayListi#addAll 方法的第一行代码即 Object[] a = c.toArray(); 其中 c 为输入集合参数，如果为 null，则直接抛出异常。
  

  【强制】使用工具类 Arrays.aslist() 把数组转换成集合时，不能使用其修改集合相关的方法它的 add/remove/clear 方法会抛出 Unsupportedoperationexception 异常。

  【推荐】使用 entryset 遍历 Map 类集合 KV，而不是 keyset 方式进行遍历。

• 说明：keyset 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key 所对应的 value。而 entryset 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更高。如果是 JDK8, 使用 Map.foreach 方法。

• 正例：values()返回的是 V 值集合，是一个 list 集合对象；keySet()返回的是 K 值集合，是一个 Set 集合对象；entrySet()返回的是 K-V 值组合集合。

  【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格:

  
  

  【参考】利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的 contains() 进行遍历去重或者判断包含操作。

  4. 并发处理【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。

• 正例: 自定义线程工厂，并且根据外部特征进行分组，比如，来自同一机房的调用，把机房编号赋值给 whatFeatureOfGroup

  public class UserThreadFactory implements ThreadFactory { private final String namePrefix;
  private final AtomicInteger nextId = new AtomicInteger(1);
    // 定义线程组名称，在利用 jstack 来排查问题时，非常有帮助
    UserThreadFactory(String whatFeatureOfGroup) {
    namePrefix = "From UserThreadFactory's " + whatFeatureOfGroup + "-Worker-";
  }
  @Override
  public Thread newThread(Runnable task) {
    String name = namePrefix + nextId.getAndIncrement(); 
    Thread thread = new Thread(null, task, name, 0, false); 
    System.out.println(thread.getName());
    return thread;
  } }

  
  
  

  5. 控制语句

  【强制】在一个switch块内，每个case要么通过continue/break/return等来终止，要么 注释说明程序将继续执行到哪一个 case 为止;在一个 switch 块内，都必须包含一个 default 语句并且放在最后，即使它什么代码也没有。

• 说明:注意 break 是退出 switch 语句块，而 return 是退出方法体。

6. 注释和前后端规范

【强制】类、类属性、类方法的注释必须使用Javadoc规范，使用/*内容/格式，不得使用 // xxx 方式。

• 说明:在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释;在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

  【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使 用/ /注释，注意与代码对齐。

  【强制】前后端数据列表相关的接口返回，如果为空，则返回空数组[]或空集合{}，减少前端琐碎的 null 判断

  【强制】HTTP 请求通过 body 传递内容时，必须控制长度，超出最大长度后，后端解析会出错：

• 说明：nginx 默认限制是 1MB, tomcat 默认限制为 2MB，当确实有业务需要传较大内容时，可以通过调大服务器端的限制

7. 其他

8. 异常处理

9. 异常处理