Log4j详细教程

一、简单的使用Log4j日志

1，新建一个Java工程，导入包log4j-1.2.17.jar，目录如下：

2，src同级创建并设置log4j.properties

### 把指定级别的日志信息输出到指定的一个或者多个位置###

### 把DEBUG层级以及以上的信息输出到console，all，error，interface###

log4j.rootLogger=DEBUG,console,all,interface,error

### 编码格式###

log4j.appender.encoding="utf-8"

### 输出信息到控制抬 ###

log4j.appender.console=org.apache.log4j.ConsoleAppender

log4j.appender.console.target=System.out

log4j.appender.console.layout=org.apache.log4j.PatternLayout

log4j.appender.console.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss} [%p] %c{2}:%L - [%M]%m%n

### 输出所有级别的日志到logs/all.log ###

log4j.appender.all=org.apache.log4j.DailyRollingFileAppender

log4j.appender.all.file=logs/all.log

log4j.appender.all.DatePattern='.'yyyy-MM-dd

log4j.appender.all.layout=org.apache.log4j.PatternLayout

log4j.appender.all.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss} [%p] %c{2}:%L - [%M]%m%n

### 输出INFO 级别以上的日志到logs/info.log ###

log4j.appender.interface=org.apache.log4j.DailyRollingFileAppender

log4j.appender.interface.file=logs/info.log

log4j.appender.interface.Threshold=INFO

log4j.appender.interface.DatePattern='.'yyyy-MM-dd

log4j.appender.interface.layout=org.apache.log4j.PatternLayout

log4j.appender.interface.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss} [%p] %c{2}:%L - [%M]%m%n

### 输出ERROR 级别以上的日志到logs/error.log ###

log4j.appender.error=org.apache.log4j.DailyRollingFileAppender

log4j.appender.error.file=logs/error.log

log4j.appender.error.Threshold=ERROR

log4j.appender.error.DatePattern='.'yyyy-MM-dd

log4j.appender.error.layout=org.apache.log4j.PatternLayout

log4j.appender.error.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss} [%p] %c{2}:%L - [%M]%m%n

3、创建Test类，如下

/**
 * 
 * @类名称：Test
 * @类描述：测试
 * @创建人：zender
 */
public class Test {
    private static Logger log = Logger.getLogger(Test.class);
    public static void main(String[] args) {
        // 记录debug级别的信息  
        log.debug("这是 debug 信息.");  
        // 记录info级别的信息  
        log.info("这是 info 信息.");  
        // 记录error级别的信息  
        log.error("这是 error 信息.");  
    }
}

4，输出结果

控制台：

文件：

All.log

Error.log

Info.log

二、Log4j日志级别

每个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)将不会被打印出来。

三、Log4j配置文件

Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。

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

1，配置根Logger：log4j.rootLogger

语法：

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

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

Log4j建议只使用四个级别，优 先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。

比如：定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。 appenderName就是指日志信息输出到哪个地方。您可以同时指定多个输出目的地。第一个例子就自定义了console,all,interface,error4个输出目的地。

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

log4j.appender.appenderName = fully.qualified.name.of.appender.class

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

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

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class

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（包含日志产生的时间、线程、类别等等信息）

Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，常用打印参数如下：

%m 输出代码中指定的消息

%M 显示调用logger的方法名

%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)

4，读取配置文件：

BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。

PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。

DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

例如：

### 输出信息到控制抬 ###

log4j.appender.console=org.apache.log4j.ConsoleAppender

###控制台输出###

log4j.appender.console.target=System.out

###可以灵活地指定布局模式###

log4j.appender.console.layout=org.apache.log4j.PatternLayout

### 输出信息的格式 ###

log4j.appender.console.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss} [%p] %c{2}:%L - [%M]%m%n

   

### 每天产生一个日志文件 ###

log4j.appender.all=org.apache.log4j.DailyRollingFileAppender

### 日志输出的到文件：logs/all.log ###

log4j.appender.all.file=logs/all.log

###Log4j会先生成all.log这样一个文件，然后当这一天过去的时候，生成一个新的all.log，然后把原来的保存为加上日期格式后缀的文件###

log4j.appender.all.DatePattern='.'yyyy-MM-dd

###可以灵活地指定布局模式###

log4j.appender.all.layout=org.apache.log4j.PatternLayout

### 输出信息的格式 ###

log4j.appender.all.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss} [%p] %c{2}:%L - [%M]%m%n

四、Web环境中使用Log4j

在WEB应用使用Log4j，必须先在启动服务时加载Log4j的配置文件进行初始化，可以在web.xml中进行。

1，使用InitServlet ,设置令其自启动来初始化 Log4j 。

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

（2）PathUtils类，用来获取WEB应用路径

/**
 * 
 * @类名称：PathUtils
 * @类描述：获取web应用路径
 * @创建人：zender
 */
public class PathUtils {
    private static String webroot = null;
    static {
        webroot = getWebrootPath();
    }
 
    private final static String getWebrootPath() {
        String root = PathUtils.class.getResource("/").getFile();
        try {
            root = new File(root).getParentFile().getParentFile().getCanonicalPath();
            root += File.separator;
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return root;
    }
 
    /**
     * 返回Web应用的路径
     * @return
     */
    public static String webRoot() {
        return webroot;
    }
}

（3）InitServlet类，用来初始化Log4j

/**
 * 
 * @类名称：InitServlet
 * @类描述：初始化Log4j
 * @创建人：zender
 */
public class InitServlet extends HttpServlet {
    private static final long serialVersionUID = -9074849844731671080L;
    static {
        // 获取web应用路径
        String root = PathUtils.webRoot();
        String logFilesPath = root + "WEB-INF" + File.separator;
        System.setProperty("logFilesPath", logFilesPath);
    }
 
