Spring 核心技术解析【纯干货版】- XIX：Spring 日志模块 Spring-Jcl 模块精讲

在现代 Java 开发中，日志是调试、监控和维护应用程序的重要工具。Spring 作为企业级框架，提供了 Spring-Jcl 作为日志抽象层，使开发者可以灵活切换不同的日志实现，而无需修改业务代码。本篇文章将深入解析 Spring-Jcl 模块，并通过一个案例，展示如何集成 Log4j 进行日志管理，助力高效开发和问题排查。

文章目录

- - [1、Spring-Jcl 模块介绍](#1、Spring-Jcl 模块介绍)
  - - [1.1、Spring-Jcl 模块概述](#1.1、Spring-Jcl 模块概述)
    - [1.2、Spring-Jcl 模块依赖](#1.2、Spring-Jcl 模块依赖)
    - [1.3、Spring-Jcl 模块作用](#1.3、Spring-Jcl 模块作用)
  - [2、Spring WebSocket 案例](#2、Spring WebSocket 案例)
  - - 2.1、项目依赖
    - [2.2、配置 Log4j](#2.2、配置 Log4j)
    - 2.3、编写日志示例
    - 2.4、运行结果
  - X、后记

1、Spring-Jcl 模块介绍

1.1、Spring-Jcl 模块概述

Spring JCL模块，是 Spring 中用以提供日志支持的模块，其中 JCL 指的是 Java Commons Logging。

Spring JCL模块提供了 Spring 框架对 Apache Commons Logging（简称 JCL）的支持和集成。

Apache Commons Logging 是一个广泛使用的日志 API，它提供了一种通用的日志记录接口，允许开发者在他们的应用代码中使用日志记录，而不必关心底层的日志实现框架是什么

1.2、Spring-Jcl 模块依赖

Spring-Jcl 主要依赖于 Spring-Core 模块，因为它提供了 Spring 框架的基础核心功能，并且需要依赖 Java 的日志 API，如 SLF4J 或 Log4j（具体取决于项目的日志实现）。

1.3、Spring-Jcl 模块作用

Spring-Jcl 模块的主要作用：

作为 Spring 框架的日志适配层，提供对不同日志实现的支持。
提供自动检测和绑定不同日志框架的能力，避免手动适配。
允许开发者在不改变代码的情况下，灵活切换日志实现，如从 Log4j 迁移到 SLF4J。

2、Spring WebSocket 案例

在 Spring 传统项目中，我们可以使用 Spring-Jcl 作为日志抽象层，并结合 Log4j 作为日志实现。

2.1、项目依赖

在 pom.xml 文件中添加以下依赖：

xml 复制代码

<dependencies>
    <!-- Spring 核心模块 -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>5.3.30</version>
    </dependency>

    <!-- Spring-Jcl 日志模块 -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jcl</artifactId>
        <version>5.3.30</version>
    </dependency>

    <!-- Log4j 作为日志实现 -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version>
    </dependency>
</dependencies>

2.2、配置 Log4j

在 src/main/resources 目录下创建 log4j.properties 文件，配置日志级别和日志输出方式：

properties 复制代码

# 设置日志级别
log4j.rootLogger=INFO, stdout, file

# 控制台输出
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} [%t] %-5p %c{1} - %m%n

# 文件输出
log4j.appender.file=org.apache.log4j.FileAppender
log4j.appender.file.File=app.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%t] %-5p %c{1} - %m%n

2.3、编写日志示例

创建 LoggingService.java 并使用 Spring-Jcl 进行日志记录：

java 复制代码

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class LoggingService {
    // 使用 Spring-Jcl 提供的 LogFactory 获取日志对象
    private static final Log logger = LogFactory.getLog(LoggingService.class);

    public void performTask() {
        logger.info("执行任务中...");
        
        try {
            int result = 10 / 0; // 模拟异常
        } catch (Exception e) {
            logger.error("发生错误：", e);
        }
        
        logger.debug("任务执行完毕！");
    }

    public static void main(String[] args) {
        LoggingService service = new LoggingService();
        service.performTask();
    }
}

2.4、运行结果

运行 LoggingService，控制台会输出日志信息，同时 app.log 文件中也会记录日志：

复制代码

2025-04-03 12:00:00 [main] INFO  LoggingService - 执行任务中...
2025-04-03 12:00:00 [main] ERROR LoggingService - 发生错误：
java.lang.ArithmeticException: / by zero
    at LoggingService.performTask(LoggingService.java:11)
    at LoggingService.main(LoggingService.java:19)
2025-04-03 12:00:00 [main] DEBUG LoggingService - 任务执行完毕！

X、后记

通过本篇文章，我们详细解析了 Spring-Jcl 模块的核心概念、依赖关系及其作用，并通过 Log4j 案例演示了如何在传统 Spring 项目中集成日志管理。