MyBatis 简介及入门程序

文章目录

MyBatis 简介及入门程序
- 1 基本概念
- 2 MyBatis 与 Hibernate
- 3 MyBatis 的核心接口与对象
- - 3.1 SqlSessionFactoryBuilder
  - 3.2 SqlSessionFactory
  - 3.3 SqlSession
- 4 入门程序
- - 4.1 准备工作
  - - 4.1.1 创建数据库的 SQL
    - 4.1.2 创建 maven 工程
    - 4.1.3 创建 MyBatis 的核心配置文件
    - 4.1.4 创建 POJO(实体类)
  - 4.2 基于 xml 方式使用 MyBatis
  - - 4.2.1 创建持久层接口（AccountMapper）
    - 4.2.2 创建 xml 映射文件
    - 4.2.3 在核心配置文件中注册 Mapper
    - 4.2.4 测试与结果
  - 4.3 基于注解方式使用 MyBatis
  - - 4.3.1 创建持久层接口(AccountMapper2)
    - 4.3.2 在核心配置文件中注册 Mapper
    - 4.3.3 测试与结果
  - 4.4 基于实现类方式使用 MyBatis
  - - 4.4.1 创建持久层接口（AccountMapper3）
    - 4.4.2 创建持久层接口实现类（AccountMapper3Impl）
- 5. 总结

本篇博文介绍 MyBatis 的基本概念及快速入门。

MyBatis 学习的 demo 已上传 GitHub，地址：https://github.com/Jacks5320/MybatisStudyDemo

1 基本概念

MyBatis，原名 iBatis，由原来的 apache 迁移到了谷歌，更名为 MyBatis。MyBatis 指的就是 iBatis 3.x 后的版本。
MyBatis 是采用 ORM（Object Relational Mapping，对象关系映射）思想实现的持久化层框架，之前学习持久层解决方案 JDBC、JdbcTemplate、DBUtil都不是框架，JDBC 是一种规范，JdbcTemplate 和 DBUtil 都是简单封装了 JDBC 的工具类。
MyBatis 支持自定义 SQL、存储过程以及高级映射，免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。可以通过简单的 XML 或注解把原始类型、接口和 Java POJO(Plain Old Java Objects，普通老式 Java 对象) 映射为数据库中的记录。
使用 MyBatis 框架，让开发人员专注于 SQL 的编写，不再去关注注册驱动、获取连接、执行 SQL、释放资源等操作，极大简化了持久层开发工作。
mybatis官网
百度百科

2 MyBatis 与 Hibernate

由于博主没学过 Hibernate 框架，所以就直接引用其他博文的资料了。

Hibernate

是全自动全映射的 ORM 框架，旨在消除 SQL，可以使用 HQL 定制 sql。
全自动，自动生产数据库表，自动映射对象属性与数据库表字段。
提供封装好 JDBC 的方法，自动生产 SQL，可以直接调用，无需再编写 SQL 语句。
全映射，如果数据库中有 100 字段，在 Java 实体类中就要写 100 个映射。
由于是全自动框架，难以优化 SQL，如果要定制 SQL，还需学习 HQL 相关知识，学习成本更高。

MyBatis

MyBatis 是半自动 ORM 框架。
将 SQL 定制抽取出来，以配置文件的方式交由开发人员编写。
封装了预编译、设置参数、执行 SQL、封装结果等操作。
实现了 SQL 与 Java 编码分离。
只需要掌握 SQL 和 MyBatis 相关配置就可以使用，学习成本相对更低。
由于 SQL 需要由开发人员编写，方便维护与优化。
相比于 Hibernate 更加轻量级。

可参考文章：

Hibernate与 MyBatis的区别
mybatis和hibernate比较_区别_优缺点

3 MyBatis 的核心接口与对象

3.1 SqlSessionFactoryBuilder

用于创建 SqlSessionFactory，这个类可以被实例化、使用和丢弃。
一旦创建了 SqlSessionFactory，就不再需要它了，所以最佳作用域是方法作用域(局部方法变量)。
可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，最好不要一直保留着它，以保证所有的 XML 解析资源可以被释放，从而去处理更重要的事情。

3.2 SqlSessionFactory

用于创建 SqlSession 实例。
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。
在应用运行期间不要重复创建多次 SqlSessionFactory ，多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。
SqlSessionFactory 的最佳作用域是应用作用域。有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

3.3 SqlSession

用于创建 Mapper 的代理对象。
SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。
绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。
也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。
每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。

4 入门程序

入门程序将介绍基于 xml方式、注解方式、持久层接口实现类等三种方式使用 MyBatis 框架。

4.1 准备工作

在准备工作中，需要创建数据库、普通 Maven 工程、Mybatis 核心配置文件、POJO 类等工作。

