异常日志规范

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

异常处理

  • 【强制】不要捕获 Java 类库中定义的继承自 RuntimeException 的运行时异常类,如:IndexOutOfBoundsException / NullPointerException,这类异常由程序员预检查来规避,保证程序健壮性.
    正例:if(obj != null) {...}
    反例:try { obj.method() } catch(NullPointerException e){ … }
  • 【强制】异常不要用来做流程控制,条件控制,因为异常的处理效率比条件分支低.
  • 【强制】一大段代码进行 try-catch,这是不负责任的表现.catch 时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码.对于非稳定代码的 catch 尽可能进行区分异常类型,再做对应的异常处理.
  • 【强制】捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它,请将该异常抛给它的调用者.最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容.
  • 【强制】有 try 块放到了事务代码中,catch 异常后,如果需要回滚事务,一定要注意手动回滚事务.
  • 【强制】finally 块必须对资源对象、流对象进行关闭,有异常也要做 try-catch.

说明: 如果 JDK7,可以使用 try-with-resources 方法.

  • 【强制】不能在 finally 块中使用 return,finally 块中的 return 返回后方法结束执行,不会再执行 try 块中的 return 语句.
  • 【强制】捕获异常与抛异常,必须是完全匹配.捕获异常必须是抛异常的父类.
    说明: 如果预期抛的是绣球,实际接到的是铅球,就会产生意外情况.
  • 【推荐】方法的返回值可以为 null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回 null 值.调用方需要进行 null 判断防止 NPE 问题.

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

  • 【推荐】防止 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.

反例: "一拍档客户"的返回值从空对象变成了 null,导致线上故障,NPE 无小事.

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

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

  • 【参考】避免出现重复的代码(Don’t Repeat Yourself),即 DRY 原则.

说明: 随意复制和粘贴代码,必然会导致代码的重复,在以后需要修改时,需要修改所有的副本,容易遗漏.必要时抽取共性方法,或者抽象公共类,甚至是共用模块.

正例: 一个类中有多个 public 方法,都需要进行数行相同的参数校验操作,这个时候请抽取:

private boolean checkParam(DTO dto){ ... }

日志规约

  • 【强制】应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架(SLF4J)中的 API.

说明: 日志框架(SLF4J、JCL--Jakarta Commons Logging)的使用方式(推荐使用 SLF4J):

使用 SLF4J:

import org.slf4j.Logger; 
import org.slf4j.LoggerFactory;  
private  static  final Logger logger = LoggerFactory.getLogger(Abc.class);
  • 【强制】日志文件推荐至少保存 15 天,因为有些异常具备以"周"为频次发生的特点.对于当天日志,以"应用名.log"来保存,保存在/home/admin/应用名/logs/目录下,过往日志格式为: {logname}.log.{保存日期},日期格式:yyyy-MM-dd

说明: 以 mppserver 应用为例,日志保存在/home/admin/mppserver/logs/mppserver.log,历史日志名称为 mppserver.log.2016-08-01

  • 【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:appName_logType_logName.log.logType:日志类型,推荐分类有 stats/desc/monitor/visit 等;logName:日志描述.这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找.

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

说明: 推荐对日志进行分类,错误日志和普通提示日志尽量分开存放,便于开发人员查看,也便于通过日志对系统进行及时监控.

  • 【强制】对 trace/debug/info 级别的日志输出,必须使用条件输出形式或者使用占位符的方式,否则大量的对象 toString 和字符串拼接会带来严重的性能问题.

正例: (条件)

if (logger.isDebugEnabled()) { logger.debug("Processing trade with id: " + id + " symbol: " + symbol); }

  正例: (占位符)

logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);

  • 【强制】避免重复打印日志,浪费磁盘空间,务必在 log4j.xml 中设置 additivity=false.

正例:name="com.taobao.ecrm.member.config" additivity="false"

  • 【强制】生产环境禁止直接使用 System.out 或 System.err 输出日志或使用 e.printStackTrace()打印异常堆栈.由于标准日志输出与标准错误输出文件每次 Jboss 重启时才滚动,如果大量输出送往这两个文件,容易造成文件大小超过操作系统大小限制.
  • 【强制】异常信息应该包括两类信息:案发现场信息和异常堆栈信息.如果不处理,那么往上抛.

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

输出的 POJO 类必须重写 toString 方法,否则只输出此对象的 hashCode 值(地址值),没啥参考意义.

  • 【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所适从.注意日志输出的级别,error 级别只记录系统逻辑出错、异常、或者重要的错误信息.如非必要,请不要在此场景打出 error 级别,避免频繁报警.
  • 【推荐】如果使用 log.warn 记录跟踪调试信息,一定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志.
  • 【参考】如果日志用英文描述不清楚,推荐使用中文注释.对于中文 UTF-8 的日志,在 secureCRT 中,set encoding=utf-8;如果中文字符还乱码,请设置:全局 > 默认的会话设置 > 外观 > 字体 > 选择字符集 gb2312;如果还不行,执行命令:set termencoding=gbk,并且直接使用中文来进行检索.
  • Java

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

    3186 引用 • 8212 回帖

相关帖子

欢迎来到这里!

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

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

