SpringBoot中使用Mybatis持久层框架操作数据库

SpringBoot项目中绝大多数的数据都是存储在数据库中，所以项目与数据库的交互是很常有的操作。SpringBoot项目中我们可以使用JDBC去连接数据库，但是有非常多的 JDBC 代码、手动设置参数以及获取结果集会耗费很多时间。MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。

创建项目配置pom.xml

使用IDEA开发工具创建一个空的Maven项目，pom.xml引入springboot、mybatis以及mysql数据库驱动依赖:

<?xml version="1.0" encoding="UTF-8"?>
<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.4.RELEASE</version>
    </parent>

    <groupId>com.flyduck</groupId>
    <artifactId>mybatis</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>mybatis</name>
    <description>mybatis使用Demo</description>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.3</version>
        </dependency>

    </dependencies>

    <!-- 其他build配置 -->
</project>

 创建mybatis的mapper(dao)、entity以及mapper.xml

我们可以手动的创建数据库表对应的实体类entity，以及操作实体类entity的mapper(dao)和对应的mapper.xml配置。但是这是一个偏重复的工作，会耗费我们大量的时间。我们可以使用mybatis generator逆向工具自动生成entity以及基础的mapper(dao)，参考：IDEA中使用Mybatis Generator自动生成ORM相应的代码。这里我们只是用mybatis generator自动生成mybatis相关的代码。生成后的项目结构如下：

注册mapper(dao)为bean

我们需要将实体类对应的mapper(dao)注册为java bean才能够正常的工作，有两种方式可以注册为java bean。一种是通过@Mapper注解的方式 ，另一种通过@MapperScan扫描的方式。

@Mapper注解方式

需要在每一个mapper(dao)接口类上加上@Mapper，比如在上面生成的UserMapper接口类上需要手动的加上@Mapper注解：

package com.flyduck.mybatis.mapper;

import com.flyduck.mybatis.entity.User;
import org.apache.ibatis.annotations.Mapper;

import java.util.List;

@Mapper
public interface UserMapper {
    /**
     * This method was generated by MyBatis Generator.
     * This method corresponds to the database table user
     *
     * @mbg.generated Sun Nov 15 21:45:32 CST 2020
     */
    int deleteByPrimaryKey(Long id);

    /**
     * This method was generated by MyBatis Generator.
     * This method corresponds to the database table user
     *
     * @mbg.generated Sun Nov 15 21:45:32 CST 2020
     */
    int insert(User record);

    /**
     * This method was generated by MyBatis Generator.
     * This method corresponds to the database table user
     *
     * @mbg.generated Sun Nov 15 21:45:32 CST 2020
     */
    User selectByPrimaryKey(Long id);

    /**
     * This method was generated by MyBatis Generator.
     * This method corresponds to the database table user
     *
     * @mbg.generated Sun Nov 15 21:45:32 CST 2020
     */
    List<User> selectAll();

    /**
     * This method was generated by MyBatis Generator.
     * This method corresponds to the database table user
     *
     * @mbg.generated Sun Nov 15 21:45:32 CST 2020
     */
    int updateByPrimaryKey(User record);
}

 @MapperScan扫描方式

通过@Mapper注解的方式我们需要在每个mapper(dao)接口类上增加，当接口类比较多的时候回很繁琐。而且当我们使用mybatis generator逆向工具生成的接口类，如果更新表结构重新生成后，需要我们手动再次处理@Mapper注解，增加我们重复的工作。此时我们可以在Application启动类上通过@MapperScan包扫描的方式将mapper(dao)注册为bean。

package com.flyduck.mybatis;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;


@SpringBootApplication
@MapperScan("com.flyduck.mybatis.mapper")
public class MybatisApplication {

    public static void main(String[] args) {
        SpringApplication.run(MybatisApplication.class, args);
    }
}

配置mybatis.mapper-locations

我们需要在application.yml文件中配置mybatis的mapper-locations，mapper-locations需要配置为mybatis的mapper(dao)对应的xml文件:

server:
  port: 9005
  # tomcat params.
  tomcat:
    uri-encoding: utf-8
    max-connections: 10000
    threads:
      max: 1000
spring:
  application:
    name: mybatis

# mybatis配置
mybatis:
  mapper-locations: classpath:mybatis/mapper/*.xml

# --- logging config   --
logging:
  config: classpath:logback-spring.xml

project:
  # config for logback file.
  log:
    path: ./logs
    level: INFO

测试

创建UserController控制器，开发测试接口，示例程序如下：

@RestController
@RequestMapping("user")
public class UserController {

    @Autowired
    private UserMapper userMapper;

    @GetMapping("{id}")
    public User get(@PathVariable Long id) {
        User user  = userMapper.selectByPrimaryKey(id);
        return user;
    }
}

运行SpringBoot项目，访问接口通过mybatis从数据库获取数据成功：

总结 

项目先通过maven引入SpringBoot、mybatis以及mysql驱动依赖，正确配置pom.xml。然后通过mybatis generator逆向工具自动创建mybatis相关实体类、mapper(dao)接口以及xml配置文件。然后将mapper(dao)注册为java bean交给Spring管理。接着配置mybatis的mapper-locations正确加载xml配置文件，最后我们创建测试控制器UserController测试mybatis获取数据。这是SpringBoot使用mybatis的一个基本步骤，实际项目中我们肯定会根据情况自己手动扩展mapper(dao)接口类。完整的示例代码地址：https://gitee.com/flyduck128/springboot-demo/tree/master/flyduck-mybatis。本文总结了实际项目中mybatis的基本使用过程，将需要的配置和使用方式做一个演示，希望可以给其他小伙伴提供一些帮助，如果有描述错误的地方欢迎指正。