Spring Boot 3 集成 MyBatis详解

梦里梦外; 2024-02-05 13:52 49阅读 0赞

MyBatis是一款开源的持久层框架，它极大地简化了与数据库的交互流程。与类似Hibernate的ORM框架不同，MyBatis更具灵活性，允许开发者直接使用SQL语句与数据库进行交互。Spring Boot和MyBatis分别是两个功能强大的框架，它们的协同使用可以极大地简化数据访问层的开发，提高整体的开发效率。本文将详细介绍在Spring Boot项目中如何集成MyBatis，以实现对数据库的轻松访问和操作。

![springboot3-mybatis.jpg][]

### 添加依赖 ###

Spring Boot 3 发布后,Mybatis Starter相对应的`mybatis-spring-boot-starter`版本为3.x

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

### 添加配置文件 ###

常用的mybatis配置如下所示：

mybatis:
      mapper-locations: classpath:mybatis/**/*Mapper.xml
      type-aliases-package: cn.xj.xjdoc.**.entity
      configuration:
        map-underscore-to-camel-case: true

参数说明：

*  mybatis.mapper-locations：指定MyBatis的Mapper XML文件的位置。
 *  mybatis.type-aliases-package：指定MyBatis的类型别名包，即包含实体类的包路径，方便在xml配置文件中使用实体类时不用写包名。
 *  mybatis.configuration.map-underscore-to-camel-case：开启或关闭驼峰命名法的自动映射功能。true表示开启，将数据库字段的下划线风格（例如，user\_name）自动映射为Java实体类的驼峰命名风格（例如，userName）。

### 创建实体类和Mapper接口 ###

创建一个实体类，表示数据库中的表，然后创建一个Mapper接口，用于定义数据库操作的方法。示例：

实体类SysUser：

@Data
    public class SysUser {
        
        private String userName;
        private String account;
    }

Mapper接口SysUserMapper:

@Mapper
    public interface SysUserMapper {
        
        List<SysUser> listUser();
    }

如果我们在启动类上使用了 `@MapperScan` 注解，就可以批量扫描 MyBatis 的 Mapper 接口所在的包，并将这些接口注册为 MyBatis 的映射器。在这种情况下，Mapper 接口本身就不再需要使用 `@Mapper` 注解来明确标识其为 MyBatis 的 Mapper 接口了。

@SpringBootApplication
    @MapperScan("cn.xj.xjdoc.**.mapper")
    public class XjdocApplication {
        
    	public static void main(String[] args) {
        
    		SpringApplication.run(XjdocApplication.class, args);
    	}
    
    }

### 创建Mapper XML文件 ###

<?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="cn.xj.xjdoc.system.mapper.SysUserMapper">
    
        <select id="listUser"  resultType="SysUser">
            select * from sys_user
        </select>
    </mapper>

最后，运行你的Spring Boot应用程序，并确保没有错误发生。访问相关端点，测试数据库操作是否正常。

### 总结 ###

总体而言，Spring Boot集成MyBatis为开发者提供了一套高效而又易于维护的数据库访问方案。通过合理的配置和良好的代码组织，我们能够快速搭建出健壮可靠的数据访问层，为整个应用的开发打下坚实基础。

[springboot3-mybatis.jpg]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/085179de722c4e83a029191e3962bc7e.png