Spring boot Mybatis 整合（注解版）

Bertha 。 2022-06-05 10:07 231阅读 0赞

> 之前写过一篇关于springboot 与 mybatis整合的博文，使用了一段时间[spring-data-jpa][]，发现那种方式真的是太爽了，mybatis的xml的映射配置总觉得有点麻烦。接口定义和映射离散在不同的文件中，阅读起来不是很方便。于是，准备使用mybatis的注解方式实现映射。如果喜欢xml方式的可以看我之前的博文：[ Spring boot Mybatis 整合（完整版）][Spring boot Mybatis]

### 个人开源项目 ###

*  [springboot+mybatis+thymeleaf+docker构建的个人站点开源项目（集成了个人主页、个人作品、个人博客）][springboot_mybatis_thymeleaf_docker]

### 最新 Spring Cloud Hoxton.RELEASE 版本 ###

*  [SpringCloud系列教程(一)开篇][SpringCloud]
 *  [SpringCloud系列教程(二)之Nacos | 8月更文挑战][SpringCloud_Nacos _ 8]
 *  [SpringCloud系列教程(三)之Open Feign | 8月更文挑战][SpringCloud_Open Feign _ 8]
 *  [SpringCloud系列教程(四)之SpringCloud Gateway | 8月更文挑战][SpringCloud_SpringCloud Gateway _ 8]
 *  [SpringCloud系列教程(五)之SpringCloud Gateway 网关聚合开发文档 swagger knife4j 和登录权限统一验证][SpringCloud_SpringCloud Gateway _ swagger knife4j]
 *  [SpringCloud系列教程(六)之SpringCloud 使用sentinel作为熔断器][SpringCloud_SpringCloud _sentinel]
 *  [SpringCloud系列教程(七)之使用Spring Cloud Sleuth+Zipkin实现链路追踪][SpringCloud_Spring Cloud Sleuth_Zipkin]

### 推荐开源项目 ###

*  [开源的springboot接口文档组件swagger2][springboot_swagger2]

### 更多干货 ###

[SpringBoot系列目录][SpringBoot]

### 源码 ###

请前往文章末端查看

### 开发环境： ###

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

*  开发工具：Intellij IDEA 2017.1.3
 *  JDK : 1.8.0\_101
 *  spring boot 版本 ： 1.5.8.RELEASE
 *  maven : 3.3.9

### 拓展： ###

*  springboot 整合 Mybatis 事务管理

### 开始 ###

#### 1.新建一个springboot项目： ####

![这里写图片描述][format_png]

![这里写图片描述][format_png 1]

**添加依赖**  
![这里写图片描述][format_png 2]

#### 2.看一下项目结构 ####

![这里写图片描述][format_png 3]

#### 3.完整依赖 ####

<?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>
    
    	<groupId>com.winterchen</groupId>
    	<artifactId>springboot-mybatis-demo2</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<packaging>jar</packaging>
    
    	<name>springboot-mybatis-demo2</name>
    	<description>Demo project for Spring Boot</description>
    
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.5.8.RELEASE</version>
    		<relativePath/> 
    	</parent>
    
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    		<java.version>1.8</java.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.mybatis.spring.boot</groupId>
    			<artifactId>mybatis-spring-boot-starter</artifactId>
    			<version>1.3.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>
    		</dependency>
    	</dependencies>
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>
    
    
    </project>

#### 4.配置文件 ####

因为习惯性的喜欢使用yml作为配置文件，所以将application.properties替换为application.yml

spring:
      datasource:
         url: jdbc:mysql://127.0.0.1:3306/mytest
         username: root
         password: root
         driver-class-name: com.mysql.jdbc.Driver

简单且简洁的完成了基本配置，下面看看我们是如何在这个基础下轻松使用Mybatis访问数据库的

### 使用Mybatis ###

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

*  在Mysql数据库中创建数据表：

CREATE DATABASE mytest;
    
    USE mytest;
    
    CREATE TABLE t_user(
      id BIGINT NOT NULL PRIMARY KEY AUTO_INCREMENT,
      name VARCHAR(255) NOT NULL ,
      password VARCHAR(255) NOT NULL ,
      phone VARCHAR(255) NOT NULL
    ) ENGINE=INNODB AUTO_INCREMENT=1000 DEFAULT CHARSET=utf8;

*  创建映射对象User

package com.winterchen.domain;
    
    /** * User实体映射类 * Created by Administrator on 2017/11/24. */
    
    public class User { 
    
        private Integer id;
        private String name;
        private String password;
        private String phone;
    
    	//省略 get 和 set ...
    }

*  创建User映射的操作UserMapper，为了后续单元测试验证，实现插入和查询操作

package com.winterchen.mapper;
    
    import com.winterchen.domain.User;
    import org.apache.ibatis.annotations.Insert;
    import org.apache.ibatis.annotations.Mapper;
    import org.apache.ibatis.annotations.Param;
    import org.apache.ibatis.annotations.Select;
    
    /** * User映射类 * Created by Administrator on 2017/11/24. */
    @Mapper
    public interface UserMapper { 
    
        @Select("SELECT * FROM T_USER WHERE PHONE = #{phone}")
        User findUserByPhone(@Param("phone") String phone);
    
        @Insert("INSERT INTO T_USER(NAME, PASSWORD, PHONE) VALUES(#{name}, #{password}, #{phone})")
        int insert(@Param("name") String name, @Param("password") String password, @Param("phone") String phone);
    
    }

