Java异常日志处理

(一) 异常处理

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。

   说明：finally块中的return返回后方法结束执行，不会再执行try块中的return语句。

7. 【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。

   说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。

8. 【推荐】方法的返回值可以为null，不强制返回空集合，或者空对象等，必须添加注释充分

   说明什么情况下会返回null值。
   说明：本手册明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回null的情况。

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

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

11. 【参考】对于公司外的http/api开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间RPC调用优先考虑使用Result方式，封装isSuccess()方法、“错误码”、“错误简短信息”。

    说明：关于RPC方法返回方式使用Result方式的理由：

    1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
    2）如果不加栈信息，只是new自定义异常，加入自己的理解的error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。

12. 【参考】避免出现重复的代码（Don’t Repeat Yourself），即DRY原则。

    说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。
    正例：一个类中有多个public方法，都需要进行数行相同的参数校验操作，这个时候请抽取：

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

(二) 日志规约

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

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

1. 【强制】日志文件推荐至少保存15天，因为有些异常具备以“周”为频次发生的特点。

2. 【强制】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName_logType_logName.log。logType:日志类型，推荐分类有stats/monitor/visit等；logName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。

   正例：mppserver应用中单独监控时区转换异常，如：
   mppserver_monitor_timeZoneConvert.log

   说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。

3. 【强制】对trace/debug/info级别的日志输出，必须使用条件输出形式或者使用占位符的方式。

   说明：logger.debug("Processing trade with id: " + id + " and symbol: " + symbol); 如果日志级别是warn，上述日志不会打印，但是会执行字符串拼接操作，如果symbol是对象，会执行toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。

   正例：

   （条件） 
     if (logger.isDebugEnabled()) {    
     logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);   
     }  
   

正例：

（占位符）

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

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

正例：
<logger name="com.taobao.dubbo.config" additivity="false">
6. 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws往上抛出。

正例：

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

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

2. 【推荐】可以使用warn日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出error级别，避免频繁报警。

   说明：注意日志输出的级别，error级别只记录系统逻辑出错、异常或者重要的错误信息。

(三) 其它

1. 【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。

   说明：不要在方法体内定义：Pattern pattern = Pattern.compile(规则);

2. 【强制】velocity调用POJO类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用POJO的getXxx()，如果是boolean基本数据类型变量（boolean命名不需要加is前缀），会自动调用isXxx()方法。
   说明：注意如果是Boolean包装类对象，优先调用getXxx()的方法。

3. 【强制】后台输送给页面的变量必须加$!{var}——中间的感叹号。

   说明：如果var=null或者不存在，那么${var}会直接显示在页面上。

4. 【强制】注意 Math.random() 这个方法返回是double类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。

5. 【强制】获取当前毫秒数

System.currentTimeMillis();

而不是

new Date().getTime();

说明：如果想获取更加精确的纳秒级时间值，使用System.nanoTime()的方式。在JDK8中，针对统计时间等场景，推荐使用Instant类。

1. 【推荐】不要在视图模板中加入任何复杂的逻辑。
   说明：根据MVC理论，视图的职责是展示，不要抢模型和控制器的活。

2. 【推荐】任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。

3. 【推荐】及时清理不再使用的代码段或配置信息。

   说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。

   正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由。