日志框架log4j

本篇博客主要讲解日志框架log4j在web工程中的配置和使用。

简介

Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。

Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。

配置文件

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是properties格式的文件。下面我们介绍使用properties格式作为配置文件的方法： 

示例：

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

① 配置根Logger，其语法为： 

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

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。 

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

② 配置日志信息输出目的地Appender，其语法为： 

log4j.appender.appenderName = fully.qualified.name.of.appender.class 
log4j.appender.appenderName.option1 = value1 
… 
log4j.appender.appenderName.option = valueN 

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

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

（1）ConsoleAppender选项

Threshold=WARN：指定日志消息的输出最低层次。 
ImmediateFlush=true：默认值是true，意味着所有的消息都会被立即输出。 
Target=System.err：默认情况下是：System.out,指定输出控制台

（2）FileAppender 选项 

Threshold=WARN：指定日志消息的输出最低层次。 
ImmediateFlush=true：默认值是true，意味着所有的消息都会被立即输出。 
File=mylog.txt：指定消息输出到mylog.txt文件。 
Append=false：默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。 

（3）DailyRollingFileAppender 选项

Threshold=WARN：指定日志消息的输出最低层次。 
ImmediateFlush=true：默认值是true，意味着所有的消息都会被立即输出。 
File=mylog.txt：指定消息输出到mylog.txt文件。 
Append=false：默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。 
DatePattern='.'yyyy-ww：每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下： 

1)'.'yyyy-MM: 每月  
2)'.'yyyy-ww: 每周 
3)'.'yyyy-MM-dd: 每天 
4)'.'yyyy-MM-dd-a: 每天两次 
5)'.'yyyy-MM-dd-HH: 每小时 
6)'.'yyyy-MM-dd-HH-mm: 每分钟 

（4）RollingFileAppender 选项

Threshold=WARN：指定日志消息的输出最低层次。 
ImmediateFlush=true：默认值是true，意味着所有的消息都会被立即输出。 
File=mylog.txt：指定消息输出到mylog.txt文件。 
Append=false：默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。 
MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。 
MaxBackupIndex=2：指定可以产生的滚动文件的最大数。

③ 配置日志信息的布局，其语法为：

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class 
log4j.appender.appenderName.layout.option1 = value1 
… 
log4j.appender.appenderName.layout.option = valueN 
其中，Log4j提供的layout有以下几种： 
org.apache.log4j.HTMLLayout（以HTML表格形式布局）， 
org.apache.log4j.PatternLayout（可以灵活地指定布局模式）， 
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）， 
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

④ 输出格式设置

在配置文件中可以通过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字符，就从左边交远销出的字符截掉。

日志输出示例：

[%d{HH\:mm\:ss\:SSS}][%p] (%c\:%L) - %m%n
输出格式为：[08:58:59:412][INFO] (com.soon.action:35) - 服务器启动

加载log4j.properties文件

log4j.properties放在类路径下：

log4j.rootLogger = debug,stdout,D,E
 

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 = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
 

log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = F://logs/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG 
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
 

log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =F://logs/error.log 
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR 
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

① 普通web工程（非Spring注解驱动）

log4j不整合slf4j使用

（1）添加依赖

<!--web项目-->
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
    <scope>provided</scope>
</dependency>

<!--log4j-->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

（2）编写web.xml中需要初始化的Log4JInitServlet

public class Log4JInitServlet extends HttpServlet {

    @Override
    public void init(ServletConfig config) throws ServletException {
        System.out.println("Log4JInitServlet 正在初始化 log4j日志设置信息");
        String log4jLocation = config.getInitParameter("log4j-properties-location");

        ServletContext sc = config.getServletContext();

        if (log4jLocation == null) {
            System.err.println("*** 没有 log4j-properties-location 初始化的文件, 所以使用 BasicConfigurator初始化");
            BasicConfigurator.configure();
        } else {
            String webAppPath = sc.getRealPath("/");
            String log4jProp = webAppPath + log4jLocation;
            File yoMamaYesThisSaysYoMama = new File(log4jProp);
            if (yoMamaYesThisSaysYoMama.exists()) {
                System.out.println("使用: " + log4jProp + "初始化日志设置信息");
                PropertyConfigurator.configure(log4jProp);
            } else {
                System.err.println("*** " + log4jProp + " 文件没有找到， 所以使用 BasicConfigurator初始化");
                BasicConfigurator.configure();
            }
        }
        super.init(config);
    }
}

