黑马程序员-MyBatis 框架-最全入门笔记、阿伟看了都得说真大、真细、真全！！！_javaweb黑马阿玮

MyBaits

写在最前
本篇文章是我学完黑马程序员 JavaWeb MyBatis 的总结分享，定位呢是最大小白友好的快速入门，欢迎大家一起交流技术！

代码仓库

代码仓库无疑是我的教学里最大的特色，它的功能十分强大。它蕴含了本篇文章全部的代码，项目结构，特别注意事项。

• 代码仓库的定位类似 Mybatis 的工具类或者 API 文档
• 将分散的代码，注意事项聚合到一个单独的文件里，显然是一个很高效的创新，毫无疑问它对待初学者十分友好，清晰的项目结构，详尽的注解都极大的提高了效率
• 同时它还帮助那些只是来查找关键代码的朋友们最大程度的提高了查找效率。比如 SqlSessionFactory 对象的获取，mybatis-config.xml 的默认配置，这些我们完全不会背下来的内容，在使用时，不再需要不断下滑寻找再复制，所有你需要的东西就明明白白的躺在那里——代码仓库
• 点开下面的链接吧，保证不会让你失望。

代码仓库

---

MyBatis 概述

概述

• MyBatis 是一款优秀的持久层框架，用于简化 JDBC 开发

持久层

• 负责将数据到保存到数据库的那一层代码
• JavaEE 三层框架：表现层、业务层、持久层

框架

• 框架就是一个半成品软件，是一套可重用的、通用的、软件基础代码模型
• 在框架的基础之上构建软件编写更加高效、规范、通用、可扩展

官方文档

https://mybatis.org/mybatis-3/zh/index.html

学习思路

1. 首先从‘快速入门’开始。“我始终相信，学习框架的最快方法就是敲一遍！” 跟着教程，在敲完一遍代码后，你可以很轻易的用 MyBatis 实现了基本的查找语句，接下来带着实现过程中产生的问题，我们会更加高效的学习
2. 然后我们会围绕 MyBatis 的核心代理开发来学习几个核心知识点 ：Mapper、xml 配置和实现原理
3. 最后学习两个可以极大简化我们代码量的 MyBatis 特性：动态 sql 和 注解开发

---

快速入门

第一部分 MyBatis 的快速入门，本节的目的只是想来看一看 MyBatis 这个持久层框架到底有什么优势，并不需要弄懂每一步的具体含义，只需要跟着敲一遍代码即可

具体步骤

这里用的是 Maven 构建的项目

1. 准备 MySQL 环境，创建 tb_brand 表，并添加初始数据，
   
2. 用 Maven 创建项目，导入坐标，配置好 pom.xml （Maven 的配置文件）

//添加 MyBatis 依赖，使用的是3.5.5版本
<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>3.5.5</version>
</dependency>
//添加 JDBC 依赖
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.46</version>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
12

3. 定义标准的 javabean 类，用来存储 sql 的查找结果。这里 Brand 类的成员变量的数量和数据类型需要和 tb_brand 表中列的数量和数据类型一致

4. 编写 MyBatis 核心配置文件

//在resources文件夹下创建mybatis-config.xml
//将官网提供的快速入门 xml 配置文件，直接复制粘贴到 mybatis-config.xml 中即可
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//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">
      /**
      *driver 导入 JDBC 下的 Driver 类
      *url 用来连接数据库和对数据库的配置
      *下面两个表示数据库的账号和密码
      */
        <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.xml 建议和 Mapper 接口在同一目录，别忘了修改 resource 路径
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers>
</configuration>
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
27
28

我的配置信息如图

java和resources是同级目录，同时创建同名目录即可实现 Mapper 接口和 xml 文件在同一目录下

5.编写SQL映射文件

• MyBatis 会把查询到的结果封装到一个对象里，但是数据库列名和类中属性名的命名习惯不同。例如 brand_name 和 brandName，MyBatis 在封装时，如果列名和属性名不同无法实现自动封装，所以就需要在 Mapper.xml 中配置 resultMap，来实现自动封装。

    //resultMap 的本质是给列名起别名，别名和成员变量名一致，即可实现自动封装
	//id 为此resultMap的名字，建议使用类名 + resultMap
	//type 为此类在项目中的路径
	//result标签表示非主键的关联，若给主键起别名，就把 result 换成 id
	//column 表示列名，property表示属性名，将其一一对应
    <resultMap id="brandResultMap" type="com.itheima.pojo.Brand">
        <result column="brand_name" property="brandName"/>
        <result column="company_name" property="companyName"/>
    </resultMap>
