《阿里巴巴 Java 开发手册 》二、异常日志

本贴最后更新于 2229 天前,其中的信息可能已经时移俗易

(一)异常处理  

1.【强制】Java 类库中定义的一类 RuntimeException可以通过预先检查进行规避,而不应该通过 catch 来处理

比如:IndexOutOfBoundsException,NullPointerException 等等。  

说明:无法通过预检查的异常除外,如在解析一个外部传来的字符串形式数字时,通过 catch NumberFormatException 来实现。  

正例:if (obj != null) {...}  

反例:try { obj.method() } catch (NullPointerException e) {...}  

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

3.【强制】对大段代码进行 try-catch,这是不负责任的表现。

catch 时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型,再做对应的异常处理。  

4.【强制】捕获异常是为了处理它

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

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

6.【强制】finally块必须对资源对象、流对象进行关闭,有异常也要做 try-catch。  

说明:如果 JDK7 及以上,可以使用 try-with-resources 方式。  

7.【强制】不能在 finally块中使用 return

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

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

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

9.【推荐】方法的返回值可以为 null

方法的返回值可以为 null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。  

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

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

11.【推荐】定义时区分 unchecked/checked 异常

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

12.【参考】在代码中使用“抛异常”还是“返回错误码”

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

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

1)使用抛异常返回方式,调用方如果没有捕获到就会产生运行时错误。  

2)如果不加栈信息,只是 new 自定义异常,加入自己的理解的 error message,对于调用端解决问题的帮助不会太多。如果加了栈信息,在频繁调用出错的情况下,数据序列化和传输的性能损耗也是问题。  

13.【参考】避免出现重复的代码(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);  

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

3.【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:  

appName_logType_logName.log。

logType:日志类型,推荐分类有 stats/desc/monitor/visit 等;

logName:日志描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找。  

正例:mppserver 应用中单独监控时区转换异常,如:  

mppserver_monitor_timeZoneConvert.log  

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

4.【强制】对 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。  

正例:  

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

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

7.【推荐】谨慎地记录日志。

生产环境禁止输出 debug 日志;有选择地输出 info 日志;如果使用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘  撑爆,并记得及时删除这些观察日志。  

说明:大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。记录日志时请  

思考:这些日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?  

8.【参考】可以使用 warn日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所适从。

注意日志输出的级别,error 级别只记录系统逻辑出错、异常等重要的错误信息。如非必要,请不要在此场景打出 error 级别。

  • 阿里巴巴

    阿里巴巴网络技术有限公司(简称:阿里巴巴集团)是以曾担任英语教师的马云为首的 18 人,于 1999 年在中国杭州创立,他们相信互联网能够创造公平的竞争环境,让小企业通过创新与科技扩展业务,并在参与国内或全球市场竞争时处于更有利的位置。

    43 引用 • 221 回帖 • 158 关注
  • Java

    Java 是一种可以撰写跨平台应用软件的面向对象的程序设计语言,是由 Sun Microsystems 公司于 1995 年 5 月推出的。Java 技术具有卓越的通用性、高效性、平台移植性和安全性。

    3170 引用 • 8209 回帖 • 1 关注

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...

