MyBatis

笔记来源：【尚硅谷】SSM框架全套教程，MyBatis+Spring+SpringMVC+SSM整合一套通关

一 MyBatis简介

1.1 Mabatis简史

MyBatis最初是Apache的一个开源项目iBatis, 2010年6月这个项目由Apache Software Foundation迁移到了Google Code。随着开发团队转投Google Code旗下， iBatis3.x正式更名为MyBatis。代码于2013年11月迁移到Github。

iBatis一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。 iBatis提供的持久层框架包括SQL Maps和Data Access Objects（DAO）。

1.2 Mybatis特性

1. MyBatis是支持定制化SQL、存储过程以及高级映射的优秀的持久层框架
2. MyBatis避免了几乎所有的JDBC代码和手动设置参数以及获取结果集
3. MyBatis可以使用简单的XML或注解用于配置和原始映射，将接口和Java的POJO（Plain Old JavaObjects，普通的Java对象）映射成数据库中的记录
4. MyBatis是一个半自动的ORM（Object Relation Mapping，对象关系映射）框架

1.3 Mybatis与其他持久化层技术的对比

• JDBC
  • SQL夹杂在Java代码中，耦合度高，导致硬编码内伤
  • 维护不易。在实际开发中若SQL需求有变化，则不要改动源码。
  • 代码冗长，开发效率低。
• Hibernate和JPA
  • 操作简单，开发效率高，但框架只支持较为简单的SQL语句
  • 程序中的长难SQL需要绕过框架
  • 内部自动产生的SQL不容易做特殊优化
  • 基于全自动的ORM，自定义POJO映射比较困难
  • 反射操作太多，导致数据库性能下降
• Mybatis
  • 轻量级，性能出色
  • SQL和Java代码分开，功能边界清晰。Java代码专注于业务，SQL语句专注于数据。
  • 开发效率略逊于Hibernate，但完全能够接受。

二 Mybatis环境配置

2.1 Mybatis核心配置文件

• 习惯上，MyBatis的核心配置文件通常命名为mybatis-config.xml，但这个文件名只是建议，并非强制要求。

• 将来整合Spring之后，这个配置文件就可以省略了。

• 核心配置文件主要用于配置数据库连接以及Mybatis的全局配置信息

• 在Maven项目中，Mybatis核心配置文件存放于src/main/resources目录下

• 核心配置文件中的标签必须按照固定的顺序：

  properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration> <!--设置连接数据库的环境-->
    <!--MyBatis核心配置文件中，标签的顺序：
    properties?,settings?,typeAliases?,typeHandlers?, objectFactory?,objectWrapperFactory?,
    reflectorFactory?, plugins?,environments?,databaseIdProvider?,mappers? -->
    <!--引入properties文件-->
    <properties resource="jdbc.properties"/>
    <!--设置类型别名-->
    <typeAliases>
        <!--typeAlias：设置某个类型的别名
            属性：type：设置需要设置别名的类型
            属性：alias：设置某个类型的别名，若不设置该属性，那么该类型拥有默认的别名，即类名 且不区分大小写 -->
        <!--<typeAlias type="com.atguigu.mybatis.pojo.User"></typeAlias>-->
        <!--以包为单位，将包下所有的类型设置默认的类型别名，即类名且不区分大小写-->
        <package name="com.atguigu.mybatis.pojo"/>
    </typeAliases>
    <!--environments：配置多个连接数据库的环境 属性：default：设置默认使用的环境的id -->
    <environments default="development">
        <!--environment：配置某个具体的环境 属性：id：表示连接数据库的环境的唯一标识，不能重复 -->
        <environment id="development">
            <!--transactionManager：设置事务管理方式
                属性：type="JDBC|MANAGED"
                     JDBC：表示当前环境中，执行SQL时，使用的是JDBC中原生的事务管理方式，事 务的提交或回滚需要手动处理
                     MANAGED：被管理，例如Spring -->
            <transactionManager type="JDBC"/>
            <!--dataSource：配置数据源
                属性：type：设置数据源的类型 type="POOLED|UNPOOLED|JNDI"
                                              POOLED：表示使用数据库连接池缓存数据库连接
                                              UNPOOLED：表示不使用数据库连接池
                                              JNDI：表示使用上下文中的数据源 -->
            <dataSource type="POOLED">
                <!--设置连接数据库的驱动-->
                <property name="driver" value="${jdbc.driver}"/>
                <!--设置连接数据库的连接地址-->
                <property name="url" value="${jdbc.url}"/>
                <!--设置连接数据库的用户名-->
                <property name="username" value="${jdbc.username}"/>
                <!--设置连接数据库的密码-->
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
    <!--引入映射文件-->
    <mappers>
        <!--<mapper resource="mappers/UserMapper.xml"/>-->
        <!--以包为单位引入映射文件
            要求： 1、mapper接口所在的包要和映射文件所在的包一致
                  2、mapper接口要和映射文件的名字一致 -->
        <package name="com.atguigu.mybatis.mapper"/>
    </mappers>
</configuration>

2.2 创建Mapper接口

• MyBatis中的mapper接口相当于以前的dao，封装了对数据库表的具体操作。但是区别在于，mapper仅仅是接口，我们不需要提供实现类,Mybatis会为Mapper接口自动创建代理实现类对象。

