MyBatis初级实战之一：Spring Boot集成

我会带着你远行 2023-03-06 03:41 3阅读 0赞

### MyBatis初级实战 ###

《MyBatis初级实战》系列旨在通过一系列编码实战，和读者一起掌握MyBatis的基本用法，帮助初学者快速运用MyBatis参与实际开发；

### 聚焦MyBatis ###

《MyBatis初级实战》面向的是对MyBatis有兴趣的读者，向读者们提供可用的方案和代码，这里不是比较Hibernate、sqltoy-orm的地方，作者也十分认可这些ORM框架，但《MyBatis初级实战》不参与比较；

### 关于MyBatis ###

引自官方：MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

### 实战环境 ###

《MyBatis初级实战》系列的环境信息如下：

1.  JDK：1.8.0\_181
2.  mybatis-spring-boot-starter：2.1.3（对应的MyBatis：3.5.5）
3.  Spring Boot：2.3.2.RELEASE
4.  MySQL：5.7.29
5.  实战环境：win10
6.  开发工具：IntelliJ IDEA 2019.2.1 (Ultimate Edition)

### Spring Boot集成MyBatis常规步骤概览 ###

Spring Boot集成MyBatis的常规步骤如下：

1.  maven中添加mybatis-spring-boot-starter的依赖；
2.  Spring Boot的配置中指定MyBatis配置文件的位置；
3.  Spring Boot的配置中指定MyBatis映射文件的位置；
4.  添加MyBatis配置文件，后续MyBatis的常规配置集中在此；
5.  映射文件xxxMapper.xml及其对应的接口文件；
6.  业务代码中，Autowired注解修饰接口文件并使用；

*  接下来开始实战，咱们先把数据准备好；

### 准备数据 ###

1.  请您自行准备好MySQL服务，我这边MySQL是部署在docker上的，可以参考[《群晖DS218+部署mysql》][DS218_mysql]；
2.  创建名为mybatis的数据库；
3.  在mybatis数据库下执行以下SQL，即可创建本次实战所需数据：

