解读阿里Java开发手册(v1.1.1)

传送门

解读阿里Java开发手册(v1.1.1) - 编程规约

前言

阿里Java开发手册谈不上圣经，但确实是大量程序员踩坑踩出来的一部非常有价值的宝典。其从代码规范性、性能、健壮性、安全性等方面出发，对程序员提出了一系列简单直观的要求，对于人员流动性强，程序员技术水平参差不齐的团队来说，尤其具备价值。

阿里Java开发手册中，有一部分规约是针对阿里自己的工程环境特点设置的，其他团队可以用于借鉴，无需照搬，而大部分的规约，都是具备推广价值的。

然而这本手册中的规约众多，部分搭配了简短的说明，相当一部分规约则对原理说明的不够详细。本着“知道为什么要这样做”强于“知道应该这样做”的思想，本文在列出阿里Java开发手册的同时，对其中部分语焉不详的规约进行了比较详细的说明，并尽可能搭配代码样例。

本文覆盖阿里Java开发手册中的前两章，即编程规约和异常日志两章，后三章MySQL规约、工程规约、安全规约不列入主要有两个考虑，一是这三章的内容与Java不紧密相关，二是这三章中除MySQL之外的规约与阿里现行的技术架构捆绑的比较紧，普适性较低。

本文中，在阿里Java开发手册基础上增加的说明内容全部以引用的形式出现，即

引用部分的文字是本文作者对阿里Java规约的附加说明

二、异常日志

(一) 异常处理

【强制】Java 类库中定义的一类RuntimeException可以通过预先检查进行规避，而不应该通过catch 来处理，比如：IndexOutOfBoundsException，NullPointerException等等。
说明：无法通过预检查的异常除外，如在解析一个外部传来的字符串形式数字时，通过catch NumberFormatException来实现。
正例：

    if (obj != null) {
        ...
    }

反例：

    try {
        obj.method();
    } catch (NullPointerException e) {
        ...
    }

对于通过入参或全局上下文获取的对象，在使用之前，必须先判null

【强制】异常不要用来做流程控制，条件控制，因为异常的处理效率比条件分支低。

使用异常来做流程控制有时用起来很方便，例如进行资格校验的API，可以通过抛出的异常的message来说明资格校验不通过的原因。但这样做会牺牲性能，因为异常对象的产生本身就涉及生成stacktrace等比较耗时的行为，最好避免。

【强制】对大段代码进行try-catch，这是不负责任的表现。catch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型，再做对应的异常处理。

有些工程的顶层代码中可能存在大段的try-catch，其目的是确保异常不会从业务代码中逃逸，导致没有进入最外层兜底的异常处理逻辑。但考虑代码的简洁和可维护性，最好还是通过框架级的统一异常处理逻辑来进行（例如spring-mvc、Struts等都有通用的全局异常处理机制）。

【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。

异常处理的原则之一 - 延迟捕获：
不要在程序有能力处理异常之前捕获它，将异常交由掌握更多信息的作用域处理
所以说，如果处理不了这个异常，那就干脆不要捕获它，让外层的逻辑来处理。当然如果已经是最外层了，那就必须处理

【强制】有try块放到了事务代码中，catch异常后，如果需要回滚事务，一定要注意手动回滚事务。

使用spring的事务管理能力可以做到在产生异常后自动回滚事务

【强制】finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch。说明：如果JDK7及以上，可以使用try-with-resources方式。

try-with-resources非常方便

try (BufferedReader br = new BufferedReader(new FileReader(path))) {
    return br.readLine();
}

