史上最详细log4j使用文档

日志是应用软件中不可缺少的部分，Apache的开源项目log4j是一个功能强大的日志组件,提供方便的日志记录。在apache网站：jakarta.apache.org/log4j 可以免费下载到Log4j最新版本的软件包。

一、入门实例

1.新建一个JAva工程，导入包log4j-1.2.17.jar，整个工程最终目录如下

2、src同级创建并设置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### 输出DEBUG 级别以上的日志到=E://logs/error.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = E://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### 输出ERROR 级别以上的日志到=E://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =E://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

3、设置日志内容

package com.mucfc;
import org.apache.log4j.Logger;
/***@author linbingwen*@2015年5月18日9:14:21*/
public class Test {private static Logger logger = Logger.getLogger(Test.class);  /** * @param args */  public static void main(String[] args) {  // System.out.println("This is println message.");  // 记录debug级别的信息  logger.debug("This is debug message.");  // 记录info级别的信息  logger.info("This is info message.");  // 记录error级别的信息  logger.error("This is error message.");  }  }

4、输出结果

（1）首先是控制台的信息

（2）再来看输出的文件

内容如下，发现已按照要求输出到对应的文档中去了。

二、Log4j基本使用方法

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

2.1、定义配置文件

其实您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件（键=值）。下面我们介绍使用Java特性文件做为配置文件的方法：
1.配置根Logger，其语法为：

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

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

2.配置日志信息输出目的地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（将日志信息以流格式发送到任意指定的地方）

3.配置日志信息的格式（布局），其语法为：

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

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

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

Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下： %m 输出代码中指定的消息

%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
%r 输出自应用启动到输出该log信息耗费的毫秒数
%c 输出所属的类目，通常就是所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”
%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

2.2、在代码中使用Log4j

1.得到记录器

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

public static Logger getLogger( String name)

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

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

2.读取配置文件

当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：

BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

3.插入记录信息（格式化日志信息）

当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：

Logger.debug ( Object message ) ;
Logger.info ( Object message ) ;
Logger.warn ( Object message ) ;
Logger.error ( Object message ) ;

2.3、日志级别

每个Logger都被了一个日志级别（log level），用来控制日志信息的输出。日志级别从高到低分为：
A：off 最高等级，用于关闭所有日志记录。
B：fatal 指出每个严重的错误事件将会导致应用程序的退出。
C：error 指出虽然发生错误事件，但仍然不影响系统的继续运行。
D：warm 表明会出现潜在的错误情形。
E：info 一般和在粗粒度级别上，强调应用程序的运行全程。
F：debug 一般用于细粒度级别上，对调试应用程序非常有帮助。
G：all 最低等级，用于打开所有日志记录。

上面这些级别是定义在org.apache.log4j.Level类中。Log4j只建议使用4个级别，优先级从高到低分别是error,warn,info和debug。通过使用日志级别，可以控制应用程序中相应级别日志信息的输出。例如，如果使用b了info级别，则应用程序中所有低于info级别的日志信息(如debug)将不会被打印出来。

三、Web项目中使用Log4j实例

上面代码描述了Log4j的简单应用，其实使用Log4j也就是这样简单方便。当然除了上面的配置方法，还有其它，比如做一个J2EE应用，在J2EE应用使用Log4j，必须先在启动服务时加载Log4j的配置文件进行初始化，可以在web.xml中进行。

1、web应用的log4j使用基本上都采用：新建一个servlet，这个servlet在init函数中为log4j执行配置。一般就是读入配置文件。所以需要在web.xml中为这个servlet配置，同时设定load-on-startup为1。

2、这个servlet配置log4j就是读出配置文件，然后调用configure函数。这里有两个问题：一、需要知道文件在哪里；二、需要正确的文件类型

3、配置文件位置在web.xml中配置一个param即可，路径一般是相对于web的root目录

4、文件类型一般有两种，一个是Java的property文件，另一种是xml文件

配置文件的大致内容：log4j可以指定输出的log级别的最低等级，以及log的输出配置格式，每个log可以指定多个输出方式

（1）创建Web工程，整个工程最后目录如下

（2）web.xml配置如下：

<?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">  <display-name>LogLearning</display-name>  <servlet>  <servlet-name>Log4JTestServlet</servlet-name>  <servlet-class>com.mucfc.Log4JTestServlet</servlet-class>  </servlet>  <!--用来启动 log4jConfigLocation的servlet -->  <servlet>  <servlet-name>Log4JInitServlet</servlet-name>  <servlet-class>com.mucfc.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>Log4JTestServlet</servlet-name>  <url-pattern>/test</url-pattern>  </servlet-mapping>  </web-app>

（3）配置文件log4j.properties

