阿里java开发手册学习笔记(二、 异常日志)

(一)异常处理

  1. Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该过 catch 的方式来处理,比如:NullPointerException,IndexOutOfBoundsException 等。
  2. 异常不要用来做流程控制,条件控制。
  3. catch 时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码对于非稳定代码的 catch 尽可能进行区分异常类型,再做对应的异常处理。
  4. 捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它请将该异常抛给它的调用者。最外层的业务使用者,必须处理异常,将其转化为用户可以解的内容。
  5. 有 try 块放到了事务代码中,catch 异常后,如果需要回滚事务,一定要注意手动滚事务。
  6. finally 块必须对资源对象、流对象进行关闭,有异常也要做 try-catch。
  7. 不要在 finally 块中使用 return
  8. 捕获异常与抛异常,必须是完全匹配,或者捕获异常是抛异常的父类。
  9. 在调用 RPC、二方包、或动态生成类的相关方法时,捕捉异常必须使用 Throwable类来进行拦截。
  10. 方法的返回值可以为 null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回 null 值。
  11. 防止 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 问题。
  12. 定义时区分 unchecked / checked 异常,避免直接抛出 new RuntimeException(),更不允许抛出 Exception 或者 Throwable,应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常,如:DAOException / ServiceException 等。
  13. 对于公司外的 http/api 开放接口必须使用“错误码”;而应用内部推荐异常抛出;跨应用间 RPC 调用优先考虑使用 Result 方式,封装 isSuccess()方法、“错误码”、“错误简短信息”。
  14. 避免出现重复的代码(Don’t Repeat Yourself),即 DRY 原则。

(二)日志规约

  1. 应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架SLF4J 中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。
  2. 所有日志文件至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。网络运行状态、安全相关信息、系统监测、管理后台操作、用户敏感操作需要留存相关的网络日志不少于 6 个月。
  3. 应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:
    appName_logType_logName.log。logType:日志类型,如 stats/monitor/access 等;logName:日志描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找。
  4. 在日志输出时,字符串变量之间的拼接使用占位符的方式。
//:因为 String 字符串的拼接会使用 StringBuilder 的 append()方式,有一定的性能损耗。使用占位符仅是替换动作,可以有效提升性能
logger.debug("Processing trade with id: {} and symbol: {}", id, symbol);
  1. 对于 trace/debug/info 级别的日志输出,必须进行日志级别的开关判断。
  2. 避免重复打印日志,浪费磁盘空间,务必在 log4j.xml 中设置 additivity=false。
<logger name="com.taobao.dubbo.config" additivity="false"> 
  1. 异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通过关键字 throws 往上抛出。
logger.error(各类参数或者对象 toString() + "_" + e.getMessage(), e);
  1. 谨慎地记录日志。生产环境禁止输出 debug 日志;有选择地输出 info 日志;如果使用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志。
  2. 可以使用 warn 日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所适从。如非必要,请不要在此场景打出 error 级别,避免频繁报警。
  3. 尽量用英文来描述日志错误信息,如果日志中的错误信息用英文描述不清楚的话使用中文描述即可,否则容易产生歧义。
  4. 【强制】国际化团队或海外部署的服务器由于字符集问题,使用全英文来注释和描述日志错误信息

猜你喜欢

转载自blog.csdn.net/qq_43925089/article/details/106381664
今日推荐