log4j简介
Log4j是Apache的一个开放源代码项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。
log4j三大组件
Log4j由三个重要的组件构成:日志信息的优先级,日志信息的输出目的地,日志信息的输出格式。日志信息的优先级从高到低有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别,分别用来指定这条日志信息的重要程度;日志信息的输出目的地指定了日志将打印到控制台还是文件中;而输出格式则控制日志信息的显示内容的格式。
log4j配置方式
Log4j支持两种配置方式,一种是在代码中进行配置,一种是使用配置文件经行配置。使用配置文件进行配置时,Log4j支持两种配置文件格式,一种是XML格式的文件,一种是properties格式的文件。
在项目中我们一般是使用配置文件的方式进行配置,下面我们介绍一下 properties 方式配置log4j 环境的方式。
log4j配置
新建配置文件 log4j.properties 文件内容如下:
log4j.properties
#配置根目录Logger 优先级为INFO,A1 给输出的目的地起个名字方便下面的配置。
log4j.rootLogger=INFO, A1
#配置输出目的地为控制台
log4j.appender.A1=org.apache.log4j.ConsoleAppender
#配置输出格式的布局(可以灵活地指定布局模式)
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
#配置日志信息的输出格式
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
配置解析
1. 配置根Logger,其语法为:
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中,level 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别,则应用程序中所有DEBUG级别的日志信息将不被打印出来。
appenderName 就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地,用逗号进行分割。
2. 配置日志信息输出目的地Appender,其语法为:
log4j.appender.appenderName1 = 输出目的地 1
log4j.appender.appenderName1 = 输出目的地 2
…
log4j.appender.appenderName1= 输出目的地 Nlog4j.appender.appenderName2 = 输出目的地 1
log4j.appender.appenderName2 = 输出目的地 2
…
log4j.appender.appenderName2= 输出目的地 N
一个 appenderName 可以配置多个输出目的地。(appenderName1 这里所说的 appenderName ? 就是上文配置 Logger 是用到的A1)
输出的目的地分别为:
org.apache.log4j.ConsoleAppender(控制台)
org.apache.log4j.FileAppender(文件)
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
3.配置日志信息的布局,其语法为:
log4j.appender.appenderName.layout = 布局 1
log4j.appender.appenderName.layout.option1 = value1
Log4j提供的layout有以下几种:
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
配置解析:
布局 1 为以上 4 中的一个。
option1 为引用输出目的地的类名(如引用
org.apache.log4j.ConsoleAppender 是option 1 为ConsoleAppender ) 。
value 1 为 输出的格式。
4、输出格式设置
在配置文件中可以通过log4j.appender.A1.layout.ConversionPattern设置日志输出格式。
参数:
%p: 输出日志信息优先级,即DEBUG,INFO,WARN,ERROR,FATAL,
%d: 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921
%r: 输出自应用启动到输出该log信息耗费的毫秒数
%c: 输出日志信息所属的类目,通常就是所在类的全名
%t: 输出产生该日志事件的线程名
%l: 输出日志事件的发生位置,相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main(TestLog4.Java:10)
%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像Java servlets这样的多客户多线程的应用中。
%%: 输出一个”%”字符
%F: 输出日志消息产生时所在的文件名称
%L: 输出代码中的行号
%m: 输出代码中指定的消息,产生的日志具体信息
%n: 输出一个回车换行符,Windows平台为”\r\n”,Unix平台为”\n”输出日志信息换行
可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如:
1)%20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,默认的情况下右对齐。
2)%-20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,”-”号指定左对齐。
3)%.30c:指定输出category的名称,最大的宽度是30,如果category的名称大于30的话,就会将左边多出的字符截掉,但小于30的话也不会有空格。
4)%20.30c:如果category的名称小于20就补空格,并且右对齐,如果其名称长于30字符,就从左边交远销出的字符截掉。