《阿里巴巴Java开发手册(正式版)》 学习笔记 - 异常日志

更多 Java 基础知识方面的文章,请参见文集《Java 基础知识》


摘要: 阿里巴巴集团推出的《阿里巴巴Java开发手册(正式版)》是阿里巴巴近万名开发同学集体智慧的结晶,以开发视角为中心,详细列举如何开发更加高效、更加容错、更加有协作性,力求知其然,更知其不然,结合正反例,让Java开发者能够提升协作效率、提高代码质量。

作为一个 Java 开发人员,我花了一天时间阅读了这个开发手册,摘要了一些对于我有用的知识点。记录如下,仅供参考。

1. 异常处理

  1. 不要捕获 Java 类库中定义的继承自 RuntimeException 的运行时异常类,如: IndexOutOfBoundsException / NullPointerException,这类异常由程序员预检查来规避,保证程序健壮性。
  • 捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它,请将该异常抛给它的调用者。最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容。
  • 不能在 finally 块中使用 returnfinally 块中的 return 返回后方法结束执行,不会再执行 try 块中的 return 语句。
  • 防止 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。
  • 定义时区分 unchecked / checked 异常,避免直接使用 RuntimeException 抛出,更不允许抛出 Exception 或者 Throwable,应使用有业务含义的自定义异常。

2.日志规约

  1. 应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架SLF4J 中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class); 
  • 异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么往上抛。
  • 谨慎地记录日志。生产环境禁止输出 debug 日志;有选择地输出 info 日志;如果使用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志。

引用:
【Java编码规范】《阿里巴巴Java开发手册(正式版)》发布!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 传送门 解读阿里Java开发手册(v1.1.1) - 编程规约 前言 阿里Java开发手册谈不上圣经,但确实是大量...
    kelgon阅读 2,730评论 2 49
  • 来源与:阿里云栖 禁止用于商业用途 ps:如果需要电子书 评论你们邮箱 我会发给你们 下面感觉还是有点乱 目录 一...
    小向资源网阅读 7,688评论 0 12
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,993评论 19 139
  • 在没有价值衡量标准的情况下,你没法证明任何东西是有价值的或没价值的。价值衡量标准本身的价值更是没法证明的,只有感受...
    乾道下济阅读 94评论 0 0
  • 米可宝贝今天是你的生日妈妈祝你生日快乐把全世界最美好的祝福都送给你。你在妈妈肚子里呆了10个月去年的今天是你出生的...
    我家大米可阅读 926评论 0 1