MyBatis集成日志框架Logback：从入门到精通

需要重新演唱

于 2024-09-22 08:30:00 发布

阅读量1k

点赞数 18

文章标签： mybatis tomcat java

本文链接：https://blog.csdn.net/xycxycooo/article/details/142346162

版权

MyBatis集成日志框架Logback：从入门到精通

引言

在Java开发中，日志记录是不可或缺的一部分，它帮助我们追踪应用程序的运行状态、诊断问题和优化性能。MyBatis作为一个优秀的持久层框架，提供了灵活的日志记录机制。本文将带你深入探索如何在MyBatis中集成日志框架Logback，从基础配置到高级应用，让你轻松掌握这一重要技能。

前置知识

在开始之前，你需要了解以下几个基本概念：

日志框架：用于记录应用程序运行时信息的工具，如Logback、Log4j、SLF4J等。
MyBatis：一个优秀的持久层框架，简化了数据库操作的复杂性。
Logback：一个高性能的日志框架，是Log4j的继任者，广泛应用于Java应用程序中。
SLF4J：一个简单的日志门面（Facade），用于统一不同日志框架的接口。

为什么选择Logback？

Logback具有以下优势：

高性能：Logback的设计目标之一是高性能，它比Log4j更快。
灵活配置：Logback提供了丰富的配置选项，支持XML和Groovy配置文件。
自动重载配置：Logback支持自动重载配置文件，无需重启应用程序。
强大的过滤器：Logback提供了强大的过滤器机制，可以根据日志级别、日志内容等进行过滤。

集成步骤

1. 添加依赖

首先，你需要在项目中添加MyBatis和Logback的依赖。如果你使用Maven构建项目，可以在pom.xml文件中添加以下依赖：

<dependencies>
    <!-- MyBatis依赖 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.7</version>
    </dependency>
    <!-- Logback依赖 -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.3</version>
    </dependency>
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-core</artifactId>
        <version>1.2.3</version>
    </dependency>
    <!-- SLF4J依赖 -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.30</version>
    </dependency>
</dependencies>

2. 配置Logback

在src/main/resources目录下创建一个名为logback.xml的配置文件。以下是一个简单的Logback配置示例：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 文件输出 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/mybatis.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/mybatis.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- MyBatis日志配置 -->
    <logger name="org.apache.ibatis" level="DEBUG"/>
    <logger name="java.sql" level="DEBUG"/>

    <!-- 根日志配置 -->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>

3. 配置MyBatis

在MyBatis的配置文件mybatis-config.xml中，启用日志记录。以下是一个示例：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <settings>
    <!-- 启用日志记录 -->
    <setting name="logImpl" value="SLF4J"/>
  </settings>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/mydb"/>
        <property name="username" value="root"/>
        <property name="password" value="password"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="com/example/mapper/UserMapper.xml"/>
  </mappers>
</configuration>

4. 运行程序

在配置完成后，运行你的MyBatis应用程序。你将在控制台和日志文件中看到详细的日志输出。

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.InputStream;

public class Main {
    public static void main(String[] args) {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Main.class.getClassLoader().getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            User user = userMapper.getUserById(1);
            System.out.println(user);
        }
    }
}

高级配置

1. 日志级别

Logback支持多种日志级别，如TRACE、DEBUG、INFO、WARN、ERROR。你可以根据需要调整日志级别。

<logger name="org.apache.ibatis" level="DEBUG"/>
<logger name="java.sql" level="DEBUG"/>

2. 日志过滤器

Logback提供了强大的过滤器机制，可以根据日志级别、日志内容等进行过滤。

<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
    <level>DEBUG</level>
</filter>

3. 日志滚动策略

Logback支持多种日志滚动策略，如按时间滚动、按大小滚动等。

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <fileNamePattern>logs/mybatis.%d{yyyy-MM-dd}.log</fileNamePattern>
    <maxHistory>30</maxHistory>
</rollingPolicy>

4. 异步日志

为了提高性能，你可以配置异步日志记录。

<appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
    <appender-ref ref="FILE"/>
</appender>

<root level="INFO">
    <appender-ref ref="STDOUT"/>
    <appender-ref ref="ASYNC"/>
</root>