    @Override
    public void init() throws ServletException {
        System.out.println("InitServlet 正在初始化 log4j日志设置信息.");
        super.init();
        String prefix = getServletContext().getRealPath("/");
        String log4jFile = getServletConfig().getInitParameter("log4j");
        // 获取Log4j配置文件路径
        String log4jConfigPath = prefix + log4jFile;
        // 设置Log4j配置文件
        PropertyConfigurator.configure(log4jConfigPath);
    }
}

（4）配置文件log4j.properties

### 把指定级别的日志信息输出到指定的一个或者多个位置###

### 把DEBUG层级以及以上的信息输出到console,all，error###

log4j.rootLogger=DEBUG,console,all,error

   

### 编码格式###

log4j.appender.encoding="utf-8"

   

### 输出信息到控制抬 ###

log4j.appender.console=org.apache.log4j.ConsoleAppender

log4j.appender.console.target=System.out

log4j.appender.console.layout=org.apache.log4j.PatternLayout

log4j.appender.console.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss} [%p] %c{2}:%L - [%M]%m%n

   

### 输出所有级别的日志到logs/all.log ###

log4j.appender.all=org.apache.log4j.DailyRollingFileAppender

log4j.appender.all.file=${logFilesPath}/logs/all.log

log4j.appender.all.DatePattern='.'yyyy-MM-dd

log4j.appender.all.layout=org.apache.log4j.PatternLayout

log4j.appender.all.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss} [%p] %c{2}:%L - [%M]%m%n

   

### 输出ERROR 级别以上的日志到logs/error.log ###

log4j.appender.error=org.apache.log4j.DailyRollingFileAppender

log4j.appender.error.file=${logFilesPath}/logs/error.log

log4j.appender.error.Threshold=ERROR

log4j.appender.error.DatePattern='.'yyyy-MM-dd

log4j.appender.error.layout=org.apache.log4j.PatternLayout

log4j.appender.error.layout.ConversionPattern=%d{yy/MM/dd HH:mm:ss} [%p] %c{2}:%L - [%M]%m%n

（5）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>Log4jWeb</display-name>
    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.htm</welcome-file>
        <welcome-file>index.jsp</welcome-file>
        <welcome-file>default.html</welcome-file>
        <welcome-file>default.htm</welcome-file>
        <welcome-file>default.jsp</welcome-file>
    </welcome-file-list>
 
    <servlet>
        <servlet-name>initServlet</servlet-name>
        <servlet-class>com.zender.servlet.InitServlet</servlet-class>
        <init-param>
            <param-name>log4j</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>initServlet</servlet-name>
        <url-pattern>/initServlet.do</url-pattern>
    </servlet-mapping>
</web-app>

（5）调用日志Log4JTestServlet类

/**
 * 
 * @类名称：Log4JTestServlet
 * @类描述：测试Log4j的Servlet
 * @创建人：zender
 */
@WebServlet("/log4JTestServlet")
public class Log4JTestServlet extends HttpServlet {
    private static final long serialVersionUID = 8827404827021162856L;
    private static Logger log = Logger.getLogger(Log4JTestServlet.class);
 
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doPost(req, resp);
    }
 
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 记录debug级别的信息
        log.debug("这是 debug 信息.");
        // 记录info级别的信息
        log.info("这是 info 信息.");
        // 记录error级别的信息
        log.error("这是 error 信息.");
        resp.setCharacterEncoding("UTF-8");
        PrintWriter out = resp.getWriter();
        out.write("访问成功！");
    }
}

（6）启动WEB项目访问：http://localhost:8080/Log4jWeb/log4JTestServlet

控制台打印：

日志文件：

All.log

Error.log

2，通过监听器 ServletContextListener 监听 ServletContext 的初始化事件来初始化 Log4j 

（1）创建MyServletContextListener监听器

/**
 * 
 * @类名称：MyServletContextListener
 * @类描述：用于初始化log4j监听器
 * @创建人：zender
 */
public class MyServletContextListener implements ServletContextListener {
    static {
        // 获取web应用路径
        String root = PathUtils.webRoot();
        String logFilesPath = root + "WEB-INF" + File.separator;
        System.setProperty("logFilesPath", logFilesPath);
    }
    
    @Override
    public void contextDestroyed(ServletContextEvent arg0) {
    }
 
    @Override
    //初始化方法
    public void contextInitialized(ServletContextEvent arg0) {
        System.out.println("MyServletContextListener 正在初始化 log4j日志设置信息.");
        ServletContext ctx = arg0.getServletContext();
        String prefix = ctx.getRealPath("/");
        String log4jFile = ctx.getInitParameter("log4j");
        //// 获取Log4j配置文件路径
        String log4jConfigPath = prefix + log4jFile;
        //// 设置Log4j配置文件
        PropertyConfigurator.configure(log4jConfigPath);
    }
}

（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>Log4jWeb</display-name>
    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.htm</welcome-file>
        <welcome-file>index.jsp</welcome-file>
        <welcome-file>default.html</welcome-file>
        <welcome-file>default.htm</welcome-file>
        <welcome-file>default.jsp</welcome-file>
    </welcome-file-list>
    
    <context-param>
        <param-name>log4j</param-name>
        <param-value>/WEB-INF/classes/log4j.properties</param-value>
    </context-param>
    <!-- 用于初始化log4j的监听器 -->
    <listener>
        <listener-class>com.zender.listener.MyServletContextListener</listener-class>
    </listener>
</web-app>

（3）启动WEB项目访问：http://localhost:8080/Log4jWeb/log4JTestServlet

控制台打印：

日志文件：

All.log

Error.log