文章使用版本为 Spring Boot 2.1.x
前言
在 Spring Boot入门系列（五） 使用Mybatis(Annotation版) 中我们介绍了通过注解来使用Mybatis，这种方式的优点是接口方法和执行的SQL在一个文件里，读代码的时候比较方便。但是也有一定的缺点，就是写一些复杂的SQL或动态SQL时不太方便，这个时候使用XML来配置SQL会好一点。使用XML导致接口定义与映射离散在不同文件中，使得阅读起来并不是特别方便的问题，大家可以使用一个IDEA插件解决，Free Mybatis Plugin。使用XML时，大部分代码都可以通过 mybatis-generator 来自动生成，其实用起来也很方便。
下面我们就一起来学习吧。
添加依赖
添加的依赖与Annotation版中相同
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.0</version>
</dependency>
<!--mybatis分页插件-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.12</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
另外我们将使用 mybatis-generator 来自动生成实体对象、xml文件和接口类。在maven下使用 mybatis-generator 很简单，需要在pom文件中添加如下插件
<build>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
</plugin>
</plugins>
</build>
mybatis-generator会默认使用 resources/generatorConfig.xml 作为自己的配置文件。下面我给出一个 generatorConfig.xml 的示例配置。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!--驱动-->
<classPathEntry
location="/usr/local/maven/maven3.3.9/repository/mysql/mysql-connector-java/5.1.8/mysql-connector-java-5.1.8.jar"/>
<context id="mysqlTables" targetRuntime="MyBatis3">
<!--去除注释 -->
<commentGenerator>
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!--数据库连接-->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://127.0.0.1:3306/spring_boot_learn"
userId="root" password="root"/>
<!-- 指定生成的类型为java类型，避免数据库中number等类型字段 -->
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!-- 生成model模型，对应的包，存放位置可以指定具体的路径,如/ProjectName/src，也可以使用MAVEN来自动生成 -->
<javaModelGenerator targetPackage="org.schhx.springbootlearn.module" targetProject="src/main/java">
<property name="enableSubPackages" value="true"/>
</javaModelGenerator>
<!--对应的xml mapper文件 -->
<sqlMapGenerator targetPackage="resources.mapper" targetProject="src/main">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 对应的dao接口 -->
<javaClientGenerator type="XMLMAPPER" targetPackage="org.schhx.springbootlearn.dao"
targetProject="src/main/java">
<property name="enableSubPackages" value="false"/>
</javaClientGenerator>
<!-- 自动生成数据库表的对应关系 -->
<table tableName="user" domainObjectName="User">
<property name="useActualColumnNames" value="true"/>
</table>
<!--不想使用Example可使用下面的配置-->
<!--<table tableName="user" domainObjectName="User"-->
<!--enableCountByExample="false" enableUpdateByExample="false"-->
<!--enableDeleteByExample="false" enableSelectByExample="false"-->
<!--selectByExampleQueryId="false">-->
<!--<property name="useActualColumnNames" value="true"/>-->
<!--</table>-->
</context>
</generatorConfiguration>
如果你不想使用 Example，可以通过enableCountByExample="false"等来控制。其实我觉得 Example 很有用，通过它我们几乎可以任意组装SQL，而不需要自己手写SQL，大大避免了手写SQL引起的错误。
最后通过命令
mvn mybatis-generator:generate
就可以生成代码了。
配置application.yml
这里我们需要额外的指定XML文件的位置
spring:
datasource:
url: jdbc:mysql://127.0.0.1:3306/spring_boot_learn?useUnicode=true&characterEncoding=utf8&allowMultiQueries=true&autoReconnect=true&useSSL=true
driver-class-name: com.mysql.jdbc.Driver
username: root
password: root
hikari:
minimum-idle: 2
maximum-pool-size: 5
mybatis:
mapper-locations: classpath:mapper/*.xml
configuration:
default-executor-type: reuse
default-statement-timeout: 2
扫描接口类
现在我们还需要把接口类交给Spring来管理，扫描接口类的方式有两种
- 在接口类上加上注解 @Mapper。
- 在项目启动类上加注解 @MapperScan(basePackages = {"org.schhx.springbootlearn.dao"})，它会扫描指定包下的所有接口类。
建议使用第二种方式。
测试
最后我们来检验下XML版是否有效吧。
package org.schhx.springbootlearn.dao;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.schhx.springbootlearn.module.User;
import org.schhx.springbootlearn.module.UserExample;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.transaction.annotation.Transactional;
import java.util.List;
import static org.junit.Assert.*;
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperTest {
@Autowired
UserMapper userMapper;
@Test
@Transactional
public void insertSelective() throws Exception {
User user = new User()
.setId("123")
.setUsername("张三")
.setAge(20);
int result = userMapper.insertSelective(user);
Assert.assertEquals(1, result);
}
@Test
@Transactional
public void selectByExample() throws Exception {
User user;
for(int i=0; i<10; i++){
user = new User()
.setId("1000" + i)
.setUsername("user" + i)
.setAge(20 + i);
userMapper.insertSelective(user);
}
PageHelper.startPage(1, 5);
UserExample example = new UserExample();
example.or().andAgeGreaterThanOrEqualTo(20);
List<User> users = userMapper.selectByExample(example);
PageInfo<User> userPageInfo = new PageInfo<>(users);
System.out.println(userPageInfo);
}
@Test
@Transactional
public void selectByPrimaryKey() throws Exception {
User user = new User()
.setId("123")
.setUsername("张三")
.setAge(20);
userMapper.insertSelective(user);
User result = userMapper.selectByPrimaryKey("123");
System.out.println(result);
Assert.assertNotEquals(null, result);
}
}
