Mybatis 知识点

1.1 Mybatis 简介

1.1.1 什么是 Mybatis

Mybatis 是一款优秀的持久层框架
支持定制化 SQL、存储过程及高级映射
Mybatis 几乎避免了所有的 JDBC 代码和手动设置参数以及获取结果集
MyBatis 可以使用简单的 XML 或注解来配置和映射原生类型、接口和 Java 的 POJO 为数据库中的记录

1.1.2 为什么需要 Mybatis

更方便的将数据存入到数据库中
传统的 JDBC 代码太复杂。简化，自动化
减少了50%以上的代码量，比JDBC更简洁
Mybatis 的优点
- 简单易学
- 灵活
- sql 和代码分离，提高了可维护性
- 提供映射标签，支持对象与数据库的 orm 字段关系映射
- 提供对象关系映射标签，支持对象关系组建维护
- 提供 xml 标签，支持编写动态 sql

1.1.3 如何获取 Mybatis

maven 仓库获取

可直接用以下代码引入自己的 maven 仓库中

<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency><groupId>org.mybatis</groupId><artifactId>mybatis</artifactId><version>3.5.13</version>
</dependency>

Github 获取源码

下载地址：Releases · mybatis/mybatis-3 (github.com)

中文文档

可以帮助你更好的了解 Mybatis
文档地址：mybatis – MyBatis 3 | 入门

1.2 第一个 Mybatis 程序

编写第一个 Mybatis 程序首先需要有一个具体步骤：

搭建环境–> 导入 Mybatis–>编写代码–>测试

1.2.1 搭建环境

新建数据库，随便添加一张表，添加一些数据，便于测试


SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user`  (`userId` int(11) NOT NULL AUTO_INCREMENT COMMENT '用户id',`userName` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '用户名称',`userAge` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '用户年龄',PRIMARY KEY (`userId`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES (1, '张三', '12');
INSERT INTO `user` VALUES (2, '李四', '15');
INSERT INTO `user` VALUES (3, '王五', '18');SET FOREIGN_KEY_CHECKS = 1;

创建一个 maven 项目
导入三个 maven依赖
- mysql驱动
- mybatis
- junit

    <dependencies><!-- mybatis --><dependency><groupId>org.mybatis</groupId><artifactId>mybatis</artifactId><version>3.5.13</version></dependency><!-- mysql 驱动 --><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.33</version></dependency><!-- junit --><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.13.2</version><scope>test</scope></dependency></dependencies>

1.2.2 编写 mybatis 的核心配置文件

在 resources 文件夹新建一个名为 mybatis-config.xml 的 xml 文件

将以下代码粘贴进核心配置文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""https://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>

以上 property 标签中的 value 值，就是我们在 JDBC 中编写配置文件对应的
例如 driver 代表驱动类的位置等等
下面按照我自己的项目中的写法，示例

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""https://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/mybatis?TRUE&amp;useUnicode=TRUE&amp;characterEncoding=UTF-8&amp;serverTimezone=GMT%2B8"/><property name="username" value="root"/><property name="password" value="root"/></dataSource></environment></environments><mappers><mapper resource="org/mybatis/example/BlogMapper.xml"/></mappers>
</configuration>

1.2.3 编写 Mybatis 工具类

每个 Mybatis 的应用都是一个以 SqlSessionFactory 的实例为核心的

SqlSessionFactory 可以通过 SqlSessionFactoryBuilder 来获取

**而 SqlSessionFactoryBuilder 可以从 XML 配置文件来构建出 SqlSessionFactory **

从 SqlSessionFactory 可以获取 SqlSession 实例

通过 SqlSession 可以直接执行已经映射的 SQL 语句

创建一个 dao 包和 utils 工具包

在 utils 包下创建一个工具类 MybatisUtils
编写 MybatisUtils 类，获取 SqlSessionFactory 实例

package com.qiaoer.utils;import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;import java.io.IOException;
import java.io.InputStream;public class MybatisUtils {private static SqlSessionFactory sqlSessionFactory;static {//获取资源String resource = "mybatis-config.xml";InputStream inputStream = null;try {inputStream = Resources.getResourceAsStream(resource);sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);} catch (IOException e) {throw new RuntimeException(e);}}
}

String resource 的值是刚刚编写的 resource 文件夹下的 xml 文件路径
通过已经获取的 SqlSessionFactory 实例，来获取 SqlSession 实例
编写 getSqlSession() 方法，来获取 SqlSession 实例

package com.qiaoer.utils;import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;import java.io.IOException;
import java.io.InputStream;public class MybatisUtils {private static SqlSessionFactory sqlSessionFactory;static {//获取资源String resource = "mybatis-config.xml";InputStream inputStream = null;try {inputStream = Resources.getResourceAsStream(resource);sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);} catch (IOException e) {throw new RuntimeException(e);}}//获取 SqlSession 实例public static SqlSession getSqlSession(){return sqlSessionFactory.openSession();}
}

获取 SqlSession 实例后，可以使用 SqlSession 中的很多方法来对数据库进行操作

1.2.4 测试，编写代码

编写实体类

User 实体类代码

package com.qiaoer.entity;public class User {private int userId;private String userName;private String userAge;public int getUserId() {return userId;}public void setUserId(int userId) {this.userId = userId;}public String getUserName() {return userName;}public void setUserName(String userName) {this.userName = userName;}public String getUserAge() {return userAge;}public void setUserAge(String userAge) {this.userAge = userAge;}public User() {}public User(int userId, String userName, String userAge) {this.userId = userId;this.userName = userName;this.userAge = userAge;}@Overridepublic String toString() {return "User{" +"userId=" + userId +", userName='" + userName + '\'' +", userAge='" + userAge + '\'' +'}';}
}

编写 dao 接口

UserDao 接口代码

package com.qiaoer.dao;import com.qiaoer.entity.User;import java.util.List;public interface UserDao {//获取所有用户List<User> getUsers();
}

编写 dao 的接口实现类
在 Mybatis 中，不需要在编写接口的实现类，只需要编写一个 xml 文档即可
由原来的 UserDaoImpl 转换为一个 UserMapper.xml 文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.qiaoer.dao.UserDao">
<!-- SQL 语句查询--><select id="selectBlog" resultType="com.qiaoer.entity.User">select * from user</select>
</mapper>

其中 <mapper namespace="com.qiaoer.dao.UserDao"> 中的 namespace 的值对应的是要实现的接口类
<select id="selectBlog" resultType="com.qiaoer.entity.User"> 中 id 的值为对应的方法名
resultType属性表示返回一个结果
resultType 的值为返回值类型的返回类型对应的实体类
编写完 UserMapper.xml 后，需要在 Mybatis 的核心配置文件 mybatis-config.xml 进行 Mapper 注册

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""https://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/mybatis?TRUE&amp;useUnicode=TRUE&amp;characterEncoding=UTF-8&amp;serverTimezone=GMT%2B8"/><property name="username" value="root"/><property name="password" value="root"/></dataSource></environment></environments><mappers><mapper resource="com/qiaoer/dao/UserMapper.xml"/></mappers>
</configuration>

这段代码中 <mappers> 则表现 Mapper 注册
每一个 Mapper.xml 文件都需要进行注册
resource 属性的值就是对应的 Mapper.xml 文件路径
但是这样也存在一定的资源过滤问题，可能会导致你填写的 Mapper.xml 路径找不到
**因此需要在我们的 maven 中的 build 中配置 resources 来防止资源导出失败的问题 **
将以下代码赋值到自己的 maven 中即可

<!--在build中配置resources，来防止我们资源导出失败的问题--><build><resources><resource><directory>src/main/resources</directory><includes><include>**/*.properties</include><include>**/*.xml</include></includes></resource><resource><directory>src/main/java</directory><includes><include>**/*.properties</include><include>**/*.xml</include></includes><filtering>true</filtering></resource></resources></build>

测试代码

import com.qiaoer.dao.UserDao;
import com.qiaoer.entity.User;
import com.qiaoer.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import java.util.List;public class Test01 {public static void main(String[] args) {//第一步，获取 SqlSession 对象SqlSession sqlSession= MybatisUtils.getSqlSession();//方法一:通过 SqlSession 对象获取实现类System.out.println("=====方法1=====");UserDao mapper = sqlSession.getMapper(UserDao.class);List<User> users = mapper.getUsers();for (User user:users) {System.out.println(user);}//直接获取结果List<User> UserLists = sqlSession.selectList("com.qiaoer.dao.UserDao.getUsers");System.out.println("=====方法2=====");for (User user:UserLists) {System.out.println(user);}//关闭 SqlSessionsqlSession.close();}
}

1.3 Mybatis 中 CRUD （增删改查）的标签介绍

在 Mybatis 中编写dao层的实现类的 Mapper.xml 文件中，对增删改查的标签进行介绍

1.3.1 select 标签

select 标签主要作用域 sql 语句的查询
select 标签语法

  <select id="对应方法" resultType="方法的返回值类型" parameterType="方法的参数类型">查询的 SQL 语句</select>

**id：**对应的 namespace 所对应的 dao 层接口类中的方法名
**resultType：**Sql 语句执行的返回值
**parameterType：**参数类型
若 sql 语句中的条件需要参数来进行判读，则使用 #{参数名}
示例如下,若需要通过方法传递过来的参数 id，来查询数据

<mapper namespace="com.qiaoer.dao.UserDao">
<!-- SQL 语句查询--><select id="selectBlog" resultType="com.qiaoer.entity.User" parameterType="int">select * from user where userId=#{id}</select>
</mapper>

1.3.2 insert 标签

insert 标签主要作用域 sql 语句的增加数据
insert 标签语法

    <insert id="对应方法" parameterType="方法的参数类型">增加的 SQL 语句</insert>

当我们的参数是一个对象时，在 #{} 当中直接写对象的属性名即可
示例

<insert id="addUser" parameterType="com.qiaoer.entity.User">insert into user (userName, userAge) values (#{userName},#{userAge});
</insert>

其中 #{userName},#{userAge} 两个均是 User 对象的属性名
==注意：==当我们执行 SQL 语句的增删改时，都需要开启 SQL 的提交事务，否则并不会实际添加
开启提交事务使用 SqlSession 中的 commit() 方法
代码示例

import com.qiaoer.dao.UserDao;
import com.qiaoer.entity.User;
import com.qiaoer.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import java.util.List;public class Test01 {public static void main(String[] args) {//第一步，获取 SqlSession 对象SqlSession sqlSession= MybatisUtils.getSqlSession();UserDao mapper = sqlSession.getMapper(UserDao.class);//执行增加用户mapper.addUser(new User(-1,"你好","15"));//查询所有用户List<User> users = mapper.getUsers();for (User user : users) {System.out.println(user);}//提交事务sqlSession.commit();//关闭 SqlSessionsqlSession.close();}
}

1.3.3 update 标签

update 标签主要作用域 sql 语句的修改数据
update 标签语法

    <insert id="对应方法" parameterType="方法的参数类型">修改的 SQL 语句</insert>

它的参数设置与增加一样
执行完毕也需要进行 SQL 的提交事务
Mapper.xml 示例

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.qiaoer.dao.UserDao"><update id="updateUser" parameterType="com.qiaoer.entity.User">update user set  userName=#{userName}  where userId=#{userId};</update>
</mapper>

代码示例

import com.qiaoer.dao.UserDao;
import com.qiaoer.entity.User;
import com.qiaoer.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import java.util.List;public class Test01 {public static void main(String[] args) {//第一步，获取 SqlSession 对象SqlSession sqlSession= MybatisUtils.getSqlSession();UserDao mapper = sqlSession.getMapper(UserDao.class);//执行修改 id为1的用户mapper.updateUser(new User(1,"Qiaoer","15"));//查询所有用户List<User> users = mapper.getUsers();for (User user : users) {System.out.println(user);}//提交事务sqlSession.commit();//关闭 SqlSessionsqlSession.close();}
}

1.3.3 delete 标签

delete标签主要作用域 sql 语句的修改数据
delete标签语法

    <delete id="对应方法" parameterType="方法的参数类型">删除的 SQL 语句</delete>

增删改的操作基本一致

1.3.4 多参数传递 Map

当我们的 sql 需要多个参数时，而这些参数并不只单单包含某个实体类，可以使用 Map 来传递参数
Map 传递参数，取值时直接使用 key 值来取出 value 值
示例，在 dao 层接口类中，编写方法，通过用户年龄及用户姓名，查询用户

package com.qiaoer.dao;import com.qiaoer.entity.User;import java.util.List;
import java.util.Map;
import java.util.Objects;public interface UserDao {//通过用户年龄，用户姓名，查询用户List<User> getUserByUserAgeAndUserName(Map<String, Object> map);
}

在 Mapper.xml 中编写对应的生成实现类标签

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.qiaoer.dao.UserDao"><select id="getUserByUserAgeAndUserName" resultType="com.qiaoer.entity.User" parameterType="map">select * from user where userAge=#{userAge} and userName=#{userName}</select>
</mapper>

其中 #{userAge} 和 #{userName} 都属于 map 的 key 值
编写测试类，调用方法

import com.qiaoer.dao.UserDao;
import com.qiaoer.entity.User;
import com.qiaoer.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;public class Test01 {public static void main(String[] args) {//获取 SqlSession 对象SqlSession sqlSession=MybatisUtils.getSqlSession();//获取实现类UserDao userDao=sqlSession.getMapper(UserDao.class);//创建参数 mapMap<String, Object> map=new HashMap<String, Object>();map.put("userAge",15);map.put("userName","Qiaoer");//调用查询方法List<User> userByUserAgeAndUserName = userDao.getUserByUserAgeAndUserName(map);//输出结果for (User user : userByUserAgeAndUserName) {System.out.println(user);}//提交事务sqlSession.commit();//关闭 SqlSessionsqlSession.close();}
}

1.4 配置解析

1.4.1 核心配置文件

核心配置文件一般官方命名为：mybatis-config.xml
MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息
核心配置文件的主要结构

configuration（配置）
properties（属性）
settings（设置）
typeAliases（类型别名）
typeHandlers（类型处理器）
objectFactory（对象工厂）
plugins（插件）
environments（环境配置）
environment（环境变量）
transactionManager（事务管理器）
dataSource（数据源）

databaseIdProvider（数据库厂商标识）
mappers（映射器）

1.4.2 environments（环境配置）

MyBatis 可以配置成适应多种环境
但是一次只可以选择一种环境
示例

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""https://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration><environments default="test"><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/mybatis?TRUE&amp;useUnicode=TRUE&amp;characterEncoding=UTF-8&amp;serverTimezone=GMT%2B8"/><property name="username" value="root"/><property name="password" value="root"/></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/mybatis?TRUE&amp;useUnicode=TRUE&amp;characterEncoding=UTF-8&amp;serverTimezone=GMT%2B8"/><property name="username" value="root"/><property name="password" value="root"/></dataSource></environment></environments><mappers><mapper resource="com/qiaoer/dao/UserMapper.xml"/></mappers>
</configuration>

在上方的<environments></environments> 标签内，<environment></environment> 标签代表不同的环境
environment 标签的属性 id，则对应的是自己的环境名称
environments 标签的属性 default，则表示用户要选择哪个环境，与environment 标签的属性 id 的值对应
例如，上方示例中，我的 environments 标签的属性 default 的值为 test ，则代表我选择了环境 <environment id="test">
<transactionManager/> 标签为事务管理器
- 在 MyBatis 中有两种类型的事务管理器（也就是 type=“[JDBC|MANAGED]”）
- 只需记住 MyBatis 的默认的事务管理器为 JDBC 即可
<dataSource></dataSource> 标签为数据源
- 大多数 MyBatis 应用程序会按示例中的例子来配置数据源。虽然数据源配置是可选的，但如果要启用延迟加载特性，就必须配置数据源
- 有三种内建的数据源类型（也就是 type=“[UNPOOLED|POOLED|JNDI]”）
- MyBatis 的默认的数据源类型为 POOLED