Spring Boot(六)：如何优雅的使用 Mybatis
这两天启动了一个新项目因为项目组成员一直都使用的是 Mybatis，虽然个人比较喜欢 Jpa 这种极简的模式，但是为了项目保持统一性技术选型还是定了 Mybatis 。到网上找了一下关于 Spring Boot 和 Mybatis 组合的相关资料，各种各样的形式都有，看的人心累，结合了 Mybatis 的官方 Demo 和文档终于找到了最简的两种模式，花了一天时间总结后分享出来。
Orm 框架的本质是简化编程中操作数据库的编码，发展到现在基本上就剩两家了，一个是宣称可以不用写一句 Sql 的 Hibernate，一个是可以灵活调试动态 Sql 的 Mybatis , 两者各有特点，在企业级系统开发中可以根据需求灵活使用。发现一个有趣的现象：传统企业大都喜欢使用 Hibernate , 互联网行业通常使用 Mybatis 。
Hibernate 特点就是所有的 Sql 都用 Java 代码来生成，不用跳出程序去写（看） Sql ，有着编程的完整性，发展到最顶端就是 Spring Data Jpa 这种模式了，基本上根据方法名就可以生成对应的 Sql 了，有不太了解的可以看我的上篇文章Spring Boot(五)： Spring Data Jpa 的使用。
Mybatis 初期使用比较麻烦，需要各种配置文件、实体类、Dao 层映射关联、还有一大推其它配置。当然 Mybatis 也发现了这种弊端，初期开发了generator可以根据表结果自动生产实体类、配置文件和 Dao 层代码，可以减轻一部分开发量；后期也进行了大量的优化可以使用注解了，自动管理 Dao 层和配置文件等，发展到最顶端就是今天要讲的这种模式了，mybatis-spring-boot-starter 就是 Spring Boot+ Mybatis 可以完全注解不用配置文件，也可以简单配置轻松上手。
现在想想 Spring Boot 就是牛逼呀，任何东西只要关联到 Spring Boot 都是化繁为简。
mybatis-spring-boot-starter
官方说明：MyBatis Spring-Boot-Starter will help you use MyBatis with Spring Boot
其实就是 Mybatis 看 Spring Boot 这么火热也开发出一套解决方案来凑凑热闹，但这一凑确实解决了很多问题，使用起来确实顺畅了许多。mybatis-spring-boot-starter主要有两种解决方案，一种是使用注解解决一切问题，一种是简化后的老传统。
当然任何模式都需要首先引入mybatis-spring-boot-starter的 Pom 文件，现在最新版本是 2.0.0
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.0.0</version>
</dependency>
好了下来分别介绍两种开发模式
无配置文件注解版
就是一切使用注解搞定。
1 添加相关 Maven 文件
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.0.0</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
</dependencies>
完整的 Pom 包这里就不贴了，大家直接看源码
2、application.properties 添加相关配置
mybatis.type-aliases-package=com.neo.model
spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
Spring Boot 会自动加载 spring.datasource.* 相关配置，数据源就会自动注入到 sqlSessionFactory 中，sqlSessionFactory 会自动注入到 Mapper 中，对了，你一切都不用管了，直接拿起来使用就行了。
在启动类中添加对 mapper 包扫描@MapperScan
@SpringBootApplication
@MapperScan("com.neo.mapper")
public class MybatisAnnotationApplication {
<span class="kd">public <span class="kd">static <span class="kt">void <span class="nf">main<span class="o">(<span class="n">String<span class="o">[] <span class="n">args<span class="o">) <span class="o">{
<span class="n">SpringApplication<span class="o">.<span class="na">run<span class="o">(<span class="n">MybatisAnnotationApplication<span class="o">.<span class="na">class<span class="o">, <span class="n">args<span class="o">);
<span class="o">}
}
或者直接在 Mapper 类上面添加注解@Mapper，建议使用上面那种，不然每个 mapper 加个注解也挺麻烦的
3、开发 Mapper
第三步是最关键的一块， Sql 生产都在这里
public interface UserMapper {
<span class="nd">@Select<span class="o">(<span class="s">"SELECT * FROM users"<span class="o">)
<span class="nd">@Results<span class="o">({
<span class="nd">@Result<span class="o">(<span class="n">property <span class="o">= <span class="s">"userSex"<span class="o">, <span class="n">column <span class="o">= <span class="s">"user_sex"<span class="o">, <span class="n">javaType <span class="o">= <span class="n">UserSexEnum<span class="o">.<span class="na">class<span class="o">),
<span class="nd">@Result<span class="o">(<span class="n">property <span class="o">= <span class="s">"nickName"<span class="o">, <span class="n">column <span class="o">= <span class="s">"nick_name"<span class="o">)
<span class="o">})
<span class="n">List<span class="o"><<span class="n">UserEntity<span class="o">> <span class="nf">getAll<span class="o">();
<span class="nd">@Select<span class="o">(<span class="s">"SELECT * FROM users WHERE id = #{id}"<span class="o">)
<span class="nd">@Results<span class="o">({
<span class="nd">@Result<span class="o">(<span class="n">property <span class="o">= <span class="s">"userSex"<span class="o">, <span class="n">column <span class="o">= <span class="s">"user_sex"<span class="o">, <span class="n">javaType <span class="o">= <span class="n">UserSexEnum<span class="o">.<span class="na">class<span class="o">),
<span class="nd">@Result<span class="o">(<span class="n">property <span class="o">= <span class="s">"nickName"<span class="o">, <span class="n">column <span class="o">= <span class="s">"nick_name"<span class="o">)
<span class="o">})
<span class="n">UserEntity <span class="nf">getOne<span class="o">(<span class="n">Long <span class="n">id<span class="o">);
<span class="nd">@Insert<span class="o">(<span class="s">"INSERT INTO users(userName,passWord,user_sex) VALUES(#{userName}, #{passWord}, #{userSex})"<span class="o">)
<span class="kt">void <span class="nf">insert<span class="o">(<span class="n">UserEntity <span class="n">user<span class="o">);
<span class="nd">@Update<span class="o">(<span class="s">"UPDATE users SET userName=#{userName},nick_name=#{nickName} WHERE id =#{id}"<span class="o">)
<span class="kt">void <span class="nf">update<span class="o">(<span class="n">UserEntity <span class="n">user<span class="o">);
<span class="nd">@Delete<span class="o">(<span class="s">"DELETE FROM users WHERE id =#{id}"<span class="o">)
<span class="kt">void <span class="nf">delete<span class="o">(<span class="n">Long <span class="n">id<span class="o">);
}
为了更接近生产我特地将 user_sex、nick_name 两个属性在数据库加了下划线和实体类属性名不一致，另外 user_sex 使用了枚举
- @Select 是查询类的注解，所有的查询均使用这个
- @Result 修饰返回的结果集，关联实体类属性和数据库字段一一对应，如果实体类属性和数据库属性名保持一致，就不需要这个属性来修饰。
- @Insert 插入数据库使用，直接传入实体类会自动解析属性到对应的值
- @Update 负责修改，也可以直接传入对象
- @delete 负责删除
注意，使用 #符号和 $ 符号的不同：
// This example creates a prepared statement, something like select * from teacher where name = ?;
@Select("Select * from teacher where name = #{name}")Teacher selectTeachForGivenName(@Param("name") String name);
// This example creates n inlined statement, something like select * from teacher where name = 'someName';
@Select("Select * from teacher where name ='${name}'")
Teacher selectTeachForGivenName(@Param("name") String name);
4、使用
上面三步就基本完成了相关 Mapper 层开发，使用的时候当作普通的类注入进入就可以了
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperTest {
<span class="nd">@Autowired
<span class="kd">private <span class="n">UserMapper <span class="n">userMapper<span class="o">;
<span class="nd">@Test
<span class="kd">public <span class="kt">void <span class="nf">testInsert<span class="o">() <span class="kd">throws <span class="n">Exception <span class="o">{
<span class="n">userMapper<span class="o">.<span class="na">insert<span class="o">(<span class="k">new <span class="n">User<span class="o">(<span class="s">"aa1"<span class="o">, <span class="s">"a123456"<span class="o">, <span class="n">UserSexEnum<span class="o">.<span class="na">MAN<span class="o">));
<span class="n">userMapper<span class="o">.<span class="na">insert<span class="o">(<span class="k">new <span class="n">User<span class="o">(<span class="s">"bb1"<span class="o">, <span class="s">"b123456"<span class="o">, <span class="n">UserSexEnum<span class="o">.<span class="na">WOMAN<span class="o">));
<span class="n">userMapper<span class="o">.<span class="na">insert<span class="o">(<span class="k">new <span class="n">User<span class="o">(<span class="s">"cc1"<span class="o">, <span class="s">"b123456"<span class="o">, <span class="n">UserSexEnum<span class="o">.<span class="na">WOMAN<span class="o">));
<span class="n">Assert<span class="o">.<span class="na">assertEquals<span class="o">(<span class="mi">3<span class="o">, <span class="n">userMapper<span class="o">.<span class="na">getAll<span class="o">().<span class="na">size<span class="o">());
<span class="o">}
<span class="nd">@Test
<span class="kd">public <span class="kt">void <span class="nf">testQuery<span class="o">() <span class="kd">throws <span class="n">Exception <span class="o">{
<span class="n">List<span class="o"><<span class="n">User<span class="o">> <span class="n">users <span class="o">= <span class="n">userMapper<span class="o">.<span class="na">getAll<span class="o">();
<span class="n">System<span class="o">.<span class="na">out<span class="o">.<span class="na">println<span class="o">(<span class="n">users<span class="o">.<span class="na">toString<span class="o">());
<span class="o">}
<span class="nd">@Test
<span class="kd">public <span class="kt">void <span class="nf">testUpdate<span class="o">() <span class="kd">throws <span class="n">Exception <span class="o">{
<span class="n">User <span class="n">user <span class="o">= <span class="n">userMapper<span class="o">.<span class="na">getOne<span class="o">(<span class="mi">30<span class="n">l<span class="o">);
<span class="n">System<span class="o">.<span class="na">out<span class="o">.<span class="na">println<span class="o">(<span class="n">user<span class="o">.<span class="na">toString<span class="o">());
<span class="n">user<span class="o">.<span class="na">setNickName<span class="o">(<span class="s">"neo"<span class="o">);
<span class="n">userMapper<span class="o">.<span class="na">update<span class="o">(<span class="n">user<span class="o">);
<span class="n">Assert<span class="o">.<span class="na">assertTrue<span class="o">((<span class="s">"neo"<span class="o">.<span class="na">equals<span class="o">(<span class="n">userMapper<span class="o">.<span class="na">getOne<span class="o">(<span class="mi">30<span class="n">l<span class="o">).<span class="na">getNickName<span class="o">())));
<span class="o">}
}
源码中 Controller 层有完整的增删改查，这里就不贴了
极简 xml 版本
极简 xml 版本保持映射文件的老传统，接口层只需要定义空方法，系统会自动根据方法名在映射文件中找对应的 Sql .
1、配置
pom 文件和上个版本一样，只是application.properties新增以下配置
mybatis.config-location=classpath:mybatis/mybatis-config.xml
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml
指定了 Mybatis 基础配置文件和实体类映射文件的地址
mybatis-config.xml 配置
<configuration>
<typeAliases>
<typeAlias alias="Integer" type="java.lang.Integer" />
<typeAlias alias="Long" type="java.lang.Long" />
<typeAlias alias="HashMap" type="java.util.HashMap" />
<typeAlias alias="LinkedHashMap" type="java.util.LinkedHashMap" />
<typeAlias alias="ArrayList" type="java.util.ArrayList" />
<typeAlias alias="LinkedList" type="java.util.LinkedList" />
</typeAliases>
</configuration>
这里也可以添加一些 Mybatis 基础的配置
2、添加 User 的映射文件
<mapper namespace="com.neo.mapper.UserMapper" >
<resultMap id="BaseResultMap" type="com.neo.entity.UserEntity" >
<id column="id" property="id" jdbcType="BIGINT" />
<result column="userName" property="userName" jdbcType="VARCHAR" />
<result column="passWord" property="passWord" jdbcType="VARCHAR" />
<result column="user_sex" property="userSex" javaType="com.neo.enums.UserSexEnum"/>
<result column="nick_name" property="nickName" jdbcType="VARCHAR" />
</resultMap>
<span class="nt"><sql <span class="na">id=<span class="s">"Base_Column_List" <span class="nt">>
id, userName, passWord, user_sex, nick_name
<span class="nt"></sql>
<span class="nt"><select <span class="na">id=<span class="s">"getAll" <span class="na">resultMap=<span class="s">"BaseResultMap" <span class="nt">>
SELECT
<span class="nt"><include <span class="na">refid=<span class="s">"Base_Column_List" <span class="nt">/>
FROM users
<span class="nt"></select>
<span class="nt"><select <span class="na">id=<span class="s">"getOne" <span class="na">parameterType=<span class="s">"java.lang.Long" <span class="na">resultMap=<span class="s">"BaseResultMap" <span class="nt">>
SELECT
<span class="nt"><include <span class="na">refid=<span class="s">"Base_Column_List" <span class="nt">/>
FROM users
WHERE id = #{id}
<span class="nt"></select>
<span class="nt"><insert <span class="na">id=<span class="s">"insert" <span class="na">parameterType=<span class="s">"com.neo.entity.UserEntity" <span class="nt">>
INSERT INTO
users
(userName,passWord,user_sex)
VALUES
(#{userName}, #{passWord}, #{userSex})
<span class="nt"></insert>
<span class="nt"><update <span class="na">id=<span class="s">"update" <span class="na">parameterType=<span class="s">"com.neo.entity.UserEntity" <span class="nt">>
UPDATE
users
SET
<span class="nt"><if <span class="na">test=<span class="s">"userName != null"<span class="nt">>userName = #{userName},<span class="nt"></if>
<span class="nt"><if <span class="na">test=<span class="s">"passWord != null"<span class="nt">>passWord = #{passWord},<span class="nt"></if>
nick_name = #{nickName}
WHERE
id = #{id}
<span class="nt"></update>
<span class="nt"><delete <span class="na">id=<span class="s">"delete" <span class="na">parameterType=<span class="s">"java.lang.Long" <span class="nt">>
DELETE FROM
users
WHERE
id =#{id}
<span class="nt"></delete>
</mapper>
其实就是把上个版本中 Mapper 的 Sql 搬到了这里的 xml 中了
3、编写 Mapper 层的代码
public interface UserMapper {
<span class="n">List<span class="o"><<span class="n">UserEntity<span class="o">> <span class="nf">getAll<span class="o">();
<span class="n">UserEntity <span class="nf">getOne<span class="o">(<span class="n">Long <span class="n">id<span class="o">);
<span class="kt">void <span class="nf">insert<span class="o">(<span class="n">UserEntity <span class="n">user<span class="o">);
<span class="kt">void <span class="nf">update<span class="o">(<span class="n">UserEntity <span class="n">user<span class="o">);
<span class="kt">void <span class="nf">delete<span class="o">(<span class="n">Long <span class="n">id<span class="o">);
}
对比上一步，这里只需要定义接口方法
4、使用
使用和上个版本没有任何区别，大家就看文章对应的示例代码吧
如何选择
两种模式各有特点，注解版适合简单快速的模式，其实像现在流行的这种微服务模式，一个微服务就会对应一个自已的数据库，多表连接查询的需求会大大的降低，会越来越适合这种模式。
老传统模式比适合大型项目，可以灵活的动态生成 Sql ，方便调整 Sql ，也有痛痛快快，洋洋洒洒的写 Sql 的感觉。
文章内容已经升级到 Spring Boot 2.x
资料推荐
最近又赶上跳槽的高峰期（招聘旺季），好多读者都问我要有没有最新面试题，找华为朋友整理一份内部资料《第 6 版：互联网大厂面试题》并分类 4 份 PDF，累计 926 页！
整个资料包，包括 Spring、Spring Boot/Cloud、Dubbo、JVM、集合、多线程、JPA、MyBatis、MySQL、大数据、Nginx、Git、Docker、GitHub、Servlet、JavaWeb、IDEA、Redis、算法、面试题等几乎覆盖了 Java 基础和阿里巴巴等大厂面试题等、等技术栈！
据说已经有小伙伴通过这套资料，成功的入职了蚂蚁金服、字节跳动等大厂。
而且，这些资料不是扫描版的，里面的文字都可以直接复制，非常便于我们学习：
如果你想获得完整 PDF 可以通过以下方式获得
面试大全怎么获取：
- 关注下方公众号
- 在下方公众号后台回复 【555】 即可。
👆长按上方二维码 2 秒
回复「555」即可获取资料