Log4j介绍
Log4j是一个用Java编写的可靠,快速和灵活的日志框架(API)。通过log4j可以控制日志信息输送的目的地:数据库,文件,控制台,UNIX系统日志等;可以控制每一条日志的输出格式;可以选择输出日志信息的级别,根据自己的需要选择性的输出不同级别的日志信息。简单来说就是这个配置文件告诉Log4j以什么样的格式、把什么样的信息、输出到什么地方。这些可以通过一个配置文件来灵活地进行配置,不需要修改应用的代码。–>Log4j官方文档
Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java的properties文件。通常都选择在src根目录下创建一个log4j.properties文件。这是一个键 - 值对保存 log4j 配置属性的文件。默认情况下,日志管理在classpath 查找 log4j.properties 文件。
Log4j中有三个主要组成部分:
- loggers: 根据日志级别捕获日志记录信息。
- appenders : 负责发布日志信息,发布到指定位置。
- layouts: 定义日志信息输出的格式。
下面是一个完整的log4j.properties文件
###配置根Logger###
log4j.rootLogger=info, stdout
###配置日志输出目的地Appender###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
###配置输出格式###
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p - %m%n
###配置package输出级别###
log4j.logger.org.springframework=info
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.chb.test=debug
1.配置根Logger
语法:log4j.rootLogger = [ level ] , appenderName, appenderName
其中,level 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。
优先级:ALL < DEBUG < INFO < WARN < ERROR < FATAL < OFF。上面文件设置的info级别,意思是大于等于info级别的日志都会输出。
常用的就是:ERROR、WARN、INFO、DEBUG。
appenderName指定日志信息输出位置,可同时指定多个输出目的地。譬如同时输出到控制台和输出到文本文件。
2.配置日志输出目的地Appender
Appender主要定义日志信息输出在什么位置。
语法:
log4j.appender.appenderName = org.apache.log4j.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.optionN = valueN
3.配置日志输出格式Layout
Layout 负责格式化Appender的输出。
语法:
log4j.appender.appenderName.layout = classInfo
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN
log4j的输出格式化参数
%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字符,就从左边交远销出的字符截掉。
4.配置package输出级别
可以设置不同package的日志输出级别。
语法:
log4j.logger.packageName=level,packageName为实际的包名,level为日志级别。
在spring框架中使用log4j
先在启动服务时加载Log4j的配置文件进行初始化。
1.定义log4j配置文件
如文章开头配置的那样。
2.配置log4j监听器
监听器需要定义在web.xml中,主要包括:定义log4j配置文件目录、log4j监听器。
<listener>
<listener-class>
org.springframework.web.util.Log4jConfigListener
</listener-class>
</listener>
<context-param>
<param-name>log4jConfigLocation</param-name>
<param-value>classpath:conf/properties/log4j.properties</param-value>
</context-param>
3.使用log4j
使用Log4j,第一步就是获取日志记录器,这个记录器将负责控制日志信息。
getLogger的参数一般就是本类。
Logger.debug ( Object message ) ;
Logger.info ( Object message ) ;
Logger.warn ( Object message ) ;
Logger.error ( Object message ) ;
想输出日志到指定文件的话就在log4j.properties文件里配置好相应的参数就好了。
附上:
非常详细的参考文档
在web项目中配置Log4j的技巧