阿里巴巴 Java 开发手册之异常日志(二)-------我的经验-阿里云开发者社区

开发者社区> 开发与运维> 正文
登录阅读全文

阿里巴巴 Java 开发手册之异常日志(二)-------我的经验

简介: (异常篇)阿里javaa开发手册经验总结,我会说一下日常写代码我的规范,也会补充说一下为什么阿里要这么规定,总之,都是经验,也有不合理的,忘海涵。。。。

二、异常日志

(一) 异常处理

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

说明:无法通过预检查的异常除外,如在解析一个外部传来的字符串形式数字时,通过catch NumberFormatException来实现。 正例:if (obj != null) {...} 反例:try { obj.method() } catch (NullPointerException e) {...}

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

3. 【强制】对大段代码进行try-catch,这是不负责任的表现。catch时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型,再做对应的异常处理。(大段代码的try catch确实不负责任,而且永远不可能出错的也不需要try catch)

4. 【强制】捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它,请将该异常抛给它的调用者。最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容。(基础服务尽量去抛异常,API层就得按照这些异常转化成用户能看的懂的提示信息)

5. 【强制】有try块放到了事务代码中,catch异常后,如果需要回滚事务,一定要注意手动回滚事务。(比如说Spring的事务如果用try把Dao层包起来的就不会回滚事务,所以Spring上执行Dao的方法不要去try catch。)

6. 【强制】finally块必须对资源对象、流对象进行关闭,有异常也要做try-catch。 说明:如果JDK7及以上,可以使用try-with-resources方式。(没用过这个哈,以后可以试试)

7. 【强制】不能在finally块中使用return,finally块中的return返回后方法结束执行,不会再执行try块中的return语句。(常识)

8. 【强制】捕获异常与抛异常,必须是完全匹配,或者捕获异常是抛异常的父类。 说明:如果预期对方抛的是绣球,实际接到的是铅球,就会产生意外情况。

9. 【推荐】方法的返回值可以为null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回null值。调用方需要进行null判断防止NPE问题。 (说实话,一般调用方都会写上null判断)

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

10. 【推荐】防止NPE,是程序员的基本修养,注意NPE产生的场景:

 1) 返回类型为包装数据类型,有可能是null,返回int值时注意判空。     反例: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问题。(说实话,这个Optional没用过)

11. 【推荐】在代码中使用“抛异常”还是“返回错误码”,对于公司外的http/api开放接口必须使用“错误码”;而应用内部推荐异常抛出;跨应用间RPC调用优先考虑使用Result方式,封装isSuccess、“错误码”、“错误简短信息”。

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

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

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 + " 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);

5. 【强制】避免重复打印日志,浪费磁盘空间,务必在log4j.xml中设置additivity=false。 (不是说不能使用log4j吗?应该是logback.xml吧)

正例:< logger name="com.taobao.dubbo.config" additivity="false">

6. 【强制】异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通过关键字throws往上抛出。 (error级别日志应该可以不用拼接的方式)

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

7. 【推荐】谨慎地记录日志。生产环境禁止输出debug日志;有选择地输出info日志;如果使用warn来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志。 说明:大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。

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

8. 【参考】可以使用warn日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所适从。注意日志输出的级别,error级别只记录系统逻辑出错、异常等重要的错误信息。如非必要,请不要在此场景打出error级别。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

分享: