MyBatis初学

╰半橙微兮° 2021-09-22 09:44 277阅读 0赞

**MyBatis简介**  
MyBatis 是一个简化和实现了 Java 数据持久化层(persistence layer)的开源框架，它抽象了大量的 JDBC 冗余代码，并提供了一个简单易用的 API 和数据库交互。  
MyBatis 的前身是 iBATIS，iBATIS 于 2002 年由 Clinton Begin 创建。MyBatis 3 是 iBATIS 的全新设计，支持注解和 Mapper。  
MyBatis 流行的主要原因在于它的简单性和易使用性。在 Java 应用程序中，数据持久化层涉及到的工作有：将从数据库查询到的数据生成所需要的 Java 对象；将 Java 对象中的数据通过 SQL 持久化到数据库中。 MyBatis 通过抽象底层的 JDBC 代码，自动化 SQL 结果集产生 Java 对象、Java 对象的数据持久化数据库中的过程使得对 SQL 的使用变得容易。  
**MyBatis优势**  
● 它消除了大量的 JDBC 冗余代码  
● 它有低的学习曲线  
● 它能很好地与传统数据库协同工作  
● 它可以接受 SQL 语句  
● 它提供了与 Spring 和 Guice 框架的集成支持  
● 它提供了与第三方缓存类库的集成支持  
● 它引入了更好的性能  
**开始使用**  
要使用 MyBatis， 只需将 mybatis-x.x.x.jar 文件置于 classpath 中即可。  
如果使用 Maven 来构建项目，则需将下面的 dependency 代码置于 pom.xml 文件中：

<dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>x.x.x</version>
    </dependency>

