log4j的使用详细解析

更新时间：2013年08月30日 10:06:53 作者：

最近在整理公司产品的日志输出规范，涉及log4j的使用介绍，就简单整理了一下。需要的朋友可以过来参考参考

1 Log4j配置说明

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

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

•xml文件
•properties文件（推荐）
下面是一个log4j配置文件的完整内容：

log4j.rootCategory=INFO, stdout
log4j.rootLogger=info, stdout

### stdout ###
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=%d{ABSOLUTE} %5p - %m%n

### set package ###
log4j.logger.org.springframework=info
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
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主要定义日志信息输出在什么位置，主要语法为：

复制代码代码如下:

log4j.appender.appenderName = classInfo
log4j.appender.appenderName.option1 = value1
　　…
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为例，如：

复制代码代码如下:

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

1.4 配置日志信息的格式Layout
Layout 负责格式化Appender的输出，其语法为：

复制代码代码如下:

log4j.appender.appenderName.layout = classInfo
log4j.appender.appenderName.layout.option1 = value1
…
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为日志级别，例如：

复制代码代码如下:

log4j.logger.org.springframework=info
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.chb.test=debug

2 Log4j与J2ee结合

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

2.1.1 定义log4j配置文件

复制代码代码如下:

log4j.rootCategory=INFO, stdout
log4j.rootLogger=info, stdout

### stdout ###
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=%d{ABSOLUTE} %5p - %m%n

### log to file ###
log4j.logger.org.springframework=info
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.chb.test=debug

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

复制代码代码如下:

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4"
    xmlns="http://java.sun.com/xml/ns/j2ee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
    http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">

    <!--由Spring载入的Log4j配置文件位置-->
    <context-param>
       <param-name>log4jConfigLocation</param-name>
       <param-value>/WEB-INF/log4j.properties</param-value>
    </context-param>

    <context-param>
       <param-name>contextConfigLocation</param-name>
       <param-value>
           /WEB-INF/classes/applicationContext*.xml
       </param-value>
    </context-param>

    <!--Spring log4j Config loader-->
    <listener>
       <listener-class>
           org.springframework.web.util.Log4jConfigListener
       </listener-class>
    </listener>

    <listener>
       <listener-class>
           org.springframework.web.context.ContextLoaderListener
       </listener-class>
    </listener>

    <servlet>
       <servlet-name>InitiaServlet</servlet-name>
    <servlet-class>chb.test.web.InitiaServlet</servlet-class>
       <load-on-startup>1</load-on-startup>
    </servlet>

  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
</web-app>

2.1.3 测试类

复制代码代码如下:

package com.dheaven.mip.web;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;

import org.apache.log4j.Logger;

public class InitiaServlet extends HttpServlet {

    protected Logger log = Logger.getLogger(InitiaServlet.class);

    private static final long serialVersionUID = 8550329576989690578L;

    /**
     * Constructor of the object.
     */
    public InitiaServlet() {
       super();
    }

    /**
     * Destruction of the servlet. <br>
     */
    public void destroy() {
       super.destroy();
    }

    /**
     * Initialization of the servlet. <br>
     *
     * @throws ServletException if an error occure
     */
    public void init() throws ServletException {
       log.debug("服务器启动了，log4j开始工作了");
    }
}

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

2.2.1 定义log4j配置文件
放在web工程的WEB-INF目录下，内容如：

复制代码代码如下:

log4j.rootCategory=INFO, stdout
log4j.rootLogger=info, stdout

### stdout ###
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=%d{ABSOLUTE} %5p - %m%n

### set package ###
log4j.logger.org.apache.catalina=info
log4j.logger.org.apache.commons.digester.Digester=info
log4j.logger.org.apache.catalina.startup.TldConfig=info
log4j.logger.com.dheaven=debug

2.2.2 创建log4j初始化类

复制代码代码如下:

package com.dheaven.mip.web;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;

import org.apache.log4j.PropertyConfigurator;

public class InitLog4j extends HttpServlet {

    private static final long serialVersionUID = 1L;

