用Java日志来写诗
作者:crazyacking 发布时间:[ 2016/7/18 10:43:15 ] 推荐标签:测试开发技术 Java
工欲善其事,必先利其器
很多程序员可能都忘了记录应用程序的行为是一件多么重要的事,当遇到多线程环境下高压力导致的并发bug时,你能体会到记录log的重要性。
有的人很高兴的在代码里加上了这么句:
log.info("Happy and carefree logging");
他可能都没有意识到应用程序的日志在维护,调优和故障识别中的重要性。
我认为slf4j是好的日志API,主要是因为它支持一个很棒的模式注入的方式:
log.debug("Found {} records matching filter: '{}'", records, filter);
log4j的话你只能这样:
log.debug("Found " + records + " recordsmatching filter: '" + filter + "'");
这样写不仅更?嗦和可读性差,而且字符串拼接影响效率(当这个级别并不需要输出的时候)。
slf4j引入了{}注入特性,并且由于避免了每次都进行字符串拼接,toString方法不会被调用,也不再需要加上isDebugEnabled了。
slf4j是外观模式的一种应用,它只是一个门面。具体实现的话我推荐logback框架,之前已经做过一次广告了,而不是已经很完备的log4j。它有许多很有意思的特性,和log4j不同的是,它还在积极的开发完善中。
还有一个要推荐的工具是perf4j:
Perf4J is to System.currentTimeMillis() as log4j is to System.out.println()
好比log4j是System.out.println的一种更好的替换方式一样,perf4j更像是System.currentTimeMillis()的替代。
我已经在一个项目中引入了perf4j,并在高负载的情况下观察它的表现。管理员和企业用户都被这个小工具提供的漂亮的图表惊呆了。
我们可以随时查看性能问题。perf4j应该专门开一篇文章来讲,现在的话可以先看下它的开发者指南。
还有一个Ceki Gülcü(log4j,slf4j和logback工程的创建者)提供了一个简单的方法供我们移除对commons-logging的依赖。
不要忘了日志级别
每次你要加一行日志的时候,你都会想,这里该用哪种日志级别?大概有90%的程序员都不太注意这个问题,都是用一个级别来记录日志,通常不是INFO是DEBUG。为什么?
日志框架和System.out相比有两大优势:分类和级别。两者可以让你可以选择性的过滤日志,的或者只是在排查错误的时候。
ERROR 发生了严重的错误,必须马上处理。这种级别的错误是任何系统都无法容忍的。比如:空指针异常,数据库不可用,关键路径的用例无法继续执行。
WARN 还会继续执行后面的流程,但应该引起重视。其实在这里我希望有两种级别:一个是存在解决方案的明显的问题(比如,"当前数据不可用,使用缓存数据"),另一个是潜在的问题和建议(比如“程序运行在开发模式下”或者“管理控制台的密码不够安全”)。应用程序可以容忍这些信息,不过它们应该被检查及修复。
DEBUG 开发人员关注的事。后面我会讲到什么样的东西应该记录到这个级别。
TRACE 更为详尽的信息,只是开发阶段使用。在产品上线之后的一小段时间内你可能还需要关注下这些信息,不过这些日志记录只是临时性的,终应该关掉。DEBUG和TRACE的区别很难区分,不过如果你加了一行日志,在开发测试完后又删了它的话,这条日志应该是TRACE级别的。
上面的列表只是一个建议,你可以根据自己的规则来记录日志,但好要有一定的规则。我个人的经验是:在代码层面不要进行日志过滤,而是用正确的日志级别能够快速的过滤出想要的信息,这样能节省你很多时间。
后要说的是这个臭名昭著的is*Enabled的条件语句了。有的人喜欢把每次日志前加上这个:
if(log.isDebugEnabled())
log.debug("Place for your commercial");
个人认为,应该避免在代码里加入这个乱哄哄的东西。性能看起来没有什么提升(尤其是用了slf4j之后),更像是过早的优化。还有,没发现这么做有点多余么?很少有时候是明确需要这种显式的判断语句的,除非我们证明构造日志消息本身开销太大。不然的话,该怎么记怎么记,让日志框架去操心这个吧。
你清楚你在记录什么吗?
每次你写下一行日志,花点时间看看你到底在日志文件里打印了些什么。读一遍你的日志,找出异常的地方。首先,至少要避免空指针异常:
log.debug("Processing request with id: {}", request.getId());
你确认过request不是null了吗?
记录集合也是一个大坑。如果你用Hibernate从数据库里获取领域对象的集合的时候,不小心写成了这样:
log.debug("Returning users: {}", users);
slf4j只会在这条语句确实会打印的时候调用toString方法,当然这个很酷。不过如果内存溢出了,N+1选择问题,线程饿死,延迟初始化异常,日志存储空间用完了...这些都有可能发生。
好的方式是只记录对象的ID(或者只记录集合的大小)。不过收集ID需要对每个对象调用getId方法,这个在Java里可真不是件简单的事。Groovy有个很棒的展开操作符(users*.id),在Java里我们可以用Commons Beanutils库来模拟下:
log.debug("Returning user ids: {}", collect(users, "id"));
collect方法大概是这么实现的:
public static Collection collect(Collection collection, String propertyName) {
return CollectionUtils.collect(collection, new BeanToPropertyValueTransformer(propertyName));
}
后要说的是,toString方法可能没有正确的实现或者使用。
首先,为了记录日志,为每个类创建一个toString的做法比比皆是,好用 ToStringBuilder来生成(不过不是它的反射实现的那个版本)。
第二,注意数组和非典型的集合。数组和一些另类的集合的toString实现可能没有挨个调用每个元素的toString方法。可以使用JDK提供的Arrays#deepToString方法。经常检查一下你自己打印的日志,看有没有格式异常的一些信息。
避免副作用
日志打印一般对程序的性能没有太大影响。近我一个朋友在一些特殊的平台上运行的一个系统抛出了Hibernate的LazyInitializationException异常。你可能从这已经猜到了,当会话连接进来的时候,一些日志打印导致延迟初始化的集合被加载。在这种情况下,把日志级别提高了,集合也不再被初始化了。如果你不知道这些上下文信息,你得花多长时间来发现这个BUG。
另一个副作用是影响程序的运行速度。快速回答一下这个问题:如果日志打印的过多或者没有正确的使用toString和字符串拼接,日志打印会对性能产生负面影响。能有多大?好吧,我曾经见过一个程序每15分钟重启一次,因为太多的日志导致的线程饿死。这是副作用!从我的经验来看,一小时打印百来兆差不多是上限了。
当然如果由于日志打印异常导致的业务进程中止,这个副作用大了。我经常见到有人为了避免这个而这么写:
try {
log.trace("Id=" + request.getUser().getId() + " accesses " + manager.getPage().getUrl().toString())
} catch(NullPointerException e) {}
这是段真实的代码,但是为了让世界清净点,请不要这么写。
描述要清晰
每个日志记录都会包含数据和描述。看下这个例子:
log.debug("Message processed");
log.debug(message.getJMSMessageID());
log.debug("Message with id '{}' processed", message.getJMSMessageID());
当在一个陌生的系统里排查错误的时候,你更希望看到哪种日志?相信我,上面这些例子都很常见。还有一个反面模式:
if(message instanceof TextMessage)
//...
else
log.warn("Unknown message type");
在这个警告日志里加上消息类型,消息ID等等这些难道很困难吗?我是知道发生错误了,不过到底是什么错误?上下文信息是什么?
第三个反面例子是“魔法日志”。一个真实的例子:团队里的很多程序员都知道,3个&号后面跟着!号再跟着一个#号,再跟着一个伪随机数的日志意味着”ID为XYZ的消息收到了”。没人愿意改这个日志,某人敲下键盘,选中某个的”&&&!#”字符串,他能很快找到想要的信息。
结果是,整个日志文件看起来像一大串随机字符。有人不禁会怀疑这是不是一个perl程序。
日志文件应当是可读性强的,清晰的,自描述的。不要用一些魔数,记录值,数字,ID还有它们的上下文。记录处理的数据以及它的含义。记录程序正在干些什么。好的日志应该是程序代码的一份好的文档。
我有提过不要打印密码还有个人信息吗?相信没有这么傻的程序员。
调整你的格式
日志格式是个很有用的工具,无形中在日志添加了很有价值的上下文信息。不过你应该想清楚,在你的格式中包含什么样的信息。比如说,在每小时循环写入的日志中记录日期是没有意义的,因为你的日志名已经包含了这个信息。相反的,如果你没记录线程名的话当两个线程并行的工作的时候,你无法通过日志跟踪线程了——日志已经重叠到一起了。在单线程的应用程序中,这样做没问题,不过那个已经是过去的事儿了。
从我的经验来看,理想的日志格式应当包括(当然除了日志信息本身了):当前时间(无日期,毫秒级精度),日志级别,线程名,简单的日志名称(不用全称)还有消息。在logback里会是这样的:
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} %-5level [%thread][%logger{0}] %m%n</pattern>
</encoder>
</appender>
文件名,类名,行号,都不用列进来,尽管它们看起来很有用。我还在代码里见过空的日志记录:
log.info("");
因为程序员认为行号会作为日志格式的一部分,并且他知道如果空日志消息出现在这个文件的67行的话,意味着这个用户是认证过的。不仅这样,记录类名方法名,或者行号对性能都有很大的影响。
日志框架的一个比较高级的特性是诊断上下文映射(Mapped Diagnostic Context)。MDC只是一个线程本地的一个map。你可以把任何键值对放到这个map里,这样的话这个线程的所有日志记录都能从这个map里取到相应的信息作为输出格式的一部分。
相关推荐
更新发布
功能测试和接口测试的区别
2023/3/23 14:23:39如何写好测试用例文档
2023/3/22 16:17:39常用的选择回归测试的方式有哪些?
2022/6/14 16:14:27测试流程中需要重点把关几个过程?
2021/10/18 15:37:44性能测试的七种方法
2021/9/17 15:19:29全链路压测优化思路
2021/9/14 15:42:25性能测试流程浅谈
2021/5/28 17:25:47常见的APP性能测试指标
2021/5/8 17:01:11