1.背景介绍
2.知识剖析
3.常见问题
4.解决方案
5.编码实战
6.扩展思考
7.参考文献
8.更多讨论
1.背景介绍
在应用程序中添加日志记录总的来说基于三个目的:
(1)监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析工作
(2)跟踪代码运行时轨迹,作为日后审计的依据
(3)担当集成开发环境中的调试器的作用,向文件或控制台打印代码的调试信息。
最普通的做法就是在代码中嵌入许多的打印语句,这些打印语句可以输出到控制台或文件中,比较好的做法就是构造一个日志操作类来封装此类操作,而不是让一系列的打印语句充斥了代码的主体。
2.知识剖析
在强调可重用组件开发的今天,除了自己从头到尾开发一个可重用的日志操作类外, Apache提供了一个强有力的日志操作包------Log4j
Log4j是Apache的一个开放源代码项目,通过使用Log4j,可以控制日志信息输送的目的地是控制台、文件、GUI组件等;也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,能够更加细致地控制日志的生成过程。这些操作可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。
精确控制日志的输出,包括输出的格式,输出的目的地,输出的过滤(不同级别日志的输出)等
配置简单,不需要在代码中配置环境,支持两种配置文件格式,XML文件和.properties文件,常用后者,如log4j.properties
配置文件需要配置3个方面的内容:
(1)根目录(级别和目的地)
(2)目的地(控制台、文件等等)
(3)输出样式
log4j的基本使用方法:
Log4j 由三个重要的组件构成:日志信息的优先级,日志信息的输出目的地,日志信息的输出格式。
(1)日志信息的优先级从高到低有 ERROR 、 WARN 、 INFO 、 DEBUG ,分别用来指定这条日志信息的重要程度
(2)日志信息的输出目的地指定了日志将打印到控制台还是文件中
(3)而输出格式则控制了日志信息的显示内容。
Logger ----日志写出器,供程序员输出日志信息
Log4j的Loggers组件建议使用四个级别:DEBUG、INFO、WARN、ERROR。这四个级别是有顺序的.
DEBUG < INFO < WARN < ERROR ,分别用来指定这条日志信息的重要程度。
Log4j有一个规则:假设Loggers级别为P,如果在Loggers中发生了一个级别Q比P高,则可以启动,否则屏蔽掉。假设定义的级别是info,那么error和warn的日志可以显示而比他低的debug信息就不显示了。
Appender ----日志目的地,把格式化好的日志信息输出到指定的地方去
Log4j日志系统允许把日志输出到不同的地方,如控制台(Console)、文件(Files)、根据天数或者文件大小产生新的文件、以流的形式发送到其它地方等等。
其语法表示为:
org.apache.log4j.ConsoleAppender(控制台)
org.apache.log4j.FileAppender(文件)
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
Layout ----日志格式化器,用来把程序员的 logging request 格式化成字符串
有时用户希望根据自己的喜好格式化自己的日志输出。Log4j可以在Appenders的后面附加Layouts来完成这个功能。Layouts提供了四种日志输出样式,如根据HTML样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式等等
其语法表示为:
org.apache.log4j.HTMLLayout(以HTML表格形式布局)
org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
3.常见问题
为什么要用Log4j来替代System.out.println?
4.解决方案
Log4j就是帮助开发人员进行日志输出管理的API类库。它最重要的特点就可以配置文件灵活的设置日志信息的优先级、日志信息的输出目的地以及日志信息的输出格式。
Log4j除了可以记录程序运行日志信息外还有一重要的功能就是用来显示调试信息。
程序员经常会遇到脱离java ide环境调试程序的情况,这时大多数人会选择使用System.out.println语句输出某个变量值的方法进行调试。这样会带来一个非常麻烦的问题:一旦哪天程序员决定不要显示这些System.out.println的东西了就只能一行行的把这些垃圾语句注释掉。若哪天又需调试变量值,则只能再一行行去掉这些注释恢复System.out.println语句。
使用log4j可以很好的处理类似情况。
5.编码实战
6.扩展思考
如果不用log4j.properties,用xml格式配置日志的话,应该怎么配置?
7.参考文献
参考一:http://blog.csdn.net/win7system/article/details/51602239
参考二:https://www.cnblogs.com/godtrue/p/6442273.html
参考三:http://www.open-open.com/lib/view/open1402654461790.html
8.更多讨论
Log4j的ConversionPattern参数的格式含义
%c 输出日志信息所属的类的全名
%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy-MM-dd HH:mm:ss },输出类似:2002-10-18- 22:10:28
%f 输出日志信息所属的类的类名
%l 输出日志事件的发生位置,即输出日志信息的语句处于它所在的类的第几行
%m 输出代码中指定的信息,如log(message)中的message
%n 输出一个回车换行符,Windows平台为“rn”,Unix平台为“n”
%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL。如果是调用debug()输出的,则为DEBUG,依此类推
%r 输出自应用启动到输出该日志信息所耗费的毫秒数
%t 输出产生该日志事件的线程名