1.简介
历史
MyBatis
最初是Apache
的一个开源项目iBatis
,iBatis
一词来源于internet
和abatis
的组合,是一个基于Java的持久层框架。iBatis
提供的持久层框架,包括SQL Maps
(其实就是把Java中实体类对象和数据库中一条记录进行映射)和Data Access Objects
(DAO
)
特性
MyBatis
是支持定制化SQL
(所有SQL
语句需要自己写)、存储过程以及高级映射的优秀的持久层框架
MyBatis
避免了几乎所有的JDBC
代码和手动设置参数以及获取结果集
MyBatis
可以使用简单的XML
或注解用于配置和原始映射,将接口和Java的POJO
(Plain Old Java Objects
,普通的Java
对象)映射成数据库中的记录
MyBatis
是一个 半自动的ORM
(Object Relation Mapping
,表示Java实体类对象和关系型数据库记录之间的关系)框架
与其他持久层技术对比
JDBC
:
SQL
夹杂在Java代码中耦合度高,导致硬编码内伤- 维护不易且实际开发需求中
SQL
有变化,频繁修改的情况多见- 代码冗长,开发效率低
Hibernate
和JPA
- 操作简便,开发效率高(直接调用方法即可,不需要写
SQL
语句)- 程序中的长难复杂
SQL
需要绕过框架- 内部自动生产的
SQL
,不容易做特殊优化- 基于全映射的全自动框架,大量字段的
POJO
进行部分映射时比较困难(因为操作的不是表,而是实体类)- 反射操作太多,导致数据库性能下降
MyBatis
:
- 轻量级,性能出色
SQL
和Java
编码分开,功能边界清晰(Java
代码专注业务、SQL
语句专注数据)- 开发效率稍逊于
HIbernate
,但是完全能够接受
2.搭建MyBatis
开发环境
IDE
:Idea 2019.1.4
构建工具:
maven 3.6.1
MySQL
版本:MySQL 8
MySQL 8
使用的驱动类:com.mysql.cj.jdbc.Driver
MySQL 8
的URL
:jdbc:mysql://localhost:3306/xxxx?serverTimezone=UTC
MyBatis
版本:MyBatis 3.5.7
创建maven工程
- 打包方式:
JAR
(因为不需要使用到Tomcat等服务器) - 引入依赖:代码参考pom.xml文件
创建MyBatis的核心配置文件
- 习惯上命名为
mybatis-config.xml
,将来整合Spring
之后该配置文件可以省略- 核心配置文件主要用于配置连接数据库的环境以及
MyBatis
的全局配置信息- 核心配置文件存放的位置是
src/main/resources
目录下
<?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="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/{数据库名}?serverTimezone=UTC"/>
<property name="username" value="xxxx"/>
<property name="password" value="xxxx"/>
</dataSource>
</environment>
</environments>
<!--引入映射文件-->
<mappers>
<!--mybatis-config.xml和mappers/UserMapper.xml都在resources目录下-->
<mapper resource="mappers/UserMapper.xml"/>
</mappers>
</configuration>
创建mapper接口
MyBatis
中的mapper
接口相当于以前的dao
,区别在于mapper
只是接口,不需要提供实现类
public interface UserMapper {
/**
* 添加用户信息
*/
int insertUser();
}
创建MyBatis的映射文件
- 映射文件的命名规则:表所对应的
实体类的类名+Mapper.xml
,例如表名为t_user
,映射的实体类为User
,对应的映射文件为UserMapper.xml
MyBatis
映射文件用于编写SQL
,访问以及操作表中的数据MyBatis
映射文件存放的位置是src/main/resources/mappers
目录下MyBatis
中可以面向接口操作数据,要保证两个一致:
mapper
接口的全类名和映射文件的命名空间(namespace
)保持一致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.psj.mybatis.mapper.UserMapper">
<!--int insertUser();-->
<insert id="insertUser">
insert into t_user values(null,'admin','123456',100,'男','12345@qq.com')
</insert>
</mapper>
通过junit测试功能
@Test
public void testInsert() 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);
// ------------------使用mapper接口--------------------
// 通过代理模式创建UserMapper接口的代理实现类对象
// 之所以不直接new是因为UserMapper是一个接口,无法直接new
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 调用UserMapper接口中的方法,就可以根据UserMapper的全类名匹配元素文件
// 通过调用的方法名匹配映射文件中的SQL标签,并执行标签中的SQL语句
int result = userMapper.insertUser(); // 底层也是调用sqlSession.insert
// ------------------使用mapper接口--------------------
// ------------------不使用mapper接口--------------------
// 通过SQL语句的唯一标识(namespace.sqlId)找到SQL并执行
// int result = sqlSession.insert("com.psj.mybatis.mapper.UserMapper.insertUser");
// ------------------不使用mapper接口--------------------
// sqlSession.commit(); // 如果设置了自动提交就不需要该句
sqlSession.close();
System.out.println("结果:" + result);
}
加入log4j日志功能
日志的级别:
FATAL(致命)>ERROR(错误)>WARN(警告)>INFO(信息)>DEBUG(调试)
,从左到右打印的内容越来越详细(连DEBUG
的日志都会打印,其他出现的日志就更不用说了)
-
在
pom.xml
中加入log4j
依赖: -
在
src/main/resources
目录下加入log4j
的配置文件
3.MyBatis的增删改查
重点在查询功能中的
resultType
和resultMap
,具代码参考MyBatis_01_helloworld中的UserMapper.xml和UserMapper.java
<mapper namespace="com.psj.mybatis.mapper.UserMapper">
<!--int insertUser();-->
<insert id="insertUser">
insert into t_user values(1,'admin','123456',100,'男','12345@qq.com')
</insert>
<!--int updateUser();-->
<update id="updateUser">
update t_user set username='psj',password='123' where id = 1
</update>
<!--int deleteUser();-->
<delete id="deleteUser">
delete from t_user where id = 1
</delete>
<!--User getUserById();-->
<!--
查询的标签select必须设置属性resultType或resultMap
resultType:自动映射,用于属性名和表中字段名一致的情况
resultMap:自定义映射,用于一对多或多对一或字段名和属性名不一致的情况
-->
<select id="getUserById" resultType="com.psj.mybatis.pojo.User">
select * from t_user where id = 1
</select>
<!--List<User> getUserList();-->
<!--这里不是返回一个集合,还是返回集合中对于的Java类型-->
<select id="getAllUser" resultType="com.psj.mybatis.pojo.User">
select * from t_user
</select>
</mapper>
public interface UserMapper {
/**
* 添加用户信息
*/
int insertUser();
/**
* 修改用户信息
*/
void updateUser();
/**
* 删除用户信息
*/
void deleteUser();
/**
* 根据用户Id获取用户信息
*/
User getUserById();
/**
* 查询所有用户信息
*/
List<User> getAllUser();
}
4.核心配置文件详解
核心配置文件中的标签必须按照固定的顺序:
properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?
5.MyBatis获取参数值的两种方式
${}
:
- 本质是字符串拼接**(存在
SQL
注入)**- 使用字符串拼接的方式拼接
SQL
,若为字符串类型或日期类型的字段进行赋值时,需要手动加单引号#{}
:
- 本质是占位符赋值
- 使用占位符赋值的方式拼接
SQL
,若为字符串类型或日期类型的字段进行赋值时,可以自动添加单引号
单个字面量类型的参数
代码参考MyBatis_02_parameter中的UserMapper.xml和UserMapper.java中的
getUserByUsername
方法
多个字面量类型的参数
代码参考MyBatis_02_parameter中的UserMapper.xml和UserMapper.java中的
checkLogin
方法
map集合类型的参数
代码参考MyBatis_02_parameter中的UserMapper.xml和UserMapper.java中的
checkLoginByMap
方法
实体类类型的参数*
代码参考MyBatis_02_parameter中的UserMapper.xml和UserMapper.java中的
insertUser
方法注意事项:
- 在一个实体类中,假设没有成员变量
name
,但是有name
的setter
和getter
方法,也是可以访问name
属性的(即属性只和setter
和getter
方法有关)
使用@Param标识参数*
代码参考MyBatis_02_parameter中的UserMapper.xml和UserMapper.java中的
checkLoginByParam
方法(建议单/多个或map
集合类型都使用该方式)
6.MyBatis的各种查询功能
查询一个实体类对象
代码参考MyBatis_02_parameter中的SelectMapper.xml和SelectMapper.java中的
getUserById
方法注意事项:
- 若
SQL
语句查询的结果为多条时,一定不能以实体类类型作为方法的返回值(因为MyBatis
底层sqlSession
是根据方法的返回值选择执行的方法),否则会抛出异常TooManyResultsException
查询一个list集合
代码参考MyBatis_02_parameter中的SelectMapper.xml和SelectMapper.java中的
getAllUser
方法注意事项:
- 若
SQL
语句查询的结果为1条时,可以使用实体类类型或list
集合类型作为方法的返回值
查询单个数据
代码参考MyBatis_02_parameter中的SelectMapper.xml和SelectMapper.java中的
getCount
方法
查询一条数据为map集合
代码参考MyBatis_02_parameter中的SelectMapper.xml和SelectMapper.java中的
getUserByIdToMap
方法注意事项:
- 如果某条记录中的字段为
null
,则不会在结果Map
中出现- 大多数情况返回的数据并不是一个实体类,所以需要存放在
Map
中
查询多条数据为map集合
代码参考MyBatis_02_parameter中的SelectMapper.xml和SelectMapper.java中的
getAllUserToMap
方法注意事项:
- 尽管结果是多条记录(即多个
Map
),但不管SelectMapper.java
中返回是List
还是Map
,SelectMapper.xml
中的resultType
都是Map
@MapKey("id")
中id
作为键,Map<String, Object>
作为值
7、特殊SQL的执行
模糊查询
代码参考MyBatis_02_parameter中的SpecialSQLMapper.xml和SpecialSQLMapper.java中的
getUserByLike
方法注意事项:
- 因为模糊查询不确定结果返回几条记录,所以在
SpecialSQLMapper.java
中返回是List
,但是在SpecialSQLMapper.xml
中的resultType
是User
- 如果写为
"%#{mohu}%"
,最终会被解析为"%?%"
,此时的?
属于字符串的一部分,不会被当作占位符解析(即对占位符进行setter
方法赋值),所以报错
批量删除
代码参考MyBatis_02_parameter中的SpecialSQLMapper.xml和SpecialSQLMapper.java中的
deleteMoreUser
方法注意事项:
- 如果写为
in(#{ids})
,最终会被解析为in('9,10')
(因为自动加上了双引号),而正确的语句应该是in(9,10)
,所以报错
动态设置表名
代码参考MyBatis_02_parameter中的SpecialSQLMapper.xml和SpecialSQLMapper.java中的
getUserList
方法注意事项:
- 不能使用
#{tableName}
是因为在SQL
语句中表名不能加上引号,而#{xxx}
会自动添加引号
添加功能获取自增的主键
代码参考MyBatis_02_parameter中的SpecialSQLMapper.xml和SpecialSQLMapper.java中的
insertUser
方法注意事项:
- 设置
useGeneratedKeys="true" keyProperty="id"
并成功插入数据,此时作为参数的User
对象的id
属性会打印出值(在创建对象时赋值为null
)- 增删改的返回值是受影响的行数,因此只能将获取的自增的主键放在传输的参数
User
对象的某个属性中
8.自定义映射resultMap
resultMap处理字段和属性的映射关系
代码参考MyBatis_03_resultMap中的EmpMapper.xml和EmpMapper.java中的
getEmpByEmpId
方法注意事项:
- 若字段名(emp_name)和实体类中的属性名(empName)不一致,则通过
resultMap
设置自定义映射(还有其他两种方式,在注释中有介绍)
多对一映射处理
要求查询员工信息以及员工所对应的部门信息
- 使用级联方式处理多对一关系,代码参考MyBatis_03_resultMap中的EmpMapper.xml和EmpMapper.java中的
getEmpAndDeptByEmpId
方法,并且resultMap
为empAndDeptResultMapOne
- 使用
association
处理映射关系,代码参考MyBatis_03_resultMap中的EmpMapper.xml和EmpMapper.java中的getEmpAndDeptByEmpId
方法,并且resultMap
为empAndDeptResultMap
- 使用分步查询:
- 先查询员工信息,代码参考MyBatis_03_resultMap中的EmpMapper.xml和EmpMapper.java中的
getEmpAndDeptByStepOne
方法,并且resultMap
为empAndDeptByStepResultMap
- 再根据员工所对应的部门
id
查询部门信息,代码参考MyBatis_03_resultMap中的DeptMapper.xml和DeptMapper.java中的getEmpAndDeptByStepTwo
方法注意事项:
- 分步查询的优点即可以实现延迟加载(按需加载),比如获取员工信息时暂时不想获取部门信息就可以开启延迟加载,开启后只执行如
emp.getName()
方法就只会执行查询员工信息的SQL
语句,减少内存消耗(需要在mybatis-config.xml
设置lazyLoadingEnabled
为true
,并且确保aggressiveLazyLoading
为false
,因为如果为true
则不管lazyLoadingEnabled
为什么值都会全部加载)
一对多映射处理
要求根据部门
id
查询部门以及部门中的员工信息
- 使用
collection
处理一对多关系,代码参考MyBatis_03_resultMap中的DeptMapper.xml和DeptMapper.java中的getDeptAndEmpByDeptId
方法,并且resultMap
为deptAndEmpResultMap
- 使用分步查询:
- 先查询部门信息,代码参考MyBatis_03_resultMap中的DeptMapper.xml和DeptMapper.java中的
getDeptAndEmpByStepOne
方法,并且resultMap
为deptAndEmpResultMapByStep
- 再根据部门
id
查询部门中的所有员工,代码参考MyBatis_03_resultMap中的EmpMapper.xml和EmpMapper.java中的getDeptAndEmpByStepTwo
方法
9.动态SQL
动态
SQL
技术是根据特定条件动态拼装SQL
语句的功能,它是为了解决拼接SQL
语句字符串时的痛点问题
if
通过
test
属性的表达式进行判断,若表达式的结果为true
,则标签中的内容会执行;反之标签中的内容不会执行代码参考MyBatis_04_dynamicSQL中的DynamicSQLMapper.xml和DynamicSQLMapper.java中的
getEmpByConditionOne
方法注意事项:
test
属性中是对类的属性进行判断- 为了避免拼接错误,可以在语句中加上
where 1=1
,也可以使用where
标签
where
where
标签一般结合if
标签使用:
- 若
where
标签中的if
条件都不满足,则where
标签没有任何功能(即不会添加where
关键字)- 若
where
标签中的if
条件满足,则where
标签会自动添加where
关键字,并将条件最前方多余的and
去掉代码参考MyBatis_04_dynamicSQL中的DynamicSQLMapper.xml和DynamicSQLMapper.java中的
getEmpByConditionTwo
方法注意事项:
where
标签不能去掉条件最后多余的and
(即如果写成gender = #{gender} and
则无法除去后面这个and
)
trim
trim
用于去掉或添加标签中的内容代码参考MyBatis_04_dynamicSQL中的DynamicSQLMapper.xml和DynamicSQLMapper.java中的
getEmpByCondition
方法
choose、when、otherwise
相当于
if...else if..else
代码参考MyBatis_04_dynamicSQL中的DynamicSQLMapper.xml和DynamicSQLMapper.java中的
getEmpByChoose
方法注意事项:
- 在
when
标签内容中不需要加上and
,因为只要有一个分支成立就不会往下判断
foreach
代码参考MyBatis_04_dynamicSQL中的DynamicSQLMapper.xml和DynamicSQLMapper.java中的
insertMoreEmp
方法和deleteMoreEmp
方法
SQL片段
可以记录一段公共
SQL
片段,在使用的地方通过include
标签进行引入代码参考MyBatis_04_dynamicSQL中的DynamicSQLMapper.xml和DynamicSQLMapper.java中的
getAllEmp
方法