4.1.1 创建数据库的 SQL

CREATE DATABASE `mybatis_study`;USE `mybatis_study`;CREATE TABLE IF NOT EXISTS `tb_account`(`id` INT(10) NOT NULL AUTO_INCREMENT,`name` VARCHAR(10) DEFAULT NULL,`money` FLOAT(5.2) DEFAULT 0,PRIMARY KEY( `id` )
)ENGINE=INNODB DEFAULT CHARSET=utf8;INSERT INTO `tb_account`(`id`,`name`,`money`) VALUES
(1,'小张',1000.0),
(2,'小李',2000.0),
(3,'小丽',1500.0);

4.1.2 创建 maven 工程

创建一个普通 Maven 工作，导入以下依赖。

<!-- 数据库 -->
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.17</version>
</dependency>
<!-- mybatis -->
<dependency><groupId>org.mybatis</groupId><artifactId>mybatis</artifactId><version>3.5.5</version>
</dependency>
<!-- 测试单元 -->
<dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.12</version><scope>test</scope>
</dependency>

需要注意的是，我这里的 MySQL 版本为 8.0.17，如果是 5.x 版本，则更换为 5.x.x。

4.1.3 创建 MyBatis 的核心配置文件

在 resources 文件夹下创建 MyBatis 的核心配置文件，命名随意，我这里命名为 mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd">
<!-- MyBatis 核心配置 -->
<configuration><!--环境配置，可以配置多个 可以根据 id 选择默认环境--><environments default="mysql"><!-- mysql 环境--><environment id="mysql"><!--配置事务的类型--><transactionManager type="JDBC"/><!-- 配置数据源(连接池) --><dataSource type="POOLED"><!-- JDBC 的 4 个基本信息 --><property name="driver" value="com.mysql.cj.jdbc.Driver"/><property name="url" value="jdbc:mysql://localhost:3306/mybatis_study?serverTimezone=Asia/Shanghai"/><property name="username" value="root"/><property name="password" value="root"/></dataSource></environment></environments><!-- 指定映射配置文件的位置，映射配置文件指的是每个 mapper 独立的配置文件。 --><!-- 每个 Mapper 都需要在 核心配置文件中注册 --><mappers><!-- 使用 xml 配置文件 --><mapper resource="mapper/AccountMapper.xml"/><!-- 使用注解 --><mapper class="com.mapper.AccountMapper2"/><!-- 使用实现类 --><mapper resource="mapper/AccountMapper3.xml"/></mappers>
</configuration>

4.1.4 创建 POJO(实体类)

public class Account {private Integer id;private String name;private Double money;//  以下省略 set、get、toString 等方法
}

4.2 基于 xml 方式使用 MyBatis

4.2.1 创建持久层接口（AccountMapper）

在 MyBatis 框架中，持久层的接口和配置文件叫做 Mapper，就等同于之前写的 Dao。

public interface AccountMapper {List<Account> findAccountList();
}

4.2.2 创建 xml 映射文件

xml 映射文件可以理解为 Mapper 接口的实现类，必须指定名称空间(Mapper接口的全限定类名)和对应方法(Mapper 接口中的方法名字)。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd"><!-- namespace 命名空间，绑定一个对应的 Mapper 接口，且为全限定类名 -->
<mapper namespace="com.mapper.AccountMapper"><!-- 查询所有 --><!-- id 为 namespace 指定接口的方法名字 --><!-- resultType 为 SQL 执行后返回的结果类型，如果是 pojo 类，需要用全限定类名 --><select id="findAccountList" resultType="com.pojo.Account">select * from tb_account</select>
</mapper>

4.2.3 在核心配置文件中注册 Mapper

<mappers><!-- 使用 xml 配置文件 --><mapper resource="mapper/AccountMapper.xml"/>
</mappers>

这一步在准备工作中提前做了，实际开发中的步骤，应该是创建 xml 映射文件，然后在核心配置文件中注册。

4.2.4 测试与结果

@Test
public void testXmlMapper() throws IOException {// 1 读取配置文件InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");// 2 创建 SqlSessionFactory 工厂：使用 SqlSessionFactoryBuilder 构建者SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(inputStream);// 3 使用工厂生产 SqlSession 对象SqlSession sqlSession = factory.openSession();// 4 使用 SqlSession 创建 Mapper 的代理对象AccountMapper mapper = sqlSession.getMapper(AccountMapper.class);// 5 使用代理对象执行方法List<Account> accountList = mapper.findAccountList();for (Account account : accountList){System.out.println(account);}// 6 释放资源sqlSession.close();inputStream.close();
}

注意步骤：

