Spring boot（四）Spring Boot 集成 MyBatis

MyBatis

优点：
SQL 被统一提取出来，便于统一管理和优化
SQL 和代码解耦，将业务逻辑和数据访问逻辑分离，使系统的设计更清晰，更易维护，更易单元测试
提供映射标签，支持对象与数据库的 ORM 字段关系映射
提供对象关系映射标签，支持对象关系组件维护
灵活书写动态 SQL，支持各种条件来动态生成不同的 SQL
缺点：
编写 SQL 语句时工作量很大，尤其是字段多、关联表多时，更是如此
SQL 语句依赖于数据库，导致数据库移植性差

什么是 MyBatis-Spring-Boot-Starter
MyBatis-Spring-Boot-Starter 是 MyBatis 帮助我们快速集成 Spring Boot 提供的一个组件包。使用
这个组件 可以做到以下几点： 
构建独立的应用 
几乎可以零配置
需要很少的 XML 配置

注意：MyBatis-Spring-Boot-Starter 依赖于 MyBatis-Spring 和 Spring Boot，最新版 1.3.1 需要 MyBatis-Spring 1.3 以上，Spring Boot 版本 1.5 以上。
mybatis-spring-boot-starter 主要提供了两种解
决方案， 一种是简化后的 XML 配置版，一种是使用注解解决一切问题。
XML 版本
XML 版本保持映射文件的老传统，优化主要体现在不需要实现 Dao 的实现层，系统会自动根据方法名在映射文件中找到对应的 SQL。
关键依赖包
当然任何模式都需要先引入ybatis-spring-boot-starter 的 pom 文件，现在最新版本是 1.3.1。

<dependency> 
   <groupId>org.mybatis.spring.boot</groupId> 
   <artifactId>mybatis-spring-boot-starter</artifactId> 
   <version>1.3.1</version> 
</dependency> 

下面包有非常多的工具类可以使用,如常用的判断字符串是否为空，快速复写实体类的toString()方法等

<dependency> 
   <groupId>org.apache.commons</groupId> 
   <artifactId>commons-lang3</artifactId> 
    <version>3.6</version> 
</dependency>

application 配置
application.properties 添加相关配置：

mybatis.config-locations=classpath:mybatis/mybatis-config.xml 
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml 
mybatis.type-aliases-package=com.neo.entity 
spring.datasource.driverClassName = com.mysql.jdbc.Driver 
spring.datasource.url = jdbc:mysql://localhost:3306/test1?useUnicode=true&characte rEncoding=utf-8 
spring.datasource.username = root 
spring.datasource.password = root

Spring Boot 启动时数据源会自入动注到 SqlSessionFactory 中，使用SqlSessionFactory 构建
SqlSessionFactory，再自动注入到 Mapper 中，最后我们直接使用Mapper即可。
启动类
在启动类中添加对 Mapper 包扫描 @MapperScan ，Spring Boot 启动的时候会自动加载包路径下的 Mapper。

@Spring BootApplication 
@MapperScan("com.neo.mapper") 
   public class Application { 
   public static void main(String[] args) { 
      SpringApplication.run(Application.class, args); 
   } 
} 

或者直接在 Mapper 类上面添加注解@Mapper，建议使用上面那种，不然每个 Mapper 加个注解会很麻烦。
开发 SQL
MyBatis 公共属性
mybatis-config.xml ，主要配置常用的 typeAliases，设置类型别名为 Java 类型设置一个短的名字。 它
只和 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>

xml这部分sql和我们平时项目中的Mybatis的sql语句没有啥区别，不再说明

无配置文件注解版
具体的执行流程都和 XML 版本比较类似，因此这里只介绍两者有差异的部分。
相关配置：注解版在 application.properties 只需要指明实体类的包路径即可。

mybatis.type-aliases-package=com.neo.entity

其他配置和xml相同。注解版最大的特点是具体的 SQL 文件需要写在 Mapper 中。

