Spring Boot 整合MyBatis

经过一个小例子来实现Spring Boot 与MyBatis的整合。

加入maven依赖

<!-- mybatis整合spring boot的starter -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.0</version>
</dependency>

<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>runtime</scope>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

Spring Boot官方提供的starter是这样的：spring-boot-starter-* 而其余第三方提供的starter是这样的：*-spring-boot-starter

开发实体类

public class Emp {

    private Long id;
    private String name;
    private Date birthday;
    private Double salary;

    public Emp() {
    }

    public Emp(String name, Date birthday, Double salary) {
        this.name = name;
        this.birthday = birthday;
        this.salary = salary;
    }

    //getter and setter
}

开发持久层

public interface EmpMapper {
    List<Emp> findAll();
    Emp findById(Long id);
    void save(Emp emp);
    void update(Emp emp);
    void delete(Long id);
}

开发Spring Boot的启动类

@MapperScan("org.yun.mapper")  //这里指定要扫描的mapper包
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

@MapperScan指定要扫描的mapper包

在src/main/resources/下建立包 org.yun.mapper（与EmpMapper.java的包同名）。而后，创建EmpMapper.xml文件

<?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="org.yun.mapper.EmpMapper">

    <sql id="baseSql">
        id,name,birthday,salary
    </sql>

    <select id="findAll" resultType="org.yun.domain.Emp">
        select
        <include refid="baseSql"/>
        from emp
    </select>

    <select id="findById" parameterType="long" resultType="org.yun.domain.Emp">
        select
        <include refid="baseSql"/>
        from emp
        where id = #{id}
    </select>

    <insert id="save" parameterType="org.yun.domain.Emp" keyProperty="id" useGeneratedKeys="true">
        insert into emp(name,birthday,salary)values(#{name},#{birthday},#{salary})
    </insert>

    <update id="update" parameterType="org.yun.domain.Emp">
        update emp set name = #{name},birthday = #{birthday},salary = #{salary}
        where id = #{id}
    </update>

    <delete id="delete" parameterType="long">
        delete from emp where id = #{id}
    </delete>

</mapper>

关于 MyBatis 这部分，使用 MBG 或 MyBatis Plus会更方便。

配置 application.properties

#指定实体类的名别包
mybatis.type-aliases-package=org.yun.domain

#指定XxxMapper.xml的位置
#mybatis.mapper-locations=classpath:org/yun/mapper/*Mapper.xml

建立数据表schema.sql

CREATE TABLE emp (
  id       BIGINT  AUTO_INCREMENT,
  name     VARCHAR(30),
  birthday DATE,
  salary   DOUBLE,
  PRIMARY KEY(id)
);

初始化数据data.sql

insert into emp(name,birthday,salary)values('admin','1999-09-09',9000);

将schema.sql、data.sql（名字固定）文件放置在src/main/resources下目录，Spring Boot启动的时候会自动执行。

单元测试

@RunWith(SpringRunner.class)
@SpringBootTest
public class ApplicationTests {

    @Autowired
    private EmpMapper empMapper;

    @Test
    public void contextLoads() {
        assertNotNull(empMapper);

        Emp emp1 = new Emp("tom", new Date(), 5000D);
        Emp emp2 = new Emp("bill", new Date(), 6000D);
        empMapper.save(emp1);
        empMapper.save(emp2);

        assertTrue(empMapper.findAll().size() == 3);

        Emp emp = empMapper.findById(2L);
        emp.setSalary(8000D);
        empMapper.update(emp);
        assertTrue(emp.getSalary() == 8000D);

        empMapper.delete(2L);
        assertTrue(empMapper.findAll().size() == 2);
    }
}

参考资料：

• https://github.com/mybatis/spring-boot-starter/wiki/Quick-Start

• http://www.mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/index.html

补充：

在实际项目中通常都会使用Mybatis Generator来实现实体类、映射文件的生成。

那具体怎么操做呢？以MySQL数据库为例。

<!--
 <dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>runtime</scope>
</dependency>
-->

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.41</version>
    <scope>runtime</scope>
</dependency>

取消h2内存数据库驱动的依赖，加入MySQL数据库驱动的依赖。

同时添加以一个Mybatis Generator插件

<plugin>
	<groupId>org.mybatis.generator</groupId>
	<artifactId>mybatis-generator-maven-plugin</artifactId>
	<version>1.3.2</version>
	<dependencies>
		<dependency>
		<groupId>mysql</groupId>
		<artifactId>mysql-connector-java</artifactId>
		<version>5.1.41</version>
		</dependency>
	</dependencies>
</plugin>

编写mybatis的文件生成配置文件：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>

    <!--加载jdbc属性文件-->
    <properties resource="application.properties"/>

    <context id="DB2Tables" targetRuntime="MyBatis3" defaultModelType="flat">
        <!--缓存 暂时不加-->
        <!--<plugin type="org.mybatis.generator.plugins.CachePlugin"/>-->
        <!--重写equals()和hashCode()-->
        <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"/>
        <!-- 分页 -->
        <plugin type="org.mybatis.generator.plugins.RowBoundsPlugin"/>
        <!--序列化-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!--重写toString()-->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!-- 注释 -->
        <commentGenerator>
            <!-- 是否取消注释 -->
            <property name="suppressAllComments" value="true"/>
            <!-- 是否生成注释代时间戳-->
            <property name="suppressDate" value="true"/>
        </commentGenerator>
        <!--数据库连接URL，用户名、密码 -->
        <jdbcConnection driverClass="${spring.datasource.driver-class-name}"
                        connectionURL="${spring.datasource.url}"
                        userId="${spring.datasource.username}"
                        password="${spring.datasource.password}"/>
        <!-- 类型解析器 -->
        <!--  默认false：把JDBC DECIMAL 和 NUMERIC 类型解析为java.lang.Integer
                  true：把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal
        -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!-- 生成model的包名和位置 -->
        <javaModelGenerator targetPackage="org.yun.domain"
                            targetProject="src\main\java">
            <!-- 是否让schema做为包的后缀 -->
            <property name="enableSubPackages" value="true"/>
            <!-- 从数据库返回的值被清理先后的空格  -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 生成 xxxMapper.xml文件的包名和位置 -->
        <sqlMapGenerator targetPackage="org.yun.mapper"
                         targetProject="src\main\resources"> <!-- 这里必定是src/main/resources目录 -->
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <!-- 生成xxxMapper的包名和位置 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="org.yun.mapper"
                             targetProject="src\main\java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <!-- 要生成哪些表 -->
        <table tableName="emp" domainObjectName="Emp"/>
    </context>
</generatorConfiguration>

使用IDA右键执行，便可实现代码生成。

会生成以下代码