异常日志
(一) 异常处理
异常接口及类结构
- 【强制】Java 类库中定义的一类 RuntimeException 可以通过预先检查进行规避，而不应该通过 catch 来处理，比如：IndexOutOfBoundsException，NullPointerException 等等。
正例：if (obj != null) {...}
反例：try { obj.method() } catch (NullPointerException e) {...}
理解：判空是一个永恒的话题，只要你不确定变量是否为空，都应该判空，否则后患无穷。另外，catch语句块中不要写业务逻辑，就打印或抛出异常日志就可以了，当然这可能只对开发阶段有用，最好采用错误代码结合输出日志进行处理。
- 【强制】异常不要用来做流程控制，条件控制，因为异常的处理效率比条件分支低。
理解：禁止使用异常来封装业务逻辑，业务异常应该用错误码来表示，系统异常则使用Java原生异常。
异常处理是通过异常表查询来实现的，肯定没有跳转语句性能高。
- 【强制】对大段代码进行 try-catch，这是不负责任的表现。catch 时请分清稳定代码和非稳 定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理。
理解：不能简单的catch Throwable，然后打印日志，这是不负责任的表现，应该有针对的抓住和处理异常。
- 【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。
理解：我们不能让客户看到的是Java原生异常码。
- 【强制】有 try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回滚事务。
理解：框架我们一般基本采用声明式事务，出现异常需要回滚的情况，建议继续抛出异常让声明式事务自动回滚，不建议代码中手工控制事务。
- 【强制】finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。
说明：如果 JDK7 及以上，可以使用 try-with-resources 方式。
理解：资源对象如数据库连接，流对象如文件流，关于try catch finally的使用。
1、不管有没有异常，finally中的代码都会执行
2、当try、catch中有return时，finally中的代码依然会继续执行
3、finally是在return后面的表达式运算之后执行的，此时并没有返回运算之后的值，而是把值保存起来，不管finally对该值做任何的改变，返回的值都不会改变，依然返回保存起来的值。也就是说方法的返回值是在finally运算之前就确定了的。
4、finally代码中最好不要包含return，程序会提前退出，也就是说返回的值不是try或catch中的值
举例：
情况1：try{}catch{}finally{} return;
程序正常进行
情况2：try{return;}catch{}finally{} return;
无异常：a、先执行try中的语句，b、然后执行finally中的语句，c、最后执行try中的return
有异常：返回值是finally后面的return语句
情况3：try{} catch{return;} finally{} return;
无异常：执行finally中的代码块，然后执行return语句
有异常：a、先执行catch中的代码块 b、然后执行finally中的语句，c、最后执行catch中的return，finally后面的return不会被执行
情况4：try{return;} catch{} finally{return;}
无异常：a、先执行try中的语句，包括return后面的表达式，b、然后执行finally中的语句，c、最后执行finally中的return
有异常：返回的值是finally中return后面的表达式的值，因为finally中有return语句，所以会提前退出。
情况5：try{} catch{return} finally{return};
先执行try中的代码块
无异常：执行finally中的代码块，然后执行finally中的return
有异常：a、先执行catch中的语句，包括return后面的表达式，b、然后执行finally中的语句，c、最后执行finally中的return，因为finally中有return语句，所以会提前退出
情况6：try{return;} catch{return;} finally{return;}
先执行try中的代码块，包括return后面的表达式
无异常：执行finally中的代码块，然后执行finally中的return
有异常：a、先执行catch中的语句，包括return后面的表达式，b、然后执行finally中的语句，c、最后执行finally中的return，因为finally中有return语句，所以会提前退出。
JDK7之前，通常的try catch finally用法
public static void main(String[] args) {
FileInputStream inputStream = null;
try {
inputStream = new FileInputStream(new File("test"));
System.out.println(inputStream.read());
} catch (IOException e) {
throw new RuntimeException(e.getMessage(), e);
} finally {
if (inputStream != null) {
try {
inputStream.close();
} catch (IOException e) {
throw new RuntimeException(e.getMessage(), e);
}
}
}
}
JDk7 try-with-resources
public static void main(String[] args) {
try (FileInputStream inputStream = new FileInputStream(new File("test"))) {
System.out.println(inputStream.read());
} catch (IOException e) {
throw new RuntimeException(e.getMessage(), e);
}
}
- 【强制】不能在 finally 块中使用 return，finally 块中的 return 返回后方法结束执行，不会再执行 try 块中的 return 语句。
理解：见6的详细分析。 - 【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。
理解：异常处理后，让异常变得更小，而不是变大，大而化小，小而化了。
- 【推荐】方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。
说明：本手册明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回 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 问题。
理解：自J2SE 5.0开始提供的基本数据类型的自动装箱(autoboxing)、拆箱(unboxing)功能。
何为自动装箱：
当我们创建一个Integer对象时，却可以这样：
Integer i = 100; (注意：不是 int i = 100; )
实际上，执行上面那句代码的时候，系统为我们执行了：Integer i = new Integer(100); 此即基本数据类型的自动装箱功能。
何为自动拆箱
自动拆箱(unboxing)，也就是将对象中的基本数据从对象中自动取出。如下可实现自动拆箱：
Integer integer=100;
int flag=integer; //该语句即实现了自动拆箱。
JDK8 的 Optional 类来防止 NPE详见如下链接。
- 【推荐】定义时区分 unchecked / checked 异常，避免直接抛出 new RuntimeException()， 更不允许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DAOException / ServiceException 等。
理解：将派生于Error或者RuntimeException的异常称为unchecked异常，所有其他的异常称为checked异常。
尽量不要在抛出异常时throw new RuntimeException("xxxx"); 应该使用具备业务含义的自定义异常类，这样做可以在捕获异常时提供方便
绝对不要在抛出异常时throw new Exception("xxx")或throw new Throwable("xxx")，这样做不仅仅是屏蔽了异常本身的业务含义，同时也屏蔽了异常的分类（checked/unchecked），甚至连Exception和Error的区别也屏蔽了
异常处理机制见如下链接。
- 【参考】在代码中使用“抛异常”还是“返回错误码”，对于公司外的 http/api 开放接口必须 使用“错误码”；而应用内部推荐异常抛出；跨应用间 RPC 调用优先考虑使用 Result 方式，封 装 isSuccess()方法、“错误码”、“错误简短信息”。
说明：关于 RPC 方法返回方式使用 Result 方式的理由：
1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
2）如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。
理解：业务异常使用Result模式，系统异常用Java原生异常。
RPC建议使用Result模式，不想让一个异常在系统间跳来跳去的，异常是包含调用栈的。
- 【参考】避免出现重复的代码（Don’t Repeat Yourself），即 DRY 原则。
说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。
正例：一个类中有多个 public 方法，都需要进行数行相同的参数校验操作，这个时候请抽取： private boolean checkParam(DTO dto) {...}
理解：DRY原则对于优化和维护程序都很有用处。这一条放这里有点莫名其妙。
(二) 日志规约
- 【强制】应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架 SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);
理解：设计模式分为三大类：
创建型模式，共五种：工厂方法模式、抽象工厂模式、单例模式、建造者模式、原型模式。
结构型模式，共七种：适配器模式、装饰器模式、代理模式、外观模式、桥接模式、组合模式、享元模式。
行为型模式，共十一种：策略模式、模板方法模式、观察者模式、迭代子模式、责任链模式、命令模式、备忘录模式、状态模式、访问者模式、中介者模式、解释器模式。
所谓门面模式(外观模式)是对象的结构模式，外部与一个子系统的通信必须通过一个统一的门面对象进行。门面模式提供一个高层次的接口，使得子系统更易于使用。门面模式实例如下：
- 【强制】日志文件推荐至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。
理解：日志文件也不要保存太久，日志的增长很快，如果不及时处理（最好能自动化处理），就会导致系统不可以用，譬如nginx做负载均衡，日志如果达到70%，会严重影响访问性能。处理方法参见：
- 【强制】应用中的扩展日志（如打点（数据统计的日志称为打点日志）、临时监控、访问日志等）命名方式：
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 + " 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);
理解：Log4j建议只使用四个级别，优先级从高到低分别是 ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来，也是说大于等于的级别的日志才输出。
- 【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。
正例：<logger name="com.taobao.dubbo.config" additivity="false">
理解：log4j配置详细说明参见：
- 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过 关键字 throws 往上抛出。
正例：logger.error(各类参数或者对象 toString + "_" + e.getMessage(), e);
理解：打印日志一定要包含环境
- 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。
说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？
理解：打印日志只需要打印核心内容，不要随便就把对象json序列化打印出来，如果是列表会很大。
- 【参考】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。注意日志输出的级别，error 级别只记录系统逻辑出错、异常等重要的错误信息。如非必 要，请不要在此场景打出 error 级别。
理解：合理利用warn级别日志，error级别日志最重要，理想情况下生产上产生的error和warn日志开发要定期的梳理。
- 【推荐】尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用 中文描述即可，否则容易产生歧义。国际化团队或海外部署的服务器由于字符集问题，【强制】 使用全英文来注释和描述日志错误信息。
讨论
异常处理和日志处理在combiz上可能需要改进一下。
网友评论