等价于
```java

BufferedReader br = new BufferedReader(new FileReader(path));
try {
    return br.readLine();
} finally {
    if (br != null)
        br.close();
}

【强制】不能在finally块中使用return，finally块中的return返回后方法结束执行，不会再执行try块中的return语句。

方法的退出方式有两种：return或抛出异常，而finally块中的代码是在return或抛出异常之后执行的，所以如果finally块中有return，会把之前return过的返回值覆盖掉，如果之前抛出了异常，也会被吞掉

【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。
【推荐】方法的返回值可以为null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回null值。调用方需要进行null判断防止NPE问题。
说明：本手册明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回null的情况。

防止NPE是调用者的责任，这一点很对。如果API的提供者拍胸脯说“绝对不会返回null”，你就敢不进行null判断了吗？

【推荐】防止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问题。

简单来说，拿到的对象只要不是你自己的代码产生的，那么都有可能是null，均需要进行NPE检查
Optional类既可以用来装B，又实实在在的有用。如果升级JDK8有困难，google guava库中也提供了Optional类。
关于Optional类的具体使用，可参考http://www.tuicool.com/articles/uIzeYjf

【推荐】定义时区分unchecked / checked 异常，避免直接使用RuntimeException抛出，更不允许抛出Exception或者Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DAOException / ServiceException等。

这一条规约分解一下，有几条：

自定义异常时，想好要定义的异常是unchecked还是checked异常，如果是前者，继承RuntimeException，如果是后者，继承Exception

尽量不要在抛出异常时throw new RuntimeException("xxxx"); 应该使用具备业务含义的自定义异常类，这样做可以在捕获异常时提供方便

绝对不要在抛出异常时throw new Exception("xxx")或throw new Throwable("xxx")，这样做不仅仅是屏蔽了异常本身的业务含义，同时也屏蔽了异常的分类（checked/unchecked），甚至连Exception和Error的区别也屏蔽了

如果不清楚Throwable/Exception/Error的关系，或不清楚unchecked/checked异常的含义，建议先阅读笔者的另一篇文章Java异常控制机制和异常处理原则

【参考】在代码中使用“抛异常”还是“返回错误码”，对于公司外的http/api开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间RPC调用优先考虑使用Result方式，封装isSuccess、“错误码”、“错误简短信息”。
说明：关于RPC方法返回方式使用Result方式的理由：
1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
2）如果不加栈信息，只是new自定义异常，加入自己的理解的error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。
【参考】避免出现重复的代码（Don’t Repeat Yourself），即DRY原则。
说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是共用模块。
正例：一个类中有多个public方法，都需要进行数行相同的参数校验操作，这个时候请抽取：

private boolean checkParam(DTO dto) {...}

说的很对，但为啥放在异常处理分类下……？

(二) 日志规约

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

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

slf4j是日志门面框架，其仅提供日志记录的API，而不实现日志记录的功能，slf4j需要通过适配库适配到log4j或logback等日至系统来实现日志的记录。
使用slf4j api能够提升代码和应用的可移植性，在使用不同日志系统的应用之间能够做到无缝的适配。
同时，使用slf4j api的应用，在切换日志系统时（比如从logback切换到log4j2，不需要代码改造）

【强制】日志文件推荐至少保存15天，因为有些异常具备以“周”为频次发生的特点。
【强制】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName_logType_logName.log。
logType:日志类型，推荐分类有stats/desc/monitor/visit等；
logName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。
正例：mppserver应用中单独监控时区转换异常，如： mppserver_monitor_timeZoneConvert.log
说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。
【强制】对trace/debug/info级别的日志输出，必须使用条件输出形式或者使用占位符的方式。
说明：logger.debug("Processing trade with id: " + id + " symbol: " + symbol); 如果日志级别是warn，上述日志不会打印，但是会执行字符串拼接操作，如果symbol是对象，会执行toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。
正例：（条件）

    if (logger.isDebugEnabled()) {
        logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
    }

正例：（占位符）

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

占位符方式，log4j2/logback支持，log4j1.x是不直接支持的，只能通过slf4j库适配

【强制】避免重复打印日志，浪费磁盘空间，务必在log4j.xml中设置additivity=false。
正例：

additivity默认为true，即通过该logger输出的日志会同时输出到root logger，如果还为该logger指定了独立的appender，就会导致这部分日志重复输出

【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws往上抛出。
正例：

    logger.error(各类参数或者对象toString + "_" + e.getMessage(), e);

记录异常日志的常见错误：
logger.error(e);
logger.error(e.getMessage());
logger.error("上下文"+e.getMessage())；
上面这几种都是错的！请确保使用的是两个入参的API，如error(String s, Throwable t)

【推荐】谨慎地记录日志。生产环境禁止输出debug日志；有选择地输出info日志；如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。
说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

不要认为日志记录不怎么消耗性能，我见过不少事无巨细式的日志把系统性能严重拖慢的案例

【参考】可以使用warn日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。注意日志输出的级别，error级别只记录系统逻辑出错、异常等重要的错误信息。如非必要，请不要在此场景打出error级别。

解读阿里Java开发手册(v1.1.1) - 异常日志

传送门

前言

二、异常日志

(一) 异常处理

(二) 日志规约

你可能感兴趣的:(解读阿里Java开发手册(v1.1.1) - 异常日志)