一文搞定 Mybatis 的应用

Posted 2021-01-30 余同学的开发之路

 

Mybatis 介绍

Mybatis 是一个开源的持久层框架，原来叫 ibatis ，它对 jdbc 操作数据库的过程进行了封装，使开发者只需要关注 SQL 本身，而不需要花费精力去处理例如注册驱动、创建 connection、创建 statement、手动设置参数、结果集检索等 jdbc 繁杂的过程代码。

 

Mybatis 通过 xml 或注解的方式将要执行的各种 statement（statement、preparedStatemnt、CallableStatement）配置起来，并通过 Java 对象和 statement 中的 sql 进行映射生成最终执行的 sql 语句，最后由 mybatis 框架执行 sql 并将结果映射成 Java 对象并返回。

 

Mybatis 系统架构

下面好好看一下 Mybatis 的系统架构图，核心配置文件是 sqlMapConfig.xml，通过 Mappers 映射器来连接主配置和各个实体类操作所用到的 SQL 语句。有了配置和 SQL 语句 ，使用 SqlSession 来执行 SQL，在执行的时候会涉及到入参和出参。

 

而 SqlSession 的生成则是由 SqlSessionFactory 通过加载主配置文件来创建。表面上使用 SqlSession 来执行 SQL ，实际上是 SqlSession 所封装的 Executor ，Executor 又封装了 MapperedStatement 在工作。

 

 

搭建 Mybatis 开发环境

1 创建 Java 项目。 2 加入 jar 包（核心包，驱动包，依赖包）。  3 创建主配置文件 sqlMapConfig.xml，日志格式配置文件 log4j.properties 。 4 创建 pojo ，注意这里的 pojo 要和数据库字段相对应。  5 书写实体类对应的 mapper 文件，该文件主要用来写 SQL 。  6 加载 mapper 文件，在 sqlMapConfig.xml 中使用 Mappers 标签进行关联 。

 

测试

@Test
public void test1() throws Exception {
    String resource = "sqlMapConfig.xml";

    // 加载配置文件
    InputStream in = Resources.getResourceAsStream(resource);

    // 绑定配置文件，生成 SqlSession
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
    SqlSession session = sqlSessionFactory.openSession();
    User user = session.selectOne("namespace.findUserById",10);
    System.out.println(user);
}

 

在项目中比较常用的是 mapper 动态代理开发，为什么会出现这个东西呢？ Mybatis 主要为操作数据库服务，主要用在 DAO 层，具体的 SQL 都在实体类对应的 mapper 文件中了，一般来说，对于一个 DAO 层的业务，我们需要编写接口，实现类，还有 mapper 文件，至少需要这 3 个东西，而实现类和接口中的代码会存在大量的重复。

 

为了简化开发，Mybatis 的开发人员就想到使用 mapper 动态代理开发，其结果就是，我们只需要为 DAO 层的业务编写一个接口和 mapper 文件即可，既然把实现类给省略了，那肯定需要以某种形式体现出具体的实现在哪里。

 

我们要保证以下几个方面

1 命名空间命名为接口的全类名，这样接口和 SQL 就绑定在一起了。

2 方法名和 statement 的 id 一致，这样接口中的方法和具体的 SQL  就绑定在一起了。

3 方法的入参和 parameterType 一致

4 方法的返回值和 resultType 一致

 

保证了上面 4 点的匹配即可将接口和 mapper 文件绑定，这里没有实现类，mybatis 会自动给我们生成实现类。上面的 mapper 中入参使用 Map 是为了方便传参，不仅仅是 Integer ，其它类型的参数也可以接收。

 

在入参或是出参选择类型的时候，parameterType 和 parameterMap 的区别主要是 Type 是已经存在的类型，可以直接配置使用，若是使用 Map 则需要我们在 mapper 文件中自定义输入集或是结果集。

 

