MyBatis3-最全讲解入门、精通、原理、插件

1.为什么要使用MyBatis?

• MyBatis是一个半自动的持久化层框架
  • 对开发人员而言，核心SQL还是需要自己优化
  • SQL和JAVA编码分开，功能边界清晰，一个专注业务、一个专注数据
• JDBC
  • SQL夹在JAVA代码块里，耦合度高导致硬编码
  • 维护不易且实际开发需求中SQL是有变化，频繁修改的情况很多见
• Hibernate和JPA
  • 长、难、复杂的SQL，对于Hibernate而言，处理不容易
  • 内部自动生成SQL，不容易做特殊优化
  • 基于全映射的全自动框架，大量字段的POJO进行部分映射时比较困难，导致数据库性能下降

2.下载MyBatis

下载链接：https://github.com/mybatis/mybatis-3/

3.构建MyBatis的HelloWord

1. 引入jar包

如果是maven项目，直接拷贝依赖配置到pom.xml中

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>x.x.x</version>
</dependency>

如果是Gradle项目，直接拷贝配置到build.gradle中

implementation group: 'org.mybatis', name: 'mybatis', version: 'x.x.x'

如果是J2SE项目，则直接下载jar包，拷贝到类路径下：https://github.com/mybatis/mybatis-3/releases

2.创建全局配置文件mybatis-config.xml

需要修改对应的数据源配置信息和mapper.xml的资源路径

<?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>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="${driver}"/>
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers>
</configuration>

3.创建xxxx-mapper.xml

<?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="org.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>

4. 获取SqlSessionFactory

String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

5.创建Mapper接口

public interface BlogMapper{
   
	public Bolg selectOne(Integer i);
}

6.获取SqlSession并调用接口查询数据库

SqlSession session = sqlSessionFactory.openSession();
BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);
session.close();

4.全局配置文件参数(Configuration)标签配置

1.<properties>

mybatis可以使用properties标签来引入外部properties配置文件的内容，可以通过${xxxx}获取到配置文件参数的值
**resource:**引用类路径下的资源
**url:**引入网络路径或者磁盘路径下的资源

<properties resource="org/mybatis/example/config.properties"/>

2.<settings>

这是Mybatis的一个非常重要的标签，可以设置Mybatis运行时的行为

