JAVA开发手册华山版 - 学习笔记

淩亂°似流年 2022-08-31 09:58 331阅读 0赞

### JAVA开发手册华山版 ###

*   *  关于Java开发手册
     *  JAVA开发手册（华山版）下载
     *  一、编程规约
     *   *  1. 编程风格
         *  2. 常量定义
         *  3. 代码格式
         *  4. OOP规约
         *  5. 集合处理
         *  6. 并发处理
         *  7. 控制语句
         *  8. 注释规约
         *  9. 其他
     *  二、异常日志
     *   *  1. 异常处理
         *  2. 日志规约
     *  三、单元测试
     *  四、安全规约
     *  五、MySQL数据库
     *   *  1. 建表规约
         *  2. 索引规约
         *  3. SQL语句
         *  4. ORM映射
     *  六、工程结构
     *   *  1. 应用分层
         *  2. 二方库依赖
         *  3. 服务器
     *  七、设计规约
     *  附2：专有名词解释

最近开始实习，前一两周主要在学习（摸鱼），然后看了一下阿里巴巴的Java开发手册（华山版），发现自己在开发过程还有很多不够规范的地方，在这里记录一下

## 关于Java开发手册 ##

> 《Java开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结，经历了多次大规模一线实战的检验及不断完善，公开到业界后，众多社区开发者踊跃参与，共同打磨完善，系统化地整理成册。现代软件行业的高速发展对开发者的综合素质要求越来越高，因为不仅是编程知识点，其它维度的知识点也会影响到软件的最终交付质量。比如：数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险；工程结构混乱导致后续维护艰难；没有鉴权的漏洞代码易被黑客攻击等等。所以本手册以Java开发者为中心视角，划分为编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约七个维度，再根据内容特征，细分成若干二级子目录。另外，依据约束力强弱及故障敏感性，规约依次分为强制、推荐、参考三大类。在延伸信息中，“说明”对规约做了适当扩展和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要提防的雷区，以及真实的错误案例。

## JAVA开发手册（华山版）下载 ##

这是我的百度网盘位置，大家可以在这里下载，也可以自己去找最新版

**链接**：  
https://pan.baidu.com/s/14ih53jnW03m-xa35HmKINA  
**提取码**：fapc

## 一、编程规约 ##

### 1. 编程风格 ###

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

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

1.  【**强制**】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。
2.  【**强制**】POJO类中布尔类型变量都不要加is前缀，否则部分框架解析会引起序列化错误。说明：在本文MySQL规约中的建表约定第一条，表达是与否的值采用is\_xxx的命名方式，所以，需要在设置从is\_xxx到xxx的映射关系。

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

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

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

1.  【参考】各层命名规约：

*  Service/DAO层方法命名规约  
    1） 获取单个对象的方法用get做前缀。  
    2） 获取多个对象的方法用list做前缀，复数形式结尾如：listObjects。  
    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。

### 2. 常量定义 ###

1.  【**强制**】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。

反例：String key = "Id#taobao_" + tradeId; cache.put(key, value);
    // 缓存get时，由于在代码复制时，漏掉下划线，导致缓存击穿而出现问题

1.  【**强制**】在long或者Long赋值时，数值后使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。 说明：Long a = 2l; 写的是数字的21，还是Long型的2。

### 3. 代码格式 ###

1.  【**强制**】如果是大括号内为空，则简洁地写成\{\}即可，大括号中间无需换行和空格；如果是非空代码块则：  
    1） 左大括号前不换行。  
    2） 左大括号后换行。  
    3） 右大括号前换行。  
    4） 右大括号后还有else等代码则不换行；表示终止的右大括号后必须换行。
2.  【**强制**】采用4个空格缩进，禁止使用tab字符。  
    说明：如果使用tab缩进，必须设置1个tab为4个空格。IDEA设置tab为4个空格时，请勿勾选Use tab character；而在eclipse中，必须勾选insert spaces for tabs。  
    正例：

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");
    // 在右大括号后直接结束，则必须换行
    }
    }

1.  【**强制**】单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则：  
    1）第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进，参考示例。  
    2）运算符与下文一起换行。  
    3）方法调用的点符号与下文一起换行。  
    4）方法调用中的多个参数需要换行时，在逗号后进行。  
    5）在括号前不要换行，见反例。

正例：

StringBuilder sb = new StringBuilder();
    // 超过120个字符的情况下，换行缩进4个空格，点号和方法名称一起换行
    sb.append("Jack").append("Ma")...
    .append("alibaba")...
    .append("alibaba")...
    .append("alibaba");
    反例：
    StringBuilder sb = new StringBuilder();
    // 超过120个字符的情况下，不要在括号前换行
    sb.append("Jack").append("Ma")...append
    ("alibaba");
    // 参数很多的方法调用可能超过120个字符，不要在逗号前换行
    method(args1, args2, args3, ...
    , argsX);

