个人认为,如果在公司的野蛮生长阶段,一些基础类库不做约束,很可能“埋坑”,形成技术债务,最终为此付出代价。本文讲解一个最简的日志打印规范。
事实上,日志打印规范互联网上已有很多,但大多比较冗长(记不住),也不太契合我们团队(关注点不契合)。
所以,我又造了个轮子,写了个简单易懂、容易记的“最简日志打印规范”,后续随着团队实力的增长,和项目的演进,会逐步增加新的条例。
日志组件有很多,日志门面的选择有:Slf4j、Apache Commons Logging等。
日志的实现更多,有:log4j、logback、log4j2、Java Util Logging(jul)、Jboss Logging等。
目前,我们使用Slf4j作为日志门面,logback作为日志实现。
日志的级别有很多,我们一般只用四个。日志级别由低到高DEBUG - INFO - WARN - ERROR。
在我们的系统中,不同的日志级别的打印场景大致如下:
日志级别 | 打印场景 |
---|---|
DEBUG | 调试日志。目前管理相对宽松,我们暂时没有严格要求。 |
INFO | 业务日志。我们用来记录业务的主流程的走向。 |
WARN | 警告日志。一般来说,发生对整个系统没什么影响的异常时,可以打印该级别的日志。 |
ERROR | 错误日志。级别比较高,如果发生一些异常,并且任何时候都需要打印时使用。 |
public static final Logger LOGGER = LoggerFactory.getLogger(MyRealm.class); |
我们使用的日志门面是slf4j,使用时应面向接口编程,LOGGER/LoggerFactory应该都是slf4j的API。
严禁直接使用日志实现包。原因大致有两点,第一是面向接口编程更优雅,这点不必说明;第二,举个例子,因为log4j已经几年不更新,老的项目可能使用了log4j,现在想要换用logback或者log4j2,如直接使用log4j的API,不利于选型更换与API的统一(当然,非要用也没关系,有个log4j-over-slf4j的适配器。但接口不统一,总感觉哪里不对劲)。
例如:
LOGGER.debug("当前用户是:" + user + ",传入参数是:" + userId); |
严禁使用字符串拼接的方式打印日志,可读性、可维护性都比较差。
建议的写法如下:
LOGGER.debug("当前用户是:{},传入参数是:{},返回值是:{},用户信息:{}", a,b new Object[]{token, userId, userInfo, authcInfo}); |
因为我们使用的是Slf4j,Slf4j有占位符填充的功能。多个占位符可放在Object数组中。
不优雅示例:
if (LOGGER.isDebugEnabled()) {LOGGER.debug("当前用户是{}", token);} |
以前,为了性能,我们常常在打印日志之前判断一下。
使用Slf4j后,我们可以写成如下形式就OK了。
LOGGER.debug("当前用户是{}", token); |
当然,如果依然使用字符串拼接的方式,还是得判断一下级别的。
本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系我们删除。