Java应用在 Java 中使用Log4j/Logback进行日志记录和调试

Posted 2023-03-01

如果您觉得本博客的内容对您有所帮助或启发，请关注我的博客，以便第一时间获取最新技术文章和教程。同时，也欢迎您在评论区留言，分享想法和建议。谢谢支持！

相关阅读：

​​Java应用【六】Java 反射：动态类加载和调用教程​​

​​Java应用【七】使用Java实现数据结构和算法：排序、查找、图​​

​​Java应用【八】使用网络编程进行 socket 通信​​

【使用Log4j】

一、介绍

1. Log4j是什么？

Log4j是一个Java日志框架，它允许开发人员记录应用程序中发生的事件。它具有非常灵活的配置选项，可以将日志消息发送到不同的目标（如文件、控制台、数据库、syslog等）并使用各种格式进行格式化。Log4j是Apache Software Foundation的一个开源项目，现在已经发布了多个版本，最新的版本是Log4j 2.x。

2. 为什么要使用Log4j？

日志记录是一种重要的调试和排除错误的方法，它可以帮助开发人员在应用程序中识别问题。使用Log4j可以使开发人员更轻松地进行日志记录，并提供了许多功能，如灵活的配置选项和输出目标，以及记录日志消息的不同级别。此外，Log4j是一个广泛使用的日志框架，具有丰富的社区支持和广泛的文档资料。

3. Log4j的核心组件

Log4j的核心组件包括Logger、Appender、Layout和Filter。

• Logger：日志记录器，用于记录日志消息。
• Appender：用于将日志消息发送到不同的目标，如文件、控制台、数据库、syslog等。
• Layout：用于格式化日志消息。
• Filter：用于过滤日志消息，仅将符合特定条件的消息发送到Appender。

二、安装Log4j

1. 下载Log4j