注意看有个小细节，接口文件和 mapper 文件在同一目录下，且同名。为什么要这么做呢 ？因为在主配置文件中关联 mapper 文件的时候，若是使用如下图方式，就需要 mapper 文件和接口名称相同且在同一目录下。Mybatis 直接对包进行扫描，不用一个一个的配置 mapper 文件。

 

 

有了上面的接口，实现类，主配置文件，关于主配置文件文件，还会涉及到一些标签的使用，比方 properties 属性，别名等。其中配置别名的时候也可以使用包扫描的方式进行配置，配置之后的别名即为实体类名，且不区分大小写。还要注意使用标签的时候不能乱序。

 

我们在开发的时候，可能会遇到这么一个需求，在插入一个记录之后，就要对该记录进行操作，这就需要知道刚刚插入记录的 ID ，以下展示在 mysql 中获取 ID 的方式。

 

 

配置并使用 select LAST_INSERT_ID( ) 函数即可，这里 order 为主键生成的顺序，在主键自增的时候使用 AFTER，在主键为 UUID 的时候配置为 BRFORE 。

 

以上既是在单表操作时 Mybatis 的应用了。在应用的时候可能会有这样几个问题。

 

Mybatis 中 #{ }  和  ${ }  区别 ？

#{} 表示一个占位符号，通过 #{} 可以实现 preparedStatement 向占位符中设置值，自动进行 Java 类型和 jdbc 类型转换。防止 sql 注入。 #{} 可以接收简单类型值或 pojo 属性值。 如果 parameterType 传输单个简单类型值，#{} 括号中可以是 value 或其它名称。会给值自动加上引号。

 

${} 表示拼接 sql 串，通过 ${} 可以将 parameterType 传入的内容拼接在 sql 中且不进行 jdbc 类型转换，${} 可以接收简单类型值或 pojo 属性值，如果 parameterType 传输单个简单类型值，${} 括号中只能是 value。

 

Mybatis 和 Hibernate 的区别 ？

Mybatis 和 Hibernate 不同，它不完全是一个 ORM 框架，因为 MyBatis 需要程序员自己编写 SQL 语句。

 

Mybatis 学习门槛低，简单易学，程序员直接编写原生态 sql，可严格控制 sql 执行性能，灵活度高，但是灵活的前提是 Mybatis 无法做到数据库无关性，如果需要实现支持多种数据库的软件则需要自定义多套 sql 映射文件，工作量大。

 

Hibernate 对象/关系映射能力强，数据库无关性好，对于关系模型要求高的软件（例如需求固定的定制化软件）如果用 Hibernate 开发可以节省很多代码，提高效率。但是 Hibernate 的学习门槛高。

 

下面就开始 Mybtis 的进阶篇了！

 

输入映射和输出映射

输入映射类型用 parameterType 来表示，输入类型可以是简单类型，比方说 Integer、String。也可以是 pojo 类型，今天再说一个输入类型，还可以是 pojo 的包装类型，就是说我们的入参是对实体类的封装，取值的时候就需要注意了，假如我们使用 QueryUser 对 User 进行封装。

 

而我们需要的参数是 User 对象的 username，而入参设置的又是 QueryUser ，那我们取值的时候该怎么取呢？注意下图中的连续调用，入参设置为 QueryUser 是为了方便接收参数。

 

 

 

 

为什么会出现这种现象呢 ？我们需要调用 user 再调用 username 是因为 Mybatis 在处理参数的时候，使用的是 Map 的形式，我们传入的是一个对象，实际上被分解为一个一个的属性 put 进集合，而集合的键就是属性名称，值才是我们需要的值。所以在传入实体类的时候我们可以直接使用 #{username} 得到值，实际上就是对 Map 进行 get("username") 操作。而我们传入 VO 对象时，多了一层封装，所以就需要多一层调用。

 

parameterType 是 Mybatis 自动给我们映射，parameterMap 是手动映射入参，基本不使用。

 

