MyBatis基础知识点总结

MyBatis了解

---

MyBatis 是什么？

1. MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架

2. MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集

3. MyBatis 可以使用简单的XML或注解用于配置和原始映射，将接口和Java的 POJO（Plain Old Java Objects，普通的Java对象）映射成数据库中的记录

4. MyBatis 是一个半自动的ORM（Object Relation Mapping）框架

MyBatis 优点（与 JDBC，Hibernate 和 JPA 相比）：

• 轻量级，性能出色

• SQL 和 Java 编码分开，功能边界清晰。Java 代码专注业务、SQL 语句专注数据

• 开发效率稍逊于HIbernate，但是完全能够接受

JDBC

• SQL 夹杂在 Java 代码中耦合度高，导致硬编码内伤

• 维护不易且实际开发需求中 SQL 有变化，频繁修改的情况多见

• 代码冗长，开发效率低

Hibernate 和 JPA

• 操作简便，开发效率高

• 程序中的复杂 SQL 需要绕过框架

• 内部自动生产的 SQL，不容易做特殊优化

• 基于全映射的全自动框架，大量字段的 POJO 进行部分映射时比较困难

• 反射操作太多，导致数据库性能下降

搭建 MyBatis

①创建 maven 工程

1. 打包方式：jar

2. 引入依赖

<dependencies>
	
	<dependency>
		<groupId>org.mybatisgroupId>
		<artifactId>mybatisartifactId>
		<version>3.5.7version>
	dependency>
	
	<dependency>
		<groupId>junitgroupId>
		<version>4.12version>
		<scope>testscope>
	dependency>
	
	<dependency>
		<groupId>mysqlgroupId>
		<artifactId>mysql-connector-javaartifactId>
		<version>8.0.32version>
	dependency>
dependencies>

②创建MyBatis的核心配置文件

• 一般命名为 mybatis-config.xml ，但仅仅只是建议，并非强制要求。以后整合Spring时，这个配置文件可以省略

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

• 核心配置文件存放的位置是 maven 工程的 src/main/resources 目录下

DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
	
	<environments default="development">
		<environment id="development">
			<transactionManager type="JDBC"/>
			<dataSource type="POOLED">
				<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
				<property name="url" value="jdbc:mysql://localhost:3306/db1"/>
				<property name="username" value="root"/>
				<property name="password" value="root"/>
			dataSource>
		environment>
	environments>
	
	<mappers>
		<package name="mappers/UserMapper.xml"/>
	mappers>
configuration>

③创建mapper接口

• MyBatis中的mapper接口相当于以前的dao。但是区别在于，mapper仅仅是接口，我们不需要提供实现类。

public interface UserMapper {
	/**
	* 添加用户信息
	*/
	void insertUser();
}

④创建MyBatis的映射文件

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

• 对象：Java的实体类对象

• 关系：关系型数据库

• 映射：二者之间的对应关系

Java与数据库中一些存在对应关系的概念

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

映射文件的命名规则：

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

  • 例如：表 t_user ，映射的实体类为 User ，所对应的映射文件为 UserMapper.xml

  • 因此一个映射文件对应一个实体类，对应一张表的操作

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

• MyBatis 映射文件存放的位置是 src/main/resources/mappers 目录下

注意：MyBatis 中可以面向接口操作数据，要保证两个一致：

• mapper 接口的全类名和映射文件的命名空间（namespace）保持一致

• mapper 接口中方法的方法名和映射文件中编写 SQL 的标签的id属性保持一致

DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.zrb.mapper.UserMapper">
	
	<insert id="insertUser">
	insert into t_user values(null,'admin','123456',23,'男','[email protected]')
	insert>
mapper>

⑤通过junit测试功能

 @Test
   public void test() throws IOException {
	//读取MyBatis的核心配置文件
	InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
	//创建SqlSessionFactoryBuilder对象
	SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
	//通过核心配置文件所对应的字节输入流创建工厂类SqlSessionFactory，生产SqlSession对象
	SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
	//创建SqlSession对象，此时通过SqlSession对象所操作的sql都必须手动提交或回滚事务
	//SqlSession sqlSession = sqlSessionFactory.openSession();
	//创建SqlSession对象，此时通过SqlSession对象所操作的sql都会自动提交
	SqlSession sqlSession = sqlSessionFactory.openSession(true);
	//通过代理模式创建UserMapper接口的代理实现类对象
	UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
	//调用UserMapper接口中的方法，就可以根据UserMapper的全类名匹配元素文件，通过调用的方法名匹配映射文件中的SQL标签，并执行标签中的SQL语句
	int result = userMapper.insertUser();
	//sqlSession.commit();
	System.out.println("结果："+result);
   }