### 4. OOP规约 ###

1.  【**强制**】所有的覆写方法，必须加@Override注解。 说明：getObject()与get0bject()的问题。一个是字母的O，一个是数字的0，加@Override可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。
2.  【**强制**】相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。 说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程） 正例：public List listUsers(String type, Long… ids) \{…\}
3.  【**强制**】Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。

正例："test".equals(object); 
    反例：object.equals("test"); 
    说明：推荐使用java.util.Objects#equals（JDK7引入的工具类）。

1.  【**强制**】所有整型包装类对象之间值的比较，全部使用equals方法比较。 说明：对于Integer var = ? 在-128至127范围内的赋值，Integer对象是在 IntegerCache.cache产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断。
2.  【**强制**】浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用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 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) 使用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.equals(y)) {  
    System.out.println("true"); 
    }

1.  【**强制**】为了防止精度损失，禁止使用构造方法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.  关于基本数据类型与包装数据类型的使用标准如下：  
    1） 【**强制**】所有的POJO类属性必须使用包装数据类型。  
    2） 【**强制**】RPC方法的返回值和参数必须使用包装数据类型。  
    3） 【推荐】所有的局部变量使用基本数据类型。  
    说明：POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。  
    正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE风险。  
    反例：比如显示成交总额涨跌情况，即正负x%，x为基本数据类型，调用的RPC服务，调用不成功时，返回的是默认值，页面显示为0%，这是不合理的，应该显示成中划线。所以包装数据类型的null值，能够表示额外的信息，如：远程调用失败，异常退出。
2.  【**强制**】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。
3.  【**强制**】禁止在POJO类中，同时存在对应属性xxx的isXxx()和getXxx()方法。 说明：框架在调用属性xxx的提取方法时，并不能确定哪个方法一定是被优先调用到。
4.  【推荐】循环体内，字符串的连接方式，使用StringBuilder的append方法进行扩展。 说明：下例中，反编译出的字节码文件显示每次循环都会new出一个StringBuilder对象，然后进行append操作，最后通过toString方法返回String对象，造成内存资源浪费。

反例：

String str = "start";
    for (int i = 0; i < 100; i++) { 
    str = str + "hello";
    }

1.  【推荐】类成员与方法访问控制从严：  
    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成员方法或成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。

### 5. 集合处理 ###

1.  【**强制**】关于hashCode和equals的处理，遵循如下规则：  
    1） 只要覆写equals，就必须覆写hashCode。  
    2） 因为Set存储的是不重复的对象，依据hashCode和equals进行判断，所以Set存储的对象必须覆写这两个方法。  
    3） 如果自定义对象作为Map的键，那么必须覆写hashCode和equals。  
    说明：String已覆写hashCode和equals方法，所以我们可以愉快地使用String对象作为key来使用。
2.  【**强制**】在subList场景中，高度注意对原集合元素的增加或删除，均会导致子列表的遍历、增加、删除产生ConcurrentModificationException 异常。
3.  【**强制**】使用集合转数组的方法，必须使用集合的toArray(T\[\] 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：  
1） 等于0，动态创建与size相同的数组，性能最好。  
2） 大于0但小于size，重新创建大小等于size的数组，增加GC负担。  
3） 等于size，在高并发情况下，数组创建完成之后，size正在变大的情况下，负面影响与上相同。  
4） 大于size，空间浪费，且在size处插入null值，存在NPE隐患。

1.  【强制】不要在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();
    }
    }

反例：

for (String item : list) { 
    if ("1".equals(item)) { 
    list.remove(item);
    }
    }

说明：以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的结果吗？

1.  【**强制**】在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;
    }
    };

1.  【**推荐**】集合初始化时，指定集合初始值大小。 说明：HashMap使用HashMap(int initialCapacity) 初始化。  
    正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即loader factor）默认为0.75，如果暂时无法确定初始值大小，请设置为16（即默认值）。  
    反例：HashMap需要放置1024个元素，由于没有设置容量初始大小，随着元素不断增加，容量7次被迫扩大，resize需要重建hash表，严重影响性能。
2.  【推荐】高度注意Map类集合K/V能不能存储null值的情况，如下表格：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzUyMDY3MA_size_16_color_FFFFFF_t_70]  
    反例：由于HashMap的干扰，很多人认为ConcurrentHashMap是可以置入null值，而事实上，存储null值时会抛出NPE异常。

### 6. 并发处理 ###

1.  【**强制**】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。 说明：资源驱动类、工具类、单例工厂类都需要注意。
2.  【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。 正例：自定义线程工厂，并且根据外部特征进行分组，比如机房信息。

public class UserThreadFactory implements ThreadFactory {  
    
    private final String namePrefix; 
    private final AtomicInteger nextId = new AtomicInteger(1); 
    
