MybatisPlus打印SQL详解

一、MybatisPlus打印SQL日志

在使用MybatisPlus时，有时需要查看生成的SQL语句以及执行结果。MybatisPlus提供了打印SQL日志的功能，可以帮助我们更好的调试SQL语句。

要启用SQL日志，我们需要在mybatis-plus的全局配置文件中设置logging.enableSqlLog为true。

mybatis-plus:
  configuration:
    # 打印SQL日志
    logging:
      enableSqlLog: true

启用后，MybatisPlus就会在控制台输出所有生成的SQL语句，便于我们查看。

二、MybatisPlus打印SQL语句的原理

MybatisPlus的打印SQL日志功能，是通过org.apache.ibatis.logging.Log接口实现的。它会在MybatisPlus的全局配置文件中，设置为使用Log4j2输出SQL日志。

# 配置Log4j2
logging:
  level:
    com.baomidou.mybatisplus.core.MybatisPlus: info
  appenders:
    console:
      type: console
      name: console
      target: SYSTEM_OUT
      layout:
        type: pattern
        pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{36} - %msg%n"
  loggers:
    com.baomidou.mybatisplus.core.MybatisPlus:
      level: info
      additivity: false
      AppenderRef:
        - ref: console

在Log4j2配置中，我们设置了输出MybatisPlus的日志级别为info，即大于等于info级别的日志都会输出。同时，我们在控制台输出日志信息，设置输出格式为时间、日志级别、日志名称、日志内容。

三、MybatisPlus打印SQL执行时间

在使用MybatisPlus执行SQL语句时，有时需要查看SQL的执行时间，以便对性能进行优化。MybatisPlus提供了打印SQL执行时间的功能。

启用SQL执行时间功能，我们可以在MybatisPlus的全局配置文件中设置performance.maxTime属性，单位为毫秒。当SQL执行时间超过该值时，MybatisPlus会在控制台打印执行时间。

mybatis-plus:
  configuration:
    # 打印SQL执行时间
    performance:
      maxTime: 2000

在上述配置中，我们设置SQL最大执行时间为2000毫秒，也就是2秒，如果执行时间超过2秒，MybatisPlus就会在控制台输出执行时间。

四、MybatisPlus打印SQL语句到文件

有些情况下，我们需要将生成的SQL语句记录到文件中，供后续查看和分析。MybatisPlus提供了将SQL语句打印到文件的功能。

启用打印SQL到文件功能，我们需要在Log4j2配置中添加FileAppender配置。

# 配置Log4j2
logging:
  level:
    com.baomidou.mybatisplus.core.MybatisPlus: info
  appenders:
    console:
      type: console
      name: console
      target: SYSTEM_OUT
      layout:
        type: pattern
        pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{36} - %msg%n"
    file:
      type: file
      name: sql_log
      fileName: ${sys:user.dir}/sql.log
      layout:
        type: pattern
        pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{36} - %msg%n"
  loggers:
    com.baomidou.mybatisplus.core.MybatisPlus:
      level: info
      additivity: false
      AppenderRef:
        - ref: console
        - ref: sql_log

在上述配置中，我们添加了一个FileAppender配置，将SQL语句记录到${sys:user.dir}/sql.log文件中，并设置日志输出格式为时间、日志级别、日志名称、日志内容。

五、Mybatis打印SQL语句

除了MybatisPlus，Mybatis本身也支持打印SQL语句。我们可以通过在mybatis配置文件中设置logImpl属性为STDOUT_LOGGING或LOG4J2_LOGGING来启用。

# 配置Mybatis日志
mybatis:
  # 打印SQL语句
  configuration:
    logImpl: org.apache.ibatis.logging.stdout.StdOutImpl

在上述配置中，我们将logImpl属性设置为STDOUT_LOGGING，即输出到控制台。我们也可以设置为LOG4J2_LOGGING，即输出到Log4j2配置文件中。

六、Mybatis打印的total

在进行分页或者批量操作时，我们可能需要知道总记录数，以便进行分页计算或者判断操作是否成功。Mybatis的PageInterceptor提供了total的输出功能。

启用total输出功能，我们需要在mybatis配置文件中添加PageInterceptor配置，并设置其属性defaultCount为true。

# 配置Mybatis分页
mybatis:
  # 打印总记录数
  configuration:
    plugins:
      - interceptor:
          class: com.github.pagehelper.PageInterceptor
          properties:
            defaultCount: true

在上述配置中，我们配置了PageInterceptor插件，并设置其属性defaultCount为true。这样，在进行分页查询时，Mybatis就会输出查询结果的总记录数。

七、MybatisPlus注解

除了使用MybatisPlus的XML文件进行映射配置，我们还可以使用注解来进行映射配置。

例如，我们可以使用MybatisPlus提供的注解@Table进行表名的映射：

@Data
@Table(name = "user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
}

在上述代码中，@Table注解指定了该类对应的表名为”user”。@TableId注解用于指定主键ID，并设置ID生成策略为自动递增。

八、MybatisPlus查询

MybatisPlus提供了一系列方便的查询方法，如eq(等于)、ne(不等于)、lt(小于)、le(小于等于)、gt(大于)、ge(大于等于)、like(模糊查询)等。

例如，我们可以使用eq方法进行等于查询：

QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name", "张三");
List<User> userList = userMapper.selectList(wrapper);

在上述代码中，我们使用eq方法将查询条件设置为”name”字段等于”张三”。然后使用QueryWrapper封装查询条件，并传入userMapper的selectList方法进行查询。

九、MybatisPlus文件注解

MybatisPlus还提供了一系列文件注解，用于简化开发。

例如，我们可以使用@TableName和@TableField注解等来进行表名和字段的映射：

@Data
@TableName("user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    @TableField("name")
    private String username;
    private Integer age;
}

在上述代码中，@TableName注解指定了该类对应的表名为”user”。@TableField注解用于指定类中的属性与表中的列名之间的映射。我们将类中的”name”属性映射到了”user”表的”name”列。

十、MybatisPlus文档

如果你对MybatisPlus还不太熟悉，可以参考官方文档，官方文档中包含了MybatisPlus的详细使用说明以及示例代码。

MybatisPlus官方文档地址：https://mybatis.plus/guide/