spring中的log4j简单配置

1. 内容简介

本帖的主要内容在于介绍在spring中通过log4j实现基础日志打印。

2. 所需组件

2.1 所需jar包

log4j-1.2.17.jar

commons-logging-1.2.jar

2.2 所需的配置文件

1. spring基本配置文件，类似 web.xml、applicationcontext.xml等

2. log4j的配置文件，log4j.xml 文件

3. 必要组件的配置

3.1 log4j.xml的配置

在log4j.xml中共分为两个部分：1.<appender></appender>，主要用于指定日志文件路径和名字（见下面代码中的注释）以及日志输出的方式；2.<logger></logger>部分用于给java代码提供调用点，相当于是一个对外的接口。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC "-//LOGGER"
"http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/doc-files/log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
    <!-- 文件中指定重写ProbeRollingFileApp,其实可以不重写而直接用 -->
    <appender name="CHAMTLOG" class = "com.china.domain.logs.ProbeRollingFileApp">
        <!-- 用于指定日志文件的路径和名字，其中 ${catalia.home}是tomcat底下/conf/所在路径 -->
        <param name="File" value="${catalina.home}/logs/chamt.log"/>
        <param name="MaxFileSize"  value="10MB"/>
        <param name="MaxBackupIndex" value="20MB"/>
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 用于指定日志文件中各个打印的格式 -->
            <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss:SSS} [%-5p][method:%l][%t]%n%m%n%n"/>
        </layout>
    </appender>
    
    <!-- 在代码中关联了该name，则用该节点指定的appender进行打印 -->
    <logger name="test.log4j.test8.UseLog4j" additivity="false">
        <!-- 指定打印的级别，在该例中，只有大于等于WARN级别的日志才会被打印 -->
        <level value ="WARN"/>
        <appender-ref ref="CHAMTLOG"/>
    </logger>
    
    <!-- 默认打印的appender -->
    <root>
        <level value ="INFO"/>
        <appender-ref ref="CHAMTLOG"/>
    </root>

</log4j:configuration>

关于ProbeRollingFileApp文件的说明，其实没有必要重写RollingFileAppender类而可以直接用，之所以在本文中要重新，是考虑到打印过程中句柄失效的场景，在这种情况下需要重新建立句柄以实现继续打印。其代码如下所示：

package com.china.domain.logs;

import java.io.File;

import org.apache.log4j.RollingFileAppender;
import org.apache.log4j.spi.LoggingEvent;

public class ProbeRollingFileApp extends RollingFileAppender {

	protected void subAppend(LoggingEvent event) {  
		
		/**
		 * 这段代码主要考虑一种情况：当句柄不存在的时候重新建立句柄以继续打印
		 */
		if(!new File(this.fileName).exists()) {
			try {
				super.setFile(this.fileName, this.getAppend(), this.bufferedIO, this.bufferSize);
			}catch(Exception e) {
				System.out.println(e.toString());
			}
		}
        super.subAppend(event);  
       
    }  
}

3.2 在web.xml文件中的配置

在web.xml中的配置主要分为以下几个方面：1. 指定log4j.xml文件的位置；2. 指定扫描的间隔时间；3. 配置log4j的监听器。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
	
	<context-param>
	    <param-name>contextConfigLocation</param-name>
	     <param-value>/WEB-INF/applicationContext.xml</param-value>
	</context-param>
	
	<!-- 指定log4j.xml文件的位置 -->
	<context-param>
        <param-name>log4jConfigLocation</param-name>
        <param-value>/WEB-INF/log4j.xml</param-value>
    </context-param>
    
    <!-- 指定日志重新扫描的时间，服务器每隔该指定时间对该文件进行重新扫描。实现修改日志级别后不重启tomcat也可生效 -->
    <context-param>
        <param-name>log4jRefreshInterval</param-name>
        <param-value>10000</param-value>
    </context-param>
    
    <!-- log4j 监听器 -->
    <listener>
        <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
    </listener>

	<listener>
	    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener>
	
	<listener>
	    <listener-class>org.springframework.web.context.request.RequestContextListener</listener-class>
	</listener>
	
	<servlet>
	    <servlet-name>dispatcher</servlet-name>
	    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
	    <load-on-startup>3</load-on-startup>
	</servlet>
	
	<servlet-mapping>
	    <servlet-name>dispatcher</servlet-name>
	    <url-pattern>*.html</url-pattern>
	</servlet-mapping>
	
</web-app>	

3.3 在代码中调用

1. 创建一个Logger，指定引用log4j.xml中<logger/>节点的接口，一般来说，都是填写 a.class(如下例)，则会关联到<root/>节点

2. 在需要打印的地方选择级别进行打印

@Controller
public class LoginController 
{		
	private Logger logger = Logger.getLogger(LoginController.class);
	
	@RequestMapping(value="/index.html")
	public String loginPage()
	{ 
		logger.error("++++++++++++++++++++");
		System.out.println("+++++++"+"china"+"+++++++++");
		return "login";
	}
}

3.4 打印结果展示

运行tomcat之后，会在apache-tomcat-7.0.82\logs路径下找到 chamt.log(在log4j.xml文件中所指定)文件并在文件中找到相关的打印。