SpringBoot使用log4j2将日志记录到文件及自定义数据库

2024 年 03 月 20 日

76 次浏览

2081字数

在Spring Boot应用中使用Log4j2实现日志记录是一个提升应用可管理性和可追踪性的好方法。Log4j2不仅支持日志输出到文件，还支持输出到数据库，这为开发人员提供了灵活的日志管理方案。本文旨在介绍如何在Spring Boot项目中配置Log4j2，以将日志记录到文件和自定义数据库中。

配置Log4j2依赖

首先，确保在Spring Boot项目的 pom.xml文件中引入Log4j2的依赖。如果你使用的是Spring Boot 2.4.0以上版本，则需要排除Spring Boot默认的日志依赖并引入Log4j2。

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-log4j2</artifactId>
    </dependency>
</dependencies>

配置Log4j2

接下来，需要在资源目录（src/main/resources）中创建一个 log4j2.xml配置文件。这个配置文件将指定日志的格式、输出目的地（文件、数据库）以及其他相关的设置。以下是一个基本的示例，展示了如何配置日志输出到控制台和文件。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/>
        </Console>
        <File name="FileLogger" fileName="logs/springboot-app.log">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n"/>
        </File>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="FileLogger"/>
        </Root>
    </Loggers>
</Configuration>

将日志记录到数据库

要将日志记录到数据库，首先需要定义一个数据库表来存储日志信息。以下是一个示例的SQL创建表语句：

CREATE TABLE log_entries (
    id SERIAL PRIMARY KEY,
    log_date TIMESTAMP,
    logger VARCHAR(255),
    log_level VARCHAR(50),
    message TEXT,
    exception TEXT
);

然后在 log4j2.xml配置文件中添加JDBC Appender来将日志信息存储到数据库中。

<JDBC name="DatabaseLogger" tableName="log_entries">
    <DataSource>
        <ConnectionFactory class="org.apache.logging.log4j.core.appender.db.jdbc.DriverManagerConnectionSource" 
            connectionString="jdbc:postgresql://localhost:5432/your_database" 
            userName="your_username" 
            password="your_password"
            driverClassName="org.postgresql.Driver"/>
    </DataSource>
    <Column name="log_date" isEventTimestamp="true"/>
    <Column name="logger" pattern="%logger"/>
    <Column name="log_level" pattern="%level"/>
    <Column name="message" pattern="%message"/>
    <Column name="exception" pattern="%ex{full}"/>
</JDBC>

需要将数据库URL、用户名、密码和驱动类名替换为适合你的数据库的信息。