Spring Boot整合MyBatis

最近项目原因可能会继续开始使用MyBatis，已经习惯于spring-data的风格，再回头看xml的映射配置总觉得不是特别舒服，接口定义与映射离散在不同文件中，使得阅读起来并不是特别方便。

Spring中整合MyBatis就不多说了，最近大量使用Spring Boot，因此整理一下Spring Boot中整合MyBatis的步骤。搜了一下Spring Boot整合MyBatis的文章，方法都比较老，比较繁琐。查了一下文档，实际已经支持较为简单的整合与使用。下面就来详细介绍如何在Spring Boot中整合MyBatis，并通过注解方式实现映射。

整合MyBatis

pom.xml中引入依赖

这里用到spring-boot-starter基础和spring-boot-starter-test用来做单元测试验证数据访问

引入连接mysql的必要依赖mysql-connector-java

引入整合MyBatis的核心依赖mybatis-spring-boot-starter

这里不引入spring-boot-starter-jdbc依赖，是由于mybatis-spring-boot-starter中已经包含了此依赖

{% highlight null %}

org.mybatis.spring.boot

mybatis-spring-boot-starter

1.1.1

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.21</version>
</dependency>

{% endhighlight %}

同之前介绍的使用jdbc和spring-data连接数据库一样，在application.properties中配置mysql的连接配置

{% highlight null %}

spring.datasource.url=jdbc:mysql://localhost:3306/test

spring.datasource.username=root

spring.datasource.password=1234567890

spring.datasource.driver-class-name=com.mysql.jdbc.Driver

{% endhighlight %}

同其他Spring Boot工程一样，简单且简洁的的完成了基本配置，下面看看如何在这个基础下轻松方便的使用MyBatis访问数据库。

使用MyBatis

在Mysql中创建User表，包含id(BIGINT)、name(INT)、age(VARCHAR)字段。同时，创建映射对象User

{% highlight java %}

public class User {

private Long id;

private String name;

private Integer age;

// 省略getter和setter

}

{% endhighlight %}

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

{% highlight java %}

@Mapper

public interface UserMapper {

@Select(“SELECT * FROM USER WHERE NAME = #{name}”)

User findByName(@Param(“name”) String name);

@Insert(“INSERT INTO USER(NAME, AGE) VALUES(#{name}, #{age})”)

int insert(@Param(“name”) String name, @Param(“age”) Integer age);

}

{% endhighlight %}

这里有一个问题，#{NAME}, #{AGE} 可能找不到参数，使用#{0}, #{1}可以解决此问题

创建单元测试

测试逻辑：插入一条name=测试，age=20的记录，然后根据name=测试查询，并判断age是否为20

测试结束回滚数据，保证测试单元每次运行的数据环境独立

{% highlight java %}

package com.example.www;

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.SpringApplicationConfiguration;

import org.springframework.boot.test.context.SpringBootTest;

import org.springframework.test.annotation.Rollback;

import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)

@SpringBootTest

@SpringApplicationConfiguration(classes = TestApplication.class)

public class TestApplicationTests {

@Autowired
private UserMapper userMapper;

@Test
@Rollback
public void findByName() throws Exception {
userMapper.insert("测试", 20);
User u = userMapper.findByName("测试");
Assert.assertEquals(20, u.getAge().intValue());
}

}

{% endhighlight %}