推荐标签 标签

  • OpenResty

    OpenResty 是一个基于 NGINX 与 Lua 的高性能 Web 平台,其内部集成了大量精良的 Lua 库、第三方模块以及大多数的依赖项。用于方便地搭建能够处理超高并发、扩展性极高的动态 Web 应用、Web 服务和动态网关。

    17 引用 • 49 关注
  • 以太坊

    以太坊(Ethereum)并不是一个机构,而是一款能够在区块链上实现智能合约、开源的底层系统。以太坊是一个平台和一种编程语言 Solidity,使开发人员能够建立和发布下一代去中心化应用。 以太坊可以用来编程、分散、担保和交易任何事物:投票、域名、金融交易所、众筹、公司管理、合同和知识产权等等。

    34 引用 • 367 回帖 • 5 关注
  • 支付宝

    支付宝是全球领先的独立第三方支付平台,致力于为广大用户提供安全快速的电子支付/网上支付/安全支付/手机支付体验,及转账收款/水电煤缴费/信用卡还款/AA 收款等生活服务应用。

    29 引用 • 347 回帖
  • SSL

    SSL(Secure Sockets Layer 安全套接层),及其继任者传输层安全(Transport Layer Security,TLS)是为网络通信提供安全及数据完整性的一种安全协议。TLS 与 SSL 在传输层对网络连接进行加密。

    70 引用 • 193 回帖 • 447 关注
  • Flutter

    Flutter 是谷歌的移动 UI 框架,可以快速在 iOS 和 Android 上构建高质量的原生用户界面。 Flutter 可以与现有的代码一起工作,它正在被越来越多的开发者和组织使用,并且 Flutter 是完全免费、开源的。

    39 引用 • 92 回帖 • 9 关注
  • 开源中国

    开源中国是目前中国最大的开源技术社区。传播开源的理念,推广开源项目,为 IT 开发者提供了一个发现、使用、并交流开源技术的平台。目前开源中国社区已收录超过两万款开源软件。

    7 引用 • 86 回帖
  • Unity

    Unity 是由 Unity Technologies 开发的一个让开发者可以轻松创建诸如 2D、3D 多平台的综合型游戏开发工具,是一个全面整合的专业游戏引擎。

    25 引用 • 7 回帖 • 203 关注
  • 30Seconds

    📙 前端知识精选集,包含 HTML、CSS、JavaScript、React、Node、安全等方面,每天仅需 30 秒。

    • 精选常见面试题,帮助您准备下一次面试
    • 精选常见交互,帮助您拥有简洁酷炫的站点
    • 精选有用的 React 片段,帮助你获取最佳实践
    • 精选常见代码集,帮助您提高打码效率
    • 整理前端界的最新资讯,邀您一同探索新世界
    488 引用 • 383 回帖 • 1 关注
  • FFmpeg

    FFmpeg 是一套可以用来记录、转换数字音频、视频,并能将其转化为流的开源计算机程序。

    23 引用 • 32 回帖 • 3 关注
  • jsDelivr

    jsDelivr 是一个开源的 CDN 服务,可为 npm 包、GitHub 仓库提供免费、快速并且可靠的全球 CDN 加速服务。

    5 引用 • 31 回帖 • 51 关注
  • 房星科技

    房星网,我们不和没有钱的程序员谈理想,我们要让程序员又有理想又有钱。我们有雄厚的房地产行业线下资源,遍布昆明全城的 100 家门店、四千地产经纪人是我们坚实的后盾。

    6 引用 • 141 回帖 • 569 关注
  • SVN

    SVN 是 Subversion 的简称,是一个开放源代码的版本控制系统,相较于 RCS、CVS,它采用了分支管理系统,它的设计目标就是取代 CVS。

    29 引用 • 98 回帖 • 695 关注
  • PostgreSQL

    PostgreSQL 是一款功能强大的企业级数据库系统,在 BSD 开源许可证下发布。

    22 引用 • 22 回帖 • 1 关注
  • 自由行
    4 关注
  • Python

    Python 是一种面向对象、直译式电脑编程语言,具有近二十年的发展历史,成熟且稳定。它包含了一组完善而且容易理解的标准库,能够轻松完成很多常见的任务。它的语法简捷和清晰,尽量使用无异义的英语单词,与其它大多数程序设计语言使用大括号不一样,它使用缩进来定义语句块。

    540 引用 • 672 回帖
  • React

    React 是 Facebook 开源的一个用于构建 UI 的 JavaScript 库。

    192 引用 • 291 回帖 • 417 关注
  • Maven

    Maven 是基于项目对象模型(POM)、通过一小段描述信息来管理项目的构建、报告和文档的软件项目管理工具。

    186 引用 • 318 回帖 • 325 关注
  • 996
    13 引用 • 200 回帖
  • H2

    H2 是一个开源的嵌入式数据库引擎,采用 Java 语言编写,不受平台的限制,同时 H2 提供了一个十分方便的 web 控制台用于操作和管理数据库内容。H2 还提供兼容模式,可以兼容一些主流的数据库,因此采用 H2 作为开发期的数据库非常方便。

    11 引用 • 54 回帖 • 650 关注
  • Wide

    Wide 是一款基于 Web 的 Go 语言 IDE。通过浏览器就可以进行 Go 开发,并有代码自动完成、查看表达式、编译反馈、Lint、实时结果输出等功能。

    欢迎访问我们运维的实例: https://wide.b3log.org

    30 引用 • 218 回帖 • 619 关注
  • 深度学习

    深度学习(Deep Learning)是机器学习的分支,是一种试图使用包含复杂结构或由多重非线性变换构成的多个处理层对数据进行高层抽象的算法。

    50 引用 • 40 回帖
  • 职场

    找到自己的位置,萌新烦恼少。

    127 引用 • 1704 回帖
  • Firefox

    Mozilla Firefox 中文俗称“火狐”(正式缩写为 Fx 或 fx,非正式缩写为 FF),是一个开源的网页浏览器,使用 Gecko 排版引擎,支持多种操作系统,如 Windows、OSX 及 Linux 等。

    8 引用 • 30 回帖 • 421 关注
  • Sandbox

    如果帖子标签含有 Sandbox ,则该帖子会被视为“测试帖”,主要用于测试社区功能,排查 bug 等,该标签下内容不定期进行清理。

    399 引用 • 1246 回帖 • 592 关注
  • WebClipper

    Web Clipper 是一款浏览器剪藏扩展,它可以帮助你把网页内容剪藏到本地。

    3 引用 • 9 回帖
  • Dubbo

    Dubbo 是一个分布式服务框架,致力于提供高性能和透明化的 RPC 远程服务调用方案,是 [阿里巴巴] SOA 服务化治理方案的核心框架,每天为 2,000+ 个服务提供 3,000,000,000+ 次访问量支持,并被广泛应用于阿里巴巴集团的各成员站点。

    60 引用 • 82 回帖 • 608 关注
  • 新人

    让我们欢迎这对新人。哦,不好意思说错了,让我们欢迎这位新人!
    新手上路,请谨慎驾驶!

    51 引用 • 226 回帖