同理 resultType 也是 Mybatis 对结果集自动映射，我们可以为出参配置简单类型，实体类型，这里 Mybatis 可以自动映射有个前提条件就是数据库的字段必须要实体中的属性一致。

 

那总会出现一个特立独行的不一致的情况，这时就需要我们使用 resultMap 进行手动的为出参进行配置。例如，我们的 User 实体中有个字段为 username，而数据库中为 user_name，此时就需要我们自行配置出参。

 

 

动态 SQL

动态 SQL 指的就是使用 Mybatis 提供的标签来拼接 SQL ，所以在 SQL 会写的情况下，就是在学习使用 Mybatis 的标签。吐槽一句，计算机的世界里，高大上的名词太多，实际上……，嗯，接着看动态 SQL 。

 

学的标签有这么几个 if，where，foreach ，include 。直接看具体的每个标签具体的应用场景。

 

在多条件查询中，我们希望可以随机的搭配输入的条件，例如下面这条 SQL 我们不需要写成按 sex、username、或两个条件一起查询这样三条 SQL，只需要使用 IF 标签进行改造即可。

select id, username, birthday, sex, address from user where sex = #{sex} and username = #{username}

 

 

上面的 SQL 改造还是不到位，还要添加一个鸡肋的语句 1 = 1 ，怎么才能去掉这个呢，这就需要使用 where 标签了，我们只需要这样即可

 

 

这里有个注意点，where 标签会自动去掉其后面的第一个前 and 。这也就意味着，我们可以写 and sex ，不能写成 sex and 。

 

看看 SQL 你会发现，“select * from user” 经常出现，我们可以抽取出来，这样就需要用到 include 和 sql 标签。如下图

 

 

最后一个 foreach 标签，主要用在向 SQL 中传入 list 或是数组时。类如我们有如下 SQL

select * from user where id in (1,10,24)

 

我们可以使用最常规的一种做法来实现，注意看这里的实现步骤和 foreach 标签的使用方式。

 

 

这里可以看到 foreach 中的 collection 是对象中的属性 ids ，我们再来看看其它的实现方式。

 

 

第一种方式已经说过了，后面两种的区别主要在于foreach 标签中的 collection 值不一样了，若是使用 list 集合作为入参，则遍历的类型为 list ，若是使用数组作为入参，则遍历的元素则是 array 。

 

为什么这样呢？上面已经说过，在 Mybatis 中，参数的传递使用 Map ，所以我们要填写的东西就是 Map 中的主键，而记录 List 和数组的 Map 默认主键就是 list 和 array 。

 

Mybatis 中的一对一、一对多的表示

在用户和订单关系中，一个订单只能对应一个用户，而一个用户可以对应多个订单，所以，站在订单的角度，订单和用户的关系就是一对一，而站在用户的角度，一个用户可以对应多个订单，是一对多的关系。

 

在代码中的体现就是，我们在订单实体中添加一个用户对象，表示这个订单属于哪个用户。而在用户对象中添加一个订单的 List，来表示一个用户对应多个订单。

 

在 SQL 语句的体现就是两张表的连接查询，当 order left join user 时，表示订单全查，并查出关联的用户信息。而 user left join order 时，表示用户全查，并查出关联的订单信息。

 

那我们如何使用 Mybatis 将 SQL 结果与对象绑定呢，这里我们必须要使用 resultMap 来重新定义结果集，在定义结果集的时候，我们需要将关联的对象一并表示出来。在一对一的关系中，我们可以使用 association 标签，具体如下图所示

 

 

而在一对多的关系中，我们可以使用 collection 标签进行表示，如下图所示

 

 

有个需要注意的地方，若是进行单表的操作，resultMap 中的 result 可以只配置实体类中和数据库不一致的列，但是涉及到两个表时就需要将用到的列和主键全部列出来，不然没有值。

 

到这里 Mybatis 的应用就说完了，并没有对 Mybatis 的内部逻辑做过多的介绍，目前还只是会用，后面还有与 Spring 的整合，等其它框架的应用说的差不多再整理。