1. Mybatis简介

1.1 原始jdbc操作

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
//模拟实体对象
User user = new User();
user.setId(2);
user.setUsername("tom");
user.setPassword("lucy"); .
//注册驱动
Class.forName("com.mysql.jdbc.Driver");
//获得连接
Connection connection = DriverManager.getConnection("jdbc:mysql:///test","root","root" );
//获得statement
PreparedStatement statement = connection.prepareStatement("insert into user(id,username , password) values(?,?,?)");
//设置占位符参数
statement.setInt(1,user.getId());
statement.setString(2,user.getUsername());
statement.setString(3,user.getPassword());
//执行更新操作
statement.executeUpdate();
//释放资源
statement.close();
connection.close();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
//注册驱动
Class.forName("com.mysql.jdbc.Driver");
//获得连接
Connection connection = DriverManager.getConnection("jdbc:mysql:///test","root","root" );
"root", password: "root");
//获得statement
PreparedStatement statement = connection.prepareStatement("select id,username,password from user"); .
//执行查询
ResultSet resultSet = statement.executeQuery();
//遍历结果集
while(resultSet.next()){
//封装实体
User user = new User();
user.setId(resultSet.getInt("id"));
user.setUsername(resultSet.getString("username"));
user.setPassword(resultSet.getString("password"));
//user实体封装完毕
System.out.println(user);
//释放资源
resultSet.close();
statement.close();
connection.close();

1.2 原始jdbc操作的分析

原始jdbc开发存在的问题如下:

  1. 数据库连接创建、释放频繁造成系统资源浪费从而影响系统性能
  2. sql 语句在代码中硬编码,造成代码不易维护,实际应用 sql 变化的可能较大,sql 变动需要改变java代码
  3. 查询操作时,需要手动将结果集中的数据手动封装到实体中,插入操作时,需要手动将实体的数据设置到sql语句的占位符位置

应对上述问题给出的解决方案:

  1. 使用数据库连接池初始化连接资源
  2. 将sql语句抽取到xml配置文件中
  3. 使用反射、内省等底层技术,自动将实体与表进行属性与字段的自动映射

1.3 什么是Mybatis

  • mybatis 是一个优秀的基于java的持久层框架,它内部封装了 jdbc,使开发者只需要关注sql语句本身,而不需要花费精力去处理加载驱动、创建连接、创建statement等繁杂的过程

  • mybatis通过xml或注解的方式将要执行的各种 statement配置起来,并通过java对象和statement中sql的动态参数进行 映射生成最终执行的sql语句

  • 最后mybatis框架执行sql并将结果映射为java对象并返回

    采用ORM思想解决了实体和数据库映射的问题,对jdbc 进行了 封装,屏蔽了jdbc api 底层访问细节,使我们不用与jdbc api打交道,就可以完成对数据库的持久化操作

1.4 Mybatis架构

Mybatis的功能架构分为三层:

  1. API接口层:提供给外部使用的接口API,开发人员通过这些本地API来操纵数据库

    接口层一接收到调用请求就会调用数据处理层来完成具体的数据处理

  2. 数据处理层:负责具体的SQL查找、SQL解析、SQL执行和执行结果映射处理等

    它主要的目的是根据调用的请求完成一次数据库操作

  3. 基础支撑层:负责最基础的功能支撑,包括连接管理、事务管理、配置加载和缓存处理,这些都是共用的东西,将他们抽取出来作为最基础的组件

    为上层的数据处理层提供最基础的支撑。

Mybatis架构图

1.5 Mybatis原理步骤

  1. mybatis配置文件,包括Mybatis全局配置文件和Mybatis映射文件

    其中全局配置文件配置了数据源、事务等信息;映射文件配置了SQL执行相关的信息

  2. mybatis通过读取配置文件信息(全局配置文件和映射文件),构造出SqlSessionFactory,即会话工厂

  3. 通过SqlSessionFactory,可以创建SqlSession即会话

    Mybatis是通过SqlSession来操作数据库的

  4. SqlSession本身不能直接操作数据库,它是通过底层的Executor执行器接口来操作数据库的

    Executor接口有两个实现类,一个是普通执行器,一个是缓存执行器(默认)

  5. Executor执行器要处理的SQL信息是封装到一个底层对象MappedStatement

    该对象包括:SQL语句、输入参数映射信息、输出结果集映射信息

    其中输入参数和输出结果的映射类型包括HashMap集合对象、POJO对象类型

2. Mybatis的快速入门

2.1 MyBatis开发步骤

  1. 添加MyBatis的坐标
  2. 创建user数据表
  3. 编写User实体类
  4. 编写映射文件UserMapper.xml
  5. 编写核心文件SqlMapConfig.xml
  6. 编写测试类

2.2 MyBatis 快速实现

  1. 导入MyBatis的坐标和其他相关坐标
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<!--mybatis坐标-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<!--mysql坐标-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.25</version>
<scope>runtime</scope>
</dependency>
<!--单元测试坐标-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13</version>
<scope>test</scope>
</dependency>
<!--日志坐标-->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
  1. 创建user数据表
类型
id int
username varchar
password varchar
  1. 编写User实体类
1
2
3
4
5
6
public class User {
private int id;
private String username;
private String password;
//省略get个set方法
}
  1. 编写映射文件UserMapper.xml
1
2
3
4
5
6
7
8
9
<?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="userMapper">
<select id="findAll" resultType="cn.jyw.pojo.User">
select * from User
</select>
</mapper>
  1. 编写核心文件SqlMapConfig.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<?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.jdbc.Driver"/>
<property name="url" value="jdbc:mysql:///test"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<!--加载映射文件-->
<mappers>
<mapper resource="cn.jyw/mapper.xml"/>
</mappers>
</configuration>
  1. 编写测试类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
public void test1() throws IOException {
//获得核心配置文件
InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
//获得session工厂对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
//获得session会话对象
SqlSession sqlSession = sqlSessionFactory.openSession();
//执行操作 参数:namespace+id
List<User> userList = sqlSession.selectList("userMapper.findAll");
//打印数据
System.out.println(userList);
//释放资源
sqlSession.close();
}

3. MyBatis的映射文件概述

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<?xml version="1.0" encoding="UTF-8" ?>
<!--映射文件DTD约束头-->
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--跟标签 命名空间,与下面语句的id一起组成查询的标识-->
<mapper namespace="userMapper">
<!--select 查询操作,可选的还有insert,update,delete
id 语句id标识 与上面的命名空间一起组成查询标识
resultType 查询结果对应的实体类型-->
<select id="findAll" resultType="cn.jyw.pojo.User">
# 要执行的sql语句
select * from User
</select>
</mapper>

4. MyBatis的增删改查操作

  1. 写UserMapper映射文件
1
2
3
4
5
<mapper namespace="userMapper">
<insert id="add" parameterType="cn.jyw.pojo.User">
insert into user values(#{id},#{username},#{password})
</insert>
</mapper>
  1. 编写插入实体User的代码
1
2
3
4
5
6
7
8
InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession sqlSession = sqlSessionFactory.openSession();
int insert = sqlSession.insert("userMapper.add", user);
System.out.println(insert);
//提交事务
sqlSession.commit();
sqlSession.close();

插入操作注意问题

  1. 插入语句使用insert标签
  2. 在映射文件中使用parameterType属性指定要插入的数据类型
  3. Sql语句中使用#{实体属性名}方式引用实体中的属性值
  4. 插入操作使用的API是sqlSession.insert(“命名空间.id”,实体对象);
  5. 插入操作涉及数据库数据变化,所以要使用sqlSession对象显示的提交事务, 即sqlSession.commit()
  1. 编写UserMapper映射文件
1
2
3
4
5
<mapper namespace="userMapper">
<delete id="delete" parameterType="java.lang.Integer">
delete from user where id=#{id}
</delete>
</mapper>
  1. 编写删除数据的代码
1
2
3
4
5
6
7
InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession sqlSession = sqlSessionFactory.openSession();
int delete = sqlSession.delete("userMapper.delete",3);
System.out.println(delete);
sqlSession.commit();
sqlSession.close();

删除操作注意问题

  1. 删除语句使用delete标签
  2. Sql语句中使用#{任意字符串}方式引用传递的单个参数
  3. 删除操作使用的API是sqlSession.delete(“命名空间.id”,Object)
  1. 编写UserMapper映射文件
1
2
3
4
5
<mapper namespace="userMapper">
<update id="update" parameterType="cn.jyw.pojo.User">
update user set username=#{username},password=#{password} where id=#{id}
</update>
</mapper>
  1. 编写修改实体User的代码
1
2
3
4
5
6
7
InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession sqlSession = sqlSessionFactory.openSession();
int update = sqlSession.update("userMapper.update", user);
System.out.println(update);
sqlSession.commit();
sqlSession.close();

修改操作注意问题

  1. 修改语句使用update标签
  2. 修改操作使用的API是sqlSession.update(“命名空间.id”,实体对象);
  1. 编写UserMapper映射文件
1
2
3
4
5
<mapper namespace="userMapper">
<select id="findAll" resultType="cn.jyw.pojo.User">
select * from User
</select>
</mapper>
  1. 编写修改实体User的代码
1
2
3
4
5
6
InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
SqlSession sqlSession = sqlSessionFactory.openSession();
List<User> userList = sqlSession.selectList("userMapper.findAll");
System.out.println(userList);
sqlSession.close();

5. MyBatis核心配置文件概述

5.1 MyBatis核心配置文件层级关系

  • configuration 配置
    • properties 属性
    • settiongs 设置
    • typeAliases 类型别名
    • typeHandlers 类型处理器
    • objectFactory 对象工厂
    • plugins 插件
    • environments 环境
      • environment 环境变量
        • transactionManager 事务管理器
        • dataSource 数据源
    • databaseldProvider 数据库厂商标识
    • mappers 映射器

5.2 MyBatis常用配置解析

  1. environments标签

    数据库环境的配置,支持多环境配置
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!--指定默认的环境名称-->    
<environments default="development">
<!--指定当前环境的名称-->
<environment id="development">
<!--指定事务类型的JDBC-->
<transactionManager type="JDBC"/>
<!--指定当前数据类型是连接池-->
<dataSource type="POOLED">
<!--数据源配置的基本参数-->
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql:///test"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>

其中,事务管理器(transactionManager)类型有两种:

  • JDBC:这个配置就是直接使用了JDBC 的提交和回滚设置,它依赖于从数据源得到的连接来管理事务作用域

  • MANAGED:这个配置几乎没做什么。它从来不提交或回滚一个连接,而是让容器来管理事务的整个生命周期(比如JEE 应用服务器的上下文)

    默认情况下它会关闭连接,然而一些容器并不希望这样,因此需要将 closeConnection 属性设置 为 false 来阻止它默认的关闭行为

其中,数据源(dataSource)类型有三种:

  • UNPOOLED:这个数据源的实现只是每次被请求时打开和关闭连接
  • POOLED:这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来
  • JNDI:这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用,容器可以集中或在外部配置数据源,然后放置 一个 JNDI 上下文的引用
  1. mapper标签

该标签的作用是加载映射的,加载方式有如下几种:

  • 使用相对于类路径的资源引用,例如:< mapper resource=”org/mybatis/builder/AuthorMapper.xml”/>
  • 使用完全限定资源定位符(URL),例如:< mapper url=”file:///var/mappers/AuthorMapper.xml”/>
  • 使用映射器接口实现类的完全限定类名,例如:< mapper class=”org.mybatis.builder.AuthorMapper”/>
  • 将包内的映射器接口实现全部注册为映射器,例如:< package name=”org.mybatis.builder”/>
  1. Properties标签

实际开发中,习惯将数据源的配置信息单独抽取成一个properties文件,该标签可以加载额外配置的properties文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<properties resource="jdbc.properties"/>
<!--数据源环境-->
<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>
</environments>
  1. typeAliases标签

类型别名是为Java 类型设置一个短的名字。原来的类型名称配置如下

1
2
3
<select id="findAll" resultType="cn.jyw.pojo.User">
select * from User
</select>

配置typeAliases,为cn.jyw.pojo.User定义别名为user

typeAliases 放在核心配置文件中且位置在映射之前

1
2
3
<typeAliases>
<typeAlias type="cn.jyw.pojo.User" alias="user"/>
</typeAliases>
1
2
3
<select id="findll" resultType="user">
select * from User
</select>

上面我们是自定义的别名,mybatis框架已经为我们设置好的一些常用的类型的别名

别名 数据类型
string String
long Long
int Interger
double Double
boolean Boolean
… … … …

5.3 知识小结

  1. properties标签:该标签可以加载外部的properties文件

    < properties resource=”jdbc.properties”/>

  2. typeAliases标签:设置类型别名

    typeAliases 放在核心配置文件中且位置在映射之前

    < typeAlias type=”cn.jyw.pojo.User” alias=”user”>

  3. mappers标签:加载映射配置

    < mapper resource=”cn.jyw/mapper.xml”/>

  4. environments标签:数据源环境配置标签

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    <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>
    </environments>

6. MyBatis的相应API

6.1 SqlSession工厂构建器SqlSessionFactoryBuilder

常用API:SqlSessionFactory build(InputStream inputStream)

通过加载mybatis的核心文件的输入流的形式构建一个SqlSessionFactory对象

1
2
3
4
String resource = "org/mybatis/builder/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(inputStream);

其中, Resources 工具类,这个类在 org.apache.ibatis.io 包中

Resources 类帮助你从类路径下、文件系统或 一个 web URL 中加载资源文件。

6.2 SqlSession工厂对象SqlSessionFactory

SqlSessionFactory 有多个个方法创建 SqlSession 实例。常用的有如下两个:

方法 解释
openSession() 会默认开启一个事务,但事务不会自动提交,也就意味着需要手动提 交该事务,更新操作数据才会持久化到数据库中
openSession(boolean autoCommit) 参数为是否自动提交,如果设置为true,那么不需要手动提交事务

6.3 SqlSession会话对象

SqlSession 实例在 MyBatis 中是非常强大的一个类

在这里你会看到所有执行语句、提交或回滚事务和获取映射器实例的方法

执行语句的方法主要有:

1
2
3
4
5
<T> T selectOne(String statement, Object parameter) 
<E> List<E> selectList(String statement, Object parameter)
int insert(String statement, Object parameter)
int update(String statement, Object parameter)
int delete(String statement, Object parameter)

操作事务的方法主要有:

1
2
void commit()
void rollback()