【使用MyBatis编写程序】

简介

MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

搭建环境

• 搭建数据库

新建父项目

• 新建一个普通的maven父项目
• 删除父项目src目录
• 新建一个子模块（子项目）
  好处是父项目的依赖子项目也可以使用，不需要重复导入依赖。
  

导入依赖（父项目pom文件）

<dependencies>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.28</version>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-api</artifactId>
        <version>5.3.2</version>
        <scope>test</scope>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.9</version>
    </dependency>
</dependencies>

Maven资源过滤（子项目pom文件）

如果一个资源不在resources目录下，而在其他包中，则需要进行资源过滤

    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

搭建子模块

• 编写mybatis配置文件（mybatis-config.xml）

功能1：连接数据库
功能2：mapper映射 mappers 元素包含了一组映射器（mapper），这些映射器的 XML 映射文件包含了 SQL查询语句和映射定义信息。

<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>
<!--    <properties resource="db.properties"/>-->

    <environments default="development">
        <environment id="development">
        <!--默认JDBC事务管理-->
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <!--每一个Mapper.xml文件都要在mybatis核心配置文件中注册-->
    <mappers>
<!--        <mapper url="file:/D:\mybatis\mybatis-01\src\main\java\com\cao\Dao\UserMapper.xml"/>-->
        <mapper resource="com/cao/Dao/UserMapper.xml"/>
    </mappers>
</configuration>

&转义→&amp；

封装mybatis工具类（MybatisUtil）

• 从 XML 中构建 SqlSessionFactory

核心：SqlSessionFactory的实例
每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。

从 XML 文件中构建 SqlSessionFactory 的实例非常简单，建议使用类路径下的资源文件进行配置。 但也可以使用任意的输入流（InputStream）实例，比如用文件路径字符串或 file:// URL 构造的输入流。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，使得从类路径或其它位置加载资源文件更加容易。

package com.cao.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;

//sqlSectionFactory
public class mybatisUtils {
    //提升作用域
    private static SqlSessionFactory sqlSessionFactory;
    static {
        try {
            //第一步：获取sqlSessionFactory实例对象
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        }catch (IOException e) {
            e.printStackTrace();
        }
    }
    //既然有了sqlSessionFactory实例对象，我们就可以从中获取SqlSession的实例了
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();

    }
}

• 从 SqlSessionFactory 中获取 SqlSession
  

既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。

等价于之前使用的PreparedStatement方法
到目前为止，已经连接数据库，下一步操作实体类

编写代码

• 实体类
• Dao接口
• 接口实现类

POJO包：实体类层

封装的是数据中的设计的表对应的元素。
实体类代码编写原则：

• 封装数据库表中对应的元素
• 无参/有参构造函数自动编写
• 变量读写函数自动编写

package com.cao.pojo;

public class User {
    private int id;
    private  String name;
    private  String pwd;

    public User() {
    }

    public User(int id, String name, String pwd) {
        this.id = id;
        this.name = name;
        this.pwd = pwd;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPwd() {
        return pwd;
    }

    public void setPwd(String pwd) {
        this.pwd = pwd;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", pwd='" + pwd + '\'' +
                '}';
    }
}

Dao包：编写Mapper接口以及Mapper.xml文件，实现sql操作

编写Dao接口

package com.cao.Dao;

import com.cao.pojo.User;

import java.util.List;

public interface UserMapper {
    List<User> getUserList();
}

编写接口实现xml配置文件

将sql语句写在配置文件中
SqlSession 和 Mapper 到底具体执行什么操作
一个语句既可以通过 XML 定义，也可以通过注解定义。我们先看看 XML 定义语句的方式，事实上 MyBatis 提供的所有特性都可以利用基于 XML 的映射语言来实现，这使得 MyBatis 在过去的数年间得以流行。在一个 XML 映射文件中，可以定义无数个映射语句，这样一来，XML 头部和文档类型声明部分就显得微不足道了。文档的其它部分很直白，容易理解。 它在命名空间 “com.cao.Dao.UserMapper” 中定义了一个名为 “getUserList” 的映射语句，这样你就可以用全限定名 “com.cao.Dao.UserMapper.getUserList” 来调用映射语句了。
同时声明该语句的返回类型为：“com.cao.pojo.User”
接口实现类由原来的UserDaoImpl转变为一个Mapper配置文件
注意点：

• 命名空间写全限定名
• 返回类型写泛型
• id写对应方法名

<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
        <!--命名空间用来绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.cao.Dao.UserMapper">
<!--id对应方法名，用一个标签重写方法-->
<!--配置文件中要写全限定名，不像java代码中可以自己寻找-->
<!--返回结果写List<User>中的泛型User不要写集合-->
    <select id="getUserList" resultType="com.cao.pojo.User">
        select * from mybatis.user
    </select>
</mapper>

测试类

规范：
测试包与开发包分离
测试包与被测试包路径一致

package com.cao.Dao;

import com.cao.pojo.User;
import org.apache.ibatis.session.SqlSession;
import com.cao.utils.mybatisUtils;
import org.junit.jupiter.api.Test;

import java.util.List;

public class UserDaoTest {
    @Test
    public void test(){
    //工具类mybatisUtils之前已经实现，测试只需直接调用测试类实现的getSqlSession()即可
    //第一步：获得sqlSession 对象
        SqlSession sqlSession = mybatisUtils.getSqlSession();
        //面向接口编程
        //获取userMapper 实例
        //方式一：getMapper
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        //即可使用userMapper实例的函数
        List<User> userList = userMapper.getUserList();
        for (User user:userList){
            System.out.println(user);
        }
        //关闭sqlSession
        sqlSession.close();
    }
}

作用域（Scope）和生命周期

理解我们之前讨论过的不同作用域和生命周期类别是至关重要的，因为错误的使用会导致非常严重的并发问题。

对象生命周期和依赖注入框架

依赖注入框架可以创建线程安全的、基于事务的 SqlSession 和映射器，并将它们直接注入到你的 bean 中，因此可以直接忽略它们的生命周期。 如果对如何通过依赖注入框架使用 MyBatis 感兴趣，可以研究一下 MyBatis-Spring 或 MyBatis-Guice 两个子项目。

SqlSessionFactoryBuilder

这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。

SqlSessionFactory

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

SqlSession

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。 如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。 这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。 下面的示例就是一个确保 SqlSession 关闭的标准模式：

try (SqlSession session = sqlSessionFactory.openSession()) {
  // 你的应用逻辑代码
}

在所有代码中都遵循这种使用模式，可以保证所有数据库资源都能被正确地关闭。

映射器实例

映射器是一些绑定映射语句的接口。映射器接口的实例是从 SqlSession 中获得的。虽然从技术层面上来讲，任何映射器实例的最大作用域与请求它们的 SqlSession 相同。但方法作用域才是映射器实例的最合适的作用域。 也就是说，映射器实例应该在调用它们的方法中被获取，使用完毕之后即可丢弃。 映射器实例并不需要被显式地关闭。尽管在整个请求作用域保留映射器实例不会有什么问题，但是你很快会发现，在这个作用域上管理太多像 SqlSession 的资源会让你忙不过来。 因此，最好将映射器放在方法作用域内。就像下面的例子一样：

try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  // 你的应用逻辑代码
}

总结

每次更新maven配置文件（pom.xml）都要刷新maven