SpringBoot整合MyBatis完整详细版

野性酷女 2023-06-19 14:25 75阅读 0赞

> **写在前面：** 从2018年底开始学习SpringBoot，也用SpringBoot写过一些项目。现在想对学习Springboot的一些知识总结记录一下。如果你也在学习SpringBoot，可以关注我，一起学习，一起进步。

**相关文章：**

[【Springboot系列】Springboot入门到项目实战][Springboot_Springboot]

--------------------

上一篇写了[SpringBoot整合JdbcTemplate][SpringBoot_JdbcTemplate]，JdbcTemplate虽然简单，但在实际开发中用的并不多，因为它没有MyBatis方便，MyBatis是一个优秀的持久层框架，在实体类和SQL语句之间建立了映射关系，MyBatis支持普通SQL查询，存储过程和高级映射。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis使用简单的XML或者注解进行配置和原始映射，将查询出的数据库记录映射成java对象。这篇来看看在Spring Boot中MyBatis要如何使用。

**目录**

搭建项目

1、项目结构

2、创建SpringBoot项目

3、添加相关依赖

4、编写相关配置

表结构设计

1、表结构

2、建表

编写代码

1、编写实体类

2、编写xml文件，SQL查询

3、编写Mapper接口

3、编写业务层类

测试应用

1、编写测试Controller

2、测试应用

--------------------

**本文章项目下载地址：[SpringBoot整合Mybatis，增删改查分页动态查询。][SpringBoot_Mybatis]**

## 搭建项目 ##

### 1、项目结构 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70][]

### 2、创建SpringBoot项目 ###

**创建一个SpringBoot项目，添加Web依赖，MyBatis依赖以及MySQL驱动依赖，如下：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 1][]

### 3、添加相关依赖 ###

创建完成后，添加对应的依赖，完整的pom.xml文件如下。

<?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 https://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.2.1.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.mcy</groupId>
        <artifactId>springboot-mybatis</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>springboot-mybatis</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.0.9</version>
            </dependency>
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>2.1.1</version>
            </dependency>
    
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

### 4、编写相关配置 ###

在src/main/resources下找到application.properties文件，在该配置文件中配置数据源。

spring.datasource.url=jdbc:mysql://localhost:3306/mybatis?serverTimezone=GMT%2B8
    spring.datasource.username=root
    spring.datasource.password=root
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    
    #连接池的配置
    spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
    
    server.port=80
    
    #配置mapper  xml文件所在的路径
    mybatis.mapper-locations=classpath:mapper/*.xml
    #mybatis别名包扫描，映射类所在的包名，对应实体类的包名
    mybatis.type-aliases-package=com.mcy.springbootmybatis.entity

这里需要注意的是两个配置xml和实体类包路径不能出错，不然会报错。

#配置mapper  xml文件所在的路径
    mybatis.mapper-locations=classpath:mapper/*.xml
    #mybatis别名包扫描，映射类所在的包名，对应实体类的包名
    mybatis.type-aliases-package=com.mcy.springbootmybatis.entity

## 表结构设计 ##

### 1、表结构 ###

设计了一张tb\_user用户表，表结构如下。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 2][]

### 2、建表 ###

执行以下脚本在数据库中创建tb\_user表。

CREATE TABLE `tb_user` (
      `id` int(11) NOT NULL AUTO_INCREMENT,
      `name` varchar(255) DEFAULT NULL,
      `username` varchar(255) DEFAULT NULL,
      `password` varchar(255) DEFAULT NULL,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

## 编写代码 ##

在项目中新建4个包，分别为entity（放置持久化类）、controller（控制器）、mapper（定义数据访问接口的包）、service（业务逻辑处理类）。在resources目录下创建mapper文件夹。代码中有详细的注释，下面直接贴代码。

### 1、编写实体类 ###

实体类User.java，其代码如下（和数据库字段需要对应，继承分页公共类MyEverpage）。

public class User extends MyEverpage {
        private Integer id;
        private String name;
        private String username;
        private String password;
    
        public Integer getId() {
            return id;
        }
    
        public void setId(Integer id) {
            this.id = id;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public String getUsername() {
            return username;
        }
    
        public void setUsername(String username) {
            this.username = username;
        }
    
        public String getPassword() {
            return password;
        }
    
        public void setPassword(String password) {
            this.password = password;
        }
    }

分页查询参数公共类MyEverpage.java，代码如下。

/**
     * 分页类
     * @author Administrator
     *
     */
    public class MyEverpage {
    	private int limit;
    	private int offset;
    
    	public int getLimit() {
    		return limit;
    	}
    
    	public void setLimit(int limit) {
    		this.limit = limit;
    	}
    
    	public int getOffset() {
    		return offset;
    	}
    
    	public void setOffset(int offset) {
    		this.offset = offset;
    	}
    	
    }