    // 定义线程组名称，在jstack问题排查时，非常有帮助 
    UserThreadFactory(String whatFeaturOfGroup) {  
    namePrefix = "From UserThreadFactory's " + whatFeaturOfGroup + "-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; 
        }
    }

1.  【**强制**】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。 说明：线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。
2.  【**强制**】线程池不允许使用Executors去创建，而是通过ThreadPoolExecutor的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。  
    说明：Executors返回的线程池对象的弊端如下：  
    1） FixedThreadPool和SingleThreadPool：  
    允许的请求队列长度为Integer.MAX\_VALUE，可能会堆积大量的请求，从而导致OOM。  
    2） CachedThreadPool：  
    允许的创建线程数量为Integer.MAX\_VALUE，可能会创建大量的线程，从而导致OOM。
3.  【**强制**】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。 说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用RPC方法。
4.  【强制】在使用阻塞等待获取锁的方式中，必须在try代码块之外，并且在加锁方法与try代码块之间没有任何可能抛出异常的方法调用，避免加锁成功后，在finally中无法解锁。  
    说明一：如果在lock方法与try代码块之间的方法调用抛出异常，那么无法解锁，造成其它线程无法成功获取锁。  
    说明二：如果lock方法在try代码块之内，可能由于其它方法抛出异常，导致在finally代码块中，unlock对未加锁的对象解锁，它会调用AQS的tryRelease方法（取决于具体实现类），抛出IllegalMonitorStateException异常。  
    说明三：在Lock对象的lock方法实现中可能抛出unchecked异常，产生的后果与说明二相同。  
    正例：

Lock lock = new XxxLock();
    // ...
    lock.lock();
    try { 
    doSomething();
    doOthers();
    } finally { 
    lock.unlock();
    }

反例：

Lock lock = new XxxLock();
    // ...
    try { 
    // 如果此处抛出异常，则直接执行finally代码块
    doSomething();
    // 无论加锁是否成功，finally代码块都会执行
    lock.lock();
    doOthers();
    } finally { 
    lock.unlock();
    }

1.  【**强制**】在使用尝试机制来获取锁的方式中，进入业务代码块之前，必须先判断当前线程是否持有锁。锁的释放规则与锁的阻塞等待方式相同。 说明：Lock对象的unlock方法在执行时，它会调用AQS的tryRelease方法（取决于具体实现类），如果当前线程不持有锁，则抛出IllegalMonitorStateException异常。

正例：

Lock lock = new XxxLock();
    // ...
    boolean isLocked = lock.tryLock();
    if (isLocked) { 
    try { 
    doSomething();
    doOthers();
    } finally { 
    lock.unlock();
    }
    }

### 7. 控制语句 ###

1.  【**强制**】在一个switch块内，每个case要么通过continue/break/return等来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。 说明：注意break是退出switch语句块，而return是退出方法体。
2.  【**强制**】当switch括号内的变量类型为String并且此变量为外部参数时，必须先进行null判断。 反例：猜猜下面的代码输出是什么？

public class SwitchString { 
       public static void main(String[] args) { 
       method(null);
       }
       public static void method(String param) { 
       switch (param) { 
           // 肯定不是进入这里
           case "sth":
           System.out.println("it's sth");
           break;
           // 也不是进入这里
           case "null":
           System.out.println("it's null");
           break;
           // 也不是进入这里
           default:
           System.out.println("default");
              }
        }
    }

1.  【**强制**】在高并发场景中，避免使用”等于”判断作为中断或退出的条件。  
    说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间判断条件来代替。  
    反例：判断剩余奖品数量等于0时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变成了负数，这样的话，活动无法终止。
2.  【推荐】表达异常的分支时，少用if-else方式，这种方式可以改写成：  
    if (condition) \{  
    …  
    return obj;  
    \}  
    // 接着写else的业务逻辑代码;  
    说明：如果非使用if()…else if()…else…方式表达逻辑，避免后续代码维护困难，【**强制**】请勿超过3层。  
    正例：超过3层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现，其中卫语句即代码逻辑先考虑失败、异常、中断、退出等直接返回的情况，以方法多个出口的方式，解决代码中判断分支嵌套的问题，这是逆向思维的体现。

示例如下：

public void findBoyfriend(Man man) { 
        if (man.isUgly()) { 
            System.out.println("本姑娘是外貌协会的资深会员");
        return;
    }
        if (man.isPoor()) { 
    		System.out.println("贫贱夫妻百事哀");
    	return;
    }
    	if (man.isBadTemper()) { 
    		System.out.println("银河有多远，你就给我滚多远");
    	return;
    }
    	System.out.println("可以先交往一段时间看看");
    }

### 8. 注释规约 ###

1.  【**强制**】类、类属性、类方法的注释必须使用Javadoc规范，使用/\**内容*/格式，不得使用// xxx方式。  
    说明：在IDE编辑窗口中，Javadoc方式会提示相关注释，生成Javadoc可以正确输出相应注释；在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。
