log4j使用简介

log4j使用简介

       最近在整理公司产品的日志输出规范，涉及log4j的使用介绍，就简单整理了一下。

 

1 Log4j配置说明

1.1 配置文件

    Log4j可以通过java程序动态设置，该方式明显缺点是：如果需要修改日志输出级别等信息，则必须修改java文件，然后重新编译，很是麻烦；

    log4j也可以通过配置文件的方式进行设置，目前支持两种格式的配置文件：

• xml文件
• properties文件（推荐）

下面是一个log4j配置文件的完整内容：

[xhtml] view plain copy

1. log4j.rootCategory=INFO, stdout  
2. log4j.rootLogger=info, stdout  
3.    
4. ### stdout ###  
5. log4j.appender.stdout=org.apache.log4j.ConsoleAppender  
6. log4j.appender.stdout.Target=System.out  
7. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout  
8. log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p - %m%n  
9.    
10. ### set package ###  
11. log4j.logger.org.springframework=info  
12. log4j.logger.org.apache.catalina=info  
13. log4j.logger.org.apache.commons.digester.Digester=info  
14. log4j.logger.org.apache.catalina.startup.TldConfig=info  
15. log4j.logger.chb.test=debug  

 

 1.2 配置根Logger

根logger主要定义log4j支持的日志级别及输出目的地，其语法为：

log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。

建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。

appenderName指定日志信息输出到哪个地方，可同时指定多个输出目的地。

1.3 配置输出目的地Appender

Appender主要定义日志信息输出在什么位置，主要语法为：

[xhtml] view plain copy

1. log4j.appender.appenderName = classInfo  
2. log4j.appender.appenderName.option1 = value1  
3. 　　…  
4. log4j.appender.appenderName.optionN = valueN  

 

Log4j提供的appender有以下几种： 

• org.apache.log4j.ConsoleAppender（控制台）， 
• org.apache.log4j.FileAppender（文件）， 
• org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
• org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件） 
• org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

以ConsoleAppender为例，如：

[xhtml] view plain copy

1. log4j.appender.stdout=org.apache.log4j.ConsoleAppender  
2. log4j.appender.stdout.Target=System.out  

 

1.4 配置日志信息的格式Layout

　　Layout 负责格式化Appender的输出，其语法为：

[xhtml] view plain copy

1. log4j.appender.appenderName.layout = classInfo  
2. log4j.appender.appenderName.layout.option1 = value1  
3. …  
4. log4j.appender.appenderName.layout.optionN = valueN  

 

　　其中，Log4j提供的layout有以下几种： 

• org.apache.log4j.HTMLLayout（以HTML表格形式布局）， 
• org.apache.log4j.PatternLayout（可以灵活地指定布局模式）， 
• org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
• org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

1.5 设置package输出级别

可以设置不同package的日志输出级别，语法为：

log4j.logger.packageName=level

其中，packageName为实际的包名，level为日志级别，例如：

[xhtml] view plain copy

1. log4j.logger.org.springframework=info  
2. log4j.logger.org.apache.catalina=info  
3. log4j.logger.org.apache.commons.digester.Digester=info  
4. log4j.logger.org.apache.catalina.startup.TldConfig=info  
5. log4j.logger.chb.test=debug  

 

2 Log4j与J2ee结合

2.1 使用spring架构

Spring真是不错，替我们做了很多事情，如果系统使用了spring框架，则要集成log4j就很简单了，主要分为3个步骤，如下：

2.1.1 定义log4j配置文件

[xhtml] view plain copy

1. log4j.rootCategory=INFO, stdout  
2. log4j.rootLogger=info, stdout  
3.    
4. ### stdout ###  
5. log4j.appender.stdout=org.apache.log4j.ConsoleAppender  
6. log4j.appender.stdout.Target=System.out  
7. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout  
8. log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p - %m%n  
9.    
10. ### log to file ###  
11. log4j.logger.org.springframework=info  
12. log4j.logger.org.apache.catalina=info  
13. log4j.logger.org.apache.commons.digester.Digester=info  
14. log4j.logger.org.apache.catalina.startup.TldConfig=info  
15. log4j.logger.chb.test=debug  

 

 2.1.2  定义监听器

监听器需要定义在web.xml，主要包括：定义log4j配置文件目录、log4j监听器，如下：

[xhtml] view plain copy

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <web-app version="2.4"  
3.     xmlns="http://java.sun.com/xml/ns/j2ee"  
4.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
5.     xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee  
6.     http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">  
7.      
8.     <!--由Spring载入的Log4j配置文件位置-->  
9.     <context-param>  
10.        <param-name>log4jConfigLocation</param-name>  
11.        <param-value>/WEB-INF/log4j.properties</param-value>  
12.     </context-param>  
13.      
14.     <context-param>  
15.        <param-name>contextConfigLocation</param-name>  
16.        <param-value>  
17.            /WEB-INF/classes/applicationContext*.xml  
18.        </param-value>  
19.     </context-param>  
20.      
21.     <!--Spring log4j Config loader-->  
22.     <listener>  
23.        <listener-class>  
24.            org.springframework.web.util.Log4jConfigListener  
25.        </listener-class>  
26.     </listener>  
27.      
28.     <listener>  
29.        <listener-class>  
30.            org.springframework.web.context.ContextLoaderListener  
31.        </listener-class>  
32.     </listener>  
33.      
34.     <servlet>  
35.        <servlet-name>InitiaServlet</servlet-name>  
36.     <servlet-class>chb.test.web.InitiaServlet</servlet-class>  
37.        <load-on-startup>1</load-on-startup>  
38.     </servlet>  
39.      
40.   <welcome-file-list>  
41.     <welcome-file>index.jsp</welcome-file>  
42.   </welcome-file-list>  
43. </web-app>  

 