// 相当于UserDao
public interface UserMapper { 
    // 添加用户信息  
    int insertUser(); 
}

2.3 创建Mybatis映射文件

• 相关概念：ORM（Object Relationship Mapping）对象关系映射。

  • 对象：Java的实体类对象

  • 关系：关系型数据库

  • 映射：即将数据库查询的结果映射文Java类对象

Java概念	数据库概念
类	表
属性	字段/列
对象	记录/行

映射文件命名规则：

表对应的实体类的类名+Mapper.xml

因此一个映射文件对应一张表的所有的增删改查操作

Mybatis的映射文件用于编写SQL语句，访问以及操作表中的数据

Mybatis的映射文件存放的位置是src/main/resource/mappers目录

Mybatis是面向接口的数据操作，所以要满足两个一致

1. mapper接口的全类名和映射文件的命名空间保持一致
2. mapper接口中的方法名和映射文件中编写SQL的标签的id属性值保持一致

<?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="com.atguigu.mybatis.mapper.UserMapper">
    <!--int insertUser();-->
    <insert id="insertUser">
        insert into t_user values(null,'admin','123456',23,'男','12345@qq.com');
    </insert>
</mapper>

2.4 使用Mybatis查询数据

@Test
public void testInsert() throws IOException {
    // 1. 读取MyBatis的核心配置文件 
    InputStream is = Resources.getResourceAsStream("mybatis-config.xml"); 
    
    // 2. 创建SqlSessionFactoryBuilder对象 
    SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder(); 
    
    // 3. 通过将is传入sqlSessionFactoryBuilder的build方法创建出一个SqlSessionFactory对象
    SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is); 
    
    // 4. 通过SqlSessionFactory的openSession()方法创建SqlSession对象
    //    通过无参的openSession()方法创建的SqlSession对象的所操作的sql都必须手动提交或回滚事务 
    //    通过有参的openSession(true)方法创建的SqlSession对象的所操作的sql都会自动提交
    //SqlSession sqlSession = sqlSessionFactory.openSession(); 
    
    // 5. 通过SqlSession创建UserMapper接口的代理实现类对象 
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    
    // 6. 通过代理实现类对象执行数据库操作
    int result = userMapper.insertUser(); 
    
    // 7. 提交事务
    sqlSession.commit();
    // 8. 关闭SqlSession
    sqlSession.close();
}

2.5 整合log4j日志

1. 加入依赖

<!-- log4j日志 --> 
<dependency> 
    <groupId>log4j</groupId> 
    <artifactId>log4j</artifactId> 
    <version>1.2.17</version> 
</dependency>

2. 创建log4j配置文件

• log4j的配置文件名必须是为log4j.xml，存放的位置是src/main/resources目录下

三 Mybatis的增删改查

3.1 新增

<!--int insertUser();--> 
<insert id="insertUser"> 
    insert into t_user values(null,'admin','123456',23,'男') 
</insert> 

3.2 删除

<!--int deleteUser();--> 
<delete id="deleteUser"> 
    delete from t_user where id = 7 
</delete>

3.3 修改

<!--int updateUser();--> 
<update id="updateUser"> 
    update t_user set username='ybc',password='123' where id = 6 
</update>

3.4 查询单个实体类

<!--User getUserById();--> 
<select id="getUserById" resultType="com.atguigu.mybatis.bean.User"> 
    select * from t_user where id = 2 
</select>

3.5 查询List集合

<!--List<User> getUserList();--> 
<select id="getUserList" resultType="com.atguigu.mybatis.bean.User"> 
    select * from t_user 

</select>

注意：

• 查询的标签select必须设置属性resultType或resultMap，用于设置实体类和数据库表的映射关系

  • resultType：自动映射，用于属性名和表中字段名一致的情况

  • resultMap：自定义映射，用于一对多或多对一或字段名和属性名不一致的情况

四 Mybatis获取方法参数的两种方式

• MyBatis获取参数值的两种方式：${}和#{}
• ${}的本质就是字符串拼接，#{}的本质就是占位符赋值
• ${}使用字符串拼接的方式拼接sql，若为字符串类型或日期类型的字段进行赋值时，需要手动加单引号；但是#{}使用占位符赋值的方式拼接sql，此时为字符串类型或日期类型的字段进行赋值时，可以自动添加单引号

4.1 单个字面量类型的参数

若mapper接口中的方法参数为单个的字面量类型

此时可以使用${}和#{}以任意的名称获取参数的值，注意${}需要手动加单引号

4.2 多个字面量类型的参数

若mapper接口中的方法参数为多个时

此时MyBatis会自动将这些参数放在一个map集合中,有两种方式访问这个map集合

• 以arg0,arg1…为键，以参数为值；
• 以param1,param2…为键，以参数为值；因此只需要通过${}和#{}访问map集合的键就可以获取相对应的值，注意${}需要手动加单引号

4.3 map集合类型的参数

若mapper接口中的方法需要的参数为多个时，此时可以手动创建map集合，将这些数据放在map中

只需要通过${}和#{}访问map集合的键就可以获取相对应的值，注意${}需要手动加单引号

