全网首例全栈实践（五）Spring Boot 集成Mybatis

一、概述

我们的Spring Boot后续项目使用的都是MySQL。Spring Boot连接MySQL的方式包括JDBC，Spring JPA，Hibeirnate，Mybatis等，本文主要带大家实践Mybatis的集成。

MyBatis 前身是apache的一个开源项目iBatis，2010年由apache software foundation 迁移到了google code，更名为MyBatis，在2013年11月迁移到Github。

MyBatis是支持普通SQL查询，存储过程和高级映射的优秀持久层框架。MyBatis 消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis 使用简单的XML或注解用于配置和原始映射，将接口和Java的POJOs（Plain Ordinary Java Objects，普通的Java对象）映射成数据库中的记录。

二、创建数据库和表

MySQL的安装参考之前的文章，全网首例全栈实践（一）Mac安装使用MySQL。

使用workbench或命令行创建数据库test。

create database test;

如果是命令行：

use test;

如果使用工具直接连接到数据库，然后创建表user，输入：

DROP TABLE IF EXISTS `user`;

CREATE TABLE `user1` (

 `id` int(**11**) NOT NULL AUTO_INCREMENT,

 `name` varchar(**255**) DEFAULT NULL,

 `password` varchar(**255**) DEFAULT NULL,

 `email` varchar(**255**) DEFAULT NULL,

 `phone` varchar(**100**) DEFAULT NULL,

 `register_time` datetime DEFAULT NULL,

 `login_time` datetime DEFAULT NULL,

 PRIMARY KEY (`id`)

) ENGINE=InnoDB AUTO_INCREMENT=**1**DEFAULT CHARSET=utf8;

user表包含的字段有id（记录id），name（姓名），password（密码），phone（手机号码），register_time（注册时间），login_time（登录时间）。

三、MySQL、MyBatis配置

yml文件配置：

#开发配置
spring:
 profiles: dev
 #数据库配置
 datasource:
 url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8
 username: root
 password: xxx
 driver-class-name: com.mysql.jdbc.Driver

pom文件配置：

<!-- mysql -->
<dependency>
 <groupId>mysql</groupId>
 <artifactId>mysql-connector-java</artifactId>
 <scope>runtime</scope>
</dependency>
<!-- mybatis -->
<dependency>
 <groupId>org.mybatis.spring.boot</groupId>
 <artifactId>mybatis-spring-boot-starter</artifactId>
 <version>1.3.2</version>
</dependency>

四、MyBatis目录设置

MyBatis 强大之处在于它的映射语句，由于它的异常强大，映射器的XML 文件就显得相对简单。因此在集成MyBatis后，我们的项目结构设置如下。

 

 

 

src目录下分别新建entity实体和mapper层，mapper本质上相当于传统的dao层，只是dao层用MyBatis的特性实现。resources目录下新建mapping目录，该目录下即是MyBatis的XML实现，每个xml文件对应mapper目录下的一个文件。

五、MyBatis XML映射文件

MyBatis 是针对SQL 构建的，SQL 映射文件有很少的几个顶级元素。

• cache – 给定命名空间的缓存配置。
•  
• cache-ref – 其他命名空间缓存配置的引用。
•  
• resultMap – 是最复杂也是最强大的元素，用来描述如何从数据库结果集中来加载对象。
•  
• parameterMap – 已废弃！老式风格的参数映射。内联参数是首选,这个元素可能在将来被移除，这里不会记录。
•  
• sql – 可被其他语句引用的可重用语句块。
•  
• insert – 映射插入语句
•  
• update – 映射更新语句
•  
• delete – 映射删除语句
•  
• select – 映射查询语句

接下来我们举几个经常使用的例子来说明映射语句如何使用。

1. select

查询语句是MyBatis 中最常用的元素之一，使用示例如下：

<select id="selectPerson" parameterType="int" resultType="hashmap">
 SELECT * FROM PERSON WHERE ID = #{id}
</select>

这个语句被称作selectPerson，接受一个int（或Integer）类型的参数，并返回一个HashMap 类型的对象，其中的键是列名，值便是结果行中的对应值。

注意参数符号：

#{id}