• SqlSession：代表Java程序和数据库之间的会话。（HttpSession是Java程序和浏览器之间的会话）

• SqlSessionFactory：是生产 SqlSession 的工厂。

  • 工厂模式：如果创建某一个对象，使用的过程基本固定，那么我们就可以把创建这个对象的相关代码封装到一个工厂类中，以后都使用这个工厂类来生产我们需要的对象。

⑥加入log4j日志功能（用于查看查询信息，可不要）

1. 加入依赖

<dependency>
	<groupId>log4jgroupId>
	<artifactId>log4jartifactId>
	<version>1.2.17version>
dependency>

2. 加入log4j的配置文件

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

DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
	<appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
		<param name="Encoding" value="UTF-8" />
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%-5p %d{MM-dd HH:mm:ss,SSS}%m (%F:%L) \n" />
		layout>
	appender>
	<logger name="java.sql">
		<level value="debug" />
	logger>
	<logger name="org.apache.ibatis">
		<level value="info" />
	logger>
	<root>
		<level value="debug" />
		<appender-ref ref="STDOUT" />
	root>
log4j:configuration>

日志的级别

• FATAL(致命)>ERROR(错误)>WARN(警告)>INFO(信息)>DEBUG(调试)

• 从左到右打印的内容越来越详细

核心配置文件详解

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

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

DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>

    

    
    <properties resource="jdbc.properties" />

    
    <typeAliases>
        
        
        
        
        
        <package name="com.zrb.pojo"/>
    typeAliases>

    
    <environments default="development">
        
        <environment id="development">
            
            <transactionManager type="JDBC"/>
            
            <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>

        <environment id="test">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/db1"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            dataSource>
        environment>
    environments>

    
    <mappers>
        
        
        <package name="com.zrb.mapper"/>
    mappers>
configuration>

MyBatis获取参数值的两种方式

---

MyBatis获取参数值的两种方式：${} 和 #{}

• ${} 的本质就是字符串拼接，#{} 的本质就是占位符赋值

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

单个字面量类型的参数

若mapper接口中的方法参数为单个的字面量类型，此时可以使用 ${}和 #{} 以任意的名称获取参数的值，注意 ${} 需要手动加单引号

多个字面量类型的参数

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

此时 MyBatis 会自动将这些参数放在一个 map 集合中，以arg0,arg1...为键，以参数为值；以 param1,param2... 为键，以参数为值；因此只需要通过 ${} 和 #{} 访问 map 集合的键就可以获取相对应的值，注意 ${} 需要手动加单引号

map 集合类型的参数

若 mapper 接口中的方法需要的参数为多个时，此时可以手动创建 map 集合，将这些数据放在 map 中只需要通过 ${} 和 #{} 访问 map 集合的键就可以获取相对应的值，注意 ${} 需要手动加单引号

实体类类型的参数

若mapper接口中的方法参数为实体类对象时,此时可以使用 ${} 和 #{} ，通过访问实体类对象中的属性名获取属性值，注意 ${} 需要手动加单引号

使用@Param标识参数

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

特殊SQL的执行

①模糊查询

三种方式

