【JAVA开发】从0到1上手Log4j，Java日志记录不再难-优快云博客

Log4j 的强大功能体现在多个方面。首先，它可以控制日志信息输送的目的地，无论是控制台、文件、GUI 组件，还是套接口服务器、NT 的事件记录器、UNIX Syslog 守护进程等，Log4j 都能轻松实现。这意味着我们可以根据不同的需求，将日志输出到最合适的地方。比如，在开发和调试阶段，我们可以将日志输出到控制台，方便实时查看；而在生产环境中，我们则可以将日志输出到文件，以便后续分析和排查问题。

其次，Log4j 可以控制每一条日志的输出格式。通过定义不同的布局（Layout），我们可以将日志信息按照自己想要的格式进行输出，比如包含时间戳、日志级别、类名、方法名、日志内容等。这样，在查看日志时，我们可以更清晰地了解日志的来源和具体内容，提高排查问题的效率。

此外，Log4j 还通过定义每一条日志信息的级别，让我们能够更加细致地控制日志的生成过程。它支持多种日志级别，包括 DEBUG、INFO、WARN、ERROR 和 FATAL。不同的级别代表了不同的严重程度和重要性，我们可以根据实际情况设置合适的日志级别，只记录我们关心的信息。例如，在开发阶段，我们可以将日志级别设置为 DEBUG，以便获取尽可能多的详细信息，帮助我们调试代码；而在生产环境中，为了减少日志对系统性能的影响，我们可以将日志级别设置为 WARN 或 ERROR，只记录潜在的问题和错误信息。

二、为什么要用 Log4j

在软件开发中，记录程序运行时的各种信息是至关重要的，而 Log4j 作为一款强大的日志记录框架，在众多场景下都展现出了无可替代的优势，相较于传统的输出调试信息方式，它有着诸多显著的优点。

传统方式记录调试信息，比如在代码中大量使用System.out.println语句，会使信息来源难以定位。当项目规模变大，代码量剧增，散布在各处的System.out.println输出的信息混杂在一起，很难快速判断这些信息究竟来自于哪个类、哪个方法。例如，在一个包含多个模块、数十个类的大型项目中，如果每个类都有若干处使用System.out.println输出调试信息，当出现问题需要排查时，开发人员可能需要花费大量时间在众多的输出信息中去梳理和定位，效率极为低下。

并且传统方式难以对输出进行有效的控制。在开发阶段，可能需要输出大量详细信息用于调试，但到了生产环境，这些大量的调试信息不仅毫无用处，还可能暴露系统的敏感信息，影响系统的安全性和稳定性。而使用System.out.println时，若要控制输出，就需要手动在代码中添加或删除这些语句，这不仅繁琐，还容易出错，且不利于后期维护。假设在生产环境中，忘记删除某些敏感信息的输出语句，一旦被不法分子利用，就可能给系统带来严重的安全风险。

大量的System.out.println语句还会影响性能。频繁的输出操作会占用系统资源，特别是在高并发场景下，这种影响会更加明显，可能导致系统响应变慢，甚至出现卡顿现象。例如，在一个每秒处理上千次请求的电商交易系统中，如果在关键业务逻辑中使用System.out.println输出调试信息，会增加 I/O 操作次数，消耗系统资源，进而影响整个系统的吞吐量和响应时间，降低用户体验。

Log4j 则有效解决了这些问题。它可以灵活控制日志记录，通过配置文件就能轻松调整日志的输出级别，如在开发环境中设置为 DEBUG 级别，获取详细的调试信息；在生产环境中设置为 WARN 或 ERROR 级别，只记录重要的潜在问题和错误信息，避免过多无用信息的输出，降低对系统性能的影响。同时，Log4j 能够指定日志的输出目的地，如输出到文件便于后续分析，或者输出到控制台方便实时查看，还可以根据需求输出到其他多种目标。而且，它支持自定义日志的输出格式，包含时间戳、日志级别、类名、方法名等信息，使开发人员能更清晰地了解日志的来源和具体内容，极大地提高了开发和运维效率，在排查问题时能够快速定位到关键信息，节省大量时间和精力。

三、快速入门 Log4j

（一）环境准备

在开始使用 Log4j 之前，首先需要获取 Log4j 的相关依赖，并将其添加到 Java 项目中。获取 Log4j 的 jar 包主要有以下几种方式：