**如果想了解更多Mybatis注解的详细：[springboot中使用Mybatis注解配置详解][springboot_Mybatis]**

*  创建springboot 主类：

package com.winterchen;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class SpringbootMybatisDemo2Application { 
    
    	public static void main(String[] args) { 
    		SpringApplication.run(SpringbootMybatisDemo2Application.class, args);
    	}
    }

*  创建测试单元:
    
     *  测试逻辑：插入一条name为"weinterchen"的User，然后根据user的phone进行查询，并判断user的name是否为"winterchen"。

package com.winterchen;
    
    import com.winterchen.domain.User;
    import com.winterchen.mapper.UserMapper;
    import org.junit.Assert;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootMybatisDemo2ApplicationTests { 
    
    
    	@Autowired
    	private UserMapper userMapper;
    
    	@Test
    	public void test(){ 
    
    		userMapper.insert("winterchen", "123456", "12345678910");
    		User u = userMapper.findUserByPhone("12345678910");
    		Assert.assertEquals("winterchen", u.getName());
    	}
    
    	
    
    }

*  测试结果

![这里写图片描述][format_png 4]

说明已经成功了。  
\*\*如果出现mapper注入不了的情况，请检查版本，当前博客的搭建方法只适合1.5.\*版本的，如果你的版本是2.0以上的版本，请参照我的另一篇博客的mybatis的配置：[springboot2.0整合mybatis][springboot2.0_mybatis] \*\*

### 事务管理（重要） ###

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

> 我们在开发企业应用时，对于业务人员的一个操作实际是对数据读写的多步操作的结合。由于数据操作在顺序执行的过程中，任何一步操作都有可能发生异常，异常会导致后续操作无法完成，此时由于业务逻辑并未正确的完成，之前成功操作数据的并不可靠，需要在这种情况下进行回退。

**为了测试的成功，请把测试的内容进行替换，因为之前测试的时候已经将数据生成了，重复的数据会对测试的结果有影响**

@Test
    	@Transactional
    	public void test(){ 
    
    		userMapper.insert("张三", "123456", "18600000000");
    		int a = 1/0;
    		userMapper.insert("李四", "123456", "13500000000");
    		User u = userMapper.findUserByPhone("12345678910");
    		Assert.assertEquals("winterchen", u.getName());
    	}

只需要在需要事务管理的方法上添加 `@Transactional` 注解即可，然后我们启动测试，会发现异常之后，数据库中没有产生数据。

如果大家想对springboot事务管理有更加详细的了解，欢迎大家查看：[ springboot事务管理详解][springboot]

源码：https://github.com/WinterChenS/springboot-mybatis-demo2/

微信公众号：CodeD  
![微信公众号][20200514112419921.jpg]

[spring-data-jpa]: http://blog.csdn.net/winter_chen001/article/details/78508337
[Spring boot Mybatis]: http://blog.csdn.net/winter_chen001/article/details/77249029
[springboot_mybatis_thymeleaf_docker]: https://blog.csdn.net/Winter_chen001/article/details/80266339
[SpringCloud]: https://blog.csdn.net/Winter_chen001/article/details/119326358
[SpringCloud_Nacos _ 8]: https://blog.csdn.net/Winter_chen001/article/details/119326477
[SpringCloud_Open Feign _ 8]: https://blog.csdn.net/Winter_chen001/article/details/119326508
[SpringCloud_SpringCloud Gateway _ 8]: https://blog.csdn.net/Winter_chen001/article/details/119343024
[SpringCloud_SpringCloud Gateway _ swagger knife4j]: https://blog.csdn.net/Winter_chen001/article/details/119381398
[SpringCloud_SpringCloud _sentinel]: https://blog.csdn.net/Winter_chen001/article/details/119410132
[SpringCloud_Spring Cloud Sleuth_Zipkin]: https://blog.csdn.net/Winter_chen001/article/details/119445542
[springboot_swagger2]: https://blog.csdn.net/Winter_chen001/article/details/81335225
[SpringBoot]: https://blog.csdn.net/Winter_chen001/article/details/80537829
[format_png]: /images/20220605/408a71aaf0164a969a2e2097629ea0cf.png
[format_png 1]: /images/20220605/1a0a2a2a3def401fb775905e5385ac13.png
[format_png 2]: /images/20220605/5e3f10d8e0204d83b8c1f0356c30eb37.png
[format_png 3]: /images/20220605/2cde4681aed747508536592830188f42.png
[springboot_Mybatis]: http://blog.csdn.net/winter_chen001/article/details/78623700
[format_png 4]: /images/20220605/3aaf22bfbd64418e8a89f5ad1b274a35.png
[springboot2.0_mybatis]: https://blog.csdn.net/Winter_chen001/article/details/80010967
[springboot]: http://blog.csdn.net/Winter_chen001/article/details/78622679
[20200514112419921.jpg]: /images/20220605/4ebc04b46ef14b81b6c0ddf415a7ab00.png