    public void init() throws ServletException {
       String prefix = getServletContext().getRealPath("/");
       prefix = prefix.replace("//", "/");
       String file = getInitParameter("log4j-init-file");
       // if the log4j-init-file is not set, then no point in trying
       if (file != null) {
           PropertyConfigurator.configure(prefix + file);
       }
    }
}

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

复制代码代码如下:

    <servlet>
       <servlet-name>log4j-init</servlet-name>
       <servlet-class>chb.test.web.InitLog4j</servlet-class>

       <init-param>
           <param-name>log4j-init-file</param-name>
           <param-value>WEB-INF/log4j.properties</param-value>
       </init-param>

       <load-on-startup>1</load-on-startup>
    </servlet>

2.2.4 测试类

复制代码代码如下:

package chb.test.web;

 
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;

import org.apache.log4j.Logger;

public class InitiaServlet extends HttpServlet {

    protected Logger log = Logger.getLogger(InitiaServlet.class);

    private static final long serialVersionUID = 8550329576989690578L;

    /**
     * Constructor of the object.
     */
    public InitiaServlet() {
       super();
    }

    /**
     * Destruction of the servlet. <br>
     */
    public void destroy() {
       super.destroy();
    }

    /**
     * Initialization of the servlet. <br>
     *
     * @throws ServletException if an error occure
     */
    public void init() throws ServletException {
       log.debug("服务器启动了，log4j开始工作了");
    }
}

您可能感兴趣的文章:

log4j
使用

Java根据前端返回的字段名进行查询数据的实现方法
在Java后端开发中,我们经常需要根据前端传递的参数（如字段名）来动态查询数据库中的数据,这种需求通常出现在需要实现通用查询功能或者复杂查询接口的场景中,所以本文介绍了Java根据前端返回的字段名进行查询数据的实现方法,需要的朋友可以参考下
2024-12-12
Java编程一个随机数产生模块代码分享
这篇文章主要介绍了Java编程一个随机数产生模块代码分享,具有一定借鉴价值，需要的朋友可以参考下。
2017-12-12
IDEA如何对多线程进行debug的示例详解
开发中使用到多线程的时候不少,但是debug起来还是比较困难的,因为默认每次只会进入一个线程,这样有些问题是发现不了的,其实IDEA也是支持进入每个线程来debug的,本文给大家介绍了IDEA如何对多线程进行debug的示例,需要的朋友可以参考下
2024-05-05
Apache Commons BeanUtils: JavaBean操作方法
这篇文章主要介绍了Apache Commons BeanUtils: JavaBean操作的艺术,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-12-12
Java ProcessBuilder执行多次CMD命令的使用
本文介绍了Java的ProcessBuilder类,该类用于执行外部命令,通过ProcessBuilder,我们可以在Java程序中灵活地执行多次CMD命令,并控制输入输出流以及工作目录等,感兴趣的可以了解一下
2024-11-11
Spring中使用自定义ThreadLocal存储导致的坑及解决
这篇文章主要介绍了Spring中使用自定义ThreadLocal存储导致的坑及解决，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-12-12
ConstraintValidator类如何实现自定义注解校验前端传参
这篇文章主要介绍了ConstraintValidator类实现自定义注解校验前端传参的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-06-06
SpringBoot下载文件的正确解法方式
这篇文章主要给大家介绍了关于SpringBoot下载文件的正确解法方式,SpringBoot是一款流行的框架,用于开发Web应用程序,在使用SpringBoot构建Web应用程序时,可能需要实现文件下载的功能,需要的朋友可以参考下
2023-08-08
springMVC发送邮件的简单实现
本篇文章主要介绍了springMVC发送邮件的简单实现，主要是利用利用javax.mail发送邮件，图片与附件都可发送，有兴趣的可以了解一下
2017-04-04
Springboot 中使用Sentinel的详细步骤
文章介绍了如何在SpringBoot中使用Sentinel进行限流和熔断降级,首先添加依赖,配置Sentinel控制台地址,定义受保护的资源,配置流控规则,启动Sentinel控制台和SpringBoot应用,最后测试和监控,感兴趣的朋友一起看看吧
2025-02-02

log4j的使用详细解析

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具