设置名	描述	有效值	默认值
cacheEnabled	全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。	true | false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。	true | false	false
aggressiveLazyLoading	开启时，任一方法的调用都会加载该对象的所有延迟加载属性。 否则，每个延迟加载属性会按需加载（参考 lazyLoadTriggerMethods)。	true | false	false （在 3.4.1 及之前的版本中默认为 true）
multipleResultSetsEnabled	是否允许单个语句返回多结果集（需要数据库驱动支持）。	true | false	true
useColumnLabel	使用列标签代替列名。实际表现依赖于数据库驱动，具体可参考数据库驱动的相关文档，或通过对比测试来观察。	true | false	true
useGeneratedKeys	允许 JDBC 支持自动生成主键，需要数据库驱动支持。如果设置为 true，将强制使用自动生成主键。尽管一些数据库驱动不支持此特性，但仍可正常工作（如 Derby）。	true | false	False
autoMappingBehavior	指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示关闭自动映射；PARTIAL 只会自动映射没有定义嵌套结果映射的字段。 FULL 会自动映射任何复杂的结果集（无论是否嵌套）。	NONE, PARTIAL, FULL	PARTIAL
autoMappingUnknownColumnBehavior	指定发现自动映射目标未知列（或未知属性类型）的行为。NONE: 不做任何反应WARNING: 输出警告日志（‘org.apache.ibatis.session.AutoMappingUnknownColumnBehavior’ 的日志等级必须设置为 WARN）FAILING: 映射失败 (抛出 SqlSessionException)	NONE, WARNING, FAILING	NONE
defaultExecutorType	配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（PreparedStatement）； BATCH 执行器不仅重用语句还会执行批量更新。	SIMPLE REUSE BATCH	SIMPLE
defaultStatementTimeout	设置超时时间，它决定数据库驱动等待数据库响应的秒数。	任意正整数	未设置 (null)
defaultFetchSize	为驱动的结果集获取数量（fetchSize）设置一个建议值。此参数只可以在查询设置中被覆盖。	任意正整数	未设置 (null)
defaultResultSetType	指定语句默认的滚动策略。（新增于 3.5.2）	FORWARD_ONLY | SCROLL_SENSITIVE | SCROLL_INSENSITIVE | DEFAULT（等同于未设置）	未设置 (null)
safeRowBoundsEnabled	是否允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为 false。	true | false	False
safeResultHandlerEnabled	是否允许在嵌套语句中使用结果处理器（ResultHandler）。如果允许使用则设置为 false。	true | false	True
mapUnderscoreToCamelCase	是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。	true | false	False
localCacheScope	MyBatis 利用本地缓存机制（Local Cache）防止循环引用和加速重复的嵌套查询。 默认值为 SESSION，会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地缓存将仅用于执行语句，对相同 SqlSession 的不同查询将不会进行缓存。	SESSION | STATEMENT	SESSION
jdbcTypeForNull	当没有为参数指定特定的 JDBC 类型时，空值的默认 JDBC 类型。 某些数据库驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。	JdbcType 常量，常用值：NULL、VARCHAR 或 OTHER。	OTHER
lazyLoadTriggerMethods	指定对象的哪些方法触发一次延迟加载。 用逗号分隔的方法列表。	equals,clone,hashCode,toString
defaultScriptingLanguage	指定动态 SQL 生成使用的默认脚本语言。	一个类型别名或全限定类名。	org.apache.ibatis.scripting.xmltags.XMLLanguageDriver
defaultEnumTypeHandler	指定 Enum 使用的默认 TypeHandler 。（新增于 3.4.5）	一个类型别名或全限定类名。	org.apache.ibatis.type.EnumTypeHandler
callSettersOnNulls	指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型（int、boolean 等）是不能设置成 null 的。	true | false	false
returnInstanceForEmptyRow	当返回行的所有列都是空时，MyBatis默认返回 null。 当开启这个设置时，MyBatis会返回一个空实例。 请注意，它也适用于嵌套的结果集（如集合或关联）。（新增于 3.4.2）	true | false	false
logPrefix	指定 MyBatis 增加到日志名称的前缀。	任何字符串	未设置
logImpl	指定 MyBatis 所用日志的具体实现，未指定时将自动查找。	SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING	未设置
proxyFactory	指定 Mybatis 创建可延迟加载对象所用到的代理工具。	CGLIB | JAVASSIST	JAVASSIST （MyBatis 3.3 以上）
vfsImpl	指定 VFS 的实现	自定义 VFS 的实现的类全限定名，以逗号分隔。	未设置
useActualParamName	允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的项目必须采用 Java 8 编译，并且加上 -parameters 选项。（新增于 3.4.1） true	false true
configurationFactory	指定一个提供 Configuration 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为static Configuration getConfiguration() 的方法。（新增于 3.2.3）	一个类型别名或完全限定类名。	未设置
shrinkWhitespacesInSql	从SQL中删除多余的空格字符。请注意，这也会影响SQL中的文字字符串。 (新增于 3.5.5)	true | false	false
defaultSqlProviderType	Specifies an sql provider class that holds provider method (Since 3.5.6). This class apply to the type(or value) attribute on sql provider annotation(e.g. @SelectProvider), when these attribute was omitted.	一个类型别名或完全限定类名。	未设置

3.<typeAliases>

别名处理器，可以给java类型起别名，默认别名不区分大小写

• 单个起别名：<typeAliase>
  type:需要起别名的类型的全类名，默认是类名小写
  alias: 指定新的别名
• 批量起别名<package>
  name: 指定的包名，为当前包及其子孙包下的类起一个默认的别名，默认是类名小写。当不同的包下有相同的类名，此时会出现别名冲突，因此可以在不同的类上添加注解@Alias指定别名。