本节利用Mysql数据库（通过以下步骤）说明如何使用 MyBatis 开发一个简单的 Java 项目：  
1. 新建表 students，插入样本数据   
2. 新建一个 Java 项目，将 MyBatis依赖添加到 pom.xml中   
3. 新建MyBatisSqlSessionFactory 类构建 SqlSessionFactory  
4. 新建映射器 StudentMapper 接口和 StudentService 类   
5. 新建一个 JUnit 测试类来测试 StudentService   
**新建表 STUDENTS，插入样本数据**   
使用图形界面或sql语句创建表并添加数据，我创建的表如下：  
![Center][]  
**新建一个 Java 项目**  
如果你没有使用类似于 Maven 和 Gradle 之类的依赖管理构建工具，你需要手动下载这些依赖的 JAR 包，手动添加到 classpath 中。  
你可以从[http://code.google.com/p/mybatis][http_code.google.com_p_mybatis]上下载 MyBatis 的发布包 mybatis-3.4.5.zip。 它包含了 mybatis-3.4.5.jar 文件和可选的依赖包如 slf4j/log4j 日志 jar 包.  
我们将使用 slf4j 日志记录框架和log4j 一起记录日志。  
你可以从http://junit.org 上下载JUnit JAR文件，从[https://dev.mysql.com/downloads/connector/j/][https_dev.mysql.com_downloads_connector_j] 上下载 MySQL 数据库驱动，现在我的pom.xml文件如下：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>MyBatisDemo</groupId>
        <artifactId>MyBatisDemo</artifactId>
        <version>1.0-SNAPSHOT</version>
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <java.version>1.8</java.version>
            <junit.version>4.11</junit.version>
            <slf4j.version>1.7.21</slf4j.version>
            <log4j.version>1.2.17</log4j.version>
            <mybatis.version>3.4.5</mybatis.version>
            <mysql.version>6.0.6</mysql.version>
            <maven.compiler.plugin>3.3</maven.compiler.plugin>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>${mybatis.version}</version>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>${mysql.version}</version>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-api</artifactId>
                <version>${slf4j.version}</version>
            </dependency>
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-log4j12</artifactId>
                <version>${slf4j.version}</version>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>${log4j.version}</version>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>${junit.version}</version>
                <scope>test</scope>
            </dependency>
        </dependencies>
    </project>

现在创建一个JavaBean——Student.java

public class Student 
    { 
        private Integer studId; 
        private String name; 
        private String email; 
        private Date dob; 
        // setters and getters 
    }

创建好了表与实体类，接下来就是配置MyBatis和SQL映射器，MyBatis的配置方式有两种，一种是XML，一种是代码方式，接下来我们都会具体介绍，下面先简单说明下相关的类

### SqlSessionFactoryBuilder ###

这个类可以被初始、使用和丢弃，如果你已经创建好了一个 SqlSessionFactory 后就不用再保留它。因此，SqlSessionFactoryBuilder 的最好作用域是方法体内，比如说定义一个方法变量。你可以重复使用SqlSessionFactoryBuilder 生成多个 SqlSessionFactory 实例， 但是最好不要强行保留， 因为 XML 的解析资源要用来做其它更重要的事。

### SqlSessionFactory ###

一旦创建，SqlSessionFactory 就会在整个应用过程中始终存在。所以没有理由去销毁和再创建它，一个应用运行中也不建议多次创建 SqlSessionFactory。 如果真的那样做， 会显得很拙劣。 因此 SqlSessionFactory最好的作用域是 Application。可以有多种方法实现。最简单的方法是单例模式或者是静态单例模式。然而这既不是广泛赞成和好用的。反而，使用 Google Guice 或 Spring 来进行依赖反射会更好。这些框架允许你生成管理器来管理 SqlSessionFactory 的单例生命周期

### SqlSession ###

假设你有一个 SqlSessionFactory，你就可以来获取一个 SqlSession 实例，SqlSession 包含了针对数据库执行语句的每一个方法。

SqlSession sqlSession = MyBatisSqlSessionFactory.getSqlSession();
    try {
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
        return studentMapper.findAllStudents();
    } finally {
        sqlSession.close();
    }

每个线程都有自己的 SqlSession 实例，SqlSession 实例是不能被共享，也是不是线程安全的。因此最好使用 Request 作用域或者方法体作用域。不要使用类的静态变量来引用一个 SqlSession 实例，甚至不要使用类的一个实例变更来引用。永远不要在一个被管理域中引用 SqlSession，比如说在 Servlet 中的HttpSession 中。如果你正在使用 WEB 框架，应该让 SqlSession 跟随 HTTP 请求的相似作用域。也就是说，在收到一个 HTTP 请求过后，打开 SqlSession，等返回一个回应以后，立马关掉这个 SqlSession。 关闭 SqlSession 是非常重要的。你必须要确保 SqlSession 在 finally 方法体中正常关闭， 以确保所有数据库资源都被完全关闭。这是假定不是使用你自己的数据库连接，而是使用 MyBatis 来管理你的数据库连接资源\]

### Mapper实例 ###

Mapper 是一种你创建的用于绑定映射语句的接口。Mapper 接口的实例是用 SqlSession 来获得的。同样，从技术上来说，最广泛的 Mapper 实例作用域像 SqlSession 一样，使用请求作用域。确切地说，在方法被调用的时候调用 Mapper 实例，然后使用后，就自动销毁掉。不需要使用明确的注销。当一个请求执行正确无误的时候，像 SqlSession 一样，你可以轻而易举地操控这一切。保持简单性，保持 Mapper 在方法体作用域内。下面演示了如何来操作：

SqlSession session = sqlSessionFactory.openSession();

try \{

StudentMapper mapper = session.getMapper(StudentMapper.class);

// do work

\} finally \{

session.close();

本节先介绍这么多，在接下来的章节我们再详细介绍其他内容

参考：

[https://www.w3cschool.cn/mybatis/][https_www.w3cschool.cn_mybatis]

[http://www.mybatis.org/mybatis-3/zh/getting-started.html][http_www.mybatis.org_mybatis-3_zh_getting-started.html]

[Center]: /images/20210920/193ec9b4c7dc4da2b047935a3dc83f49.png
[http_code.google.com_p_mybatis]: http://code.google.com/p/mybatis
[https_dev.mysql.com_downloads_connector_j]: https://dev.mysql.com/downloads/connector/j/
[https_www.w3cschool.cn_mybatis]: https://www.w3cschool.cn/mybatis/
[http_www.mybatis.org_mybatis-3_zh_getting-started.html]: http://www.mybatis.org/mybatis-3/zh/getting-started.html