Mybatis笔记 —— 运行环境的搭建与Mybatis框架的运行过程分析

最新推荐文章于 2023-05-15 01:36:26 发布

一纸春秋

最新推荐文章于 2023-05-15 01:36:26 发布

阅读量880

点赞数

分类专栏： Mybatis 文章标签： mybatis 环境搭建运行原理 Mapper映射

本文链接：https://blog.csdn.net/qq_44823756/article/details/121996176

版权

Mybatis 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

本篇博客是根据B站up @遇见狂神说的视频以及 Mybatis官网文档整理的笔记，里面会有一些视频的代码和官网的概念，以及我个人的注释笔记，代码例子等。
还有很多总结内容，是我自己总结的，只是分享一些个人的看法，仅供参考
全篇博客包括代码均为自己手打，结果截图均为自己运行的结果。
以下是视频链接
https://www.bilibili.com/video/BV1NE411Q7Nx?p=21
Mybatis官网文档链接
https://mybatis.org/mybatis-3/zh/index.html

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

传统的jdbc操作比较复杂，所以出现了Mybatis框架。可以大量减少复杂的工作

这篇文章记录一下利用Mybatis框架实现mysql数据库的增删改查的实现

首先在mysql里面创建数据库和表格

create database mybatis;

create table `user`(
	`id` int(11) not null primary key,
	`name` varchar(255) default null,
	`pwd` varchar(255) default null
)engine=innodb default charset=utf8;

insert into `user`(`id`,`name`,`pwd`) VALUES
(1,'悟空','111111'),
(2,'小白龙','222222'),
(3,'八戒','333333')

然后在idea里面创建一个maven项目，搭建起Mybatis的运行环境，具体的环境搭建过程按照Mybatis官网的步骤来，基础架构如下
在这里插入图片描述

先在pom.xml里面写入以下依赖

<dependencies>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        <!--mybatis-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.2</version>
        </dependency>
        <!--junit-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
    </dependencies>

    <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>

在 resources下面创建一个mybatis-config.xml，编写核心配置文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://master:3306/mybatis?useSSL=false&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 resource="com/dao/UserMapper.xml"/>
    </mappers>
</configuration>

在这里插入图片描述
在environments标签里面可以定义多个环境标签environment，具体使用哪个，根据environments标签的default属性来设置。而下面第一个画红线的地方，transactionManager 标签用来设置事务管理器，默认使用的是JDBC。第二个画红线的地方 dataSource标签定义的是数据来源，这里统一就是用 pooled 连接池类型获取mysal数据库的数据即可

从 XML 中构建 SqlSessionFactory

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

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

String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

官方给出了模板，必须要有这三句话，这是mybatis的第一步，resource就是之前设置的mybatis-config.xml，下面两句都不需要改

实体类的编写

使用sql语句从数据库中查询获取到的数据需要映射成实体，因为没办法对数据库的字段名进行操作，所以用实体类将sql查询结果保存在实体类对象中。实体类的属性变量应该和数据库查询的字段名相对应，具有映射关系。比如sql语句 select name from student; 那么实体类 Student 里面应该有一个属性变量 name ，用来存放这个sql语句的查询结果。这样就可以通过实体类Student的对象来对name值进行下一步的操作

package com.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 + '\'' +
                '}';
    }
}

这样写实体类很麻烦，所以我们通常使用lombok来生成构造方法，get，set方法，以及toString方法等

@Data
@AllArgsConstructor
@NoArgsConstructor
@Getter
@Setter
@ToString
//实体类
public class User {
    private int id;
    private String name;
    private String password;
}

编写Mybatis工具类

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

public class MybatisUtils {

    public static SqlSessionFactory sqlSessionFactory;

    static{
        try {
            //使用mybatis第一步，获取 SqlSessionFactory 对象
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /*
    既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。
    SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。
     */
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }

}

前面有说过：SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。

因此：

SqlSessionFactoryBuilder，主要作用是构建SqlSessionFactory
SqlSessionFactory
（1）可以理解为一个数据库连接池
（2）一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例
SqlSession
（1）可以理解为连接到连接池的一个请求
（2）SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句
注：虽然可以通过SqlSession直接执行sql语句，但是这种方法一般不会使用，取而代之的是使用mapper接口来执行sql语句

Dao层

UserMapper接口

package com.dao;

import com.pojo.User;

import java.util.List;

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

Mapper.xml映射文件

关于Mapper文件的编写模板，在Mybatis的官网也已经给出
在这里插入图片描述
根据这个模板，修改一下，与我们之前搭建的项目环境产生联系，编写UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.dao.UserMapper">