Maven 依赖管理：如果你使用 Maven 来管理项目依赖，那么在项目的pom.xml文件中添加以下依赖即可：

<dependency>

<groupId>log4j</groupId>

<artifactId>log4j</artifactId>

<version>1.2.17</version>

</dependency>

Maven 会自动从中央仓库下载 Log4j 及其依赖的 jar 包，并将其添加到项目的类路径中。这种方式非常方便，能够自动管理依赖关系，避免版本冲突等问题。

Gradle 依赖管理：如果项目使用 Gradle 构建，在build.gradle文件中添加依赖：

implementation 'log4j:log4j:1.2.17'

Gradle 同样会自动下载并管理依赖，它的配置相对简洁，并且支持更灵活的依赖管理策略，在一些复杂项目中具有优势。

手动下载：若不使用构建工具，可从 Apache Log4j 的官方网站下载所需版本的 Log4j jar 包。下载完成后，将 jar 包添加到项目的类路径中。例如，在 Eclipse 中，右键点击项目，选择 “Properties”，在弹出的窗口中选择 “Java Build Path”，然后在 “Libraries” 选项卡中点击 “Add External JARs”，选择下载好的 Log4j jar 包即可。这种方式相对繁琐，需要手动处理依赖关系，并且在更新版本时也比较麻烦，所以通常在简单项目或没有构建工具的情况下使用。

（二）第一个 Log4j 程序

当完成环境准备后，就可以编写第一个 Log4j 程序了。下面是一个简单的 Java 代码示例，展示了如何在 Java 项目中使用 Log4j 进行日志记录：

import org.apache.log4j.Logger;

import org.apache.log4j.PropertyConfigurator;

public class Log4jExample {

// 获取Logger对象，参数通常为当前类的类名，这样可以方便地识别日志来源

private static final Logger logger = Logger.getLogger(Log4jExample.class);

public static void main(String[] args) {

// 配置Log4j的属性文件，这里假设属性文件名为log4j.properties，且位于项目的类路径下

PropertyConfigurator.configure("log4j.properties");

// 设置日志级别为DEBUG，这样可以输出DEBUG及以上级别的日志信息

logger.setLevel(org.apache.log4j.Level.DEBUG);

// 使用不同级别的日志记录方法输出信息

logger.debug("这是一条DEBUG级别的日志信息");

logger.info("这是一条INFO级别的日志信息");

logger.warn("这是一条WARN级别的日志信息");

logger.error("这是一条ERROR级别的日志信息");

logger.fatal("这是一条FATAL级别的日志信息");

}

在上述代码中，首先通过Logger.getLogger(Log4jExample.class)获取了一个Logger对象，这个对象负责记录日志信息。然后，通过PropertyConfigurator.configure("log4j.properties")加载了 Log4j 的配置文件，这里的配置文件用于设置日志的输出格式、输出目的地等。接着，设置了日志级别为DEBUG，表示将输出DEBUG及以上级别的日志信息。最后，使用logger对象的不同方法（debug、info、warn、error、fatal）输出了不同级别的日志信息。

（三）配置文件详解

Log4j 的强大之处很大程度上体现在其灵活的配置上，通过配置文件可以轻松地控制日志的输出方式、级别和目的地等。Log4j 支持多种配置文件格式，其中最常用的是properties属性文件格式，下面将以properties文件为例详细讲解配置文件的各个部分。

1. 根 Logger 配置

根 Logger 是 Log4j 中的顶级 Logger，它负责控制整个日志系统的行为。在log4j.properties文件中，根 Logger 的配置语法如下：

log4j.rootLogger = [level], appenderName1, appenderName2, ...

其中，level表示日志记录的优先级，可设置的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j 建议只使用ERROR、WARN、INFO、DEBUG这四个级别，优先级从高到低依次为ERROR > WARN > INFO > DEBUG 。通过在这里定义的级别，可以控制应用程序中相应级别的日志信息的开关。比如，若定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不会被打印出来，因为只有级别大于等于设定级别的日志才会被输出。

appenderName则是指日志信息输出到哪个地方，可以同时指定多个输出目的地，用逗号隔开。例如：

log4j.rootLogger = INFO, stdout, file

这表示将根 Logger 的日志级别设置为INFO，并将日志信息同时输出到名为stdout和file的两个 Appender 中。