推荐标签 标签

  • Swift

    Swift 是苹果于 2014 年 WWDC(苹果开发者大会)发布的开发语言,可与 Objective-C 共同运行于 Mac OS 和 iOS 平台,用于搭建基于苹果平台的应用程序。

    36 引用 • 37 回帖 • 535 关注
  • Bug

    Bug 本意是指臭虫、缺陷、损坏、犯贫、窃听器、小虫等。现在人们把在程序中一些缺陷或问题统称为 bug(漏洞)。

    75 引用 • 1737 回帖
  • 资讯

    资讯是用户因为及时地获得它并利用它而能够在相对短的时间内给自己带来价值的信息,资讯有时效性和地域性。

    55 引用 • 85 回帖 • 2 关注
  • NGINX

    NGINX 是一个高性能的 HTTP 和反向代理服务器,也是一个 IMAP/POP3/SMTP 代理服务器。 NGINX 是由 Igor Sysoev 为俄罗斯访问量第二的 Rambler.ru 站点开发的,第一个公开版本 0.1.0 发布于 2004 年 10 月 4 日。

    311 引用 • 546 回帖
  • TensorFlow

    TensorFlow 是一个采用数据流图(data flow graphs),用于数值计算的开源软件库。节点(Nodes)在图中表示数学操作,图中的线(edges)则表示在节点间相互联系的多维数据数组,即张量(tensor)。

    20 引用 • 19 回帖
  • 快应用

    快应用 是基于手机硬件平台的新型应用形态;标准是由主流手机厂商组成的快应用联盟联合制定;快应用标准的诞生将在研发接口、能力接入、开发者服务等层面建设标准平台;以平台化的生态模式对个人开发者和企业开发者全品类开放。

    15 引用 • 127 回帖 • 2 关注
  • TextBundle

    TextBundle 文件格式旨在应用程序之间交换 Markdown 或 Fountain 之类的纯文本文件时,提供更无缝的用户体验。

    1 引用 • 2 回帖 • 45 关注
  • FreeMarker

    FreeMarker 是一款好用且功能强大的 Java 模版引擎。

    23 引用 • 20 回帖 • 461 关注
  • 房星科技

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

    6 引用 • 141 回帖 • 584 关注
  • React

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

    192 引用 • 291 回帖 • 402 关注
  • CongSec

    本标签主要用于分享网络空间安全专业的学习笔记

    1 引用 • 1 回帖 • 10 关注
  • Solidity

    Solidity 是一种智能合约高级语言,运行在 [以太坊] 虚拟机(EVM)之上。它的语法接近于 JavaScript,是一种面向对象的语言。

    3 引用 • 18 回帖 • 383 关注
  • 倾城之链
    23 引用 • 66 回帖 • 138 关注
  • 安装

    你若安好,便是晴天。

    132 引用 • 1184 回帖 • 1 关注
  • Redis

    Redis 是一个开源的使用 ANSI C 语言编写、支持网络、可基于内存亦可持久化的日志型、Key-Value 数据库,并提供多种语言的 API。从 2010 年 3 月 15 日起,Redis 的开发工作由 VMware 主持。从 2013 年 5 月开始,Redis 的开发由 Pivotal 赞助。

    286 引用 • 248 回帖 • 74 关注
  • OpenStack

    OpenStack 是一个云操作系统,通过数据中心可控制大型的计算、存储、网络等资源池。所有的管理通过前端界面管理员就可以完成,同样也可以通过 Web 接口让最终用户部署资源。

    10 引用 • 2 关注
  • HBase

    HBase 是一个分布式的、面向列的开源数据库,该技术来源于 Fay Chang 所撰写的 Google 论文 “Bigtable:一个结构化数据的分布式存储系统”。就像 Bigtable 利用了 Google 文件系统所提供的分布式数据存储一样,HBase 在 Hadoop 之上提供了类似于 Bigtable 的能力。

    17 引用 • 6 回帖 • 70 关注
  • Electron

    Electron 基于 Chromium 和 Node.js,让你可以使用 HTML、CSS 和 JavaScript 构建应用。它是一个由 GitHub 及众多贡献者组成的活跃社区共同维护的开源项目,兼容 Mac、Windows 和 Linux,它构建的应用可在这三个操作系统上面运行。

    15 引用 • 136 回帖
  • QQ

    1999 年 2 月腾讯正式推出“腾讯 QQ”,在线用户由 1999 年的 2 人(马化腾和张志东)到现在已经发展到上亿用户了,在线人数超过一亿,是目前使用最广泛的聊天软件之一。

    45 引用 • 557 回帖 • 85 关注
  • Kubernetes

    Kubernetes 是 Google 开源的一个容器编排引擎,它支持自动化部署、大规模可伸缩、应用容器化管理。

    110 引用 • 54 回帖 • 3 关注
  • GitHub

    GitHub 于 2008 年上线,目前,除了 Git 代码仓库托管及基本的 Web 管理界面以外,还提供了订阅、讨论组、文本渲染、在线文件编辑器、协作图谱(报表)、代码片段分享(Gist)等功能。正因为这些功能所提供的便利,又经过长期的积累,GitHub 的用户活跃度很高,在开源世界里享有深远的声望,并形成了社交化编程文化(Social Coding)。

    209 引用 • 2031 回帖
  • SVN

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

    29 引用 • 98 回帖 • 684 关注
  • ReactiveX

    ReactiveX 是一个专注于异步编程与控制可观察数据(或者事件)流的 API。它组合了观察者模式,迭代器模式和函数式编程的优秀思想。

    1 引用 • 2 回帖 • 153 关注
  • RESTful

    一种软件架构设计风格而不是标准,提供了一组设计原则和约束条件,主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。

    30 引用 • 114 回帖 • 2 关注
  • 运维

    互联网运维工作,以服务为中心,以稳定、安全、高效为三个基本点,确保公司的互联网业务能够 7×24 小时为用户提供高质量的服务。

    148 引用 • 257 回帖 • 1 关注
  • 分享

    有什么新发现就分享给大家吧!

    247 引用 • 1792 回帖 • 7 关注
  • 脑图

    脑图又叫思维导图,是表达发散性思维的有效图形思维工具 ,它简单却又很有效,是一种实用性的思维工具。

    25 引用 • 83 回帖