白话阿里巴巴Java开发手册(异常日志)

前一阶段发布了《白话阿里巴巴Java开发手册(编程规约)》后,很多人与我探讨流程制度和研发标准的必要性,我曾经和大家做了个比喻,盖一个小窝棚,可能一个人随便堆积一下就可以了,那我们盖个3层小楼,就需要一个瓦匠和几个小工就可以了,但是如果我盖国贸三期的高楼大厦,只有这些人就可以盖成吗?肯定盖着盖着就倒了,这时候我需要的就是流程、规范、方法论。

后来有幸为《白话阿里巴巴Java开发手册》的新版本做了推荐,推荐原文为抢鲜下载 | 阿里Java开发手册最新完美版,千锤百炼始出炉!,并与原作者孤尽兄沟通后,决定把白话这个事儿一直写完,本篇为《白话阿里巴巴Java开发手册(异常日志)》。

1 异常处理

  1. 【强制】Java 类库中定义的一类 RuntimeException 可以通过预先检查进行规避,而不应该通过 catch 来处理,比如: IndexOutOfBoundsException,NullPointerException等等。 说明: 无法通过预检查的异常除外,如在解析一个外部传来的字符串形式数字时,通过 catch NumberFormatException 来实现。 正例: if (obj != null) {...} 反例: try { obj.method() } catch (NullPointerException e) {...} 白话:
    • 判空是一个永恒的话题,只要你不确定变量是否为空,都应该判空,否则后患无穷。
  2. 【强制】异常不要用来做流程控制,条件控制,因为异常的处理效率比条件分支低。 白话:
    • 禁止使用异常来封装业务逻辑,业务异常应该用错误码来表示,系统异常则使用Java原生异常。
    • 异常处理是通过异常表查询来实现的,肯定没有跳转语句性能高。
  3. 【强制】对大段代码进行 try-catch,这是不负责任的表现。catch 时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型,再做对应的异常处理。 白话:
    • 做事要直切主题,不能一概而论。
    • 不能简单的catch Throwable,然后打印日志,这是不负责任的表现,应该有针对的抓住和处理异常。
  4. 【强制】捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它,请 将该异常抛给它的调用者。最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容。 白话:
    • 禁止吃掉异常,吃掉异常就是捕获异常什么都没做,也没抛出,这也是不负责任的表现。
    • 是在不能处理的异常抛出去,但是得让使用方知道这种情况,这是编程提供方契约的一种方式。
  5. 【强制】有 try 块放到了事务代码中,catch 异常后,如果需要回滚事务,一定要注意手动回滚事务。 白话:
    • 我们基本采用声明式事务,出现异常需要回滚的情况,建议继续抛出异常让声明式事务自动回滚,不建议代码中手工控制事务。
  6. 【强制】finally 块必须对资源对象、流对象进行关闭,有异常也要做 try-catch。 说明:如果 JDK7 及以上,可以使用 try-with-resources 方式。 白话:
    • 永恒的资源关闭原则。
  7. 【强制】不能在 finally 块中使用 return,finally 块中的 return 返回后方法结束执行,不会再执行 try 块中的 return 语句。 白话:
    • 确实会覆盖try块里面的return语句。
    • 思维不混乱的话,没人会把return语句写在finally语句里。
  8. 【强制】捕获异常与抛异常,必须是完全匹配,或者捕获异常是抛异常的父类。 说明: 如果预期对方抛的是绣球,实际接到的是铅球,就会产生意外情况。 白话:
    • 异常处理后,让异常变得更小,而不是变大,大而化小,小而化了。
  9. 【推荐】方法的返回值可以为 null,不强制返回空集合,或者空对象等,必须添加注释充分 说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。 说明: 本规约明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象,对调用 者来说,也并非高枕无忧,必须考虑到远程调用失败,运行时异常等场景返回 null 的情况。 白话:
    • 如前面所说,只要不确定的变量,一定要判空,别自找麻烦。
  10. 【推荐】防止 NPE,是程序员的基本修养,注意 NPE 产生的场景:
    1. 返回类型为包装数据类型,有可能是null,返回int值时注意判空。

    反例: public int f() { return Integer 对象}; 如果为 null,自动解箱抛 NPE。

    1. 数据库的查询结果可能为null。
    2. 集合里的元素即使isNotEmpty,取出的数据元素也可能为null。
    3. 远程调用返回对象,一律要求进行NPE判断。
    4. 对于Session中获取的数据,建议NPE检查,避免空指针。
    5. 级联调用obj.getA().getB().getC();一连串调用,易产生NPE。

    正例: 可以使用 JDK8 的 Optional 类来防止 NPE 问题。 白话:

    • 判空,判空,缓存的数据,别人的数据,都要判空。
  11. 【推荐】在代码中使用“抛异常”还是“返回错误码”,对于公司外的 http/api 开放接口必须 使用“错误码”;而应用内部推荐异常抛出;跨应用间 RPC 调用优先考虑使用 Result 方式,封 装 isSuccess、“错误码”、“错误简短信息”。 说明: 关于 RPC 方法返回方式使用 Result 方式的理由:
    1. 使用抛异常返回方式,调用方如果没有捕获到就会产生运行时错误。
    2. 如果不加栈信息,只是new自定义异常,加入自己的理解的error message,对于调用端解决问题的帮助不会太多。如果加了栈信息,在频繁调用出错的情况下,数据序列化和传输的性能损耗也是问题。

    白话:

    • 业务异常使用Result模式,系统异常用Java原生异常。
    • RPC建议使用Result模式,不想让一个异常在系统间跳来跳去的,异常是包含调用栈的。
  12. 【推荐】定义时区分unchecked/checked 异常,避免直接使用RuntimeException抛出, 更不允许抛出 Exception 或者 Throwable,应使用有业务含义的自定义异常。推荐业界已定义 过的自定义异常,如:DAOException / ServiceException 等。 白话:
    • 不要所有异常都集成自Runtime异常,希望调用方处理的异常一定用checked异常。
  13. 【参考】避免出现重复的代码(Don’t Repeat Yourself),即DRY原则。 说明: 随意复制和粘贴代码,必然会导致代码的重复,在以后需要修改时,需要修改所有的副 本,容易遗漏。必要时抽取共性方法,或者抽象公共类,甚至是共用模块。 正例: 一个类中有多个 public 方法,都需要进行数行相同的参数校验操作,这个时候请抽取: private boolean checkParam(DTO dto) {...} 白话:
    • 如果不知道DRY原则,但是回顾你以前写的代码都是这样写的,那么恭喜你,你是个好程序员,也为你发愁...