2.  【**强制**】所有的抽象方法（包括接口中的方法）必须要用Javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。  
    说明：对子类的实现要求，或者调用注意事项，请一并说明。
3.  【**强制**】所有的类都必须添加创建者和创建日期。
4.  【**强制**】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/\* \*/注释，注意与代码对齐。
5.  【**强制**】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
6.  【**推荐**】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。  
    反例：“TCP连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。
7.  【**推荐**】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。  
    说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。
8.  【**参考**】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。 说明：代码被注释掉有两种可能性：  
    1）后续会恢复此段代码逻辑。  
    2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库已然保存了历史代码）。
9.  【**参考**】对于注释的要求：第一、能够准确反映设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。
10. 【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。

反例：

// put elephant into fridge
    put(elephant, fridge);

方法名put，加上两个有意义的变量名elephant和fridge，已经说明了这是在干什么，语义清晰的代码不需要额外的注释。

1.  【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。  
    1） 待办事宜（TODO）:（标记人，标记时间，\[预计处理时间\]） 表示需要实现，但目前还未实现的功能。这实际上是一个Javadoc的标签，目前的Javadoc还没 有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个Javadoc标签）。  
    2） 错误，不能工作（FIXME）:（标记人，标记时间，\[预计处理时间\]） 在注释中用FIXME标记某代码是错误的，而且不能工作，需要及时纠正的情况。

### 9. 其他 ###

1.  【**强制**】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。  
    说明：不要在方法体内定义：Pattern pattern = Pattern.compile(“规则”);
2.  【**强制**】velocity调用POJO类的属性时，直接使用属性名取值即可，模板引擎会自动按规范调用POJO的getXxx()，如果是boolean基本数据类型变量（boolean命名不需要加is前缀），会自动调用isXxx()方法。  
    说明：注意如果是Boolean包装类对象，优先调用getXxx()的方法。
3.  【**强制**】注意 Math.random() 这个方法返回是double类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。
4.  【**强制**】获取当前毫秒数System.currentTimeMillis(); 而不是new Date().getTime(); 说明：如果想获取更加精确的纳秒级时间值，使用System.nanoTime()的方式。在JDK8中，针对统计时间等场景，推荐使用Instant类。
5.  【**强制**】日期格式化时，传入pattern中表示年份统一使用小写的y。 说明：日期格式化时，yyyy表示当天所在的年，而大写的YYYY代表是week in which year（JDK7之后引入的概念），意思是当天所在的周属于的年份，一周从周日开始，周六结束，只要本周跨年，返回的YYYY就是下一年。另外需要注意：

*  表示月份是大写的M
 *  表示分钟则是小写的m
 *  24小时制的是大写的H
 *  12小时制的则是小写的h

正例：表示日期和时间的格式如下所示： new SimpleDateFormat(“yyyy-MM-dd HH:mm:ss”);

1.  【推荐】不要在视图模板中加入任何复杂的逻辑。 说明：根据MVC理论，视图的职责是展示，不要抢模型和控制器的活。
2.  【推荐】任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
3.  【推荐】及时清理不再使用的代码段或配置信息。  
    说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。  
    正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由。

## 二、异常日志 ##

### 1. 异常处理 ###

1.  【**强制**】Java 类库中定义的可以通过预检查方式规避的RuntimeException异常不应该通过catch 的方式来处理，比如：NullPointerException，IndexOutOfBoundsException等等。 说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，可能存在数字格式错误，不得不通过catch NumberFormatException来实现。

正例：

if (obj != null) { ...} 反例：try {  obj.method(); } catch (NullPointerException e) { …}

1.  【**强制**】异常不要用来做流程控制，条件控制。  
    说明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多。
2.  【**强制**】catch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型，再做对应的异常处理。  
    说明：对大段代码进行try-catch，使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。 正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程序上作出分门别类的判断，并提示给用户。
3.  【**强制**】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。
4.  【**强制**】有try块放到了事务代码中，catch异常后，如果需要回滚事务，一定要注意手动回滚事务。
5.  【**强制**】finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch。 说明：如果JDK7及以上，可以使用try-with-resources方式。
6.  【**强制**】不要在finally块中使用return。 说明：try块中的return语句执行成功后，并不马上返回，而是继续执行finally块中的语句，如果此处存在return语句，则在此直接返回，无情丢弃掉try块中的返回点。

反例：

private int x = 0;
    public int checkReturn() { 
    try { 
    // x等于1，此处不返回
    return ++x;
    } finally { 
    Java 开发手册
    25/44
    // 返回的结果是2
    return ++x;
    }
    }

1.  【**强制**】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。  
    说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。
