springboot整合mybatis打印sql(包含一个坑)

本文介绍两种MyBatis整合方式:手动配置SqlSessionFactoryBean及使用Spring Boot自动配置MybatisAutoConfiguration。涵盖XML配置SQL打印、自动配置注意事项等内容。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

maven依赖

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.1</version>
</dependency>

整合Mybatis的两种方式

手动装配SqlSessionFactoryBean

注意:使用手动装配SqlSessionFactoryBean,一定要注意,application.yml中的mybatis配置是无效的,所有mybatis的配置都需要在代码中配置。

Bean配置类

@Configuration
public class MybatisConfig {
    @Bean
    public SqlSessionFactoryBean getSqlSessionFactoryBean(DataSource dataSource) throws IOException {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource);
        sqlSessionFactoryBean.setConfigLocation(new ClassPathResource("mybatis-config.xml"));
        sqlSessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/*Mapper.xml"));
        return sqlSessionFactoryBean;
    }
}

在这里插入图片描述

mybatis-config.xml配置sql打印

<?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="STDOUT_LOGGING" />
    </settings>
</configuration>

在这里插入图片描述

自动装配MybatisAutoConfiguration

注意:没有自定义SqlSessionFactoryBean时,Springboot会使用MybatisAutoConfiguration自动装配SqlSessionFactoryBean,mybatis的配置项需要在application.yml配置。

MybatisAutoConfiguration源码

@Bean
@ConditionalOnMissingBean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {}

application.yml配置sql打印

注释的内容同样可以达到效果,只是额外需要mybatis-config.xml配置文件

#mybatis:
#  config-location: classpath:mybatis-config.xml
#  mapper-locations: classpath:mapper/*Mapper.xml
mybatis:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  mapper-locations: classpath:mapper/*Mapper.xml

一个坑

网上的博客基本上都是说在application.yml中配置mybatis,就可以打印sql,但是前提是使用Springboot自动装配的MybatisAutoConfiguration时,才有效。因为application.yml中的mybatis配置是针对自动装配时生效。

启动类

@SpringBootApplication
@ComponentScan(basePackages = {"com.edu.*"})
@MapperScan(basePackages = {"com.edu.dao"})
@EnableTransactionManagement
@EnableAspectJAutoProxy(proxyTargetClass = true)
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
### 配置 Spring BootMyBatis 打印 SQL 日志 为了使应用程序能够记录由 `MyBatis` 发起的 SQL 语句,在 Spring Boot 中需要调整日志级别并设置特定的日志配置。由于 `Spring Data JDBC` 自身几乎不提供任何日志功能,而是依赖于底层组件如 `JdbcTemplate` 或者 `NamedParameterJdbcTemplate` 来执行 SQL 并处理日志[^1]。 #### 修改 application.properties 文件 要在控制台查看来自 `MyBatis` 的 SQL 输出,可以在项目的 `application.properties` 或 `application.yml` 文件中增加如下配置: 对于 `.properties` 文件: ```properties logging.level.com.example.mapper=DEBUG logging.level.org.mybatis.spring=DEBUG ``` 对于 `.yml` 文件: ```yaml logging: level: com.example.mapper: DEBUG org.mybatis.spring: DEBUG ``` 这里假设所有的 Mapper 接口位于包路径 `com.example.mapper` 下面;如果实际项目中的Mapper接口位置不同,则应相应修改此路径。 上述配置会开启针对指定包下的类以及 `org.mybatis.spring` 命名空间下所有类别的调试级别的日志输出,这通常足以让开发者看到完整的SQL查询语句及其参数绑定情况。 另外,还可以通过 Logback (或其他支持的日志框架) 进一步自定义日志格式化方式来增强可读性和诊断能力。例如可以创建或编辑 `logback-spring.xml` 文件加入以下内容以便更清晰地显示SQL日志信息: ```xml <configuration> <!-- ... --> <logger name="com.example.mapper" level="DEBUG"/> <logger name="org.mybatis.spring" level="DEBUG"/> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <root level="info"> <appender-ref ref="STDOUT" /> </root> </configuration> ``` 这样不仅可以让SQL语句被打印出来,而且还能保持其他部分的日志不会因为过多细节而变得混乱。
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值