mybatis为我们提供底层支持的几种默认的别名：

别名	映射的类型
_byte	byte
_long	long
_short	short
_int	int
_integer	int
_double	double
_float	float
_boolean	boolean
string	String
byte	Byte
long	Long
short	Short
int	Integer
integer	Integer
double	Double
float	Float
boolean	Boolean
date	Date
decimal	BigDecimal
bigdecimal	BigDecimal
object	Object
map	Map
hashmap	HashMap
list	List
arraylist	ArrayList
collection	Collection
iterator	Iterator

4.<typeHandlers>

类型处理器
数据库类型与java类型的映射关系
eg: JSR-310日期类型处理器，在mybatis3.4之前是需要自己显式配置的，在mybatis3.4+,默认已经把日期类型处理器添加到了底层中，无需再显式地配置

5.<plugins>

插件配置
可以拦截到mybatis的底层运行过程，在运行过程中进行修改mybatis的一些执行行为。
主要可以拦截有四大对象：Executor、StatementHandler、ParamenterHandler、ResultSetHandler

6.<environments>

环境配置
环境的相关配置，可以配置多环境设置，主要是事务管理器与数据源的配置，动态设置不同的运行环境
transactionManager: 事务管理器，type: 可以设置值：JDBC|MANAGED，自定义事务管理：实现接口TransactionFactory
dataSource: 数据源, type: UNPOOLED|POOLED|JNDI， 自定义数据源：实现接口DataSourceFactory

7.<databaseIdProvider>

支持多数据库厂商，type: DB_VENDOR(VendorDataBaseIdProvider)，作用是得到数据库厂商的标识(驱动：getDatabaseProductName)，myBatis就能根据数据库厂商的标识来执行不同的SQL

<databaseIdProvider typr="DB_VENDOR">
	<property name="MySQL" value="mysql"/>
	<property name="Oracle" value="oracle"/>
	<property name="SQL Server" value="sqlserver"/>
</databaseIdProvider>

当设置了该数据库厂商标识的别名之后，在配置执行SQL的时候，就可以指定是哪个数据库的SQL

 <select id="getEmp" resultType="Employee" databaseId="mysql">
 select * from tb_emp where id=#{id}
</select>

8.<mappers>

将sql映射注册到全局配置中

• resource: 引用类路径下的sql映射文件
• url: 引用网路上或磁盘路径下的sql映射文件
• class: 引用mapper接口，但是该方式有一些限制条件，1.有sql映射文件，映射文件名必须与接口名相同，并且放在与接口同一路径下。2.没有sql映射文件，所有的sql都是利用注解写在接口上
  推荐：
• 比较重要，复杂的Dao接口我们来写sql映射文件
• 不重要，简单的Dao接口为了快速开发，可以使用注解的方式

9.特别注意： Configuration标签下的以上这些标签是有先后顺序的

properties> settings> typeAliases> typeHandlers> objectFactory> objectWrapperFactory> reflectorFactory> plugins> environments> databaseIdProvider> mappers
这些标签的配置可以没有配置，但是只要配置了，就必须按照以上的顺序进行配置

5.mapper映射文件

1.增删改<insert>、<update>、<delete>

1. mybatis 允许增删改直接定义以下类型的返回值 Integer、Long、Boolean，表示执行sql是否成功或执行成功的行数
2. 需要手动提交事务

一般用法(以insert为例)：