第一步：使用流加载 MyBatis 核心配置文件。
第二步：用 SqlSessionFactoryBuilder 读取输入流，并创建出 SqlSessionFactory 。
第三步：使用 SqlSessionFactory 创建 SqlSession 。
第四步：使用 SqlSession 创建 Mapper 的代理对象。
第五步：使用代理对象调用方法并获取返回结果。
第六步：释放资源。

4.3 基于注解方式使用 MyBatis

基于注解使用 MyBatis 就可以不使用 xml 映射文件，直接在对应的注解中编写 SQL 即可。

4.3.1 创建持久层接口(AccountMapper2)

使用 @Select 注解标注方法，并写入对应 SQL，表示查询操作。

public interface AccountMapper2 {@Select("select * from tb_account")List<Account> findAccountList();
}

4.3.2 在核心配置文件中注册 Mapper

<mappers><!-- 使用注解 --><mapper class="com.mapper.AccountMapper2"/>
</mappers>

注意：

使用注解方式时，注册 Mapper，使用到的属性时 class，对应的值为接口的全限定类名。
这一步也正准备工作中做了，不再过多解释。

4.3.3 测试与结果

@Test
public void testAnnotationMapper() throws IOException {// 1 读取配置文件InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");// 2 创建 SqlSessionFactory 工厂：使用 SqlSessionFactoryBuilder 构建者SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(inputStream);// 3 使用工厂生产 SqlSession 对象SqlSession sqlSession = factory.openSession();// 4 使用 SqlSession 创建 Mapper 的代理对象，这里是 AccountMapper2AccountMapper2 mapper = sqlSession.getMapper(AccountMapper2.class);// 5 使用代理对象执行方法List<Account> accountList = mapper.findAccountList();for (Account account : accountList){System.out.println(account);}// 6 释放资源sqlSession.close();inputStream.close();
}

可以看到结果是一样的，测试方法中的步骤完全一致。

4.4 基于实现类方式使用 MyBatis

这种方法其实也是基于 xml 映射文件方式的，只是将测试方法中的某些步骤放到实现类中处理，实际开发中应该尽量使用前两个方法，本方法作为了解即可。

4.4.1 创建持久层接口（AccountMapper3）

public interface AccountMapper3 {List<Account> findAccountList();
}

4.4.2 创建持久层接口实现类（AccountMapper3Impl）

public class AccountMapper3Impl implements AccountMapper3 {private final SqlSessionFactory sqlSessionFactory;public AccountMapper3Impl(SqlSessionFactory sqlSessionFactory) {this.sqlSessionFactory = sqlSessionFactory;}@Overridepublic List<Account> findAccountList() {// 1 使用 工厂 创建 SqlSession 对象SqlSession sqlSession = sqlSessionFactory.openSession();//  参数为对应的方法名return sqlSession.selectList("com.mapper.AccountMapper3.findAccountList");}
}

在实现类中，把 SqlSessionFactory 作为类属性，并且使用有参构造代替默认的无参构造，使得在创建实现类对象时，必须传入 SqlSessionFactory 。
有了 SqlSessionFactory 后就可以创建 SqlSession 。
有了 SqlSession 就可以使用其中的选择方法执行 xml 映射文件中的 SQL，最终将 SQL 执行的结果返回。
SqlSession 的选择方法会根据传入的参数去查找对应 namespace 和 id ，从而定位 SQL。
对于这种方式，官方的说明：[诚然，这种方式能够正常工作，对使用旧版本 MyBatis 的用户来说也比较熟悉。但现在有了一种更简洁的方式——使用和指定语句的参数和返回值相匹配的接口（比如 BlogMapper.class），现在你的代码不仅更清晰，更加类型安全，还不用担心可能出错的字符串字面值以及强制类型转换。]

5. 总结

MyBatis 是一种持久层框架，JDBC 是一种规范，JdbcTemplate 和 DBUtils 分别是出自 Spring 和 Apache 的 工具类。
在 MyBatis 中，持久层接口和 xml 映射文件叫做 Mapper。
可以通过 xml 映射文件和注解的方式使用 MyBatis 框架，不推荐使用实现持久层接口实现类的方式使用 MyBatis。
对于简单的数据库操作，可以使用注解的方式，对于复杂类型的数据库操作，更建议使用 xml 映射文件的方式。
使用 xml 映射文件时，namespace 必须指定，值为接口的全限定类名，内部标签的 id 必须指定为 namespace 中的方法名。
无论是使用 xml 映射文件方式，还是注解方式，都需要在核心配置文件中注册 mapper。
在使用 MyBatis 框架进行查询操作中，当 POJO 类的属性名与数据库中的字段名不一致时(入门程序中时一致的)，需要配置结果集映射，否则查询出不一致的字段值为null，这个会在后面的博文中解释。
关于 MyBatis 的基本概念以及入门程序就到此为止了。