2.  【**强制**】在调用RPC、二方包、或动态生成类的相关方法时，捕捉异常必须使用Throwable类来进行拦截。 说明：通过反射机制来调用方法，如果找不到方法，抛出NoSuchMethodException。什么情况会抛出NoSuchMethodError呢？二方包在类冲突时，仲裁机制可能导致引入非预期的版本使类的方法签名不匹配，或者在字节码修改框架（比如：ASM）动态创建或修改类时，修改了相应的方法签名。这些情况，即使代码编译期是正确的，但在代码运行期时，会抛出NoSuchMethodError。
3.  【推荐】方法的返回值可以为null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回null值。 说明：本手册明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回null的情况。
4.  【推荐】防止NPE，是程序员的基本修养，注意NPE产生的场景：  
    1） 返回类型为基本数据类型，return包装数据类型的对象时，自动拆箱有可能产生NPE。 反例：public int f() \{ return Integer对象\}， 如果为null，自动解箱抛NPE。  
    2） 数据库的查询结果可能为null。  
    3） 集合里的元素即使isNotEmpty，取出的数据元素也可能为null。  
    4） 远程调用返回对象时，一律要求进行空指针判断，防止NPE。  
    5） 对于Session中获取的数据，建议进行NPE检查，避免空指针。  
    6） 级联调用obj.getA().getB().getC()；一连串调用，易产生NPE。  
    正例：使用JDK8的Optional类来防止NPE问题。
5.  【推荐】定义时区分unchecked / checked 异常，避免直接抛出new RuntimeException()，更不允许抛出Exception或者Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DAOException / ServiceException等。
6.  【参考】对于公司外的http/api开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间RPC调用优先考虑使用Result方式，封装isSuccess()方法、“错误码”、“错误简短信息”。 说明：关于RPC方法返回方式使用Result方式的理由：  
    1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。  
    2）如果不加栈信息，只是new自定义异常，加入自己的理解的error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。
7.  【参考】避免出现重复的代码（Don’t Repeat Yourself），即DRY原则。 说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。 正例：一个类中有多个public方法，都需要进行数行相同的参数校验操作，这个时候请抽取：  
    private boolean checkParam(DTO dto) \{…\}

### 2. 日志规约 ###

1.  【**强制**】应用中不可直接使用日志系统（Log4j、Logback）中的API，而应依赖使用日志框架 SLF4J中的API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    private static final Logger logger = LoggerFactory.getLogger(Test.class);

1.  【**强制**】所有日志文件至少保存15天，因为有些异常具备以“周”为频次发生的特点。网络运行状态、安全相关信息、系统监测、管理后台操作、用户敏感操作需要留存相关的网络日志不少于6个月。
2.  【**强制**】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName\_logType\_logName.log。logType:日志类型，如stats/monitor/access等；logName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。  
    说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。  
    正例：force-web应用中单独监控时区转换异常，如：force\_web\_timeZoneConvert.log
3.  【**强制**】在日志输出时，字符串变量之间的拼接使用占位符的方式。 说明：因为String字符串的拼接会使用StringBuilder的append()方式，有一定的性能损耗。使用占位符仅是替换动作，可以有效提升性能。 正例：

logger.debug("Processing trade with id: {} and symbol: {}", id, symbol);

1.  【**强制**】对于trace/debug/info级别的日志输出，必须进行日志级别的开关判断。 说明：虽然在debug(参数)的方法体内第一行代码isDisabled(Level.DEBUG\_INT)为真时（Slf4j的常见实现Log4j和Logback），就直接return，但是参数可能会进行字符串拼接运算。此外，如果debug(getName())这种参数内有getName()方法调用，无谓浪费方法调用的开销。 正例： // 如果判断为真，那么可以输出trace和debug级别的日志 if (logger.isDebugEnabled()) \{ logger.debug(“Current ID is: \{\} and name is: \{\}”, id, getName()); \}
2.  【**强制**】避免重复打印日志，浪费磁盘空间，务必在log4j.xml中设置additivity=false。 正例：

1.  【**强制**】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws往上抛出。  
    正例：logger.error(各类参数或者对象toString() + “\_” + e.getMessage(), e);

## 三、单元测试 ##

1.  【**强制**】好的单元测试必须遵守AIR原则。 说明：单元测试在线上运行时，感觉像空气（AIR）一样并不存在，但在测试质量的保障上，却是非常关键的。好的单元测试宏观上来说，具有自动化、独立性、可重复执行的特点。

*  A：Automatic（自动化）
 *  I：Independent（独立性）
 *  R：Repeatable（可重复）

1.  【**强制**】单元测试应该是全自动执行的，并且非交互式的。测试用例通常是被定期执行的，执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用System.out来进行人肉验证，必须使用assert来验证。
2.  【**强制**】对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级别，一般是方法级别。 说明：只有测试粒度小才能在出错时尽快定位到出错位置。单测不负责检查跨类或者跨系统的交互逻辑，那是集成测试的领域。
3.  【推荐】单元测试的基本目标：语句覆盖率达到70%；核心模块的语句覆盖率和分支覆盖率都要达到100% 说明：在工程规约的应用分层中提到的DAO层，Manager层，可重用度高的Service，都应该进行单元测试。