 ### set log levels ###
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

（4）web容器一来就初始化的servlet

Log4JInitServlet.java

package com.mucfc;  import java.io.File;
import java.io.IOException;  import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;  import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.PropertyConfigurator;  /** * Servlet implementation class Log4JInitServlet */
@WebServlet("/Log4JInitServlet")
public class Log4JInitServlet extends HttpServlet {  private static final long serialVersionUID = 1L;  /** * @see HttpServlet#HttpServlet() */  public Log4JInitServlet() {  super();  // TODO Auto-generated constructor stub  }  /** * @see Servlet#init(ServletConfig) */  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);  }  /** * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response) */  protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {  // TODO Auto-generated method stub  }  /** * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response) */  protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {  // TODO Auto-generated method stub  }  }

调用日志Log4JTestServlet,java

package com.mucfc;  import java.io.IOException;  import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;  import org.apache.log4j.Logger;  /** * Servlet implementation class Log4JTestServlet */
@WebServlet("/Log4JTestServlet")
public class Log4JTestServlet extends HttpServlet {  private static final long serialVersionUID = 1L;  private static Logger logger = Logger.getLogger(Log4JTestServlet.class);    /** * @see HttpServlet#HttpServlet() */  public Log4JTestServlet() {  super();  // TODO Auto-generated constructor stub  }  /** * @see Servlet#init(ServletConfig) */  public void init(ServletConfig config) throws ServletException {  // TODO Auto-generated method stub  }  /** * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response) */  protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {  // 记录debug级别的信息    logger.debug("This is debug message.");    // 记录info级别的信息    logger.info("This is info message.");    // 记录error级别的信息    logger.error("This is error message.");    }  /** * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response) */  protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {  doGet(request,response);  }  }

接下来就是运行了，来看看结果：

输出结果：

四、Spring中使用Log4j

这里要实现web项目中利用Spring来使用Log4j

（1）接上面的工程，然后再导入Spring的包

（2）web.xml增加

<!-- 设置根目录 -->  <context-param>    <param-name>webAppRootKey</param-name>    <param-value>webapp.root</param-value>    </context-param>    <context-param>  <param-name>log4jConfigLocation</param-name>  <param-value>/WEB-INF/classes/log4j.properties</param-value>
</context-param>
<!-- 3000表示 开一条watchdog线程每60秒扫描一下配置文件的变化;这样便于日志存放位置的改变 -->
<context-param>    <param-name>log4jRefreshInterval</param-name>    <param-value>3000</param-value>    </context-param>
<listener>  <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>

整个内容如下：

<?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">  <display-name>LogLearning</display-name>  <servlet>  <servlet-name>Log4JTestServlet</servlet-name>  <servlet-class>com.mucfc.Log4JTestServlet</servlet-class>  </servlet>  <!--用来启动 log4jConfigLocation的servlet -->
<!--     <servlet>  <servlet-name>Log4JInitServlet</servlet-name>  <servlet-class>com.mucfc.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>Log4JTestServlet</servlet-name>  <url-pattern>/test</url-pattern>  </servlet-mapping>   <!-- Spring 容器加载 -->  <listener>  <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  </listener>  <context-param>  <param-name>contextConfigLocation</param-name>  <param-value>classpath:applicationContext.xml</param-value>  </context-param>   <!-- 设置根目录 -->  <context-param>    <param-name>webAppRootKey</param-name>    <param-value>webapp.root</param-value>    </context-param>    <context-param>  <param-name>log4jConfigLocation</param-name>  <param-value>/WEB-INF/classes/log4j.properties</param-value>  </context-param>  <!-- 3000表示 开一条watchdog线程每60秒扫描一下配置文件的变化;这样便于日志存放位置的改变 -->  <context-param>    <param-name>log4jRefreshInterval</param-name>    <param-value>3000</param-value>    </context-param>   <listener>  <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>  </listener>   </web-app>

这里Log4JInitServlet.java就相当于没用到了。

（2）applicationContext.xml

没有内容：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"  xmlns:aop="http://www.springframework.org/schema/aop"  xsi:schemaLocation="    http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-3.2.xsdhttp://www.springframework.org/schema/aophttp://www.springframework.org/schema/aop/spring-aop-3.2.xsdhttp://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context-3.2.xsd">
</beans>

（3）这样日志就跟随Spring窗口启动而启动了

程序一运行，就会自动把日志打印

log.log

error.log为空，因为它只打印error级别以上的信息

浏览器输入http://localhost:8080/LogLearning2/test

然后打开文件

五、使用Log4j输出日志到数据库

因为项目保密性要求，需要将用户在前端的每一个查询操作都记录下来，以方便出问题之后进行问题定位。输出目的地有两个：

1、输出到文件。然后使用日志分析工具对日志进行分析

2、输出到数据库。可以更方便的查询统计分析

log4j.properties 关于数据库的配置###保存至数据库### rootCategory 旧；rootLogger 新=rootCategory的子类##定义输出sql语句到控制台，文件，数据库(仅供样式参考，实际由于输出info级别的，此处定义debug无法输出)##log4j.rootCategory=ERROR,A3log4j.logger.Java.sql.Connection=debuglog4j.logger.java.sql.Statement=debuglog4j.logger.java.sql.PreparedStatement=debug,stdout,D,E,A3##定义sql语句输入到stdout控制台，DE文件，A3数据库，sql语句是debug级别的，而一开始定义的rootlogger是info级别的，所以这里其实定义不起什么作用；如果要sql语句输出到控制台，可以将rootlogger设置为debug级别输出#定义A3输出到数据库log4j.appender.A3=org.apache.log4j.jdbc.JDBCAppenderlog4j.appender.A3.URL=jdbc\:sqlserver\://127.0.0.1\:53565;DatabaseName\=PDFPlog4j.appender.A3.driver=com.microsoft.sqlserver.jdbc.SQLServerDriverlog4j.appender.A3.user=salog4j.appender.A3.password=000000#定义A3的布局和执行的SQL语句log4j.appender.A3.Append = truelog4j.appender.A3.Threshold = WARNlog4j.appender.A3.layout=org.apache.log4j.PatternLayoutlog4j.appender.A3.layout.ConversionPattern=INSERT INTOTPDFLOG(CREATEDATE,THREAD,GRADE,CLASS,MESSAGE,PID,CURRENTSTATE) values('%d','%t','%-5p','%c','%m','%X{pid}',%X{currentstate})

输出日志到数据库

注意，开头log4j.rootLogger = info,stdout,D,E,A3定义了输出info级别到stdout控制台，D,E日志文本，A3数据库，但是在定义输出到A3数据库时，又定义了：log4j.appender.A3.Threshold = WARN表示最低输出级别；

也就是说：开头一句定义了info级别以上的输出到A3，后来又特定对A3定义了最低输出级别为WARN，实际上只有WARN以上级别的日志才会输出给A3；可以理解为，rootlogger是一般性定义，而threshold是特定性定义，实际级别是输出2者重叠的部分！

在异常表里面自定义字段

如果想异常表与业务表关联起来，必须在异常表类添加与业务表关联的自定义字段；

INSERT INTO

TPDFLOG(CREATEDATE,THREAD,GRADE,CLASS,MESSAGE,PID,CURRENTSTATE) values('%d','%t','%-5p','%c','%m','%X{pid}',%X{currentstate})

注意，pid，和currentstate是要在日志在输入给数据库之前，必须先设置好，在logger.ERROR(“…”)之前：

MDC.put("pid", pid);

MDC.put("currentstate", 1);//1准备 2生成PDF 3上传 4归档

这里用到了MDC,一开始在MDC里面存入这2个自定义字段的值，之后当捕获到异常时，log4j根据级别准备执行上述sql语句以存储信息到数据库中对应的数据表，PID,CURRENTSTATE就是自定义的字段，sql语句中从MDC取值为'%X{pid}'，%X{currentstate}，前者string，后者Integer；

Ps：MESSAGE是当你在java中执行logger.ERROR(“相关信息”)时，ERROR括号中的部分，也就是’%m’, 其他的

'%d','%t','%-5p','%c'同理，log4j会自动取值；

因为sql语句中要从MDC中的自定义字段取值，所以当你logger.error准备存储日志给数据库之前，必须保证MDC

有对应的自定义字段的key-value，如果没有设置，那么在log4j存储到数据库时，会执行sql异常导致存储到数据库失败；