5.4 实体类类型的参数

若mapper接口中的方法参数为实体类对象时

此时可以使用${}和#{}，通过访问实体类对象中的属性名获取属性值，注意${}需要手动加单引号

5.5 使用@Param标识参数

可以通过@Param注解标识mapper接口中的方法参数

此时，会将这些参数放在map集合中，以@Param注解的value属性值为键，以参数为值；以param1,param2…为键，以参数为值；只需要通过${}和#{}访问map集合的键就可以获取相对应的值，注意${}需要手动加单引号

五 MyBatis查询进阶

5.1 查询一个实体类对象

/**
 * 根据用户id查询用户信息 
 * @param id 
 * @return 
 */ 
User getUserById(@Param("id") int id); 

<!--User getUserById(@Param("id") int id);--> 
<select id="getUserById" resultType="User"> 
	select * from t_user where id = #{id} 
</select> 

5.2 查询一个list集合

/**
 * 查询所有用户信息 
 * @return 
 */ 
List<User> getUserList();

<!--List<User> getUserList();--> 
<select id="getUserList" resultType="User"> 
	select * from t_user 
</select>

5.3 查询基本数据类型

/**
 * 查询用户的总记录数 
 * @return 
 * 在MyBatis中，对于Java中常用的类型都设置了类型别名 
 * 例如： java.lang.Integer-->int|integer 
 * 例如： int-->int|integer 
 * 例如： Map-->map,List-->list 
 */ 
int getCount(); 

<!--int getCount();--> 
<select id="getCount" resultType="_integer"> 
	select count(id) from t_user 
</select>

5.4 查询一条数据为map集合

/**
 * 查询出来的每条数据既可以封装成一个对象，也可以封装成一个map
 * 根据用户id查询用户信息为map集合
 * map的key为属性名，value为查询出来的数据
 * @param id 
 * @return 
 */ 
Map<String, Object> getUserToMap(@Param("id") int id); 

<!--Map<String, Object> getUserToMap(@Param("id") int id);--> 
<!--结果： {password=123456, sex=男 , id=1, age=23, username=admin}--> 
<select id="getUserToMap" resultType="map"> 
	select * from t_user where id = #{id} 
</select> 

5.5 查询多条数据为map集合

方式一

/**
 * 查询所有用户信息为map集合 
 * @return 
 * 将表中的数据以map集合的方式查询，一条数据对应一个map；若有多条数据，就会产生多个map集合，此时可以将这些map放在一个list集合中获取
 */ 
List<Map<String, Object>> getAllUserToMap(); 

<select id="getAllUser" resultType="map">
    select * from t_user;
</select>

方式二

/**
 * 查询所有用户信息为map集合 
 * @return 
 * 将表中的数据以map集合的方式查询，一条数据对应一个map；
 * 若有多条数据，就会产生多个map集合，并且最终要以一个map的方式返回数据，此时需要通过@MapKey注解设map集合的键，值是每条数据所对应的map集合
 * 注意：该map的键为注解对应字段的实际类型
 */ 
@MapKey("id")
public Map<Integer, Object> getAllUser();

<select id="getAllUser" resultType="map">
    select * from t_user;
</select>

六 特殊SQL的执行

6.1 模糊查询

/**
 * 测试模糊查询 
 * @param mohu 
 * @return 
 */ 
List<User> testMohu(@Param("mohu") String mohu); 