## 四、安全规约 ##

1.  【**强制**】隶属于用户个人的页面或者功能必须进行权限控制校验。 说明：防止没有做水平权限校验就可随意访问、修改、删除别人的数据，比如查看他人的私信内容、修改他人的订单。
2.  【**强制**】用户敏感数据禁止直接展示，必须对展示数据进行脱敏。 说明：中国大陆个人手机号码显示为:137\*\*\*\*0969，隐藏中间4位，防止隐私泄露。
3.  【**强制**】用户输入的SQL参数严格使用参数绑定或者METADATA字段值限定，防止SQL注入，禁止字符串拼接SQL访问数据库。
4.  【**强制**】用户请求传入的任何参数必须做有效性验证。 说明：忽略参数校验可能导致：

*  page size过大导致内存溢出
 *  恶意order by导致数据库慢查询
 *  任意重定向
 *  SQL注入
 *  反序列化注入
 *  正则输入源串拒绝服务ReDoS

说明：Java代码用正则来验证客户端的输入，有些正则写法验证普通用户输入没有问题，但是如果攻击人员使用的是特殊构造的字符串来验证，有可能导致死循环的结果。

1.  【**强制**】禁止向HTML页面输出未经安全过滤或未正确转义的用户数据。
2.  【**强制**】表单、AJAX提交必须执行CSRF安全验证。 说明：CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。对于存在CSRF漏洞的应用/网站，攻击者可以事先构造好URL，只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改。
3.  【**强制**】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而导致资损。 说明：如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。
4.  【推荐】发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。

## 五、MySQL数据库 ##

### 1. 建表规约 ###

1.  【**强制**】表达是与否概念的字段，必须使用is\_xxx的方式命名，数据类型是unsigned tinyint（1表示是，0表示否）。 说明：任何字段如果为非负数，必须是unsigned。 注意：POJO类中的任何布尔类型的变量，都不要加is前缀，所以，需要在设置从is\_xxx到Xxx的映射关系。数据库表示是与否的值，使用tinyint类型，坚持is\_xxx的命名方式是为了明确其取值含义与取值范围。 正例：表达逻辑删除的字段名is\_deleted，1表示删除，0表示未删除。
2.  【**强制**】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。 说明：MySQL在Windows下不区分大小写，但在Linux下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。 正例：aliyun\_admin，rdc\_config，level3\_name 反例：AliyunAdmin，rdcConfig，level\_3\_name
3.  【**强制**】主键索引名为pk\_字段名；唯一索引名为uk\_字段名；普通索引名则为idx\_字段名。 说明：pk\_ 即primary key；uk\_ 即 unique key；idx\_ 即index的简称。
4.  【**强制**】表必备三字段：id, create\_time, update\_time。 说明：其中id必为主键，类型为bigint unsigned、单表时自增、步长为1。create\_time, update\_time的类型均为datetime类型。

### 2. 索引规约 ###

1.  【**强制**】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。 说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。
2.  【**强制**】超过三个表禁止join。需要join的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。 说明：即使双表join也要注意表索引、SQL性能。
3.  【**强制**】在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。  
    说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为20的索引，区分度会高达90%以上，可以使用count(distinct left(列名, 索引长度))/count(\*)的区分度来确定。
4.  【**强制**】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。 说明：索引文件具有B-Tree的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。

### 3. SQL语句 ###

1.  【**强制**】不要使用count(列名)或count(常量)来替代count(*)，count(*)是SQL92定义的标准统计行数的语法，跟数据库无关，跟NULL和非NULL无关。 说明：count(\*)会统计值为NULL的行，而count(列名)不会统计此列为NULL值的行。
2.  【**强制**】count(distinct col) 计算该列除NULL之外的不重复行数，注意 count(distinct col1, col2) 如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0。
3.  【**强制**】当某一列的值全是NULL时，count(col)的返回结果为0，但sum(col)的返回结果为NULL，因此使用sum()时需注意NPE问题。 正例：使用如下方式来避免sum的NPE问题：SELECT IFNULL(SUM(column), 0) FROM table;
4.  【**强制**】使用ISNULL()来判断是否为NULL值。 说明：NULL与任何值的直接比较都为NULL。  
    1） NULL<>NULL的返回结果是NULL，而不是false。  
    2） NULL=NULL的返回结果是NULL，而不是true。  
    3） NULL<>1的返回结果是NULL，而不是true。
5.  【**强制**】代码中写分页查询逻辑时，若count为0应直接返回，避免执行后面的分页语句。
6.  【**强制**】不得使用外键与级联，一切外键概念必须在应用层解决。 说明：以学生和成绩的关系为例，学生表中的student\_id是主键，那么成绩表中的student\_id则为外键。如果更新学生表中的student\_id，同时触发成绩表中的student\_id更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。
7.  【**强制**】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
8.  【**强制**】数据订正（特别是删除、修改记录操作）时，要先select，避免出现误删除，确认无误才能执行更新语句。

