Log4j笔记

Log4j笔记

 

一、概述：

1.      Log4j简介：Apache开源项目，用于管理和打印输出log信息。

分为三个部分：Logger + Appender + Layout

1.      Logger : 日志器，生成和记录日志的程序

2.      Appender : 日志器存放位置，console/文件/GUI组件等，一个Logger可有多个Appender.

3.      Layout : 控制日志的格式、输出和显示级别等

注意：log的5个级别：Debug > Info > Warn> Error > Fatal。

显示方式：高于配置级别的信息才会显示。

2.      为什么要日志？

原因： 1. 开发阶段à排错； 2. 产品阶段à记录运行状况。

3.      Log4j的优点：

设置开关：运行时可以选择打开或关闭日志的输出；

定义作用域：自定义部分类或包输出或关闭；

分级：对日志进行分级；

多样：不只文本信息，还能输出其他信息；

位置：可以改变输出log的位置。

4.      其他log插件：comments-log，JDK-log等。

 

二、如何使用：

1.      导入jar包，编写配置文件（Log4j支持两种格式的配置文件，即properties文件和xml文件）；（properties文件配置方式比较常见）

2.      properties配置文件基本格式：

log4j.properties配置文件如下：

#log4j.rootLogger=debug,stdout,R
log4j.rootLogger=debug,stdout
log4j.logger.com.test.log4j=debug,R
log4j.logger.com.test.log4j.hehe=debug,R2
log4j.logger.com.test.hehe.Test=info,R3

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=[%t] %d{yy/mm/dd HH:mm:ss}  %p (%F:%L) - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender
#log4j.appender.R.File=example.log
log4j.appender.R.File=c:/example.log
#log4j.appender.R.File=${webappHome}/example.log
log4j.appender.R.MaxFileSize=1KB

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=${catalina.home}/logs/rfidtest.log    
log4j.appender.R.MaxFileSize=10MB
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %t %c{1}:%L- %m%n

*其中rootLogger为根日志器，log4j.logger.com.Alvin.dao.AddUserDao为该类的日志器，如果设置，将覆盖根日志器。

 

3.      参照信息：

参数	说明	例子
%c	列出logger名字空间的全称，如果加上{<层数>}表示列出从最内层算起的指定层数的名字空间	Log4j配置文件参数举例		输出显示媒介
		假设当前logger名字空间是”a.b.c”
		%c		a.b.c
		%c{2}		b.c
		%20c		（若名字空间长度小于20，则左边用空格填充）
		%-20c		（若名字空间长度小于20，则右边用空格填充）
		%.30c		（若名字空间长度超过30，截取多余字符）
		%20.30c		（若名字空间长度小于20，则左边用空格填充；若名字空间长度超过30，截去多余字符）
		%-20.30c		（若名字空间长度小于20，则右边用空格填充；若名字空间长度超过30，截去多余字符）
%C	列出调用logger的类的全名（包含路径名）	假设当前是”org.apache.xyz.SomeClass”
		%C	Org.apache.xyz.SomeClass
		%C{1}	SomeClass
%d	显示日志记录的时间，{<日期格式>}使用ISO8601定义的格式	%d{yyyy/MM/dd HH:mm:ss,SSS}	2005/10/12 22:23:30,117
		%d{ABSOLUTE}	22:23:30,117
		%d{DATE}	12 Oct 2005 22:23:30,117
		%d{ISO8601}	2005-10-12 22:23:30,117
%F	显示调用logger的源文件名	%F	MyClass.java
%I	输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数	%I	MyClass.main(MyClass.java:129)
%L	显示调用logger的代码行	%L	129
%m	显示输出的消息	%m	This is a message for debug.
%M	显示调用logger的方法名	%M	Main
%n	当前平台下的换行符	%n	Windows平台下m UNIX平台下n
%p	显示该条日志的优先级	%p	INFO
%r	显示从程序启动时到记录该条日志时已经经过的毫秒数	%r	1215
%t	输出产生该日志事件的线程名	%t	MyClass
%x	按NDC（Nested Diagnostic Context，线程堆栈）顺序输出的日志	假设某程序调用顺序是MyApp调用com.foo.Bar
		%c %x - %m%n	MyApp – Call com.foo.Bar. Com.foo.Bar – Log in Bar MyApp – Return to MyApp.
%X	按照MDC（Mapped Diagnostic Context，线程映射表）输出日志。通常用于多个客户端连接同一台服务器，方便服务器区分那个客户端访问留下来的日志。	%X{5}	（记录代号为5的客户端的日志）
%%	显示一个百分号	%%	%

 

4.      通常log以文件形式输出的话，在properties配置文件中配置相对路径，以免项目发布后产生的问题，配置方法是建一个servlet，并在web.xml文件中设置其开始加载，servlet中Init()方法里读取当前项目所在路径并放入配置，然后配置文件中读取作用域${webappHome}。

 

5.      程序中如何用：

声明：private static Logger logger =Logger.getLogger(类名.class);

使用： logger.debug(“….”);  logger.info(“….”);  logger.warn(“….”);即可打印log.

6.      如果需要改变输出，只需要在properties里改一下级别就可以了。

 

三、注意点：

1.      properties配置文件必须放在src根目录下，不可放进包内。

2.      properties配置文件的名称也不能改，必须是：log4j.properties

3.      通常log以文件形式输出的话，在配置文件里设置相对路径而非绝对路径，以防项目上线后目录有变。设置方法如下：

<1>. 创建servlet，实现其Init()方法，再起在Init()方法中获取当前项目路径存入配置，即：System.setProperty(“webappHome”,this.getServletContext().getRealPath(“”));

<2>. 配置web.xml配置文件，设置<loan-on-start>为1或大于1的正数，让server启动时实例化此类，注意：不用配置<servlet-mapping>标签；

<3>. 在log4j.properties配置文件中讲路径改为${webappHome}。

4.      Log4j.properties配置文件中，配置输出log到文件需要做两步：

<1>. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

<2>. log4j.appender.stdout.layout.ConversionPattern=”输出格式”