这就告诉MyBatis 创建一个预处理语句参数，通过JDBC，这样的一个参数在SQL 中会由一个“?”来标识，并被传递到一个新的预处理语句中。

select元素有很多属性可供配置：

<select
 id="selectPerson"
 parameterType="int"
 parameterMap="deprecated"
 resultType="hashmap"
 resultMap="personResultMap"
 flushCache="false"
 useCache="true"
 timeout="10000"
 fetchSize="256"
 statementType="PREPARED"
 resultSetType="FORWARD_ONLY">
id
在命名空间中唯一的标识符，可以被用来引用这条语句。
parameterType
将会传入这条语句的参数类的完全限定名或别名。这个属性是可选的，因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数，默认值为 unset。
parameterMap
这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。
resultType
从这条语句中返回的期望类型的类的完全限定名或别名。注意如果是集合情形，那应该是集合可以包含的类型，而不能是集合本身。使用 resultType 或 resultMap，但不能同时使用。
resultMap
外部 resultMap 的命名引用。结果集的映射是 MyBatis 最强大的特性，对其有一个很好的理解的话，许多复杂映射的情形都能迎刃而解。使用 resultMap 或 resultType，但不能同时使用。
flushCache
将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：false。
useCache
将其设置为 true，将会导致本条语句的结果被二级缓存，默认值：对 select 元素为 true。
timeout
这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）。
fetchSize
这是尝试影响驱动程序每次批量返回的结果行数和这个设置值相等。默认值为 unset（依赖驱动）。
statementType
STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。
resultSetType
FORWARD_ONLY，SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一个，默认值为 unset （依赖驱动）。
databaseId
如果配置了 databaseIdProvider，MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句；如果带或者不带的语句都有，则不带的会被忽略。
resultOrdered
这个设置仅针对嵌套结果 select 语句适用：如果为 true，就是假设包含了嵌套结果集或是分组了，这样的话当返回一个主结果行的时候，就不会发生有对前面结果集的引用的情况。这就使得在获取嵌套的结果集的时候不至于导致内存不够用。默认值：false。
resultSets
这个设置仅对多结果集的情况适用，它将列出语句执行后返回的结果集并每个结果集给一个名称，名称是逗号分隔的。

1. insert，update和delete

示例如下：

<insert id="insertAuthor">
 insert into Author (id,username,password,email,bio)
 values (#{id},#{username},#{password},#{email},#{bio})
</insert>

<update id="updateAuthor">
 update Author set
 username = #{username},
 password = #{password},
 email = #{email},
 bio = #{bio}
 where id = #{id}
</update>

<delete id="deleteAuthor">
 delete from Author where id = #{id}
</delete>

属性配置包括如下：

<insert
 id="insertAuthor"
 parameterType="domain.blog.Author"
 flushCache="true"
 statementType="PREPARED"
 keyProperty=""
 keyColumn=""
 useGeneratedKeys=""
 timeout="20">

<update
 id="updateAuthor"
 parameterType="domain.blog.Author"
 flushCache="true"
 statementType="PREPARED"
 timeout="20">

<delete
 id="deleteAuthor"
 parameterType="domain.blog.Author"
 flushCache="true"
 statementType="PREPARED"
 timeout="20">
id
命名空间中的唯一标识符，可被用来代表这条语句。
parameterType
将要传入语句的参数的完全限定类名或别名。这个属性是可选的，因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数，默认值为 unset。
parameterMap
这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。
flushCache
将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：true（对应插入、更新和删除语句）。
timeout
这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）。
statementType
STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。
useGeneratedKeys
（仅对 insert 和 update 有用）这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段），默认值：false。
keyProperty
（仅对 insert 和 update 有用）唯一标记一个属性，MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值，默认：unset。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
keyColumn
（仅对 insert 和 update 有用）通过生成的键值设置表中的列名，这个设置仅在某些数据库（像 PostgreSQL）是必须的，当主键列不是表中的第一列的时候需要设置。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
databaseId
如果配置了 databaseIdProvider，MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句；如果带或者不带的语句都有，则不带的会被忽略。

MyBatis的集成就讲到这里，具体的使用我们放在之后用户的注册、登录等接口创建过程中细讲。