### 4. ORM映射 ###

1.  【**强制**】在表查询中，一律不要使用 \* 作为查询的字段列表，需要哪些字段必须明确写明。 说明：1）增加查询分析器解析成本。2）增减字段容易与resultMap配置不一致。3）无用字段增加网络消耗，尤其是text类型的字段。
2.  【**强制**】POJO类的布尔属性不能加is，而数据库字段必须加is\_，要求在resultMap中进行字段与属性之间的映射。 说明：参见定义POJO类以及数据库字段定义规定，在中增加映射，是必须的。在MyBatis Generator生成的代码中，需要进行对应的修改。
3.  【**强制**】不要用resultClass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个POJO类与之对应。 说明：配置映射关系，使字段与DO类解耦，方便维护。
4.  【**强制**】sql.xml配置参数使用：\#\{\}，\#param\# 不要使用$\{\} 此种方式容易出现SQL注入。
5.  【**强制**】iBATIS自带的queryForList(String statementName,int start,int size)不推荐使用。 说明：其实现方式是在数据库取到statementName对应的SQL语句的所有记录，再通过subList取start,size的子集合。  
    正例：

Map<String, Object> map = new HashMap<>();
    map.put("start", start);
    map.put("size", size);

1.  【**强制**】不允许直接拿HashMap与Hashtable作为查询结果集的输出。 说明：resultClass=”Hashtable”，会置入字段名和属性值，但是值的类型不可控。
2.  【**强制**】更新数据表记录时，必须同时更新记录对应的gmt\_modified字段值为当前时间。

## 六、工程结构 ##

### 1. 应用分层 ###

1.  【推荐】图中默认上层依赖于下层，箭头关系表示可直接依赖，如：开放接口层可以依赖于Web层，也可以直接依赖于Service层，依此类推：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzUyMDY3MA_size_16_color_FFFFFF_t_70 1]

*  开放接口层：可直接封装Service方法暴露成RPC接口；通过Web封装成http接口；进行网关安全控制、流量控制等。• 终端显示层：各个端的模板渲染并执行显示的层。当前主要是velocity渲染，JS渲染，JSP渲染，移动端展示等。
 *  Web层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。
 *  Service层：相对具体的业务逻辑服务层。
 *  Manager层：通用业务处理层，它有如下特征： 1） 对第三方平台封装的层，预处理返回结果及转化异常信息。 2） 对Service层通用能力的下沉，如缓存方案、中间件通用处理。 3） 与DAO层交互，对多个DAO的组合复用。
 *  DAO层：数据访问层，与底层MySQL、Oracle、Hbase等进行数据交互。
 *  外部接口或第三方平台：包括其它部门RPC开放接口，基础平台，其它公司的HTTP接口。

### 2. 二方库依赖 ###

1.  【**强制**】定义GAV遵从以下规则： 1） GroupID格式：com.\{公司/BU \}.业务线 \[.子业务线\]，最多4级。 说明：\{公司/BU\} 例如：alibaba/taobao/tmall/aliexpress等BU一级；子业务线可选。 正例：com.taobao.jstorm 或 com.alibaba.dubbo.register 2） ArtifactID格式：产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。 正例：dubbo-client / fastjson-api / jstorm-tool 3） Version：详细规定参考下方。
2.  【**强制**】二方库版本号命名方式：主版本号.次版本号.修订号  
    1）主版本号：产品方向改变，或者大规模API不兼容，或者架构不兼容升级。  
    2） 次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的API不兼容修改。  
    3） 修订号：保持完全兼容性，修复BUG、新增次要功能特性等。 说明：注意起始版本号必须为：1.0.0，而不是0.0.1，正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本号不允许覆盖升级。如当前版本：1.3.3，那么下一个合理的版本号：1.3.4 或 1.4.0 或 2.0.0
3.  【**强制**】线上应用不要依赖SNAPSHOT版本（安全包除外）。 说明：不依赖SNAPSHOT版本是保证应用发布的幂等性。另外，也可以加快编译时的打包构建。
4.  【**强制**】二方库的新增或升级，保持除功能点之外的其它jar包仲裁结果不变。如果有改变，必须明确评估和验证。  
    说明：在升级时，进行dependency:resolve前后信息比对，如果仲裁结果完全不一致，那么通过dependency:tree命令，找出差异点，进行排除jar包。
5.  【**强制**】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的POJO对象。
6.  【**强制**】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。 说明：依赖springframework-core,-context,-beans，它们都是同一个版本，可以定义一个变量来保存版本：$\{spring.version\}，定义依赖的时候，引用该版本。
7.  【**强制**】禁止在子项目的pom依赖中出现相同的GroupId，相同的ArtifactId，但是不同的Version。 说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war，只能有一个版本号出现在最后的lib目录中。可能出现线下调试是正确的，发布到线上却出故障的问题。
8.  【推荐】底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。