### 2、编写xml文件，SQL查询 ###

在resources/mapper文件夹下新建一个UserMapper.xml文件，编写查询语句，代码如下（这里的xml路径一定要和application.properties配置文件中的路径一致）。

<?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.mcy.springbootmybatis.mapper.UserMapper">
        
        <select id="findAll" resultType="User">
    		select * from tb_user
    	</select>
        
        <select id="findByName" parameterType="User" resultType="User">
    		select * from tb_user where name=#{name}
    	</select>
        
        <select id="findByUsernameLike" parameterType="User" resultType="User">
    		select * from tb_user where username like "%"#{username}"%"
    	</select>
    	
    	<select id="findById" parameterType="User" resultType="User">
    		select * from tb_user where id = #{id}
    	</select>
        
        <select id="find" parameterType="User" resultType="User">
    		select * from tb_user where 1=1
            <if test="name != '' and name != null">
                and name =#{name}
            </if>
            <if test="username != '' and username != null">
                and username =#{username}
            </if>
    	</select>
        
        <select id="findByPageAll" parameterType="User" resultType="User">
    		select * from tb_user limit #{offset},#{limit}
    	</select>
        
        <insert id="addSave" parameterType="User">
    		insert into tb_user values(null, #{name}, #{username}, #{password})
    	</insert>
        
        <update id="update" parameterType="User">
    		update tb_user set name=#{name}, username=#{username}, password=#{password}
    		where id=#{id}
    	</update>
    </mapper>

### 3、编写Mapper接口 ###

UserMapper.java接口，代码如下（需要添加@Mapper注解，方法名需要额xml中的id值对应）。

import com.mcy.springbootmybatis.entity.User;
    import org.apache.ibatis.annotations.Mapper;
    
    import java.util.List;
    
    @Mapper
    public interface UserMapper {
        //查询所有，方法名需要和UserMapper.xml中的id对应
        public List<User> findAll();
    
        //根据姓名查询
        public List<User> findByName(String name);
    
        //根据用户名模糊查询
        public List<User> findByUsernameLike(String username);
    
        //根据id查询
        public User findById(Integer id);
    
        //多条件动态查询
        public List<User> find(User user);
    
        //分页查询
        public List<User> findByPageAll(User user);
    
        //新增
        public void addSave(User user);
    
        //修改
        public void update(User user);
    }

### 3、编写业务层类 ###

UserService.java业务层类。

import com.mcy.springbootmybatis.entity.User;
    import com.mcy.springbootmybatis.mapper.UserMapper;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    import java.util.List;
    
    @Service
    public class UserService {
        @Autowired
        private UserMapper userMapper;
    
        //查询所有，方法名需要和UserMapper.xml中的id对应
        public List<User> findAll(){
            return userMapper.findAll();
        };
    
        //根据姓名查询
        public List<User> findByName(String name){
            return userMapper.findByName(name);
        };
    
        //根据用户名模糊查询
        public List<User> findByUsernameLike(String username){
            return userMapper.findByUsernameLike(username);
        };
    
        //根据id查询
        public User findById(Integer id){
            return userMapper.findById(id);
        };
    
        //多条件动态查询
        public List<User> find(User user){
            return userMapper.find(user);
        };
    
        //分页查询
        public List<User> findByPageAll(User user){
            return userMapper.findByPageAll(user);
        };
    
        //新增
        public void addSave(User user){
            userMapper.addSave(user);
        };
    
        //修改
        public void update(User user){
            userMapper.update(user);
        };
    }

## 测试应用 ##

### 1、编写测试Controller ###

访问控制器UserController.java类，代码如下。

import com.mcy.springbootmybatis.entity.User;
    import com.mcy.springbootmybatis.service.UserService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.List;
    
    @RestController
    @RequestMapping("/user")
    public class UserController {
        @Autowired
        private UserService userService;
    
        //查询所有，方法名需要和UserMapper.xml中的id对应
        @RequestMapping("/findAll")
        public List<User> findAll(){
            return userService.findAll();
        };
    
        //根据姓名查询
        @RequestMapping("/findByName")
        public List<User> findByName(String name){
            return userService.findByName(name);
        };
    
        //根据用户名模糊查询
        @RequestMapping("/findByUsernameLike")
        public List<User> findByUsernameLike(String username){
            return userService.findByUsernameLike(username);
        };
    
        //根据id查询用户对象
        @RequestMapping("/findById")
        public User findById(Integer id){
            return userService.findById(id);
        }
    
        //多条件动态查询
        @RequestMapping("/find")
        public List<User> find(User user){
            return userService.find(user);
        };
    
        //分页查询
        @RequestMapping("/findByPageAll")
        public List<User> findByPageAll(User user){
            return userService.findByPageAll(user);
        };
    
        //新增
        @RequestMapping("/addSave")
        public String addSave(){
            User user = new User();
            user.setName("张三");
            user.setUsername("admin");
            user.setPassword("admin");
            userService.addSave(user);
            user.setName("李四");
            user.setUsername("123456");
            user.setPassword("123456");
            userService.addSave(user);
            user.setName("王五");
            user.setUsername("user");
            user.setPassword("123456");
            userService.addSave(user);
            return "数据保存成功！";
        };
    
        //修改
        @RequestMapping("/update")
        public String update(){
            User user = userService.findById(1);
            user.setName("诸葛亮");
            userService.update(user);
            return "修改成功！";
        };
    }

### 2、测试应用 ###

运行项目，在浏览器中访问[http://localhost/user/addSave][http_localhost_user_addSave]，调用添加方法，添加保存方法中对应的数据，执行成功后返回“数据保存成功！”，如图。

![20191206224538980.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 3][]

测试查询所有方法，在浏览器中输入[http://localhost/user/findAll][http_localhost_user_findAll]，查询数据库中所有数据，如图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 4][]

测试修改方法，在浏览器中输入[http://localhost/user/update][http_localhost_user_update]，修改成功返回“修改成功！”，如图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 5][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 6][]

测试动态查询，在浏览器中输入[http://localhost/user/find?name=李四][http_localhost_user_find_name]，查询返回结果如图。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 7][]

测试分页查询，在浏览器中输入[http://localhost/user/findByPageAll?offset=1&limit=2][http_localhost_user_findByPageAll_offset_1_limit_2]，从索引为1开始查询，查询3条数据，索引是从0开始的，查询结构如图。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 8][]

> 基本查询就这些了，有什么不足之处，欢迎大家指出，期待与你的交流。

[Springboot_Springboot]: https://blog.csdn.net/qq_40205116/article/details/104269651
[SpringBoot_JdbcTemplate]: https://blog.csdn.net/qq_40205116/article/details/103358239
[SpringBoot_Mybatis]: https://github.com/machaoyin/springboot-mybatis
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191206222354913.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191206221946957.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200218162858411.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2,size_16,color_FFFFFF,t_70
[http_localhost_user_addSave]: http://localhost/user/addSave
[20191206224538980.png]: https://img-blog.csdnimg.cn/20191206224538980.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20191206224630294.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2,size_16,color_FFFFFF,t_70
[http_localhost_user_findAll]: http://localhost/user/findAll
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20191206224749784.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2,size_16,color_FFFFFF,t_70
[http_localhost_user_update]: http://localhost/user/update
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20191206224842800.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20191206224911400.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2,size_16,color_FFFFFF,t_70
[http_localhost_user_find_name]: http://localhost/user/find?name=%E6%9D%8E%E5%9B%9B
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20191206225040971.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2,size_16,color_FFFFFF,t_70
[http_localhost_user_findByPageAll_offset_1_limit_2]: http://localhost/user/findByPageAll?offset=1&limit=2
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/20191206225346157.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMjA1MTE2,size_16,color_FFFFFF,t_70