public interface UserMapper { 
@Select("SELECT * FROM users") 
@Results({ 
@Result(property = "userSex", column = "user_sex", javaType = UserSexEnum .class), 
@Result(property = "nickName", column = "nick_name") 
}) 
List<UserEntity> getAll(); 
@Select("SELECT * FROM users WHERE id = #{id}") 
@Results({ 
@Result(property = "userSex", column = "user_sex", javaType = UserSexEnum .class), 
@Result(property = "nickName", column = "nick_name") 
}) 
UserEntity getOne(Long id); 
@Insert("INSERT INTO users(userName,passWord,user_sex) VALUES(#{userName}, #{p assWord}, #{userSex})") 
void insert(UserEntity user); 
@Update("UPDATE users SET userName=#{userName},nick_name=#{nickName} WHERE id =#{id}") 
void update(UserEntity user); 
@Delete("DELETE FROM users WHERE id =#{id}") 
void delete(Long id); 
}

@Select 是查询类的注解，所有的查询均使用这个
@Result 修饰返回的结果集，关联实体类属性和数据库字段一一对应，如果实体类属性和数据库属性名保持一致，就不需
要这个属性来修饰。
@Insert 插入数据库使用，直接传入实体类会自动解析属性到对应的值
@Update 负责修改，也可以直接传入对象
@delete 负责删除
动态 SQL
如果我们需要写动态的 SQL，或者需要写复杂的 SQL，全部写在注解中会比较麻烦，MyBatis 还提供了另外 的一种持支。
还是以分页为例：
首先定义一个 UserSql 类，提供方法拼接需要执行的 SQL：

public class UserSql { 
public String getList(UserParam userParam) { 
StringBuffer sql = new StringBuffer("select id, userName, passWord, user_s ex as userSex, nick_name as nickName"); 
sql.append(" from users where 1=1 "); 
if (userParam != null) { 
if (StringUtils.isNotBlank(userParam.getUserName())) { 
sql.append(" and userName = #{userName}"); 
} 
if (StringUtils.isNotBlank(userParam.getUserSex())) { 
sql.append(" and user_sex = #{userSex}"); 
} 
} 
sql.append(" order by id desc"); 
sql.append(" limit " + userParam.getBeginLine() + "," + userParam.getPageS ize()); 
log.info("getList sql is :" +sql.toString()); 
return sql.toString(); 
} 
}

可以看出 UserSql 中有一个方法 getList，使用 StringBuffer 进行 SQL 拼接，最后返回需要执行的 SQL 语 句。
接下来只需要在 Mapper 中引入这个类和方法即可。

@SelectProvider(type = UserSql.class, method = "getList")
List<UserEntity> getList(UserParam userParam);

type ：动态生成 SQL 的类
method ： 类中具体的方法名
可能会觉得这样拼接 SQL 很麻烦，SQL 语句太复杂也比较乱，别着急！MyBatis 给我们提供了一种升级的方案：结构化SQL。
示例如下：

public String getCount(UserParam userParam) { 
String sql= new SQL(){{ 
SELECT("count(1)"); 
FROM("users"); 
if (StringUtils.isNotBlank(userParam.getUserName())) { 
WHERE("userName = #{userName}"); 
} 
if (StringUtils.isNotBlank(userParam.getUserSex())) { 
WHERE("user_sex = #{userSex}"); 
} 
//从这个 toString 可以看出，其内部使用有效的 StringBuilder 实现 SQL 拼接 
}}.toString(); 
log.info("getCount sql is :" +sql); 
return sql; 
}

SELECT ：表示要查询的字段，可以写多行，多行的 SELECT 会智能的进行合并不会重复，FROM 和 WHERE 跟
SELECT 一样，可以写多个参数，也可以在多行重复使用，最终会智能合并?不会报错。这 样语句适用于写很多的 SQL，且
能够保证 SQL 结构清楚，便于维护，可读性高。
如何选择
两种模式各有特点，注解版适合简单快速的模式，在微服务架构中，一般微服务都有自己对应的数据库，多表连接查询的
需求会大大的降低，会越来越适合注解版。XML 模式较适合大病型项目，可以灵活的动态生成 SQL，方便调整 SQL，也有
痛痛快快、洋洋洒洒地写 SQL 的感觉。在具体开发过程中，根据公司业务和团 队技术基础进行选型即可。

个人觉得xml更好一点，用着更爽，不过感觉注解方式对于那种需要一些公共处理实时获取当前信息的那种sql更合适！