    <select id="getUserList" resultType="com.pojo.User">
        select * from mybatis.user
    </select>
</mapper>

Mapper.xml已经写好了，但是我们是怎么使用这个映射文件，从而实现sql语句的呢，再回去看看官网文档
在这里插入图片描述
图上是官方文档的截图，前几句话，官网解释了为什么这个映射文件看起来内容好多，却依旧比传统的jdbc要简洁的原因。

然后是namespace命名空间，这个命名空间指向的是我们前面写的UserMapper接口，我们自己编写的xml文件，就是在命名空间“com.dao.UserMapper”中定义了一个名为“getUserList”的映射语句

命名空间和接口相对应，而getUserList与接口里面定义的方法对应。

这样就可以用全限定名 “com.dao.UserMapper.getUserList” 来调用映射语句了，然后该命名就可以直接映射到在命名空间中同名的映射器类，并将已映射的 select 语句匹配到对应名称、参数和返回类型的方法。就像下面这样，从测试方法里面截取两行代码来看一下：

UserDao mapper = sqlSession.getMapper(UserDao.class);
List<User> userList = mapper.getUserList();

在使用mybatis之前，是写一个UserImpl类来实现UserDao接口，然后在类里面链接数据库，写sql语句。而Mybatis则是通过映射的方式实现接口里面的抽象方法，以后如果要增加新的需求，比如增删改查，只需要在接口里面增加相应的抽象方法，然后在Mapper映射文件中编写相应的映射语句即可。

完整的测试方法代码

在这里插入图片描述

package com.dao;

import com.pojo.User;
import com.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

import java.util.List;

public class UserDaoTest {
    @Test
    public void test(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        //获取结果集
        List<User> userList = mapper.getUserList();
        //遍历输出结果集
        for (User user : userList) {
            System.out.println(user);
        }
        //关闭sqlSession
        sqlSession.close();
    }
}

下面来逐句解析一下这个测试方法里面的代码

一、 SqlSession sqlSession = MybatisUtils.getSqlSession();
这里的sqlSession对象已经获取了之前配置的mybatis-config.xml配置文件的信息
原因可以回头来看MybatisUtils工具类

String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }

创建SqlSessionFactoryBuilder的过程中有以下两个步骤，对用户是隐藏的

（1）通过XMLConfigBuilder解析配置文件流 <==> .bulid(inputStream)
（2）获取Configuration所有的配置信息

有了上面的SqlSessionFactoryBuilder解析配置文件并获取全部的配置文件信息步骤后，此时利用SqlSessionFactory创建的SqlSession已经有了配置文件的全部信息。同时SqlSession还会有一个executor执行器，用来具体执行sql语句

二、UserMapper mapper = sqlSession.getMapper(UserMapper.class);
MyBatis执行SQL的两种方式：SqlSession和Mapper接口

执行sql语句有两种方式，通过sqlSession直接发送sql语句，以及通过SqlSession再获取一个Mapper接口，再通过Mapper接口发送执行sql语句。这里选择的是Mapper接口方式，这样会更加优雅

SqlSession运行过程

SqlSession是一个接口。我们构建SqlSessionFactory就可以轻易地拿到SqlSession。通过SqlSession，我们拿到Mapper，之后可以做查询、插入、更新、删除的方法。其实getMapper()方法拿到的mapper是通过Java动态代理实现的。从getMapper()方法逐级往下看，可以发现在MapperRegistry类的getMapper()方法中会拿到一个MapperProxyFactory的对象，最后是通过MapperProxyFactory对象去生成一个Mapper的。

MyBatis只用Mapper接口便能够运行SQL，因为映射器的XML文件的命名空间namespace对应的便是这个接口的全路径，那么它根据全路径和方法名便能够绑定起来，通过动态代理技术，让这个接口跑起来。而后采用命令模式，最后还是使用SqlSession接口的方法使得它能够执行查询，有了这层封装我们便可以使用这个接口编程。
不过还是可以看到，最后插入、更新、删除、查询操作还是会回到SqlSession中进行处理。

这篇博客也解析了SqlSession的运行原理，建议看一下

三、List userList = mapper.getUserList();
指定需要实现的UserMapper接口里面的抽象类，Mapper映射文件的namespace与接口绑定，然后是执行

 <select id="getUserList" resultType="com.pojo.User">
        select * from mybatis.user
    </select>

id与接口方法相对应，正是测试方法里面要执行的方法，resultType则是指明返回类型

之后就是遍历输入获取的结果集，是一个list集合，集合中的每个User对象都是一条sql语句的查询结果

结果为
在这里插入图片描述
select * from mybatis.user

mybatis是数据库名字，user是具体的表名，* 里面包含表里面的全部字段，id，name，pwd。一条sql语句可以查询一个用户的这些字段信息，而这些字段又与实体类User里面的属性变量相对应，因此一个实体类User对象就是一个用户的信息

一纸春秋

关注

0
点赞
踩
3

收藏

觉得还不错? 一键收藏
打赏
0
评论
Mybatis笔记 —— 运行环境的搭建与Mybatis框架的运行过程分析

本篇博客是根据B站up @遇见狂神说的视频以及 Mybatis官网文档整理的笔记，里面会有一些视频的代码和官网的概念，以及我个人的注释笔记，代码例子等。还有很多总结内容，是我自己总结的，只是分享一些个人的看法，仅供参考全篇博客包括代码均为自己手打，结果截图均为自己运行的结果。以下是视频链接https://www.bilibili.com/video/BV1NE411Q7Nx?p=21Mybatis官网文档链接https://mybatis.org/mybatis-3/zh/index.htm
复制链接

扫一扫