mybatis集成 logback 日志框架

概述

整篇文章内容总结于（动力节点）老杜mybatis视频教程

笔记链接：https://www.yuque.com/zuihoudewu/java_note/mt2812

mybatis集成日志组件让我们调试起来更加方便

• mybatis 常见的集成的日志组件有哪些呢？

SLF4J（沙拉风）：沙拉风是一个日志标准，其中有一个日志框架叫做logback，它实现了沙拉风规范。
LOG4J
LOG4J2
STDOUT_LOGGING
…
log4j、log4j2、logback都是同一个作者开发的。

STDOUT_LOGGING 是标准日志，mybatis 已经实现了这种标准日志，mybatis 框架本身已经实现了这种标准，只要开启即可。

• 在 mybatis核心配置xml 文件中使用settings标签进行配置开启。

帮助手册：https://mybatis.net.cn/configuration.html#settings

<settings>
	<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>

这个标签在编写的时候要注意，它应该出现在 environments 标签之前，注意顺序。当然，不需要记忆这个顺序，因为有dtd文件进行约束，我们只要参考dtd约束即可，标签的顺序不正确会报错。

• MyBatis本身自己实现的日志框架也是可以的，可以看到一些信息，比如：连接对象什么时候创建，什么时候关闭，sql语句是怎样的。但是没有详细的日期，线程名字等。
  
  需要看到更加丰富的日志信息，可以集成第三方的log组件

集成 logback 日志框架

• logback日志框架实现了slf4j标准。(沙拉风：日志门面、日志标准)
• 在MyBatis使用标准日志 STDOUT_LOGGING 之外的其他日志框架，可以不在mybatis的配置文件中指定 MyBatis所用日志的具体实现，未指定时将会自动查找，只需要引入相应日志框架的依赖以及日志框架的配置文件即可。

使用步骤

• 第一步：引入logback的依赖。

<!-- 引入logback依赖，logback日志框架实现了slf4j规范 -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.11</version>
</dependency>

• 第二步：引入logback所必须的xml配置文件（主要配置日志输出相关的级别以及日志具体的格式）。

这个配置文件的名字必须叫做：logback.xml或者logback-test.xml，不能是其它的名字。
这个配置文件必须放到类的根路径下，不能是其他位置。

<?xml version="1.0" encoding="UTF-8"?>

<configuration debug="false">
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 按照每天生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>100MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!--mybatis log configure-->
    <logger name="com.apache.ibatis" level="TRACE"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>

    <!-- 日志输出级别,logback日志级别包括五个：TRACE < DEBUG < INFO < WARN < ERROR -->
    <root level="DEBUG">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="FILE"/>
    </root>

</configuration>

注意：
设置logImpl时，未指定时将自动查找。
所以可以省略以下设置：

<settings>
        <setting name="logImpl" value="SLF4J"/>
</settings>

如果没有设置三方日志，使用标准日志时，则需要设置以下信息：

<settings>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>