USE mybatis;
    
    DROP TABLE IF EXISTS `user`;
    
    CREATE TABLE `user` (
      `id` int(32) NOT NULL AUTO_INCREMENT,
      `name` varchar(32) NOT NULL,
      `age` int(32) NOT NULL,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;
    
    
    DROP TABLE IF EXISTS `log`;
    
    CREATE TABLE `log` (
      `id` int(32) NOT NULL AUTO_INCREMENT,
      `user_id` int(32),
      `action` varchar(255) NOT NULL,
      `create_time` datetime not null,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;
    
    INSERT INTO mybatis.user (id, name, age) VALUES (3, 'tom', 11);
    INSERT INTO mybatis.log (id, user_id, action, create_time) VALUES (3, 3, 'read book', '2020-08-07 08:18:16');

### 源码下载 ###

1.  如果您不想编码，可以在GitHub下载所有源码，地址和链接信息如下表所示(https://github.com/zq2599/blog\_demos)：

<table> 
 <thead> 
  <tr> 
   <th align="left">名称</th> 
   <th align="left">链接</th> 
   <th align="left">备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">项目主页</td> 
   <td align="left">https://github.com/zq2599/blog_demos</td> 
   <td align="left">该项目在GitHub上的主页</td> 
  </tr> 
  <tr> 
   <td align="left">git仓库地址(https)</td> 
   <td align="left">https://github.com/zq2599/blog_demos.git</td> 
   <td align="left">该项目源码的仓库地址，https协议</td> 
  </tr> 
  <tr> 
   <td align="left">git仓库地址(ssh)</td> 
   <td align="left">git@github.com:zq2599/blog_demos.git</td> 
   <td align="left">该项目源码的仓库地址，ssh协议</td> 
  </tr> 
 </tbody> 
</table>

1.  这个git项目中有多个文件夹，本章的应用在mybatis文件夹下，如下图红框所示：  
    ![在这里插入图片描述][20200808201256277.png]

### 关于父子工程 ###

为了整个系列的代码好管理，我这边用maven创建的是父子工程，如果您只要子工程，不需要父子结构，要对子工程的pom.xml做以下调整：

1.  parent节点原本如下：

<parent>
            <groupId>com.bolingcavalry</groupId>
            <artifactId>mybatis</artifactId>
            <version>1.0-SNAPSHOT</version>
            <relativePath>../pom.xml</relativePath>
        </parent>

请替换成以下内容(也就是直接用>spring-boot-starter-parent作为父工程)：

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

1.  子工程种的dependency节点中没有version子节点，这些都放在父工程的dependencyManagement中统一管理了，请您将version添加到子工程的各个dependency节点：  
    ![在这里插入图片描述][20200808120803731.png]

*  接下来开始编码

### 创建父工程 ###

创建名为mybatis的maven工程，pom.xml内容如下：

*  至此，准备工作算是全部完成了，接下来咱们开始创建一个典型的Spring Boot集成MyBatis的项目吧；

### Spring Boot集成MyBatis ###

1.  在父工程mybatis之下新建名为simple的Spring Boot子工程，其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>com.bolingcavalry</groupId>
            <artifactId>mybatis</artifactId>
            <version>1.0-SNAPSHOT</version>
            <relativePath>../pom.xml</relativePath>
        </parent>
    
        <groupId>com.bolingcavalry</groupId>
        <artifactId>simple</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>simple</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>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>2.1.3</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>

1.  Spring Boot配置文件是simple/src/main/resources/application.yml，内容如下：

server:
      port: 8080
    
    spring:
      # 数据源
      datasource:
        username: root
        password: 123456
        url: jdbc:mysql://192.168.50.43:3306/mybatis?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
        driver-class-name: com.mysql.cj.jdbc.Driver
    
    # mybatis配置
    mybatis:
      # 配置文件所在位置
      config-location: classpath:mybatis-config.xml
      # 映射文件所在位置
      mapper-locations: classpath:mappers/*Mapper.xml
    
    # 日志配置
    logging:
      level:
        root: INFO
        com:
          bolingcavalry:
            simple:
              mapper: debug

1.  新建user表对应的实体类User.java：

package com.bolingcavalry.simple.entity;
    
    /** * @Description: 实体类 * @author: willzhao E-mail: zq2599@gmail.com * @date: 2020/8/4 8:24 */
    public class User { 
        private Integer id;
        private String name;
        private Integer age;
    
        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 Integer getAge() { 
            return age;
        }
    
        public void setAge(Integer age) { 
            this.age = age;
        }
    
        @Override
        public String toString() { 
            return "User{" +
                    "id=" + id +
                    ", name='" + name + '\'' +
                    ", age=" + age +
                    '}';
        }
    }

1.  新建log表对应的实体类Log.java：

package com.bolingcavalry.simple.entity;
    
    import java.sql.Date;
    
    /** * @Description: 实体类 * @author: willzhao E-mail: zq2599@gmail.com * @date: 2020/8/4 8:24 */
    public class Log { 
        private Integer id;
        private Integer userId;
        private String action;
        private Date createTime;
    
        public Integer getId() { 
            return id;
        }
    
        public void setId(Integer id) { 
            this.id = id;
        }
    
        public Integer getUserId() { 
            return userId;
        }
    
        public void setUserId(Integer userId) { 
            this.userId = userId;
        }
    
        public String getAction() { 
            return action;
        }
    
        public void setAction(String action) { 
            this.action = action;
        }
    
        public Date getCreateTime() { 
            return createTime;
        }
    
        public void setCreateTime(Date createTime) { 
            this.createTime = createTime;
        }
    
        @Override
        public String toString() { 
            return "Log{" +
                    "id=" + id +
                    ", userId=" + userId +
                    ", action='" + action + '\'' +
                    ", createTime=" + createTime +
                    '}';
        }
    }

1.  接下来会新建三个配置文件，先来看下它们的位置，以免后面放错地方引起不必要的麻烦：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70]
2.  application.yml所在目录下，新增名为mybatis-config.xml的文件，这是mybatis的配置文件，本例很简单只有一个配置，内容如下：

<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
    <configuration>
        <typeAliases>
            
            <package name="com.bolingcavalry.simple.entity"/>
        </typeAliases>
    </configuration>

1.  resources/mappers目录下，新增名为UserMapper.xml的文件，和user表相关的查询都在此，本文只有一个查询user表的操作，注意下文中的resultType等于User，这里没有写User类的完整路径，是因为前面mybatis-config.xml文件中配置了typeAliases的package节点的缘故：

<?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.bolingcavalry.simple.mapper.UserMapper">
        <select id="sel" parameterType="int" resultType="User">
            select * from user where id = #{id}
        </select>
    </mapper>

1.  再新增LogMapper.xml，如下所示，log表中的user\_id字段在Log.java中没有同名的字段，因此要新增resultMap来建立数据库和实体类的字段映射关系，再在select节点用上这个关系，注意要用resultMap属性(UserMapper.xml中用的是resultType)：

<?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.bolingcavalry.simple.mapper.LogMapper">
    
        <resultMap id="logResultMap" type="Log">
            <id property="id" column="id" />
            <result column="user_id" jdbcType="INTEGER" property="userId" />
            <result column="action" jdbcType="VARCHAR" property="action" />
            <result column="create_time" jdbcType="TIMESTAMP" property="createTime" />
        </resultMap>
    
        <select id="sel" parameterType="int" resultMap="logResultMap">
            select * from log where id = #{id}
        </select>
    </mapper>

1.  接下来是业务要用到的接口文件，第一个是UserMapper.java：

package com.bolingcavalry.simple.mapper;
    
    import com.bolingcavalry.simple.entity.User;
    import org.springframework.stereotype.Repository;
    
    @Repository
    public interface UserMapper { 
        User sel(int id);
    }

1.  第二个是LogMapper.java：

package com.bolingcavalry.simple.mapper;
    
    import com.bolingcavalry.simple.entity.Log;
    import org.springframework.stereotype.Repository;
    
    @Repository
    public interface LogMapper { 
        Log sel(int id);
    }

1.  上述两个类都使用了Repository注解，作用是避免在编码过程中,IDEA给出红线提示，如下图：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 1]
2.  映射配置完毕，接下来就可以在应用中使用了，先为user做一个service类UserService.java，里面通过Autowired注解注入UserMapper的实现：

package com.bolingcavalry.simple.service;
    
    import com.bolingcavalry.simple.entity.User;
    import com.bolingcavalry.simple.mapper.UserMapper;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    @Service
    public class UserService { 
        @Autowired
        UserMapper userMapper;
    
        public User sel(int id){ 
            return userMapper.sel(id);
        }
    }

1.  再为log做service类LogService.java：

package com.bolingcavalry.simple.service;
    
    import com.bolingcavalry.simple.entity.Log;
    import com.bolingcavalry.simple.mapper.LogMapper;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    @Service
    public class LogService { 
        @Autowired
        LogMapper logMapper;
    
        public Log sel(int id){ 
            return logMapper.sel(id);
        }
    }

1.  最后是响应web请求的controller类，第一个是UserController.java：

package com.bolingcavalry.simple.controller;
    
    import com.bolingcavalry.simple.service.UserService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class UserController { 
        @Autowired
        private UserService userService;
    
        @RequestMapping("user/{id}")
        public String GetUser(@PathVariable int id){ 
            return userService.sel(id).toString();
        }
    }

1.  然后是LogController.java：

package com.bolingcavalry.simple.controller;
    
    import com.bolingcavalry.simple.service.LogService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class LogController { 
        @Autowired
        private LogService logService;
    
        @RequestMapping("log/{id}")
        public String log(@PathVariable int id){ 
            return logService.sel(id).toString();
        }
    }

1.  最后是引导类SimpleApplication.java，注意MapperScan注解会自动扫描包路径下的所有接口，这样UserMapper和LogMapper就不用加Mapper注解了：

package com.bolingcavalry.simple;
    
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @MapperScan("com.bolingcavalry.simple.mapper")
    public class SimpleApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(SimpleApplication.class, args);
        }
    }