<!--List<User> testMohu(@Param("mohu") String mohu);--> 
<select id="testMohu" resultType="User"> 
    <!--select * from t_user where username like '%${mohu}%'--> 
    <!--select * from t_user where username like concat('%',#{mohu},'%')--> 
    select * from t_user where username like "%"#{mohu}"%" 
</select> 

6.2 批量删除

/**
 * 批量删除 
 * @param ids 
 * @return 
 */ 
int deleteMore(@Param("ids") String ids); 

<!--int deleteMore(@Param("ids") String ids);--> 
<!--此处应该使用${}-->
<delete id="deleteMore"> 
    delete from t_user where id in (${ids}) 
</delete>

6.3 动态设置表名

/**
 * 动态设置表名，查询所有的用户信息 
 * @param tableName 
 * @return 
 */ 
List<User> getAllUser(@Param("tableName") String tableName); 

<!--List<User> getAllUser(@Param("tableName") String tableName);--> 
<select id="getAllUser" resultType="User"> 
    select * from ${tableName} 
</select> 

6.4 添加功能获取自增的主键

场景模拟：

t_clazz(clazz_id,clazz_name)

t_student(student_id,student_name,clazz_id)

1、添加班级信息

2、获取新添加的班级的id

3、为班级分配学生，即将某学的班级id修改为新添加的班级的id

/**
 * 添加用户信息 
 * @param user 
 * @return 
 * useGeneratedKeys：设置使用自增的主键 
 * keyProperty：因为增删改有统一的返回值是受影响的行数，因此只能将获取的自增的主键放在传输的参数user对象的某个属性中 
 */ 
int insertUser(User user); 

<!--int insertUser(User user);--> 
<insert id="insertUser" useGeneratedKeys="true" keyProperty="id"> 
	insert into t_user values(null,#{username},#{password},#{age},#{sex}) 
</insert>

七 自定义映射resultMap

7.1 resultMap处理字段和属性的映射关系

• 若字段名和实体类中的属性名不一致，则可以通过resultMap设置自定义映射

<!--
    resultMap：设置自定义映射 
        属性： 
            id：表示自定义映射的唯一标识 
            type：查询的数据要映射的实体类的类型 
    子标签： 
        id：设置主键的映射关系 
        result：设置普通字段的映射关系
        association：设置多对一的映射关系 
        collection：设置一对多的映射关系 
        属性：
            property：设置映射关系中实体类中的属性名 
            column：设置映射关系中表中的字段名 
--> 
<resultMap id="userMap" type="User"> 
    <id property="id" column="id"></id> 
    <result property="userName" column="user_name"></result> 
    <result property="password" column="password"></result> 
    <result property="age" column="age"></result> 
    <result property="sex" column="sex"></result> 
</resultMap> 
<!--List<User> testMohu(@Param("mohu") String mohu);--> 
<select id="testMohu" resultMap="userMap"> 
    <!--select * from t_user where username like '%${mohu}%'--> 
    select id,user_name,password,age,sex from t_user where user_name like 
    concat('%',#{mohu},'%') 
</select> 

若字段名和实体类中的属性名不一致，但是字段名符合数据库的规则（使用_），实体类中的属性名符合Java的规则（使用驼峰）

此时也可通过以下两种方式处理字段名和实体类中的属性的映射关系

• 可以通过为字段起别名的方式，保证和实体类中的属性名保持一致

• 可以在MyBatis的核心配置文件中设置一个全局配置信息mapUnderscoreToCamelCase，可

以在查询表中数据时，自动将_类型的字段名转换为驼峰

例如：字段名user_name，设置了mapUnderscoreToCamelCase，此时字段名就会转换为userName

7.2 多对一映射处理

7.2.1 级联方式处理映射关系

<resultMap id="empDeptMap" type="Emp"> 
    <id column="eid" property="eid"></id> 
    <result column="ename" property="ename"></result> 
    <result column="age" property="age"></result> 
    <result column="sex" property="sex"></result> 
    <result column="did" property="dept.did"></result> 
    <result column="dname" property="dept.dname"></result> 
</resultMap> 

<!--Emp getEmpAndDeptByEid(@Param("eid") int eid);--> 
<select id="getEmpAndDeptByEid" resultMap="empDeptMap"> 
    select emp.*,dept.* from t_emp emp left join t_dept dept on emp.did = 
    dept.did where emp.eid = #{eid} 
</select>

7.2.2 使用association处理映射关系

<resultMap id="empDeptMap" type="Emp"> 
    <id column="eid" property="eid"></id> 
    <result column="ename" property="ename"></result> 
    <result column="age" property="age"></result> 
    <result column="sex" property="sex"></result> 
    <association property="dept" javaType="Dept"> 
        <id column="did" property="did"></id> 
        <result column="dname" property="dname"></result> 
    </association> 
</resultMap> 

<!--Emp getEmpAndDeptByEid(@Param("eid") int eid);--> 
<select id="getEmpAndDeptByEid" resultMap="empDeptMap"> 
    select emp.*,dept.* from t_emp emp left join t_dept dept on emp.did = 
    dept.did where emp.eid = #{eid} 
</select>

7.2.3 分步查询(也要使用association)

1. 查询员工信息

/**
 * 通过分步查询查询员工信息 
 * @param eid 
 * @return 
 */ 
Emp getEmpByStep(@Param("eid") int eid); 

<resultMap id="empDeptStepMap" type="Emp"> 
    <id column="eid" property="eid"></id> 
    <result column="ename" property="ename"></result> 
    <result column="age" property="age"></result> 
    <result column="sex" property="sex"></result> 
    <!--
        select：设置分步查询，查询某个属性的值的sql的标识（namespace.sqlId） 
        column：将上一步sql查询结果中的某个字段设置为下一步查询的条件 
    --> 
	<association property="dept" select="com.atguigu.MyBatis.mapper.DeptMapper.getEmpDeptByStep" column="did"/> 
</resultMap> 
<!--Emp getEmpByStep(@Param("eid") int eid);--> 
<select id="getEmpByStep" resultMap="empDeptStepMap"> 
    select * from t_emp where eid = #{eid} 
</select> 

2. 根据员工所对应的部门id查询部门信息

/**
 * 分步查询的第二步： 根据员工所对应的did查询部门信息 
 * @param did 
 * @return 
 */ 
Dept getEmpDeptByStep(@Param("did") int did);

<!--Dept getEmpDeptByStep(@Param("did") int did);--> 
<select id="getEmpDeptByStep" resultType="Dept"> 
    select * from t_dept where did = #{did} 
</select> 

7.3 一对多映射处理

7.3.1 collection

/**
 * 根据部门id查新部门以及部门中的员工信息 
 * @param did 
 * @return 
 */ 
Dept getDeptEmpByDid(@Param("did") int did); 

<resultMap id="deptEmpMap" type="Dept"> 
    <id property="did" column="did"></id> 
    <result property="dname" column="dname"></result> 
    <!--
        ofType：设置collection标签所处理的集合属性中存储数据的类型 
    --> 
    <collection property="emps" ofType="Emp"> 
        <id property="eid" column="eid"></id> 
        <result property="ename" column="ename"></result> 
        <result property="age" column="age"></result> 
        <result property="sex" column="sex"></result> 
    </collection> 
</resultMap> 

<!--Dept getDeptEmpByDid(@Param("did") int did);--> 
<select id="getDeptEmpByDid" resultMap="deptEmpMap"> 
    select dept.*,emp.* from t_dept dept left join t_emp emp on dept.did = 
    emp.did where dept.did = #{did} 
</select> 

分步查询的优点：可以实现延迟加载(懒加载)

但是必须在核心配置文件中设置全局配置信息：

• lazyLoadingEnabled：延迟加载的全局开关。当开启时，所有关联对象都会延迟加载

• aggressiveLazyLoading：当开启时，任何方法的调用都会加载该对象的所有属性。否则，每个属性会按需加载

此时就可以实现按需加载，获取的数据是什么，就只会执行相应的sql。此时可通过association和collection中的fetchType属性设置当前的分步查询是否使用延迟加载， fetchType=“lazy(延迟加载)|eager(立即加载)”

八 动态SQL

• Mybatis框架的动态SQL技术是一种根据特定条件动态拼装SQL语句的功能，它存在的意义是为了解决 拼接SQL语句字符串时的痛点问题。

8.1 if标签

• if标签可通过test属性的表达式进行判断，若表达式的结果为true，则标签中的内容会执行；反之标签中的内容不会执行
• 为了避免所有的if都判断为false的情况，一般在where条件里添加一个1=1恒成立的条件判断

<!--List<Emp> getEmpListByCondition(Emp emp);--> 
<select id="getEmpListByMoreTJ" resultType="Emp"> 
    select * from t_emp where 1=1 
    <if test="ename != '' and ename != null"> 
        and ename = #{ename} 
    </if> 
    <if test="age != '' and age != null"> 
        and age = #{age} 
    </if> 
    <if test="sex != '' and sex != null"> 
        and sex = #{sex} 
    </if> 
</select> 

8.2 where标签

• where标签一般和if标签结合使用：

  • 若where标签中的if条件都不满足，则where标签没有任何功能，即不会添加where关键字

  • 若where标签中的if条件满足，则where标签会自动添加where关键字，并将条件最前方多余的and去掉

注意：where标签不能去掉条件最后多余的and

<select id="getEmpListByMoreTJ2" resultType="Emp"> 
    select * from t_emp 
    <where> 
        <if test="ename != '' and ename != null"> 
            ename = #{ename} 
        </if> 
        <if test="age != '' and age != null"> 
            and age = #{age} 
        </if>
        <if test="sex != '' and sex != null"> 
            and sex = #{sex} 
        </if> 
    </where> 
</select>

8.3 trim标签

• trim用于去掉或添加标签中的内容

• 常用属性：

  • prefix：在trim标签中的内容的前面添加某些内容

  • prefixOverrides：在trim标签中的内容的前面去掉某些内容

  • suffix：在trim标签中的内容的后面添加某些内容

  • suffixOverrides：在trim标签中的内容的后面去掉某些内容

<select id="getEmpListByMoreTJ" resultType="Emp"> 
    select * from t_emp 
    <trim prefix="where" suffixOverrides="and"> 
        <if test="ename != '' and ename != null">
            ename = #{ename} and 
        </if> 
        <if test="age != '' and age != null"> 
            age = #{age} and 
        </if> 
        <if test="sex != '' and sex != null"> 
            sex = #{sex} 
        </if> 
    </trim> 
</select> 

8.4 choose、when、otherwise标签

• choose、when、 otherwise相当于if…else if…else
• 只要有一个when条件满足，则不会再执行其省下的when和otherwise

<!--List<Emp> getEmpListByChoose(Emp emp);--> 
<select id="getEmpListByChoose" resultType="Emp"> 
    select <include refid="empColumns"></include> from t_emp 
    <where> 
        <choose> 
            <when test="ename != '' and ename != null"> 
                ename = #{ename} 
            </when> 
            <when test="age != '' and age != null"> 
                age = #{age} 
            </when> 
            <when test="sex != '' and sex != null"> 
                sex = #{sex} 
            </when> 
            <when test="email != '' and email != null"> 
                email = #{email} 
            </when> 
        </choose> 
    </where> 
</select>

8.5 foreach标签

• 属性
  • collection：要遍历的集合
  • item：集合中每个元素
  • separator：分隔符。foreach标签连接组装多个sql部分，每个sql部分要通过分隔符进行分隔
  • open：在foreach语句组装的sql头部加上特定字符
  • close：在foreach语句组装的sql尾部加上特定字符

<!--int insertMoreEmp(List<Emp> emps);--> 
<insert id="insertMoreEmp"> 
    insert into t_emp values 
    <foreach collection="emps" item="emp" separator=","> 
        (null,#{emp.ename},#{emp.age},#{emp.sex},#{emp.email},null) 
    </foreach> 
</insert> 

<!--int deleteMoreByArray(int[] eids);--> 
<delete id="deleteMoreByArray"> 
    delete from t_emp where 
    <foreach collection="eids" item="eid" separator="or"> 
        eid = #{eid} 
    </foreach> 
</delete> 

<!--int deleteMoreByArray(int[] eids);--> 
<delete id="deleteMoreByArray"> 
    delete from t_emp where eid in 
    <foreach collection="eids" item="eid" separator="," open="(" close=")">
        #{eid} 
    </foreach> 
</delete> 

8.6 SQL片段

• sql片段，可以记录一段公共sql片段，在使用的地方通过include标签进行引入

<sql id="empColumns"> 
    eid,ename,age,sex,did 
</sql> 
select <include refid="empColumns"></include> from t_emp

九 Mybatis缓存

9.1 Mybatis一级缓存

• 一级缓存是SqlSession级别的，通过同一个SqlSession查询的数据会被缓存，下次查询相同的数据，就会从缓存中直接获取，不会从数据库重新访问

• 使一级缓存失效的四种情况：

  • 不同的SqlSession对应不同的一级缓存

  • 同一个SqlSession但是查询条件不同

  • 同一个SqlSession两次查询期间执行了任何一次增删改操作

  • 同一个SqlSession两次查询期间手动清空了缓存

9.2 Mybatis二级缓存

• 二级缓存是SqlSessionFactory级别，通过同一个SqlSessionFactory创建的SqlSession查询的结果会被缓存；此后若再次执行相同的查询语句，结果就会从缓存中获取

• 二级缓存开启的条件：

  • 在核心配置文件中，设置全局配置属性cacheEnabled=“true”，默认为true，不需要设置

  • 在映射文件中设置标签

  • 二级缓存必须在一次SqlSession关闭或提交之后有效

  • 查询的数据所转换的实体类类型必须实现序列化的接口

• 使二级缓存失效的情况：两次查询之间执行了任意的增删改，会使一级和二级缓存同时失效

9.3 二级缓存相关配置

• 在mapper配置文件中添加的cache标签可以设置一些属性：

  • eviction属性：缓存回收策略，默认的是 LRU。

    • LRU（Least Recently Used） – 最近最少使用的：移除最长时间不被使用的对象。

    • FIFO（First in First out） – 先进先出：按对象进入缓存的顺序来移除它们。

    • SOFT – 软引用：移除基于垃圾回收器状态和软引用规则的对象

    • WEAK – 弱引用：更积极地移除基于垃圾收集器状态和弱引用规则的对象。

  • flushInterval属性：刷新间隔，单位毫秒，默认情况是不设置，也就是没有刷新间隔，缓存仅仅调用语句时刷新

  • size属性：引用数目，正整数，代表缓存最多可以存储多少个对象，太大容易导致内存溢出

  • readOnly属性：只读， true/false

    • true：只读缓存；会给所有调用者返回缓存对象的相同实例。因此这些对象不能被修改。这提供了 很重要的性能优势。
    • false：读写缓存；会返回缓存对象的拷贝（通过序列化）。这会慢一些，但是安全，因此默认是false

9.4 MyBatis缓存查询的顺序

1. 先查询二级缓存，因为二级缓存中可能会有其他程序已经查出来的数据，可以拿来直接使用。
2. 如果二级缓存没有命中，再查询一级缓存
3. 如果一级缓存也没有命中，则查询数据库
4. SqlSession关闭之后，一级缓存中的数据会写入二级缓存

9.5 整合第三方缓存EHCache

9.5.1 添加依赖

<!-- Mybatis EHCache整合包 --> 
<dependency> 
    <groupId>org.mybatis.caches</groupId> 
    <artifactId>mybatis-ehcache</artifactId> 
    <version>1.2.1</version> 
</dependency> 

<!-- slf4j日志门面的一个具体实现 --> 
<dependency> 
    <groupId>ch.qos.logback</groupId> 
    <artifactId>logback-classic</artifactId> 
    <version>1.2.3</version> 
</dependency>

9.5.2 各jar包功能

jar包名称	作用
mybatis-ehcache	Mybatis和EHCache的整合包
ehcache	EHCache核心包
slf4j-api	SLF4J日志门面包
logback-classic	支持SLF4J门面接口的一个具体实现

9.5.3 创建EHCache的配置文件ehcache.xml

<?xml version="1.0" encoding="utf-8" ?> 
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
         xsi:noNamespaceSchemaLocation="../config/ehcache.xsd"> 
    <!-- 磁盘保存路径 --> 
    <diskStore path="D:\atguigu\ehcache"/> 
    <defaultCache maxElementsInMemory="1000" 
                  maxElementsOnDisk="10000000" 
                  eternal="false" 
                  overflowToDisk="true" 
                  timeToIdleSeconds="120" 
                  timeToLiveSeconds="120" 
                  diskExpiryThreadIntervalSeconds="120" 
                  memoryStoreEvictionPolicy="LRU"> 
    </defaultCache> 
</ehcache>

在cache标签中设置二级缓存的类型

<cache type="org.mybatis.caches.ehcache.EhcacheCache"/>

9.5.4 加入logback日志

• 存在SLF4J时，作为简易日志的log4j将失效，此时我们需要借助SLF4J的具体实现logback来打印日志。 创建logback的配置文件logback.xml

<?xml version="1.0" encoding="UTF-8"?> 
<configuration debug="true"> 
    <!-- 指定日志输出的位置 --> 
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 
        <encoder> 
            <!--日志输出的格式--> 
            <!--按照顺序分别是： 时间、日志级别、线程名称、打印日志的类、日志主体内容、换行--> 
            <pattern>[%d{HH:mm:ss.SSS}] [%-5level] [%thread] [%logger] [%msg]%n</pattern> 
        </encoder> 
    </appender> 
    <!-- 设置全局日志级别。日志级别按顺序分别是： DEBUG、INFO、WARN、ERROR --> 
    <!-- 指定任何一个日志级别都只打印当前级别和后面级别的日志。 --> 
    <root level="DEBUG"> 
        <!-- 指定打印日志的appender，这里通过“STDOUT”引用了前面配置的appender --> 
        <appender-ref ref="STDOUT" /> 
    </root> 
    <!-- 根据特殊需求指定局部日志级别 --> 
    <logger name="com.atguigu.crowd.mapper" level="DEBUG"/> 
</configuration>

9.5.5 EHCache配置文件说明

属性名	是否必须	作用
maxElementsInMemory	是	在内存中缓存的element的最大数目
maxElementsOnDisk	是	在磁盘上缓存的element的最大数目，若是0表示无穷大
eternal	是	设定缓存的elements是否永远不过期。 如果为true，则缓存的数据始终有效， 如果为false那么还要根据timeToIdleSeconds、timeToLiveSeconds判断
overflowToDisk	是	设定当内存缓存溢出的时候是否将过期的element缓存到磁盘上
timeToIdleSeconds	否	当缓存在EhCache中的数据前后两次访问的时间超过timeToIdleSeconds的属性取值时， 这些数据便会删除，默认值是0,也就是可闲置时间无穷大
timeToLiveSeconds	否	缓存element的有效生命期，默认是0.,也就是element存活时间无穷大
diskSpoolBufferSizeMB	否	DiskStore(磁盘缓存)的缓存区大小。默认是30MB。每个Cache都应该有自己的一个缓冲区
diskPersistent	否	在VM重启的时候是否启用磁盘保存EhCache中的数据，默认是false。
diskExpiryThreadIntervalSeconds	否	磁盘缓存的清理线程运行间隔，默认是120秒。每个120s， 相应的线程会进行一次EhCache中数据的清理工作
memoryStoreEvictionPolicy	否	当内存缓存达到最大，有新的element加入的时候，移除缓存中element的策略。默认是LRU（最近最少使用），可选的有LFU（最不常使用）和FIFO（先进先出）

十 Mybatis逆向工程

• 正向工程：先创建Java实体类，由框架负责根据实体类生成数据库表。 Hibernate是支持正向工程的。

• 逆向工程：先创建数据库表，由框架负责根据数据库表，反向生成如下资源：

  • Java实体类

  • Mapper接口

  • Mapper映射文件

10.1 逆向工程创建步骤

① 添加依赖和插件

<!-- 依赖MyBatis核心包 -->
<dependencies> 
    <dependency> 
        <groupId>org.mybatis</groupId> 
        <artifactId>mybatis</artifactId> 
        <version>3.5.7</version> 
    </dependency> 
    
    <!-- junit测试 --> 
    <dependency> 
        <groupId>junit</groupId> 
        <artifactId>junit</artifactId> 
        <version>4.12</version> 
        <scope>test</scope> 
    </dependency> 

    <!-- log4j日志 --> 
    <dependency> 
        <groupId>log4j</groupId> 
        <artifactId>log4j</artifactId> 
        <version>1.2.17</version> 
    </dependency> 

    <dependency> 
        <groupId>mysql</groupId> 
        <artifactId>mysql-connector-java</artifactId> 
        <version>8.0.16</version> 
    </dependency> 
</dependencies> 

<!-- 控制Maven在构建过程中相关配置 --> 
<build> 
    <!-- 构建过程中用到的插件 --> 
    <plugins> 
        <!-- 具体插件，逆向工程的操作是以构建过程中插件形式出现的 --> 
        <plugin> 
            <groupId>org.mybatis.generator</groupId> 
            <artifactId>mybatis-generator-maven-plugin</artifactId> 
            <version>1.3.0</version> 
            <!-- 插件的依赖 --> 
            <dependencies> 
                <!-- 逆向工程的核心依赖 --> 
                <dependency> 
                    <groupId>org.mybatis.generator</groupId> 
                    <artifactId>mybatis-generator-core</artifactId> 
                    <version>1.3.2</version> 
                </dependency> 

                <!-- MySQL驱动 --> 
                <dependency> 
                    <groupId>mysql</groupId> 
                    <artifactId>mysql-connector-java</artifactId> 
                    <version>8.0.16</version> 
                </dependency> 
            </dependencies> 
        </plugin> 
    </plugins>
</build> 

② 创建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> 
    <!-- 
        targetRuntime: 执行生成的逆向工程的版本 
        MyBatis3Simple: 生成基本的CRUD（清新简洁版） 
        MyBatis3: 生成带条件的CRUD（奢华尊享版） 
	--> 
    <context id="DB2Tables" targetRuntime="MyBatis3"> 
        <!-- 数据库的连接信息 --> 
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" 
                        connectionURL="jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC"
                        userId="root"
                        password="123456"> 
        </jdbcConnection> 

        <!-- javaBean的生成策略--> 
        <javaModelGenerator targetPackage="com.atguigu.mybatis.pojo" 
                            targetProject=".\src\main\java"> 
            <property name="enableSubPackages" value="true" /> 
            <property name="trimStrings" value="true" /> 
        </javaModelGenerator> 

        <!-- SQL映射文件的生成策略 --> 
        <sqlMapGenerator targetPackage="com.atguigu.mybatis.mapper" 
                         targetProject=".\src\main\resources"> 
            <property name="enableSubPackages" value="true" /> 
        </sqlMapGenerator> 

        <!-- Mapper接口的生成策略 --> 
        <javaClientGenerator type="XMLMAPPER" 
                             targetPackage="com.atguigu.mybatis.mapper" targetProject=".\src\main\java"> 
            <property name="enableSubPackages" value="true" /> 
        </javaClientGenerator> 

        <!-- 逆向分析的表 --> 
        <!-- tableName设置为*号，可以对应所有表，此时不写domainObjectName --> 
        <!-- domainObjectName属性指定生成出来的实体类的类名 --> 
        <table tableName="t_emp" domainObjectName="Emp"/> 
        <table tableName="t_dept" domainObjectName="Dept"/> 
    </context> 
</generatorConfiguration>

④ 执行MBG插件的generate目标

10.2 QBC查询

• QBC查询就是根据条件来查询，Mybatis逆向工程为条件查询提供了便捷的查询方式

@Test 

public void testMBG(){ 
    try {
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml"); 
        SqlSessionFactory sqlSessionFactory = new 
        SqlSessionFactoryBuilder().build(is); 
        SqlSession sqlSession = sqlSessionFactory.openSession(true); 
        EmpMapper mapper = sqlSession.getMapper(EmpMapper.class); 

        // 查询所有数据 
        List<Emp> list = mapper.selectByExample(null); 
        list.forEach(emp -> System.out.println(emp));

        // 根据条件查询 
        EmpExample example = new EmpExample();
        example.createCriteria().andEmpNameEqualTo("张三").andAgeGreaterThanOrEqualTo(20); 
        example.or().andDidIsNotNull(); 
        List<Emp> list = mapper.selectByExample(example); 
        list.forEach(emp -> System.out.println(emp));
        
        // 普通方式修改，传入null值则数据库相应字段更改为null
		mapper.updateByPrimaryKey(new Emp(1,"admin",22,null,"456@qq.com",3))；
        // 选择性修改，传入null值，数据库相应字段不做修改
        mapper.updateByPrimaryKeySelective(new Emp(1,"admin",22,null,"456@qq.com",3)); 
    } catch (IOException e) { 
        e.printStackTrace(); 
    } 
}

十一 分页插件

11.1 分页相关概念

• 通过在sql语句中使用关键字limit index,pageSize来实现查询的分页操作

• 分页的相关变量

  • pageSize：每页显示的条数

  • pageNum：当前页的页码

  • index：当前页的起始索引，index=(pageNum-1)*pageSize

  • count：总记录数

  • totalPage：总页数

  • totalPage = count / pageSize;

分页效果

11.2 分页插件的使用步骤

① 添加依赖

<dependency> 
    <groupId>com.github.pagehelper</groupId> 
    <artifactId>pagehelper</artifactId> 
    <version>5.2.0</version> 
</dependency>

② 在MyBatis的核心配置文件中配置插件

<plugins> 
	<!--设置分页插件--> 
	<plugin interceptor="com.github.pagehelper.PageInterceptor"></plugin> 
</plugins>

11.3 分页插件的使用

1. 在常规查询前使用语句Page page = PageHelper.startPage(int pageNum, int pageSize)开启分页功能

   • pageNum：当前页的页码
   • pageSize：每页显示的条数

2. 在查询获取list集合之后，使用PageInfo pageInfo = new PageInfo<>(List list, int navigatePages)获取分页相关数据

   • list：分页之后的数据

   • navigatePages：导航分页的页码数，即导航分页显示几页

分页相关数据:

PageInfo{

pageNum=8, pageSize=4, size=2, startRow=29, endRow=30, total=30, pages=8,

list=Page{count=true, pageNum=8, pageSize=4, startRow=28, endRow=32, total=30,

pages=8, reasonable=false, pageSizeZero=false},

prePage=7, nextPage=0, isFirstPage=false, isLastPage=true, hasPreviousPage=true,

hasNextPage=false, navigatePages=5, navigateFirstPage4, navigateLastPage8,

navigatepageNums=[4, 5, 6, 7, 8]

}

pageNum：当前页的页码

pageSize：每页显示的条数

size：当前页显示的真实条数

total：总记录数

pages：总页数

prePage：上一页的页码

nextPage：下一页的页码

isFirstPage/isLastPage：是否为第一页/最后一页

hasPreviousPage/hasNextPage：是否存在上一页/下一页

navigatePages：导航分页的页码数

navigatepageNums：导航分页的页码，[4, 5, 6, 7, 8]