### 3. 服务器 ###

1.  【推荐】高并发服务器建议调小TCP协议的time\_wait超时时间。 说明：操作系统默认240秒后，才会关闭处于time\_wait状态的连接，在高并发访问下，服务器端会因为处于time\_wait的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。 正例：在linux服务器上请通过变更/etc/sysctl.conf文件去修改该缺省值（秒）： net.ipv4.tcp\_fin\_timeout = 30
2.  【推荐】调大服务器所支持的最大文件句柄数（File Descriptor，简写为fd）。 说明：主流操作系统的设计是将TCP/UDP连接采用与文件一样的方式去管理，即一个连接对应于一个fd。主流的linux服务器默认所支持最大fd数量为1024，当并发连接数很大时很容易因为fd不足而出现“open too many files”错误，导致新的连接无法建立。建议将linux服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。

## 七、设计规约 ##

1.  【**强制**】存储方案和底层数据结构的设计获得评审一致通过，并沉淀成为文档。 说明：有缺陷的底层数据结构容易导致系统风险上升，可扩展性下降，重构成本也会因历史数据迁移和系统平滑过渡而陡然增加，所以，存储方案和数据结构需要认真地进行设计和评审，生产环境提交执行后，需要进行double check。 正例：评审内容包括存储介质选型、表结构设计能否满足技术方案、存取性能和存储空间能否满足业务发展、表或字段之间的辩证关系、字段名称、字段类型、索引等；数据结构变更（如在原有表中新增字段）也需要进行评审通过后上线。
2.  【**强制**】在需求分析阶段，如果与系统交互的User超过一类并且相关的User Case超过5个，使用用例图来表达更加清晰的结构化需求。
3.  【**强制**】如果某个业务对象的状态超过3个，使用状态图来表达并且明确状态变化的各个触发条件。 说明：状态图的核心是对象状态，首先明确对象有多少种状态，然后明确两两状态之间是否存在直接转换关系，再明确触发状态转换的条件是什么。 正例：淘宝订单状态有已下单、待付款、已付款、待发货、已发货、已收货等。比如已下单与已收货这两种状态之间是不可能有直接转换关系的。
4.  【**强制**】如果系统中某个功能的调用链路上的涉及对象超过3个，使用时序图来表达并且明确各调用环节的输入与输出。 说明：时序图反映了一系列对象间的交互与协作关系，清晰立体地反映系统的调用纵深链路。
5.  【**强制**】如果系统中模型类超过5个，并且存在复杂的依赖关系，使用类图来表达并且明确类之间的关系。 说明：类图像建筑领域的施工图，如果搭平房，可能不需要，但如果建造蚂蚁Z空间大楼，肯定需要详细的施工图。
6.  【**强制**】如果系统中超过2个对象之间存在协作关系，并且需要表示复杂的处理流程，使用活动图来表示。 说明：活动图是流程图的扩展，增加了能够体现协作关系的对象泳道，支持表示并发等。

## 附2：专有名词解释 ##

1.  POJO（Plain Ordinary Java Object）: 在本手册中，POJO专指只有setter / getter / toString的简单类，包括DO/DTO/BO/VO等。
2.  GAV（GroupId、ArtifactctId、Version）: Maven坐标，是用来唯一标识jar包。
3.  OOP（Object Oriented Programming）: 本手册泛指类、对象的编程处理方式。
4.  ORM（Object Relation Mapping）: 对象关系映射，对象领域模型与底层数据之间的转换，本文泛指iBATIS, mybatis等框架。
5.  NPE（java.lang.NullPointerException）: 空指针异常。
6.  SOA（Service-Oriented Architecture）: 面向服务架构，它可以根据需求通过网络对松散耦合的粗粒度应用组件进行分布式部署、组合和使用，有利于提升组件可重用性，可维护性。
7.  IDE（Integrated Development Environment）: 用于提供程序开发环境的应用程序，一般包括代码编辑器、编译器、调试器和图形用户界面等工具，本《手册》泛指IntelliJ IDEA和eclipse。
8.  OOM（Out Of Memory）: 源于java.lang.OutOfMemoryError，当JVM没有足够的内存来为对象分配空间并且垃圾回收器也无法回收空间时，系统出现的严重状况。
9.  一方库：本工程内部子项目模块依赖的库（jar包）。
10. 二方库：公司内部发布到中央仓库，可供公司内部其它应用依赖的库（jar包）。
11. 三方库：公司之外的开源库（jar包）。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzUyMDY3MA_size_16_color_FFFFFF_t_70]: /images/20220829/8d27006e3bde40eaba2621b2572d8553.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzUyMDY3MA_size_16_color_FFFFFF_t_70 1]: /images/20220829/7884a090f92a4eb2b8d00c2a6aeb9a06.png