1
2
3
4
5
6
7
8
9

• 接下来需要在 Mapper 接口和 Mapper.xml 中分别定义方法和 sql 语句

Mapper 接口：

Mapper.xml :

• id 表示sql语句的名字需要和方法名相同，同时引入 resultMap 使其可以自动封装

6. 最后在测试类中定义该方法的测试方法

 @Test
    public void selectAllTest() throws IOException {
        //获取 sqlSessionFactory 对象
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        //获取 sqlSession 对象用于执行 sql 语句
        SqlSession sqlSession = sqlSessionFactory.openSession(true);
        //执行sql语句
        BrandMapper mapper = sqlSession.getMapper(BrandMapper.class);
        List<Brand> brands = mapper.selectAll();
        //释放资源
        sqlSession.close();
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14

---

Mapper 代理开发

• 我们来重新看一看执行sql语句的部分，官方文档给出了两种执行sql语句方式，在快速入门部分我使用的是 Mapper 代理开发。即先获取 Mapper 实例对象，再用这个对象来调用我们写好的方法

我们来看一下使用第二种方法 Mapper 代理开发的好处

• 第一种方法在传递地址空间的时候还是使用了字符串，仍然存在硬编码问题！
• 同时把sql语句写在xml文件里也更利于维护，不需要我们在繁杂的代码里来寻找出错的位置

---

MyBatis 核心配置文件

这里就不详细介绍了，基础的配置快速入门已给出，其余的详细配置官方文件均可见，需要学习的小伙伴，欢迎去官方文档寻找答案！

只有一个需要注意的细节

• 配置各个标签时，需要遵守标签配置的前后顺序（XML 约束）
• 标签的先后顺序在官方文档中可以找到

---

MyBatis 实现JDBC原理

官方是这样形容的：MyBatis 的真正强大在于它的语句映射，这是它的魔力所在。由于它的异常强大，映射器的 XML 文件就显得相对简单。如果拿它跟具有相同功能的 JDBC 代码进行对比，你会立即发现省掉了将近 95% 的代码。MyBatis 致力于减少使用成本，让用户能更专注于 SQL 代码。

我们来看看语句映射的强大之处

1. 实现语句映射的是 xml 映射文件，也就是我们的 Mapper.xml 文件。它通过 xml 文件向 Mapper 接口中的映射来简化代码。
2. 简单的说， Mapper 接口中存在一个抽象方法，xml 中存在一段 sql 语句，同时该 sql 语句的 id 与抽象方法同名，就完成了映射。
3. 我们在使用时，用 SqlSessionFactory 获取 SqlSession 对象，用 SqlSession 对象的方法获取 Mapper 接口的实例化对象，最后调用接口里预先写好的抽象方法。
4. 调用抽象方法时，不再需要重写，MyBatis 会在映射文件中寻找同名 sql 语句，并调用，这就是映射文件的魅力。映射文件将 sql 语句和方法分开，结构更清晰，更利于维护！

PS : 是不是会觉得其实 MyBatis 的代码量也不少，并没有简化太多好吗，别着急再往下看，等学习完动态 sql 和 注解开发后，相信你会找到答案的。

---

如何传递多个参数

参数占位符

为了解决方法传递多个参数的问题，我们引入了参数占位符，共有两个

• #{}：编译时会替换成 ？传递参数时不存在 sql 注入问题，所以此方法更加常用
• ${}：编译时是字符串的拼接，存在sql注入问题，在不关键的语句补充时有用，比如表名或者列名

• {} 中的 companyName 叫做参数占位符，需要和类的属性名保持一致，原因我们稍后再聊。

MyBatis 对传递多个参数提供了三个方法

1. 散装参数，@Param
2. 对象参数，对象属性名称要和参数占位符名称一致
3. Map 集合，键是对象的属性名，值是属性值

我们先来看两个比较简单的方法

• 对象参数，MyBatis 会对对象参数进行自动的拆封，如果参数占位符是 companyName ，底层就会从传递的对象参数中寻找同名的 companyName 属性名，找到后就把值取出来放到占位的地方，这也就是为什么参数占位符要保证和类的属性名一致的原因，如果找不到就会赋值 null 了。
• Map集合参数，参数占位符表示的是集合中的键，会从集合中把相应的值取出来，放到对应的位置，所以参数占位符要和键名保持一致，这里建议统一使用类的属性名，养成好习惯

最后我们来看一看 @Param 注解这个方法

学习@Param注解之前，我们先来学习一下MyBatis 对不同类型参数的封装方法

MyBatis 提供了 ParamNameResolver 类，通过该类的各种方法来进行参数封装

单个参数时

• POJO 类型，也就是对象类型。可以直接使用，保证属性名和参数占位符一致即可
• Map 集合，直接使用，键名和参数占位符一致就行
• Collection，底层会将集合转换成Map，在存入数据的时候会 put 两次。两次的键分别是 arg0 和collection1 ，值是相同的，是集合中的第一个数据。
• LIst ，转换成 Map 集合，put三次（arg0、collection1、list1）
• Array，转换成 Map，put 两次，键时 arg0 和 array

多个参数时

1. MyBatis 会把多个参数封装为 Map 集合
2. 底层会 put 两次，两个键名分别是 arg0、param1

说起来有点复杂我们来看一下源码

• 简单来说，当传递的参数是集合时，底层会先创建一个 Map 集合，并把参数的数据一一存入到这个 Map 集合中再使用。我们来看一下数据是如何存入 Map 中的。
  • 开始的时候，先 put 一个键值对，键为 arg0，值为单列集合第一个元素
  • 判断如果参数是 Collection 再 put 一个键值对 ，键为 collection1，值不变
  • 继续判断如果参数时 List ，再 put 一个键值对 ，键为 list1，值不变
• 如果传递的是一个数组，创建 Map 集合后 put 两次 键分别是 arg0 和 array1

可以看出 MyBatis 的底层对于数组和集合都是转换成 Map 集合使用的，而想访问 Map 集合中的值就需要先知道键，默认的键名很不方便使用，很明显我们需要一个更加好用的键名，此时@Param注解诞生了，它使得我们可以修改默认的键名！！

@Param 方法传递多个参数

• 不难看出无论参数是单列集合、多列集合 、数组还是多个参数，最终都会被转换为 Map 集合，这些 Map集合中都有一个共同的默认键名 arg0、arg1… 而 @Param 注解就是来修改这个默认键名的，让其更容易调用，只要保证键名和参数占位符一致，MyBatis 就可以很愉快的自动完成拆解，极大的简化我们的工作！
• 我们来看一下如何实现
  • 只需要在定义方法的时候加入注解修改默认键名就可以了，是不是很简单？

---

动态 sql

接下来我们来学习一下 MyBatis 的另一个很厉害得特性:动态 sql
例如：if、where、choose、when、otherwise … …

动态的 sql 帮助我们解决的什么问题呢？

• 有些时候我们想写出非常灵活的sql语句，例如

• 这样灵活的sql语句可以极大的简化很多重复性工作，这段代码表示我们在查询信息时，既可以只使用 companyName ，也可以只使用 brandName，还可以同时使用两者。如果不使用 动态 sql 技术那我们只能苦逼的写三遍 sql 语句了。
• 我们来看一下它的语法结构 首先是 if 标签，test 表示的是判断语句，满足则执行，不满足则跳过，它和 java 中的 if 没有什么区别，在这里我们不多做介绍
• 接下来我们来看看 where 标签。让我们来看一个场景，如果不使用where 标签，同时companyName 为null，brandName 为 ‘华为’，在编码过后 sql 会变成什么样子呢？select*from tb_brand where and brand_name ='华为'，显然这个and多余了，而使用where标签在编译的时候它会帮助我们自动的去掉 and 或者逗号之类的多余东西，使编译不会报错，总之非常好用！

我们再来看一个情景

• 我们想实现一个单条件查找功能，按照 Id ，或者按照 brandName查找，总之它是一个单一条件的查找。按理说这里也可以使用 if 标签来简化代码，但是 if 无法保证单条件，所有满足的条件都被加入到 sql 语句中。这里我们提供了一个更优的选择 choose，很类似 Java 中的 switch，我们来看一下对比图

choose（when，otherwise）

switch （case ， default）

很好理解，在找到满足条件后直接跳出判断，而不会再继续寻找满足的判断。

---

注解开发

上述使用的是 xml 配置文件开发，接下来我们来介绍一种更简单的开发方式——注解开发

使用技巧

• 使用时不再需要再xml配置文件中写sql语句，只需要再Mapper接口中的抽象方法上边，用注解的方式写出sql语句即可
• 注解开发用于实现简单的 sql 语句，因为其不能使用标签，所以复杂情况还是要使用 xml 配置开发

MyBatis 的入门就到这里结束啦，感觉好像大概需要大家的点赞鼓励一下呢，不要吝啬哦！！！