您可以从官方网站 [​​http://logging.apache.org/log4j/2.x/​​] 下载最新版本的Log4j。

2. 将Log4j添加到Java项目中

将下载的Log4j库添加到Java项目的classpath中。您可以将Log4j库添加到项目的lib文件夹中，或者将其添加到项目的Maven依赖项中。

3. 配置Log4j

您需要创建一个配置文件来告诉Log4j如何运作。Log4j可以使用多种格式的配置文件，如XML、JSON和属性文件。在此示例中，我们将使用XML格式的配置文件。

下面是一个简单的Log4j XML配置文件的示例，它将日志消息发送到控制台：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%dHH:mm:ss.SSS [%t] %-5level %logger36 - %msg%n" />
    </Console>
  </Appenders>
  <Loggers>
    <Root level="debug">
      <AppenderRef ref="Console" />
    </Root>
  </Loggers>
</Configuration>

配置文件中的​​status​​​属性用于设置Log4j的内部日志级别，它指定了Log4j自身日志的记录级别。这个值可以是​​DEBUG​​​、​​INFO​​​、​​WARN​​​、​​ERROR​​​或​​FATAL​​​，默认值为​​ERROR​​。

​​Appenders​​元素指定了用于将日志消息发送到不同目标的Appender，这里使用了​​Console​​ Appender将日志消息发送到控制台。在​​PatternLayout​​中指定了如何格式化日志消息，其中​​%d​​表示日期和时间、​​%t​​表示线程名、​​%-5level​​表示日志级别、​​%logger36​​表示Logger名、​​%msg​​表示消息本身，​​%n​​表示换行。

​​Loggers​​元素指定了日志记录器的配置，这里使用了一个名为​​Root​​的日志记录器。​​level​​属性指定了日志记录器的记录级别，这里设置为​​debug​​。​​AppenderRef​​元素将日志记录器与​​Console​​ Appender关联起来，这意味着所有由该日志记录器记录的消息都将被发送到控制台。

您可以根据需要修改配置文件中的参数，例如添加其他Appender、更改日志级别等。

三、在Java中使用Log4j

1. 创建一个Logger

要记录日志消息，您需要使用一个Logger对象。您可以为不同的应用程序组件创建不同的Logger。Logger类是Log4j中最重要的类之一，可以使用LoggerFactory类创建Logger对象。

下面的示例演示了如何在Java应用程序中创建一个Logger：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class MyClass 
    private static final Logger logger = LogManager.getLogger(MyClass.class);
    // ...

2. 配置Logger

在您的应用程序中，您可能需要为不同的Logger对象配置不同的记录级别、Appender等。默认情况下，所有Logger都将继承其父Logger的配置。

下面的示例演示了如何在XML配置文件中为特定的Logger设置不同的记录级别：

<Loggers>
  <Logger name="com.mycompany.myapp.MyClass" level="debug" />
</Loggers>

上述示例中，Logger元素的name属性指定了Logger对象的完整类名，level属性指定了Logger对象的记录级别。

3. 记录日志消息

要记录日志消息，您可以使用Logger对象的不同方法，如​​debug()​​、​​info()​​、​​warn()​​和​​error()​​。

下面的示例演示了如何使用Logger对象记录日志消息：

logger.debug("This is a debug message");
logger.info("This is an info message");
logger.warn("This is a warn message");
logger.error("This is an error message");

4. 为不同级别的消息设置日志级别

您可以为Logger对象的不同方法设置记录级别，以控制记录哪些消息。默认情况下，Logger对象记录所有级别的消息。在Logger对象的构造函数中可以指定记录级别。例如，如果您只想记录​​INFO​​及以上级别的消息，可以使用以下代码：

import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class MyClass 
    private static final Logger logger = LogManager.getLogger(MyClass.class);
    
    public MyClass() 
        logger.setLevel(Level.INFO);
    

在上述代码中，Logger对象的记录级别被设置为​​INFO​​。这意味着Logger对象只记录​​INFO​​、​​WARN​​、​​ERROR​​和​​FATAL​​级别的消息。

5. 日志消息的格式化

Log4j允许您在记录日志消息时使用占位符格式化消息。例如，您可以在消息中包含变量，并在调用Logger方法时将这些变量的值传递给Logger方法。下面是一个使用格式化消息的示例：

logger.info("User  logged in from ", username, ipAddress);

上述示例中，​​​​是占位符，将在记录日志消息时用传递给Logger方法的参数值替换。例如，如果​​username​​的值为​​john​​，​​ipAddress​​的值为​​192.168.1.100​​，则记录的日志消息将是：

User john logged in from 192.168.1.100

6. 异常日志

记录异常日志是调试和排查问题的关键。Log4j允许您记录异常及其堆栈跟踪。您可以使用Logger对象的不同方法来记录异常日志，例如​​error()​​方法。

下面的示例演示了如何使用Logger对象记录异常日志：

try 
    // some code that throws an exception
 catch (Exception e) 
    logger.error("An error occurred", e);

在上述示例中，Logger对象的​​error()​​方法将异常对象作为第二个参数传递。这将导致Logger对象记录异常及其堆栈跟踪。

7. 使用Log4j2实现异步日志记录

Log4j2支持异步日志记录，这意味着日志消息可以在独立的线程中异步记录。异步日志记录可以提高性能，特别是在高并发应用程序中。

要启用异步日志记录，您需要使用异步Appender，例如​​AsyncAppender​​。下面是一个使用异步Appender的示例：

<Appenders>
  <Console name="Console" target="SYSTEM_OUT">
    <PatternLayout pattern="%dHH:mm:ss.SSS [%t] %-5level %logger36 - %msg%n" />
  </Console>
  <Async name="Async">
    <AppenderRef ref="Console" />
  </Async>
</Appenders>
<Loggers>
  <Root level="debug">
    <AppenderRef ref="Async" />
  </Root>
</Loggers>

在上述示例中，使用了​​Async​​ Appender将日志消息异步记录到控制台。

8. 使用Log4j2进行日志滚动

随着时间的推移，日志文件可能会变得非常大。为了避免这种情况，您可以配置Log4j2使用滚动文件Appender，这将导致日志文件根据一定的条件（例如按日期、大小或时间间隔）滚动。

以下是一个使用按日期滚动的文件Appender的示例：

<Appenders>
  <RollingFile name="RollingFile" fileName="logs/app.log"
               filePattern="logs/app-%dMM-dd-yyyy.log">
    <PatternLayout>
      <Pattern>%dHH:mm:ss.SSS [%t] %-5level %logger36 - %msg%n</Pattern>
    </PatternLayout>
    <Policies>
      <TimeBasedTriggeringPolicy />
    </Policies>
  </RollingFile>
</Appenders>
<Loggers>
  <Root level="debug">
    <AppenderRef ref="RollingFile" />
  </Root>
</Loggers>

在上述示例中，使用​​RollingFile​​​ Appender将日志记录到名为​​app.log​​​的文件中。​​filePattern​​​属性定义了日志文件名的格式。在上述示例中，日志文件名将根据日期滚动，并带有​​MM-dd-yyyy​​​格式的日期。​​<TimeBasedTriggeringPolicy>​​元素告诉Log4j2在每天结束时滚动日志文件。

四、Log4j的高级用法

1. 使用Appenders将日志消息发送到不同的目标

Log4j允许您将日志消息发送到不同的目标，例如控制台、文件、数据库等。Log4j提供了多种不同类型的Appender，可以根据需求进行选择。

以下是一个使用多个Appender将日志消息发送到控制台和文件的示例：

<Appenders>
  <Console name="Console" target="SYSTEM_OUT">
    <PatternLayout pattern="%dHH:mm:ss.SSS [%t] %-5level %logger36 - %msg%n" />
  </Console>
  <RollingFile name="RollingFile" fileName="logs/app.log"
               filePattern="logs/app-%dMM-dd-yyyy.log">
    <PatternLayout>
      <Pattern>%dHH:mm:ss.SSS [%t] %-5level %logger36 - %msg%n</Pattern>
    </PatternLayout>
    <Policies>
      <TimeBasedTriggeringPolicy />
    </Policies>
  </RollingFile>
</Appenders>
<Loggers>
  <Root level="debug">
    <AppenderRef ref="Console" />
    <AppenderRef ref="RollingFile" />
  </Root>
</Loggers>

在上述示例中，​​Console​​ Appender将日志消息输出到控制台，​​RollingFile​​ Appender将日志消息记录到文件中。​​<AppenderRef>​​元素用于将Appender添加到Logger对象中。

2. 使用Layouts格式化日志消息

Log4j提供了多种Layouts用于格式化日志消息。默认情况下，Log4j使用​​SimpleLayout​​，它使用以下格式记录日志消息：

级别 - 消息内容

以下是一个使用​​PatternLayout​​自定义日志消息格式的示例：

<Appenders>
  <Console name="Console" target="SYSTEM_OUT">
    <PatternLayout pattern="%dHH:mm:ss.SSS [%t] %-5level %logger36 - %msg%n" />
  </Console>
</Appenders>
<Loggers>
  <Root level="debug">
    <AppenderRef ref="Console" />
  </Root>
</Loggers>

在上述示例中，​​PatternLayout​​​指定了自定义日志消息格式。​​%d​​​表示日期和时间，​​%t​​​表示线程名称，​​%-5level​​​表示级别，并将级别名称左对齐，最多显示5个字符，​​%logger36​​​表示记录器名称，最多显示36个字符，​​%msg​​​表示消息内容，​​%n​​表示换行符。

3. 使用Filters过滤日志消息

Log4j允许您使用Filters过滤日志消息。Filters是一些自定义类，用于根据特定的条件过滤日志消息。例如，您可以使用Filters仅记录特定的日志消息或从特定的记录器中过滤日志消息。

以下是一个使用​​ThresholdFilter​​过滤日志消息的示例：

<Appenders>
  <Console name="Console" target="SYSTEM_OUT">
    <PatternLayout pattern="%dHH:mm:ss.SSS [%t] %-5level %logger36 - %msg%n" />
    <Filters>
      <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY" />
    </Filters>
  </Console>
</Appenders>
<Loggers>
  <Root level="debug">
    <AppenderRef ref="Console" />
  </Root>
</Loggers>

在上述示例中，​​ThresholdFilter​​指定仅记录​​info​​级别或更高级别的日志消息。​​onMatch​​属性指定匹配时的行为（在此示例中，接受日志消息），​​onMismatch​​属性指定不匹配时的行为（在此示例中，拒绝日志消息）。

4. 使用Loggers继承机制简化配置

Log4j允许您使用Logger继承机制简化配置。Logger继承机制可以将父Logger的所有Appender、Filter和Level属性应用于所有子Logger。

以下是一个使用Logger继承机制的示例：

<Loggers>
  <Logger name="com.example" level="debug" additivity="false">
    <AppenderRef ref="Console" />
  </Logger>
  <Root level="info">
    <AppenderRef ref="Console" />
  </Root>
</Loggers>

在上述示例中，​​Logger​​​元素指定一个名为​​com.example​​​的Logger，并将其级别设置为​​debug​​​。​​additivity​​​属性设置为​​false​​​，表示不将日志消息传递给父Logger。​​Root​​​元素设置默认级别为​​info​​​，并将​​Console​​​ Appender添加到其下。由于​​com.example​​​ Logger继承自​​Root​​​ Logger，因此它也将继承​​Console​​ Appender。

五、最佳实践

1. 为不同的应用程序组件使用不同的Logger

为不同的应用程序组件使用不同的Logger可以帮助您更好地理解应用程序中发生的事件。例如，您可以为控制器、服务和数据访问层等不同的组件使用不同的Logger。

2. 确保日志级别正确配置

确保日志级别正确配置可以减少不必要的日志消息，并帮助您快速诊断问题。在开发期间，您可以将日志级别设置为​​debug​​或​​trace​​，以获取更详细的日志消息。在生产环境中，您可以将日志级别设置为​​info​​或更高级别，以减少日志消息的数量。

3. 使用MDC来跟踪请求或线程上下文

使用MDC（Mapped Diagnostic Context）可以将请求或线程上下文信息添加到日志消息中。例如，您可以在HTTP请求中添加请求ID和IP地址，并在每个日志消息中记录这些信息。这可以帮助您跟踪特定请求的日志消息，以及在日志文件中查找特定IP地址的所有请求。

以下是一个使用MDC的示例：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.ThreadContext;

public class MyServlet extends HttpServlet 
  private static final Logger LOGGER = LogManager.getLogger(MyServlet.class);

  protected void doGet(HttpServletRequest request, HttpServletResponse response) 
    // Add request ID and IP address to MDC
    ThreadContext.put("requestId", request.getId());
    ThreadContext.put("ipAddress", request.getRemoteAddr());

    try 
      // Servlet logic
      ...
     catch (Exception e) 
      LOGGER.error("Error processing request", e);
     finally 
      // Remove request ID and IP address from MDC
      ThreadContext.remove("requestId");
      ThreadContext.remove("ipAddress");
    
  

在上述示例中，​​ThreadContext​​类用于添加和删除MDC属性。在每个请求处理期间，请求ID和IP地址被添加到MDC中。在异常情况下，错误消息记录为错误级别日志消息，并附加异常堆栈跟踪。在请求处理完成后，请求ID和IP地址从MDC中删除。

4. 周期性地清理日志文件

周期性地清理日志文件可以避免日志文件变得过大，占用磁盘空间。您可以使用Log4j的​​RollingFileAppender​​或​​SizeBasedTriggeringPolicy​​来控制日志文件的大小，并定期删除旧的日志文件。

以下是一个使用​​RollingFileAppender​​的示例：

<Appenders>
  <RollingFile name="RollingFile" fileName="logs/app.log"
    filePattern="logs/app-%dyyyy-MM-dd-%i.log.gz">
    <PatternLayout pattern="%dyyyy-MM-dd HH:mm:ss.SSS [%t] %-5level %logger36 - %msg%n" />
    <Policies>
      <SizeBasedTriggeringPolicy size="10MB" />
    </Policies>
    <DefaultRolloverStrategy max="10" />
  </RollingFile>
</Appenders>
<Loggers>
  <Root level="info">
    <AppenderRef ref="RollingFile" />
  </Root>
</Loggers>

在上述示例中，​​RollingFile​​ Appender使用​​fileName​​属性指定日志文件的名称，并使用​​filePattern​​属性指定滚动文件的名称模式。​​SizeBasedTriggeringPolicy​​指定当日志文件大小达到10MB时，将创建一个新的日志文件。​​DefaultRolloverStrategy​​指定最多保留10个旧日志文件。在​​Root​​ Logger中，​​RollingFile​​ Appender被添加到Appender引用中，以便将日志消息写入文件。

六、总结

在本篇中，我们介绍了如何使用Log4j进行Java应用程序的日志记录和调试。我们首先介绍了Log4j的基础知识，包括Logger、Level和Appender等概念。然后我们介绍了如何在Java应用程序中配置Log4j，并记录不同级别的日志消息。接着，我们介绍了Log4j的高级用法，包括Appenders、Layouts、Filters和Loggers继承机制，以及最佳实践，包括为不同的应用程序组件使用不同的Logger、确保日志级别正确配置、使用MDC来跟踪请求或线程上下文、周期性地清理日志文件。

虽然Log4j和Log4j2有很多相似之处，但它们之间存在一些不同。Log4j2是Log4j的升级版，提供了更好的性能和功能。如果您在Java应用程序中需要记录日志，建议使用Log4j2。

---

【使用Logback】

一、Logback简介

1. Logback概述

Logback是一个基于Java的日志记录框架，它是Log4j框架的后继者，提供了比Log4j更高的性能和更多的功能。Logback的核心组件包括Logger、Appender、Layout、Filter等，它们可以帮助您将日志消息记录到不同的目标中，例如控制台、文件、数据库等。

2. Logback的优点

Logback的优点包括：

高性能：Logback使用异步日志记录和缓冲区技术，可以在不影响应用程序性能的情况下记录大量日志消息。

灵活性：Logback提供了丰富的配置选项和插件，可以轻松地扩展其功能。

易于使用：Logback具有良好的文档和示例，使得它容易上手和使用。

二、使用Logback

2.1 安装Logback

在使用Logback之前，需要将Logback添加到项目的classpath中。有两种方法可以做到这一点：

• 将Logback JAR文件手动添加到项目的classpath中。
• 使用依赖管理工具（如Maven或Gradle）来管理Logback依赖项。

2.2 添加Logback配置文件

要使用Logback进行日志记录，需要创建一个Logback配置文件。Logback默认会在类路径根目录下查找名为logback.xml或logback.groovy的文件。

以下是一个简单的logback.xml文件的例子：

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%dHH:mm:ss.SSS [%thread] %-5level %logger36 - %msg%n</pattern>
        </encoder>
    </appender>
    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

该配置文件定义了一个名为“STDOUT”的控制台附加器，它将日志输出到标准输出流中。此外，还定义了一个名为“root”的日志记录器，并将其级别设置为“debug”，并将其附加器设置为“STDOUT”。

下面是一个简单的logback.groovy配置文件示例：

import ch.qos.logback.classic.encoder.PatternLayoutEncoder
import ch.qos.logback.core.ConsoleAppender

def encoder = new PatternLayoutEncoder()
encoder.pattern = "%dHH:mm:ss.SSS [%thread] %-5level %logger36 - %msg%n"
encoder.context = context
encoder.start()

def consoleAppender = new ConsoleAppender()
consoleAppender.name = "console"
consoleAppender.encoder = encoder
consoleAppender.context = context
consoleAppender.start()

root(INFO, [console])

2.3 配置日志记录器

要在Java中使用Logback进行日志记录，需要创建一个Logger对象并使用它来记录消息。

以下是一个简单的Java类，它使用Logback记录消息：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class MyClass 
    private static final Logger LOGGER = LoggerFactory.getLogger(MyClass.class);

    public Log4j log for java(java的日志) 的使用

 Java优雅的记录日志：log4j实战篇
 Log4j,Log4j2,Logback,Slf4J日志框架你真的了解吗？阿里巴巴Java开发手册为什么强制推荐使用Slf4j?
 Java 13学习笔记53使用Log4j
 Java日志框架 -- LOG4J（Log4j入门案例日志级别Log4j组件（LoggersAppendersLayouts）配置文件内置日志记录自定义Logger）
 Java日志框架 -- LOG4J（Log4j入门案例日志级别Log4j组件（LoggersAppendersLayouts）配置文件内置日志记录自定义Logger）