//1.用${}，${}只进行字符串拼接，直接写入字符串中
select * from t_user where username like '%${like}%'
//2.用concat函数进行拼接
select * from t_user where username like concat('%',#{like},'%')
//3.用#{}，#{}不能字节写字符串中，否则会变成？拼接到字符串，
//并不会对其进行正确赋值，可以用"%"#{}"%"，前后的%用双引号括起
select * from t_user where username like "%"#{like}"%"

②批量删除

批量删除时可以用 ${}

delete from t_user where id in (${ids})

③动态设置表名

动态查询表是可以用 ${}

select * from ${tableName}

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

场景模拟：

t_clazz(clazz_id,clazz_name) //班级表
t_student(student_id,student_name,clazz_id) //学生表

1、添加班级信息

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

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

简单事例，获取主键自增表 t_user 的新增id

/**
* 添加用户信息
*/
int insertUser(User user);

# useGeneratedKeys：设置使用自增的主键
# keyProperty：因为增删改有统一的返回值是受影响的行数，因此只能将获取的自增的主键放在传输的参数user对象的某个属性中
<!--int insertUser(User user);-->
<insert id="insertUser" useGeneratedKeys="true" keyProperty="id">
	insert into t_user values(null,#{username},#{password},#{age},#{sex})
</insert>

自定义映射resultMap

---

resultType和resultMap

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

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

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

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

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

<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>

<select id="test" resultMap="userMap">
	
	select id,user_name,password,age,sex from t_user where user_name like concat('%',#{mohu},'%')
select>

若字段名和实体类中的属性名不一致，但是字段名符合数据库的规则（使用_），实体类中的属性名符合Java的规则（使用驼峰），此时也可通过以下两种方式处理字段名和实体类中的属性的映射关系

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

2. 可以在MyBatis的核心配置文件中设置一个全局配置信息mapUnderscoreToCamelCase，可以在查询表中数据时，自动将_类型的字段名转换为驼峰

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

多对一映射处理

场景模拟：

• 查询员工信息以及员工所对应的部门信息

级联方式处理映射关系

<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>

<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>

即这一步操作，在员工表中定义了一个部门类型的成员变量，通过数据库中查询的字段与部门类型的成员变量中的部门属性进行映射

使用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>

<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>

分步查询

①查询员工信息

/**
* 通过分步查询查询员工信息
* @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>
	
	<association property="dept"
		select="com.zrb.mapper.DeptMapper.getEmpDeptByStep" column="did">
		
	association>
resultMap>

<select id="getEmpByStep" resultMap="empDeptStepMap">
	select * from t_emp where eid = #{eid}
select>

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

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

<select id="getEmpDeptByStep" resultType="Dept">
	select * from t_dept where did = #{did}
select>

一对多映射处理

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>
	
	<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>

<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>

分步查询

①查询部门信息

/**
* 分步查询部门和部门中的员工
* @param did
* @return
*/
Dept getDeptByStep(@Param("did") int did);

<resultMap id="deptEmpStep" type="Dept">
	<id property="did" column="did">id>
	<result property="dname" column="dname">result>
	<collection property="emps" fetchType="eager"
		select="com.atguigu.MyBatis.mapper.EmpMapper.getEmpListByDid" column="did">
	collection>
resultMap>

<select id="getDeptByStep" resultMap="deptEmpStep">
	select * from t_dept where did = #{did}
select>

②根据部门id查询部门中的所有员工

/**
* 根据部门id查询员工信息
* @param did
* @return
*/
List<Emp> getEmpListByDid(@Param("did") int did);

<select id="getEmpListByDid" resultType="Emp">
	select * from t_emp where did = #{did}
select>

分步查询的优点

• 可以实现延迟加载，但是必须在核心配置文件中设置全局配置信息：
  • lazyLoadingEnabled：延迟加载的全局开关。当开启时，所有关联对象都会延迟加载
  • aggressiveLazyLoading：当开启时，任何方法的调用都会加载该对象的所有属性。否则，每个属性会按需加载，此时就可以实现按需加载，获取的数据是什么，就只会执行相应的sql。
  • 此时可通过 association 和 collection 中的 fetchType 属性设置当前的分步查询是否使用延迟加载， fetchType= lazy (延迟加载)|eager(立即加载)

动态SQL

---

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

if

if 标签可通过 test 属性的表达式进行判断，若表达式的结果为 true ，则标签中的内容会执行；反之标签中的内容不会执行

<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>

where

where 和 if 一般结合使用：

• 若 where 标签中的 if 条件都不满足，则 where 标签没有任何功能，即不会添加 where 关键字
• 若 where 标签中的if条件满足，则 where 标签会自动添加 where 关键字，并将条件最前方多余的 and 去掉

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

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>

choose、when、otherwise

choose、when、 otherwise相当于if…else if…else

<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>

foreach

<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>


<delete id="deleteMoreByArray">
	delete from t_emp where
	<foreach collection="eids" item="eid" separator="or">
		eid = #{eid}
	foreach>
delete>

<delete id="deleteMoreByArray">
		delete from t_emp where eid in
	<foreach collection="eids" item="eid" separator="," open="(" close=")">
		#{eid}
	foreach>
delete>

SQL片段

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

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

分页插件

---

分页插件的使用步骤

①添加依赖

<dependency>
	<groupId>com.github.pagehelpergroupId>
	<artifactId>pagehelperartifactId>
	<version>5.2.0version>
dependency>

②配置分页插件

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

<plugins>
	
	<plugin interceptor="com.github.pagehelper.PageInterceptor">plugin>
plugins>

分页插件的使用

（1）在查询功能之前使用PageHelper.startPage(int pageNum, int pageSize)开启分页功能

• pageNum：当前页的页码

• pageSize：每页显示的条数

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

• list：分页之后的数据

• navigatePages：导航分页的页码数

（3）分页相关数据

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：导航分页的页码，[1,2,3,4,5]