从 01 开始
2023-08-22
目录

整合 Mybatis

# 510.整合 Mybatis

之前我们使用的 JdbcTemplate，轻量级的封装；接下来我们整合 Mybatis

# 引入 starter

Mybatis 属于第三方技术，因此 SpringBoot 官方没有提供 starter；为此，Mybatis 提供了一个，我们可以访问其 GitHub 地址 (opens new window)，可以进入其 spring-boot-starter 目录，打开其 pom.xml 文件，就可以看到当前项目的依赖情况：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot</artifactId>
    <version>3.0.3-SNAPSHOT</version>
  </parent>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <name>mybatis-spring-boot-starter</name>
  <properties>
    <module.name>org.mybatis.spring.boot.starter</module.name>
  </properties>
...........
1
2
3
4
5
6
7
8
9
10
11
12
13

‍ 我们只需引入其定义的依赖即可：

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.4</version>
</dependency>
1
2
3
4
5

‍

# 自动配置分析

在之前我们使用 Mybatis，都是定义一个全局配置文件，SqlSessionFactory，SqlSession 和 Mapper，我们看看 Mybatis 是否配置好了。

starter 引入了如下依赖：一个是 JDBC 的，一个是自动配置的，还引入了 Mybatis，Mybatis 和 Spring 的整合

‍

我们来看看其自动配置了什么。首先我们看 spring.factories：

‍

之前我们说过，SpringBoot 启动的时候会自动加载这个文件，然后开启自动配置：

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.mybatis.spring.boot.autoconfigure.MybatisLanguageDriverAutoConfiguration,\
org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration
1
2
3
4

我们来看看 MybatisAutoConfiguration：

@Configuration
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties({MybatisProperties.class})
@AutoConfigureAfter({DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class})
public class MybatisAutoConfiguration implements InitializingBean {

    //.....
    @Bean
    @ConditionalOnMissingBean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
        factory.setDataSource(dataSource);   
        //.....
    }


    @Bean
    @ConditionalOnMissingBean
    public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
        //.....
    }


    @org.springframework.context.annotation.Configuration
    @Import(AutoConfiguredMapperScannerRegistrar.class)
    @ConditionalOnMissingBean({ MapperFactoryBean.class, MapperScannerConfigurer.class })
    public static class MapperScannerRegistrarNotFoundConfiguration
    //.....
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

‍ 先来说说类上的注解：

  • @ConditionalOnClass：只有引入了 Mybatis 的依赖，该配置才生效
  • @ConditionalOnSingleCandidate(DataSource.class)：有且只有一个数据源的时候，才会生效；
  • @EnableConfigurationProperties：绑定 Mybatis 配置，因此如果要配置 Mybatis，配置项的前缀就是 mybatis。
@ConfigurationProperties(prefix = MybatisProperties.MYBATIS_PREFIX)
public class MybatisProperties {

  public static final String MYBATIS_PREFIX = "mybatis";
//...........
1
2
3
4
5

再看看该自动配置类，注入的 bean：

  • SqlSessionFactory，并且配置了数据源
  • SqlSessionTemplate 则相当于是 SqlSession，用来操作数据库的。
  • MapperScannerRegistrarNotFoundConfiguration：相当于是 Mapper 的扫描配置，会自动扫描用了@Mapper 注解的类，我们可以看看其 Import 的类：
public static class AutoConfiguredMapperScannerRegistrar implements BeanFactoryAware, ImportBeanDefinitionRegistrar {

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

      logger.debug("Searching for mappers annotated with @Mapper");

      List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
      if (logger.isDebugEnabled()) {
        packages.forEach(pkg -> logger.debug("Using auto-configuration base package '{}'", pkg));
      }
    //..........
1
2
3
4
5
6
7
8
9
10
11
12

‍

# 开始使用 Mybatis

我们使用 Mybatis，来写一个案例，忘了的同学可以复习下：Mybatis | 从 01 开始 (opens new window)

新建一个实体类：

package com.peterjxl.learnspringbootwebadmin.bean;

import lombok.Data;

@Data
public class Student {
    private Integer id;
    private String name;
    private int gender;
    private int grade;
    private int score;
}
1
2
3
4
5
6
7
8
9
10
11
12

新增一个代理接口：

package com.peterjxl.learnspringbootwebadmin.mapper;

import com.peterjxl.learnspringbootwebadmin.bean.Student;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface StudentMapper {

    Student selectStudentById(Integer id);

}
1
2
3
4
5
6
7
8
9
10
11

新增 service 层：

package com.peterjxl.learnspringbootwebadmin.service;

import com.peterjxl.learnspringbootwebadmin.bean.Student;
import com.peterjxl.learnspringbootwebadmin.mapper.StudentMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class StudentService {

    @Autowired
    private StudentMapper studentMapper;

    public Student selectStudentById(Integer id) {
        return studentMapper.selectStudentById(id);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

‍ 新增表现层

我们找一个 controller，调用 service 层的方法：

@Controller
public class IndexController {
    @Autowired
    StudentService studentService;

    @GetMapping("/stu")
    public Student getStudentById(@RequestParam("id") Integer id) {
        return studentService.selectStudentById(id);
    }

//.............
1
2
3
4
5
6
7
8
9
10
11

新建全局的配置文件：resources/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="mapUnderscoreToCamelCase" value="true"/>
    </settings>
</configuration>
1
2
3
4
5
6
7
8
9

为了方便，我们开启了驼峰式命名的配置。例如数据库中，列的名字是 user_id，那么在 Java 类中只需定义 userId，也可绑定值。

ps：也可在 yml 文件中配置该项，但是这样的话，在 yml 中就不能指定全局配置文件了，因为用了两种配置方式的话（全局配置文件+yml 文件），Mybatis 就不知道以哪个为准 ‍ 新增 Mapper 配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.peterjxl.learnspringbootwebadmin.mapper.StudentMapper">

   <select id="selectStudentById" resultType="com.peterjxl.learnspringbootwebadmin.bean.Student">
        select * from students where id = #{id}
   </select>

</mapper>
1
2
3
4
5
6
7
8
9
10
11

修改 application.yml 文件，增加 Mybatis 的配置，指定全局配置文件和 Mapper 文件的位置：

mybatis:
  config-location: classpath:mybatis/mybatis-config.xml
  mapper-locations: classpath:mybatis/mapper/*.xml
1
2
3

‍ 重启，访问路径，可以看到能正常查询出来数据：

‍

# 总结

使用步骤：

  • 导入 starter
  • 编写 mapper 接口（要标注@Mapper 接口）
  • 编写 mapper 映射文件，绑定 mapper 接口
  • 在 application.yml 中指定配置文件的信息（建议不使用全局配置文件）

其实也可以在初始化 SpringBoot 项目的时候，选择 Mybatis 的依赖，这样能省略一些步骤：

‍

已将本文源码上传到 Gitee (opens new window) 或 GitHub (opens new window) 的分支 demo12，读者可以通过切换分支来查看本文的示例代码

上次更新: 2025/6/3 09:31:54
通过 starter 整合 Druid
使用注解整合 Mybatis

← 使用注解整合 Mybatis→

最近更新
01
学点统计学：轻松识破一本正经的胡说八道
06-05
02
2025 年 5 月记
05-31
03
《贫穷的本质》很棒，但可能不适合你
05-27
更多文章>
Theme by Vdoing | Copyright © 2022-2025 | 粤 ICP 备 2022067627 号 -1 | 粤公网安备 44011302003646 号 | 点击查看十年之约