*  至此，编码完成，可以启动验证了；

### 验证 ###

1.  启动SpringBoot应用的方式有两种，最简单的办法是再IDEA中直接启动，如下图：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 2]
2.  第二种是simple的目录下执行mvn clean package -U，就会在target目录得到文件simple-0.0.1-SNAPSHOT.jar，再执行java -jar simple-0.0.1-SNAPSHOT.jar即可启动；
3.  在浏览器访问http://localhost:8080/user/3，可以得到user表的查询结果：  
    ![在这里插入图片描述][20200808194740729.png]
4.  访问http://localhost:8080/log/3，可以得到log表的查询结果：  
    ![在这里插入图片描述][20200808195116327.png]
5.  在控制台可以看到日志如下所示，这是我们开发期间调试问题的重要线索：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 3]  
    至此，入门级SpringBoot集成MyBatis的实战就完成了，接下来的系列内容会有更多实战，咱们一起来学习和掌握MyBatis的基本用法；

[DS218_mysql]: https://blog.csdn.net/boling_cavalry/article/details/105460567
[20200808201256277.png]: /images/20230208/c450cf01d3074bbbb8e7d5f584d63a69.png
[20200808120803731.png]: /images/20230208/8f4e909fa12b42e380fba976b6bc9cd0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70]: /images/20230208/9893829176ff45a09249c865f78493af.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 1]: /images/20230208/5243eac57d3542cab7a3d541bd328d60.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 2]: /images/20230208/d7262de0e91f4b6ba9594975e0f2637c.png
[20200808194740729.png]: /images/20230208/aa014fa8055b47ef8395b7d3281aae08.png
[20200808195116327.png]: /images/20230208/1562c7207a914ffbb7101c9795c06fb4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 3]: /images/20230208/ef34ece5b52c4444bb7e880dae02c4d0.png