（3）web.xml的配置

因为是web服务,所以需要在当服务器启动时就应该被立即启动。

<!--用来启动 log4jConfigLocation的servlet -->
<servlet>
    <servlet-name>Log4JInitServlet</servlet-name>
    <servlet-class>com.web001.servlet.Log4JInitServlet</servlet-class>
    <init-param>
        <param-name>log4j-properties-location</param-name>
        <param-value>/WEB-INF/classes/log4j.properties</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

<servlet-mapping>
    <servlet-name>Log4JInitServlet</servlet-name>
    <url-pattern>/initLog</url-pattern>
</servlet-mapping>

（4）测试验证

1）编写请求用的Servlet

import org.apache.log4j.Logger;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;


public class ControllerServlet extends HttpServlet {

    static Logger logger = Logger.getLogger(ControllerServlet.class);

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        this.doPost(req, resp);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        logger.debug("debug test log doPost");
        logger.info("info test log doPost");
        logger.error("error test log doPost");
    }
}

2）web.xml配置

<!DOCTYPE web-app PUBLIC
        "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
        "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
    <!--用来启动 log4jConfigLocation的servlet -->
    <servlet>
        <servlet-name>Log4JInitServlet</servlet-name>
        <servlet-class>com.harvey.demo.servlet.Log4JInitServlet</servlet-class>
        <init-param>
            <param-name>log4j-properties-location</param-name>
            <param-value>/WEB-INF/classes/log4j.properties</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <!--用来验证日志记录的-->
    <servlet>
        <servlet-name>controllerServlet</servlet-name>
        <servlet-class>com.harvey.demo.servlet.ControllerServlet</servlet-class>
    </servlet>


    <servlet-mapping>
        <servlet-name>Log4JInitServlet</servlet-name>
        <url-pattern>/initLog</url-pattern>
    </servlet-mapping>

    <servlet-mapping>
        <servlet-name>controllerServlet</servlet-name>
        <url-pattern>/httpLog</url-pattern>
    </servlet-mapping>
</web-app>

3）打开浏览器，在地址栏输入：http://localhost:9898/demo/httpLog， 可以在log.log和error.log中看到打印了日志。

log4j整合slf4j

一般我们推荐使用slf4j结合log4j进行日志记录。

（1）添加依赖

<!--web项目-->
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
    <scope>provided</scope>
</dependency>

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

<!--特别注意：log4j+slf4j整合，使用的是slf4j-log4j12, log4j2使用的是log4j-slf4j-impl-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.25</version>
</dependency>

（2）代码使用

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static Logger logger = LoggerFactory.getLogger(ControllerServlet.class);

② spring方式加载，配置在web.xml中

Spring加载log4j.properties，它提供了一个Log4jConfigListener，本身就能通过web.xml配置从指定位置加载log4j配置文件和log4j的输出路径，要注意的是Log4jConfigListener必须要在Spring的Listener之前。

web.xml：

<!-- 设置由Sprng载入的Log4j配置文件位置 -->
<context-param> 
    <param-name>log4jConfigLocation</param-name> 
    <param-value>WEB-INF/classes/log4j.properties</param-value> 
</context-param> 
<!-- Spring刷新Log4j配置文件变动的间隔,单位为毫秒 -->
<context-param> 
    <param-name>log4jRefreshInterval</param-name> 
    <param-value>10000</param-value> 
</context-param> 
<listener> 
    <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> 
</listener>

③ 可以通过资源类对资源文件进行加载，与使用为一体

public  class TestLog4j  {
    public  static  void main(String[] args)  {
        PropertyConfigurator.configure( " D:/Code/conf/log4j.properties " );
        Logger logger = Logger.getLogger(TestLog4j.class.getName());
        logger.debug( " debug " );
        logger.error( " error " );
    } 
}

在程序中的使用

使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：

public static Logger getLogger(String name)

通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：

static Logger logger = Logger.getLogger(ServerWithLog4j.class.getName());

注：推荐使用slf4j结合log4j进行日志记录。