2 日志规约

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

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

***白话:***

- 使用slf4jAPI更爽更清新 :) 

- 通过占位符的方式不但代码清晰,对象的toString等方法也是根据日志等级来调用的。
  1. 【强制】日志文件推荐至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。 白话:
    • 其实需要更长,有的线上事故复盘周期更长,需要更长的日志保存。
    • 这其实不是开发的职责,应该构建大数据日志系统,比如:ELK等。
  2. 【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式: appName_logType_logName.log。 logType: 日志类型,推荐分类有stats/desc/monitor/visit 等; logName: 日志描述。 这种命名的好处: 通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找。 正例: mppserver 应用中单独监控时区转换异常,如: mppserver_monitor_timeZoneConvert.log 说明: 推荐对日志进行分类,错误日志和业务日志尽量分开存放,便于开发人员查看,也便于 通过日志对系统进行及时监控。 白话:
    • 逻辑上分开更利于日志管理。
    • 性能上,机械硬盘如果是单文件写可以一定程度利用磁盘顺序写提高性能。
  3. 【强制】对 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); ```

***白话:***

- 一定不要用字符串相加,一定要用占位符。
  1. 【强制】避免重复打印日志,浪费磁盘空间,务必在 log4j.xml 中设置additivity=false。 正例: <logger name="com.taobao.dubbo.config" additivity="false"> 白话:
    • 日志需要CPU处理,缓存的时候需要占用内存,打印过程中要占用IO带宽,存储到磁盘又需要存储空间,要绿色环保。
  2. 【强制】异常信息应该包括两类信息: 案发现场信息和异常堆栈信息。如果不处理,那么通过 关键字 throws 往上抛出。 正例: logger.error(各类参数或者对象 toString + "_" + e.getMessage(), e); 白话:
    • 打印日志一定要包含环境,否则找bug的时候日志对不上,勤奋爱干活的人一下就听懂我在说啥了。
  3. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志;有选择地输出 info 日志;如果使 用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志。 说明: 大量地输出无效日志,不利于系统性能升,也不利于快速定位错误点。记录日志时请思考:这些日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处? 白话:
    • 我常常和小伙伴们说,写代码的时候就要想到查bug的时候怎么查,需要哪些日志,打印日志只需要打印核心内容,不要随便就把对象json序列化打印出来,如果是列表会很大。
  4. 【参考】可以使用 warn 日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所适 从。注意日志输出的级别,error 级别只记录系统逻辑出错、异常等重要的错误信息。如非必要,请不要在此场景打出 error 级别。 白话:
    • 合理利用warn级别日志,error级别日志最重要,理想情况下生产上产生的error和warn日志开发要定期的梳理。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏WeTest质量开放平台团队的专栏

Unity3d底层数据传递分析

这篇文章主要分析了在Mono框架下,非托管堆、运行时、托管堆如何关联,以及通过哪些方式调用。内存方面,介绍了什么是封送,以及类和结构体的关系和区别。

5242
来自专栏Java架构沉思录

定时任务常见实现方式

在项目中,我们常常需要在特定的时间执行一些任务,比如定时删除服务器存储的数据缓存,定时获取数据以及定时发送推送等等。

801
来自专栏分布式系统和大数据处理

基于业务对象(列表)的筛选

可能大家对SQL语句太过熟悉了,也可能虽然已经从Asp过度到了Asp.Net时代,但是Asp的观念没有发生太大变化。结果就是我们将应用程序大部分的逻辑都交给了数...

745
来自专栏企鹅号快讯

mysql分表的3种方法

推荐阅读 微服务:springboot系列教程学习 源码:Javaweb练手项目源码下载 调优:十五篇好文回顾 面试笔试:面试笔试整理系列 一,先说一下为什么要...

18710
来自专栏WindCoder

网易MySQL微专业学习笔记(二)-Mysql数据对象

这个系列属于个人学习网易云课堂MySQL数据库工程师微专业的相关课程过程中的笔记,本篇为其“MySQL数据库对象与应用”中的MySQL数据类型相关笔记。

421
来自专栏腾讯Bugly的专栏

移动客户端中高效使用 SQLite

导语 iOS 程序能从网络获取数据。少量的 KV 类型数据可以直接写文件保存在 Disk 上,App 内部通过读写接口获取数据。稍微复杂一点的数据类型,也可以将...

3626
来自专栏后端技术探索

PHP 使用协同程序实现合作多任务(一)

PHP 5.5 一个比较好的新功能是实现对生成器和协同程序的支持。对于生成器,PHP的文档和各种其他的博客文章已经有了非常详细的讲解。协同程序相对受到的关注就少...

711
来自专栏美团技术团队

Node.js Stream - 进阶篇

在构建较复杂的系统时,通常将其拆解为功能独立的若干部分。这些部分的接口遵循一定的规范,通过某种方式相连,以共同完成较复杂的任务。譬如,shell通过管道|连接各...

3394
来自专栏编程一生

预告片优化方案

682
来自专栏JAVA高级架构

JVM内存管理--计算机内存和Java内存组件

JVM一向很好的帮我们管理内存,它就是一个贤内助:“向政府(内存空间)能要到地盘,还能有效的对自己的一亩三分地进行管理。”但是有时候呢,我们不懂怜香惜玉的一而再...

35314

扫码关注云+社区