MyBatis
一、简介
1、什么是MyBatis
- 一款优秀的持久层框架
- 支持定制化SQL、存储过程以及高级映射
- MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
- MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
- 原身是Apache的一个开源项目iBatis。
- 2010迁移到Google code 并改名为MyBatis,2013年11月迁移到GitHub
2、获取MyBatis
GitHub:https://github.com/mybatis/mybatis-3/releases
Maven:
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.4</version>
</dependency>
3、持久层
数据持久化
将程序的数据在持久状态和瞬时状态转化的过程。
为什么需要持久化?
内存的断电即失的特点,无法一直将数据放在内存中,需要将数据持久化到数据库
4、为什么使用MyBatis
- 方便数据存入数据库
- 简化传统JDBC代码,SQL与代码分离,提高可维护性。
- 目前流行的框架,利于自动化。
二、第一个MyBatis
1、环境搭建
- 创建数据库
- 导入maven依赖(MyBatis、MySQL连接驱动、Junit)
2、创建一个Module
-
编写MyBatis核心配置文件
用于连接数据库
<?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/mybatisstudy?userSSL=true&CharacterEncoding=utf8&useUnicode=true&serverTimezone=UTC"/> <property name="username" value="root"/> <property name="password" value="170312"/> </dataSource> </environment> </environments> </configuration>
-
编写MyBatis工具类
每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。
XML配置文件 -->SqlSessionFactoryBuilder --> SqlSessionFactory
既然有了 SqlSessionFactory,顾名思义,我们可以从中获得 SqlSession 的实例。SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。
所以这个工具类只是用于获取SqlSession,SqlSession就是用于执行SQL语句的。
3、代码编写
-
编写实体类POJO
-
编写Dao接口
-
创建mapper绑定到Dao层的接口
<mapper namespace=""> <select id=""> </select> </mapper>
-
namespace(命名空间):
命名空间的作用有两个,一个是利用更长的全限定名来将不同的语句隔离开来,同时也实现了上面见到的接口绑定。
-
mapper里面可以定制SQL语句
以select标签为例子,id填入当前mapper绑定接口下的某个方法名,相当于接口实现类的方法实现,当然需要在标签内写上SQL语句,标签内可以加上resultType即结果集,还有一个resultMap可以返回多个结果集。ParameterType填写传入参数类型
举例
<mapper namespace="com.sakura.dao.UserDao"> <select id="getUsers" resultType="com.sakura.pojo.User"> select * from mybatisstudy.user </select> </mapper>
- 这个mapper 就是绑定com.sakura.dao.UserDao这个接口,(也可以使用短命名,前提是这个短命名是全局唯一,否则就要使用全限定名)
- select标签则表示是对这个接口下的getUsers这个方法的实现。
- 返回结果集的类型resultType为实体类的User,一般返回结果集类型注明为返回集容器的泛型
完成这些步骤,就结束了对一条SQL语句的映射,就代替了传统的接口实现类
它们映射的语句不仅可以 XML 来配置,还可以使用 Java 注解来配置。
遗留问题:Mapper的底层原理?是否和动态代理有关系?
-
4、Junit测试
-
报错
org.apache.ibatis.binding.BindingException: Type interface com.sakura.dao.UserDao is not known to the MapperRegistry.
com.sakura.dao.UserDao在映射注册表中是未知的,即我们的Mapper没有注册
- 去MyBatis-config.xml中注册Mapper
<!--每个xxxMapper.xml都需要在MyBatis的配置文件中注册--> <mappers> <mapper resource="com/sakura/dao/UserMapper.xml"></mapper> </mappers>
-
再次报错
Could not find resource com/sakura/dao/UserMapper.xml
无法找找到xxxMapper.xml文件,这就是之前在Maven中提到过的资源导出问题
Maven项目在打包时,约定将资源配置文件放在resource文件夹下
(需要在pom.xml中增加配置项,使得其他包中的配置或资源文件能够导出)
<build> <resources> <!--默认只导出resource文件夹下的--> <resource> <directory>src/main/resources</directory> <includes> <include>**/*.properties</include> <include>**/*.xml</include> </includes> <filtering>true</filtering> </resource> <!--添加配置导出java文件夹下的--> <resource> <directory>src/main/java</directory> <includes> <include>**/*.properties</include> <include>**/*.xml</include> </includes> <filtering>true</filtering> </resource> </resources> </build>
测试代码:
@Test
public void Test(){
// 1.获取SqlSession对象
SqlSession sqlSession = MybatisUtils.getSqlSession();
// 2.执行SQL
//============方式A==============//
UserDao mapper = sqlSession.getMapper(UserDao.class);
List<User> users = mapper.getUsers();
for (User user : users) {
System.out.println(user.toString());
}
//===========方式B============//
List<User> list = sqlSession.selectList("com.sakura.dao.UserDao.getUsers");
for (User user : list) {
System.out.println(user);
}
sqlSession.close();
}
5、作用域和生命周期
SqlSessionFactoryBuilder
这个类可以被实例化、使用和丢弃,一旦创建了 SqlSessionFactory,就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域(也就是局部方法变量)。
SqlSessionFactory
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。 因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到,最简单的就是使用单例模式或者静态单例模式。(最好不要创建多个)
SqlSession
每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。==每次收到 HTTP 请求,就可以打开一个 SqlSession,返回一个响应后,就关闭它。==建议使用try-with-resource 表面上省去finally关闭资源的逻辑
映射器实例(Mapper)
方法作用域才是映射器实例的最合适的作用域。 也就是说,**映射器实例应该在调用它们的方法中被获取,使用完毕之后即可丢弃。**不需要被显式地关闭,保持mapper和调用getMapper获取它的SqlSession保持相同作用域。
三、CURD
增
<insert id="addUser" parameterType="com.sakura.pojo.User">
insert into mybatisstudy.user (id, name, password) VALUES (#{id},#{name},#{password})
</insert>
// 增删改需要提交事务
@Test
public void insertUser(){
try (SqlSession sqlSession = MyBatisUtils.getSqlSession()) {
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
int i = mapper.addUser(new User(4, "张三", "1234567"));
System.out.println(i);
// 提交事务
sqlSession.commit();
}
}
注意点:
- 在传入参数时,使用
#{}
直接获取传入对象的数据- 所有的增删改操作都需要提交事务 SqlSession.commit();
改
<update id="updateUser" parameterType="com.sakura.pojo.User">
update mybatisstudy.user
set password = #{password}
where #{id} = 4;
</update>
@Test
public void updateUser(){
try (SqlSession sqlSession = MyBatisUtils.getSqlSession()) {
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.updateUser(new User(4, "张三", "123456"));
// 提交事务
sqlSession.commit();
}
}
注意点:
改操作时,需要传入修改过后的对象,传入的对象保证SQL语句用于判断和修改的字段保证正确即可
例如:我通过id去查找用户并修改密码时,保证传入参数的用户对象的id和密码没有问题即可,其他属性无影响。
查
<select id="getUserById" parameterType="int" resultType="com.sakura.pojo.User">
select * from mybatisstudy.user where id=#{id}
</select>
@Test
public void getUserById(){
try (SqlSession sqlSession = MyBatisUtils.getSqlSession()) {
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User user = mapper.getUserById(2);
System.out.println(user);
}
}
删
<delete id="deleteUser" parameterType="int">
delete mybatisstudy.user
from mybatisstudy.user
where id = #{id};
</delete>
public void deleteUser(){
try (SqlSession sqlSession = MyBatisUtils.getSqlSession()) {
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.deleteUser(4);
// 提交事务
sqlSession.commit();
}
}
tisstudy.user
from mybatisstudy.user
where id = #{id};
</delete>
public void deleteUser(){
try (SqlSession sqlSession = MyBatisUtils.getSqlSession()) {
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.deleteUser(4);
// 提交事务
sqlSession.commit();
}
}
当实体的字段很多时,我们可以使用Map来封装我们需要的的参数,其他无关参数就可以不用设置,减少代码量
模糊查询
第一种方式:(安全)
带调用的时候传入带通配符的字符串
第二种:(存在漏洞)
在SQL语句中进行字符串拼接
SqlSession聊一聊
MyBatis中用于和数据库交互的
顶层类
,通常将它与ThreadLocal绑定,一个会话使用一个SqlSession,并且在使用完毕后需要close。SqlSession在构建时有两个重要参数 configuration与初始化时的相同,Executor为执行器
Executor(执行器):一个接口,又三个实现类
- BatchExecutor(重用语句并执行批量更新)
- ReuseExecutor(重用预处理语句prepared statements)
- SimpleExecutor(普通的执行器,默认)
当我们调用openSqlSession()时,默认返回一个SimpleExecutor,且事务自动提交为NULL
可以通过openSqlSession的重载方法获取不同类型的执行器和选择是否开启事务自动提交。
当执行SQL语句时 需要了解一个MappedStatement
作用:MappedStatement与Mapper配置文件中的一个select/update/insert/delete节点相对应。mapper中配置的标签都被封装到了此对象中,主要用途是描述一条SQL语句。
xxxMapper.xml任何一个 select/update/insert/delete 在初始化时,都会被封装成一个MappedStatement并将其作为Value,将完全限定类名+方法名作为Key 放入Configuration对象中的MappedStatements中
四、配置解析
MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。
核心配置文件结构
MyBatis-config.xml
configuration(配置)
- properties(属性)
- settings(设置)
- typeAliases(类型别名)
- typeHandlers(类型处理器)
- objectFactory(对象工厂)
- plugins(插件)
- environments(环境配置)
- environment(环境变量)
- transactionManager(事务管理器)
- dataSource(数据源)
- databaseIdProvider(数据库厂商标识)
- mappers(映射器)
所有xml配置文件地标签必须按照这个顺序排列
1、环境配置(environments)
MyBatis 可以配置成适应多种环境,这种机制有助于将 SQL 映射应用于多种数据库之中,**不过要记住:尽管可以配置多个环境,但每个 SqlSessionFactory 实例只能选择一种环境。**所以,如果你想连接两个数据库,就需要创建两个 SqlSessionFactory 实例,每个数据库对应一个。
例如此,虽然我们写了多个enviroment 但是必须指定使用那一个环境。这样方便了我们在多个数据库之间来回切换。
-
transactionManager(事务管理系统)
两种:**JDBC(默认)**和MANAGED
-
dataSource(数据源)
三种:UNPOOLED、POOLED(默认)、JNDI
2、属性(properties)
property标签中的属性值,可以被动态地读取和使用或者修改,提高了灵活性。
例如数据库连接地参数可以写在properties标签中,连接使用同一模板,只需要修改参数即可。
注意:当我们同时在xml内部添加properties和外部导入发生字段冲突时,优先使用外部导入的资源文件
3、类型别名(typeAliases)
为java的类型设置短的名字,减少完全限定名的冗余。
两种方式:针对具体的类、针对实体类的包
在核心配置文件中配置
代码示例:
<!--为实体类取别名-->
<typeAliases>
<typeAlias type="com.sakura.pojo.User" alias="User"/>
<package name="com.sakura.pojo"/>
</typeAliases>
1. 针对具体的类
- 使用
typeAlias
标签,type为要设置别名的类的全限定名,alias为所取的别名
拿上面这个栗子:所有使用com.sakura.pojo.User的地方,都可以使用User替换。
2. 针对实体类包
- 使用
package
标签 会自动扫描包下的JavaBean,在没有注解的情况下,会自动使用首字母小写的类名作为其别名。,name为扫描的包。
还是上面这个栗子:com.sakura.pojo下的JavaBean 例如User 默认使用user作为别名 Student的别名为student
也可以使用@Alias注解为包下的类设置别名
java内建对象的默认别名
4、设置(Setting)
5、Plugins(插件)
- mybatis-generator-core
- mybatis-plus
- 通用mapper
6、映射器(Mapper)
我们所写的Mapper,都要到核心配置文件的映射表中注册
MapperRegistry:映射表
1、使用resource
<mappers>
<mapper resource="com/sakura/dao/UserMapper.xml"/>
</mappers>
2、使用class定
<mappers>
<mapper class="com.sakura.dao.UserMapper"/>
</mappers>
**注意点:**使用class绑定,必须保证
- 接口和其Mapper配置文件在同一个包下
- 接口必须与它的Mapper配置文件同名
3、使用package
<mappers>
<package name="com.sakura.dao"/>
</mappers>
要求和使用class相同,同名同包
五、作用域和生命周期
SqlSessionFactoryBuilder
这个类可以被实例化、使用和丢弃,一旦创建了 SqlSessionFactory,就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域(也就是局部方法变量)。
SqlSessionFactory
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。 因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到,最简单的就是使用单例模式或者静态单例模式。(最好不要创建多个)
SqlSession
每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。==每次收到 HTTP 请求,就可以打开一个 SqlSession,返回一个响应后,就关闭它。==建议使用try-with-resource 表面上省去finally关闭资源的逻辑
映射器实例(Mapper)
方法作用域才是映射器实例的最合适的作用域。 也就是说,**映射器实例应该在调用它们的方法中被获取,使用完毕之后即可丢弃。**不需要被显式地关闭,保持mapper和调用getMapper获取它的SqlSession保持相同作用域。
六、解决字段名与属性名不一致问题
问题描述:
当数据库中表的字段名,与Java对应实体类中的属性名不一致时,会导致查询结果错误。
例如 现有表User(id,username,pwd) 当映射到表中时变成了User类(id,username,password)时,在执行查询后得到的结果中password总为’null’
原因:
完整的SQL查询语句是:
select id,username,pwd
from User
所以返回的结果集的列名也分别是 id、username、pwd,而当我们为resultType传递的User类中没有pwd属性,且password这个属性,在查询结果中也没有这个字段,所以就默认填上了null。
解决方案:
-
为查询结果集列名取别名,select id,username,pwd **as password **…
-
使用resultMap(结果集映射)
-
在xxxMaper.xml中的mapper标签中配置。
-
<resultMap id="UserMap" type="User"> <result column="id" property="id"/> <result column="password" property="pwd"/> <result column="name" property="name"/> </resultMap> <select id="getUsers" resultMap="UserMap"> select * from mybatisstudy.user </select>
-
将User类中与表中字段不一致的属性映射到一张resultMap上即可,然后语句使用resultMap。相同的属性可以不必填写。
-
后面会讲解更为复杂的问题及解决方案
七、日志
1、日志工厂
当我们的sql语句发生了错误是,最好的排错的帮手就是日志;
过去我们使用控制台打印或者debug排错,现在要学习使用日志工厂
可选值:
-
SLF4J
-
LOG4J(掌握)
-
LOG4J2
-
JDK_LOGGING
-
COMMONS_LOGGING
-
STDOUT_LOGGING (标准日志输出,掌握)
需要在MyBatis的核心配置文件中的settings标签中配置日志工厂,默认是无;
<settings> <setting name="logImpl" value="STDOUT_LOGGING"/> </settings>
所有的设置都在核心配置文件中的settings标签下配置,name和value属性要与官方一模一样
STDOUT_LOGGING 日志分析
LOG4J日志
Apache的一个开源项目,可以将日志输出到控制台或者文件…
我们可以控制每一条日志的输出格式,日志可以分等级输出。
可以通过配置文件来灵活配置,而不需要额外修改代码
-
Maven导包
<!-- https://mvnrepository.com/artifact/log4j/log4j --> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency>
-
log4j配置文件
log4j.rootLogger = debug ,stdout,file ### 输出到控制台 ### log4j.appender.stdout = org.apache.log4j.ConsoleAppender log4j.appender.stdout.Target = System.out log4j.appender.stdout.layout = org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n ### 输出到日志文件 ### log4j.appender.file = org.apache.log4j.FileAppender log4j.appender.file.File = ./log/sakura.log log4j.appender.file.Append = true ## 输出DEBUG级别以上的日志 log4j.appender.file.Threshold = DEBUG log4j.appender.file.layout = org.apache.log4j.PatternLayout log4j.appender.file.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n file.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n # 日志文件输出级别 log4j.logger.org.mybatis=DEBUG logj4j.logger.java.sql=DEBUG logj4j.logger.java.sql.Statement=DEBUG logj4j.logger.java.sql.ResultSet=DEBUG logj4j.logger.java.sql.PreparedStatement=DEBUG
-
设置log4j为日志的实现类
<settings> <setting name="logImpl" value="LOG4J"/> </settings>
- 使用
-
导入Log4j.Logger包
-
创建日志对象,传入参数为当前类的class对象
// 创建日志对象 public static Logger logger = Logger.getLogger(UserMapperTest.class);
-
日志级别
- info
- error
- debug
- …
八、分页
问题: 为什么学习分页?
- 减少数据的处理量
两种分页方式:limit、RowBounds
limit
使用SQL语句实现分页
limit a,b;
a为起始数据的编号,不写默认为0;
b为页面显示数据条数。
MyBatis实现
<select id="getUserByLimit" parameterType="map" resultType="user">
select * from mybatisstudy.user order by id limit #{startIndex},#{pageSize}
</select>
测试:
@Test
public void getUserByLimit() {
try(SqlSession sqlSession = MyBatisUtils.getSqlSession()){
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
HashMap<String, Integer> map = new HashMap<>();
map.put("startIndex", 1);
map.put("pageSize", 2);
List<User> userByLimit = mapper.getUserByLimit(map);
for (User user : userByLimit) {
System.out.println(user);
}
}
}
RowBounds
使用Java代码实现分页
<select id="getUsers" resultType="user">
select * from mybatisstudy.user
</select>
@Test
public void getUserByRowBounds() {
try(SqlSession sqlSession = MyBatisUtils.getSqlSession()){
RowBounds rowBounds = new RowBounds(1, 2);
List<Object> userByRowBounds = sqlSession.selectList("com.sakura.dao.UserMapper.getUsers", null, rowBounds);
for (Object user : userByRowBounds) {
System.out.println((User)user);
}
}
}
分页插件
MybatisPageHelper
九、使用注解开发
为什么面向接口编程:
根本原因:
解耦,可拓展,提高复用,分层开发中,上层不用管理具体实现,只需定义好规则,大家共同遵守,提高开发的规范性
对于面向接口编程的理解:
定义(规范与约束)和实现(具体业务)的分离。
接口就相当于一个系统的骨架,有了主干再往上面添加内容。
接口有两类:
- 对个体的抽象,抽象体
- 对个体的某个方面的抽象,抽象面
简单的SQL语句可以使用注解,稍微复杂的建议使用XML配置文件
@Select("select * from user")
List<User> getUsers();
<!--绑定接口-->
<mappers>
<mapper class="com.sakura.dao.UserMapper"/>
</mappers>
测试
@Test
public void getUser(){
try (SqlSession sqlSession = MyBatisUtils.getSqlSession()) {
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
List<User> users = mapper.getUsers();
for (User user : users) {
System.out.println(user);
}
}
}
通过debug不难发现其==底层大量使用了反射与动态代理。==顺便解决上面的遗留问题:
遗留问题:Mapper接口我们都没有实现的方法却可以使用,是为什么呢?Mapper的底层原理?是否和动态代理有关系?
参考博客:https://blog.csdn.net/weixin_43184769/article/details/91126687
MapperRegistry是Configuration中的一个属性,它内部维护一个HashMap(即knownMappers)用于存放mapper接口的工厂类
,每个接口对应一个工厂类。
-
当解析mappers标签时,它会判断解析到的是mapper配置文件时,会再将对应配置文件中的增删改查标签一 一封装成MappedStatement对象,存入mappedStatements中。(前面讲SqlSession提到)
-
当判断解析到接口时,会创建此接口对应的MapperProxyFactory对象,存入HashMap中,key = 接口的字节码对象,value = 此接口对应的MapperProxyFactory对象。
然后getMapper()
时通过这个MapperProxyFactory 创建代理的示例对象,并拿到我们传递的接口的Class对象使用动态代理
此时以及创建出来了代理对象,即可访问所代理类内的一切方法,即MapperProxy的invoke方法中,以及为我们写好了增删改查的具体实现: