Java log4j详细教程

什么是log4j

log4j是一种用于记录Java日志的流行框架，它允许开发人员在应用程序中添加灵活的、可配置的日志记录，并支持若干输出目标。

如何使用log4j

步骤一：将log4j库添加到项目中

在项目中添加log4j库有以下两种方法：

1. 将log4j包含在项目的Classpath路径下
2. 在Maven或Gradle等构建工具中添加log4j的依赖

步骤二：创建log4j.properties配置文件

log4j.properties是log4j用于初始化日志器和布局器的配置文件，我们需要根据需要对其进行修改，例如设置日志级别、输出位置等。以下是一组示例配置：

log4j.rootLogger=DEBUG, stdout

#控制台输出的日志格式
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy/MM/dd HH:mm:ss.SSS} [%t] %-5p %c - %m%n

#名称为testLogger的日志记录器，仅记录DEBUG级别以上的日志信息到dailyFile中
log4j.logger.testLogger=DEBUG, dailyFile

#每天产生一个日志文件，文件名中的日期格式为yyyy-MM-dd
log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.File=D:\\logs\\test.log
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
log4j.appender.dailyFile.layout.ConversionPattern=%d{yyyy/MM/dd HH:mm:ss.SSS} [%t] %-5p %c - %m%n

步骤三：在Java代码中使用log4j

import org.apache.log4j.Logger;

public class Test {
    private static Logger logger = Logger.getLogger(Test.class);

    public static void main(String[] args) {
        logger.debug("Debug level message.");
        logger.info("Info level message.");
        logger.warn("Warn level message.");
        logger.error("Error level message.");
        logger.fatal("Fatal level message.");
    }
}

以上代码创建了一个名为"Test"的类，并使用了log4j中的Logger类，logger的级别依次为debug、info、warn、error、fatal。这些日志级别依次递增，例如WARN级别及以上级别的日志会被输出到console和dailyFile中。

log4j的几个核心组件

Logger

Logger是log4j的核心类之一，用于记录不同级别的日志信息。

一般来讲，我们为每个需要记录日志的类创建一个Logger对象，Logger对象的名称通常使用类全名，对应了配置文件中的logger部分。

日志级别（从高到低）分别为：FATAL、ERROR、WARN、INFO、DEBUG。通常，我们需要配置一个root logger，以便它能够捕获所有的消息。

Appender

Appender用于将不同级别的日志输出到指定的位置。例如，我们可以将所有级别的日志发送到控制台、文件、系统日志或邮件。

常见的几种Appender有：

• ConsoleAppender：控制台输出的Appender
• FileAppender：文件输出的Appender
• SMTPAppender：邮件发送的Appender
• SocketAppender：套接字输出的Appender

Layout

Layout用于控制日志记录器输出的格式。例如，我们可以将日志以JSON格式输出或XML格式输出，以便我们可以更轻松地搜索和分析日志。

常见的几种Layout有：

• PatternLayout：以指定模式格式化字符串的Layout
• HTMLLayout：以HTML格式布局的Layout
• SimpleLayout：以简单格式布局的Layout

示例1

假设我们有一个需求，需要记录一个类中的所有函数的调用和返回时所用的时间戳，并将其输出到文件中。

首先，我们需要创建一个新的Appender：

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

import java.io.IOException;
import java.io.Writer;

public class TimestampAppender extends WriterAppender {
    @Override
    public void append(LoggingEvent event) {
        //记录方法调用和返回时间戳，并输出到文件中
        long timestamp = System.currentTimeMillis();
        String msg = event.getRenderedMessage();
        msg = timestamp + " | " + msg;
        try {
            Writer writer = getWriter();
            writer.write(msg);
            writer.write("\n");
            writer.flush();
        } catch (IOException e) {
            errorHandler.error("Error writing to writer.", e, ErrorCode.WRITE_FAILURE);
        }
    }
}

其中，我们继承了WriterAppender类并覆盖了其append方法，添加了输出时间戳的逻辑。

接着，我们创建一个新的Layout：

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

public class TimestampPatternLayout extends PatternLayout {
    @Override
    public String format(LoggingEvent event) {
        //在日志消息前加入时间戳
        long timestamp = System.currentTimeMillis();
        String msg = super.format(event);
        return timestamp + " | " + msg;
    }
}

在这个Layout中，我们继承了PatternLayout类，覆盖了了format方法，添加了输出时间戳的逻辑。

最后，在配置文件中添加以下内容：

log4j.rootLogger=DEBUG, FILE
log4j.appender.FILE=com.example.TimestampAppender
log4j.appender.FILE.layout=com.example.TimestampPatternLayout
log4j.appender.FILE.File=D:\\log.log

以上配置将日志记录到D:\log.log文件中，日志消息被格式化为时间戳加上消息。

示例2

假设我们需要将日志存储到数据库中，并添加下一步操作时需要知道上一个日志记录的ID，我们可以通过log4j提供的NDC（Nested Diagnostic Context）来实现。NDC是一个堆栈，每个线程都拥有自己的NDC。

在应用程序中，我们可以通过调用NDC.push（）方法将新的值添加到NDC中；通过调用NDC.get（）方法获取NDC堆栈顶部的当前值。以下是配置文件：

log4j.rootLogger=debug, DB
log4j.appender.DB=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.DB.Threshold=debug
log4j.appender.DB.URL=jdbc:postgresql://localhost:5432/testlogdb
log4j.appender.DB.driver=org.postgresql.Driver
log4j.appender.DB.user=myuser
log4j.appender.DB.password=mypassword
log4j.appender.DB.layout=org.apache.log4j.PatternLayout
log4j.appender.DB.layout.ConversionPattern=[%p] [%t] [%d] [%c] [[%X{ID}]]-[%m]%n

以上配置将日志记录到PostgreSQL数据库中，日志消息旁边的方括号中是NDC堆栈顶部的当前值。

在Java代码中，我们可以通过以下方式设置NDC：

NDC.push("123456");
logger.info("Message");
NDC.remove();

以上代码会将123456添加到NDC堆栈，然后记录一个信息，最后将NDC堆栈顶部的元素删除。

总结

这篇文章介绍了log4j的基本概念和使用方法，并提供了两个示例，同时还介绍了log4j的几个核心组件，包括Logger、Appender和Layout。了解了这些内容，相信你已经可以在你的项目中使用log4j来记录日志了。