<!--parameterType属性可以省略-->
<insert id="addEmp" parameterType="com.xxx.Employee">
 insert into tb_emp (id,last_name,gender) values (#{id},#{lastName},#{gender})
</insert>

mysql支持主键自增的，自增主键的该怎么获取呢？

mybatis也是利用了statement.genGenreatedKeys();获取的，只需要在insert标签上添加属性userGeneratedKeys=“true”;使用主键自增获取主键值的策略，并将获取到的主键值复制给javabean的哪个属性

<insert id="addEmp" parameterType="com.xxx.Employee" userGeneratedKeys="true" keyProperty="id">
 insert into tb_emp (id,last_name,gender) values (#{id},#{lastName},#{gender})
</insert>

那如果是非自增逐渐的值则该如何获取？

比如Oracle数据库，是通过序列来模拟自增。每次插入的数据的主键是从序列中拿到的值。

<insert id="addEmp" databaseId="oracle">
	<!--keyProperty查出的主键值赋值给javabean中的哪一个属性  order="BEFORE"在插入SQL之前运行  resultType:查出的数据的返回值类型-->
	<selectKey keyProperty="id" order="BEFORE" resultType="Integer">
		select EMPLOYEES_SEQ.nextVal from dual
	</selectKey>
	insert into employees (id,last_name,gender) values (#{id},#{lastName},#{gender})
</insert>	

参数处理

1. 单个参数：
   mybatis不会做特殊处理。#{参数名，任意}取出参数值
2. 多个参数：
   mybatis会做特殊处理，多个参数会被封装成一个map，实际研究源码可以发现：mybatis实际会将参数做两份，一份是特殊处理，没有指定参数名时key: 0,1…，指定参数名时，key:参数名，value:实际的值，另外一份则是key:param1,param2…value:实际的值。#{}实际就是从map中获取指定的key的值
3. 命名参数：
   明确指定封装参数时map的key，使用参数注解@Param(“id”)，此时就可以通过#{“id”}获取到值
4. POJO：
   如果多个参数正好是我们业务逻辑的数据模型，我们就可以直接传入POJO，如果多个参数不是业务模型中的数据，为了方便，我们也可以传入POJO
5. Map：
   此时参数的Map的key与value可以直接通过#{“key”}获取到value
6. TO(DTO):
   如果多个参数不是业务模型中的数据，但是经常会被使用，推荐编写一个TO(DTO)数据传输对象
7. 集合/数组
   如果是Collection(List、Set)类型或者数组，mybatis也会进行特殊处理，也是把传入的List或者数组封装在Map中。key:collection、list、array
8. null值处理
   jdbcType通常需要在某种特定的条件下被设置：在我们数据为null的时候，有些数据库可能不能识别mybatis对null的默认处理，即默认为OTHER。比如Oracle会报错：无效的类型(OTHER)。因为mybatis对所有的null值映射的原生jdbc的OTHER(JdbcType)类型，需要给设置参数时，添加属性#{email, jdbcType=NULL}，也可以在上文讲述过全局配置的<settings>配置中，将配置jdbcTypeForNull默认时OTHER设置为NULL

#{}与${}区别

#{}：可以获取map、List、Array中的值或者pojo对象属性的值
${}：可以获取map、List、Array中的值或者pojo对象属性的值

区别：
#{}: 是以预编译的形式，将参数以占位符设置到sql语句中, PreparedStatement，防止注入攻击
SELECT * FROM TABLE WHERE ID=#{id} ==> SELECT * FROM TABLE WHERE ID=?
${}: 取出的值直接拼接在sql语句中，会有安全问题，容易遭受注入攻击
SELECT * FROM TABLE WHERE ID=${id} ==> SELECT * FROM TABLE WHERE ID=1
因此，建议在大多数情况下，我们参数的值都应该使用#{}， 只有在原生JDBC不支持占位符的地方，我们才使用${}进行取值，比如在分表(按照年份分表拆分) eg:SELECT * FROM ${year}_TABLE 或eg: SELECT * FROM TABLE ORDER BY ${f_name} ${order}
#{}更丰富的用法：
规定参数的一些规则：javaType、jdbcType、mode(存储过程)、numericScale、resultMap、typeHandler、jdbcTypeName、expression(未来准备支持的功能)

2. 查询<select>

一般用法：

<select id="getEmp" resultType="com.xxx.Employee">
 select * from tb_emp where id=#{id}
</select >

查询结果为List

如果resultType返回值是一个List，只需要指定List中元素的类型即可

<select id="getEmp" resultType="com.xxx.Employee">
 select * from tb_emp where id=#{id}
</select >

查询结果为Map

单条结果数据的封装，key为属性名，value为查出的数据，直接resultMap=“map”，因为map在mybatis底层中已经取了别名

<select id="getEmp" resultType="map">
 select * from tb_emp where id=#{id}
</select >

多条结果数据的封装，key为主键，value为查询出的整条数据的封装对象类型，需要在对应的Mapper接口的方法上设置注解@MapKey("id")，即设置对象中的哪个属性作为Map的key

<select id="getEmps" resultType="com.xxx.Employee">
 select * from tb_emp where last_name like #{lastName}
</select >

resultMap自定义结果集映射

1.一般用法

resultType与resultMap只能二选一，不能同时用
type: 自定义某个javaBean的封装规则。 id: 唯一id方便引用
定义主键列的封装规则<id column="id" property="id">column指定哪一列，property指定对应的javaBean属性
定义普通列的封装规则<result column="last_name" property="lastName">column指定哪一列，property指定对应的javaBean属性，其它不指定的列会自动封装。但是建议，只要我们编写了resultMap的映射规则，就把所有列的映射规则都写上

2. 关联查询

eg: 员工中有部门信息

class Employee{
   
	String id; 
	String lastName;
	Integer gender;
	Department dept;
}

class Department{
   
	String id;
	String name;
	List<Employee> emps;
}

返回结果集的resultMap

<!-- 方式一：采用级联属性-->
<resultMap id="difEmp" type="com.xxx.Employee">
	<id column="id" property="id">
	<result column="last_name" property="lastName">
	<result column="gender" property="gender">
	<result column="did" property="dept.id">
	<result column="dept_name" property="dept.name">
</resultMap>

<!-- 方式二：采用association指定联合的javaBean对象-->
<resultMap id="difEmp" type="com.xxx.Employee">
	<id column="id" property="id">
	<result column="last_name" property="lastName">
	<result column="gender" property="gender">
	<association property="dept" javaType="com.xxx.Department">
		<id column="id" property="id">
		<result column="dept_name" property="name">
	</association >
</resultMap>

association 定义关联对象，即一对一，collection定义关联集合，即一对多
association 分步查询

1. 先按照员工id查询出员工信息
2. 根据查询的员工信息的d_id的值去部门查询部门信息
3. 部门信息设置到员工中

<mapper namespaces="com.xxx.deptNamespaceMapper">
	<select id="getDeptById" resultType="com.xxx.Department">
		select * from tb_dept where id=#{id}
	</select>
</mapper>

<mapper namespaces="com.xxx.empNamespaceMapper">
	<select id="getEmpById" resultMmap="difEmp">
		select * from tb_emp where id=#{id}
	</select>
</mapper>
<resultMap id="difEmp" type="com.xxx.Employee">
	<id column="id" property="id">
	<result column="last_name" property="lastName">
	<result column="gender" property="gender">
	<!-- select: 表明当前属性是调用select指定的方法查出的结果，column指定将哪一列的值传给这个方法-->
	<association property="dept" select="com.xxx.deptNamespaceMapper.getDeptById" column="d_id">
	</association >
</resultMap>

association 延时加载(懒加载)
在以上分步查询的基础上，再加上两个配置即可。

在全局配置文件中的<setting>中，加上
<setting name="lazyLoadingEnabled" value="true">
<setting name="aggressiveLazyLoading" value="false">
如果只是某个查询采用延时加载，可以在association或collection上添加属性fetchType="lazy"

collection 定义关联集合类型的属性的封装规则

<resultMap id="difEmp" type="com.xxx.Department">
	<id column="id" property="id">
	<result column="dept_name" property="name">
	<!-- ofType: 指定集合里面元素的类型-->
	<collection property="emps" ofType="com.xxx.Employee">
		<id column="id" property="id">
		<result column="last_name" property