2.1.3  测试类

[java] view plaincopy

1. package com.dheaven.mip.web;  
2.    
3.    
4. import javax.servlet.ServletException;  
5. import javax.servlet.http.HttpServlet;  
6.    
7. import org.apache.log4j.Logger;  
8.    
9. public class InitiaServlet extends HttpServlet {  
10.      
11.     protected Logger log = Logger.getLogger(InitiaServlet.class);  
12.    
13.     private static final long serialVersionUID = 8550329576989690578L;  
14.    
15.     /** 
16.      * Constructor of the object. 
17.      */  
18.     public InitiaServlet() {  
19.        super();  
20.     }  
21.    
22.     /** 
23.      * Destruction of the servlet. <br> 
24.      */  
25.     public void destroy() {  
26.        super.destroy();  
27.     }  
28.    
29.     /** 
30.      * Initialization of the servlet. <br> 
31.      * 
32.      * @throws ServletException if an error occure 
33.      */  
34.     public void init() throws ServletException {  
35.        log.debug("服务器启动了，log4j开始工作了");  
36.     }  
37. }  

 

2.2不使用spring架构

如果系统没有使用spring，我们以servlet为例，很简单，大家按照步骤执行即可，只贴代码，不说废话。

2.2.1 定义log4j配置文件

放在web工程的WEB-INF目录下，内容如：

[xhtml] view plain copy

1. log4j.rootCategory=INFO, stdout  
2. log4j.rootLogger=info, stdout  
3.    
4. ### stdout ###  
5. log4j.appender.stdout=org.apache.log4j.ConsoleAppender  
6. log4j.appender.stdout.Target=System.out  
7. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout  
8. log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p - %m%n  
9.    
10. ### set package ###  
11. log4j.logger.org.apache.catalina=info  
12. log4j.logger.org.apache.commons.digester.Digester=info  
13. log4j.logger.org.apache.catalina.startup.TldConfig=info  
14. log4j.logger.com.dheaven=debug  

 

2.2.2  创建log4j初始化类

[java] view plaincopy

1. package com.dheaven.mip.web;  
2.    
3. import javax.servlet.ServletException;  
4. import javax.servlet.http.HttpServlet;  
5.    
6. import org.apache.log4j.PropertyConfigurator;  
7.    
8. public class InitLog4j extends HttpServlet {  
9.    
10.     private static final long serialVersionUID = 1L;  
11.    
12.     public void init() throws ServletException {  
13.        String prefix = getServletContext().getRealPath("/");  
14.        prefix = prefix.replace("//", "/");  
15.        String file = getInitParameter("log4j-init-file");  
16.        // if the log4j-init-file is not set, then no point in trying  
17.        if (file != null) {  
18.            PropertyConfigurator.configure(prefix + file);  
19.        }  
20.     }  
21. }  

 

 2.2.3  在Web.xml中定义初始化类

[xhtml] view plain copy

1. <servlet>  
2.    <servlet-name>log4j-init</servlet-name>  
3.    <servlet-class>chb.test.web.InitLog4j</servlet-class>  
4.   
5.    <init-param>  
6.        <param-name>log4j-init-file</param-name>  
7.        <param-value>WEB-INF/log4j.properties</param-value>  
8.    </init-param>  
9.     
10.    <load-on-startup>1</load-on-startup>  
11. </servlet>  

 

2.2.4 测试类

[java] view plaincopy

1. package chb.test.web;  
2.    
3.    
4. import javax.servlet.ServletException;  
5. import javax.servlet.http.HttpServlet;  
6.    
7. import org.apache.log4j.Logger;  
8.    
9. public class InitiaServlet extends HttpServlet {  
10.      
11.     protected Logger log = Logger.getLogger(InitiaServlet.class);  
12.    
13.     private static final long serialVersionUID = 8550329576989690578L;  
14.    
15.     /** 
16.      * Constructor of the object. 
17.      */  
18.     public InitiaServlet() {  
19.        super();  
20.     }  
21.    
22.     /** 
23.      * Destruction of the servlet. <br> 
24.      */  
25.     public void destroy() {  
26.        super.destroy();  
27.     }  
28.    
29.     /** 
30.      * Initialization of the servlet. <br> 
31.      * 
32.      * @throws ServletException if an error occure 
33.      */  
34.     public void init() throws ServletException {  
35.        log.debug("服务器启动了，log4j开始工作了");  
36.     }  
37. }  

 

来源：http://blog.csdn.net/hbcui1984/article/details/5007197