SpringBoot + Mybatis

SpringBoot整合Mybatis有两种常用的方式，一种是我们常见的XML的方式，还有一种是全注解的方式。两种方式的区别是，一个将SQL语句写在XML配置文件中，一个写在Java代码中。

artifactId：mybatis-spring-boot-starter

一、全注解方式

1.注解

@Mapper：用于接口mapper上。

@Select, @Insert, @Update, @Delete：用于接口mapper的方法上。

@Results & @Result：注释@Select返回的结果集，关联实体类属性和数据库字段一一对应，如果实体类属性和数据库字段名保持一致，就不需要这个属性来修饰。如果实体类中有另一个实体类属性（一对一），可以在@Result里加one=@One(select="method in mapper")。如果实体类中有另一个实体类集合属性（一对多），可以在@Result里加many=@Many(select="method in mapper")。例：

@Select("select * from t_user")

@Results({

@Result(property="userSex", column="user_sex", javaType=UserSexEnum.class),

@Result(property="nickName", column="nick_name"),

@Result(property="departmentId", column="department_id", one=@One(select="com.test.DepartMapper.findById")),

@Result(property="cars", column="id", many=@Many(select="com.test.CarMapper.findById"))

})

List<UserEntity> getAll();

@One @Many的总结：

共同点：无论是一对一还是一对多，都是通过附属查询来实现的，我们需要定义这个附属方法；在主查询方法中通过@One @Many指定附属查询方法的全路径；都通过column来传递参数给附属方法。

不同点：一对一，那么附属方法返回的是一个单独的对象；一对多，那么附属方法返回的是一个对象集合。

@Transactional：用于Service层的方法上。

@MapperScan：可用于SpringBoot启动类上，表示动态扫描mapper所在包，与@Mapper作用相同。建议使用这种，不然每个Mapper加注解也挺麻烦的。

2.传参方式

1)使用@Param，例：

@Insert("insert into user(id, name) values(#{id}, #{name})")

int insert(@Param("id") int id, @Param("name") String name);

2)使用Map，例：

@Insert("insert into user(id, name) values(#{id, jdbcType.INTEGER}, #{name, jdbcType.VARCHAR})")

int insertByMap(Map<String, Object> map);

3)使用对象，例：

@Insert("insert into user(id, name) values(#{id}, #{name})")

int insertByUser(User user);

二、XML方式

@Mapper：用于接口DAO上，接口DAO的方法不会有@Select, @Insert, @Update, @Delete注解。

xxxMapper.xml配置文件，有以下标签元素：

mapper(nameSpace="全路径Mapper接口")。

resultMap(id="名字，可被select引用", type="全路径实体类")：select标签返回的结果集，有子元素id(column, property, jdbcType)，result(column, property, jdbcType/javaType), association(property, column, javaType), collection(property, ofType, column, select)

association(property, column, javaType, select)：关联其他查询一个对象的映射。

collection(property, ofType, column, select)：关联其他查询的集合，select属性表示该结果的其他查询方法（子查询）。

sql(id)，元素值可以是all columns，可以被include(refid)引用，include(refid)可以被select引用。

select(id, resultMap/resultType, ParameterType)

insert(id, parameterType)

update(id, parameterType)

delete(id, parameterType)

application.properties配置文件加入：

mybatis.mapper-locations=classpath:Mapper/*.xml

也可以加入以下配置文件，其中添加一些Mybatis基础的配置：

mybatis.config-location=classpath:mybatis-config.xml

三、表与实体类关联方法

如果实体类属性与表中字段名完全相同，不需要进行配置，默认对应关联。如果两者不相同，可以有以下方法：

方法一：修改SQL语句，给表中字段起别名一一对应实体类中的属性。

方法二：在Mybatis的配置文件中开启自动驼峰命名规则的映射，即从数据库列名到Java属性名的类似映射（该属性作用于实体类的属性，对返回结果为map的key无效）：

XML中配置文件config.xml中setting元素的配置：name="mapUnderscoreToCameCase" value="true"

注解中配置文件application.properties的配置：mybatis.configuration.mapUnderscoreToCameCase=true

四、Map返回结果

如果是单条数据，返回Map<String, Object>。如果是多条数据，返回List<Map<String, Object>>。结果集中存储是按照{字段名1：字段值1，字段名2：字段值2}

五、Mybatis动态构建SQL

注解方式：

1)脚本sql

（1）用<script>标签包围，然后像xml语法一样书写。

（2）SQL的拼接可以使用+号，也可以使用逗号。我这里使用的是逗号，要使用+号可以把<script>前后的大括号去掉。

（2）实现IN查询中 > 符号需要转义为 > ，其中foreach的collection直接写成@param中的值即可。

（3）这是一种使用注解完全替代XML的方法，稍微复杂的SQL语句推荐使用XML方式。例：

@Select("<script>select * from user <if test=\"id !=null \">where id = #{id} </if></script>")

public List<User> findUserById(User user);

2)在方法中构建sql，拼接SQL语句

@InsertProvider,@UpdateProvider,@DeleteProvider 和@SelectProvider，来帮助构建动态 SQL 语句，然后让MyBatis 执行这些 SQL 语句。

3)结构化SQL

可以使用SQL工具类来动态拼接SQL：

org.apache.ibatis.jdbc.SQL

XML方式：

在XML mapper文件中使用if, where, set, foreach, choose, when, otherwise, bind, sql, trim动态sql标签。

六、分页

使用com.github.pagehelper分页插件。

七、Mybatis缓存

mybatis提供查询缓存，用于减轻数据压力，提高数据库性能。

mybaits提供一级缓存，和二级缓存。

一级缓存是SqlSession级别的缓存。在操作数据库时需要构造 sqlSession对象，在对象中有一个(内存区域)数据结构（HashMap）用于存储缓存数据。不同的sqlSession之间的缓存数据区域（HashMap）是互相不影响的。

一级缓存的作用域是同一个SqlSession，在同一个sqlSession中两次执行相同的sql语句，第一次执行完毕会将数据库中查询的数据写到缓存（内存），第二次会从缓存中获取数据将不再从数据库查询，从而提高查询效率。当一个sqlSession结束后该sqlSession中的一级缓存也就不存在了。Mybatis默认开启一级缓存。

二级缓存是mapper级别的缓存，多个SqlSession去操作同一个Mapper的sql语句，多个SqlSession去操作数据库得到数据会存在二级缓存区域，多个SqlSession可以共用二级缓存，二级缓存是跨SqlSession的。

二级缓存是多个SqlSession共享的，其作用域是mapper的同一个namespace，不同的sqlSession两次执行相同namespace下的sql语句且向sql中传递参数也相同即最终执行相同的sql语句，第一次执行完毕会将数据库中查询的数据写到缓存（内存），第二次会从缓存中获取数据将不再从数据库查询，从而提高查询效率。Mybatis默认没有开启二级缓存需要在setting全局参数中配置开启二级缓存。

Spring与MyBatis整合时，MyBatis的一级缓存在没有事务存在的时候失效。

在未开启事务的情况之下，每次查询，spring都会关闭旧的sqlSession而创建新的sqlSession,因此此时的一级缓存是没有启作用的;

在开启事务的情况之下，spring使用threadLocal获取当前资源绑定同一个sqlSession，因此此时一级缓存是有效的。

SpringBoot中默认帮我们全局开启了二级缓存，如果想要使用二级缓存还需要在mapper上注明。

注解版使用@CacheNamespace注解(为给定的命名空间（比如类）配置缓存，对应xml<cache>)在该mapper上使用二级缓存。