Mybatis 最核心的原理

一、前言

Mybatis 最核心的原理也是它最便于使用的体现,为什么这说?

因为我们在使用 Mybatis 的时候,只需要定义一个不需要写实现类的接口,就能通过注解或者配置 SQL 语句的方式,对数据库进行 CRUD 操作。

那么这是怎么做到的呢,其中有一点非常重要,就是在 Spring 中可以把你的代理对象交给 Spring 容器,这个代理对象就是可以当做是 DAO 接口的具体实现类,而这个被代理的实现类就可以完成对数据库的一个操作,也就是这个封装过程被称为 ORM 框架。

说了基本的流程,我们来做点测试,让大家可以动手操作起来!学知识,一定是上手,才能得到!你可以通过以下源码仓库进行练习

 


二、把 Bean 塞到 Spring 容器,分几步

  • 关于 Bean 注册的技术场景,在我们日常用到的技术框架中,MyBatis 是最为常见的。通过在使用 MyBatis 时都只是定义一个接口不需要写实现类,但是这个接口却可以和配置的 SQL 语句关联,执行相应的数据库操作时可以返回对应的结果。那么这个接口与数据库的操作就用到的 Bean 的代理和注册。

  • 我们都知道类的调用是不能直接调用没有实现的接口的,所以需要通过代理的方式给接口生成对应的实现类。接下来再通过把代理类放到 Spring 的 FactoryBean 的实现中,最后再把这个 FactoryBean 实现类注册到 Spring 容器。那么现在你的代理类就已经被注册到 Spring 容器了,接下来就可以通过注解的方式注入到属性中。

按照这个实现方式,我们来操作一下,看看一个 Bean 的注册过程在代码中是如何实现的。

1. 定义接口

public interface IUserDao {
    String queryUserInfo();
}

复制代码

  • 先定义一个类似 DAO 的接口,基本这样的接口在使用 MyBatis 时还是非常常见的。后面我们会对这个接口做代理和注册。

2. 类代理实现

ClassLoader classLoader = Thread.currentThread().getContextClassLoader();Class<?>[] classes = {IUserDao.class};    
InvocationHandler handler = (proxy, method, args) -> "你被代理了 " + method.getName();IUserDao userDao = (IUserDao) Proxy.newProxyInstance(classLoader, classes, handler); 
String res = userDao.queryUserInfo();logger.info("测试结果:{}", res);

复制代码

  • Java 本身的代理方式使用起来还是比较简单的,用法也很固定。

  • InvocationHandler 是个接口类,它对应的实现内容就是代理对象的具体实现。

  • 最后就是把代理交给 Proxy 创建代理对象,Proxy.newProxyInstance

3. 实现 Bean 工厂

public class ProxyBeanFactory implements FactoryBean {
    @Override    public Object getObject() throws Exception {
        ClassLoader classLoader = Thread.currentThread().getContextClassLoader();        Class[] classes = {IUserDao.class};        InvocationHandler handler = (proxy, method, args) -> "你被代理了 " + method.getName();
        return Proxy.newProxyInstance(classLoader, classes, handler);    }
    @Override    public Class<?> getObjectType() {        return IUserDao.class;    } 
}

复制代码

  • FactoryBean 在 spring 起到着二当家的地位,它将近有 70 多个小弟(实现它的接口定义),那么它有三个方法;

  • T getObject() throws Exception; 返回 bean 实例对象

  • Class<?> getObjectType(); 返回实例类类型

  • boolean isSingleton(); 判断是否单例,单例会放到 Spring 容器中单实例缓存池中

  • 在这里我们把上面使用 Java 代理的对象放到了 getObject() 方法中,那么现在再从 Spring 中获取到的对象,就是我们的代理对象了。

4. Bean 注册

public class RegisterBeanFactory implements BeanDefinitionRegistryPostProcessor {
    @Override    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        GenericBeanDefinition beanDefinition = new GenericBeanDefinition();        beanDefinition.setBeanClass(ProxyBeanFactory.class);
        BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(beanDefinition, "userDao");        BeanDefinitionReaderUtils.registerBeanDefinition(definitionHolder, registry);    }
}

复制代码

在 Spring 的 Bean 管理中,所有的 Bean 最终都会被注册到类 DefaultListableBeanFactory 中,以上这部分代码主要的内容包括:

  • 实现 BeanDefinitionRegistryPostProcessor.postProcessBeanDefinitionRegistry 方法,获取 Bean 注册对象。

  • 定义 Bean,GenericBeanDefinition,这里主要设置了我们的代理类工厂。

  • 创建 Bean 定义处理类,BeanDefinitionHolder,这里需要的主要参数;定义 Bean 和名称 setBeanClass(ProxyBeanFactory.class)

  • 最后将我们自己的 bean 注册到 spring 容器中去,registry.registerBeanDefinition()

5. 测试验证

在上面我们已经把自定义代理的 Bean 注册到了 Spring 容器中,接下来我们来测试下这个代理的 Bean 被如何调用。

1. 定义 spring-config.xml
<bean id="userDao" class="org.itstack.interview.bean.RegisterBeanFactory"/>

复制代码

  • 这里我们把 RegisterBeanFactory 配置到 spring 的 xml 配置中,便于启动时加载。

2. 单元测试
@Testpublic void test_IUserDao() {    BeanFactory beanFactory = new ClassPathXmlApplicationContext("spring-config.xml");    IUserDao userDao = beanFactory.getBean("userDao", IUserDao.class);    String res = userDao.queryUserInfo();    logger.info("测试结果:{}", res);}

复制代码

测试结果

22:53:14.759 [main] DEBUG o.s.c.e.PropertySourcesPropertyResolver - Could not find key 'spring.liveBeansView.mbeanDomain' in any property source22:53:14.760 [main] DEBUG o.s.b.f.s.DefaultListableBeanFactory - Returning cached instance of singleton bean 'userDao'22:53:14.796 [main] INFO  org.itstack.interview.test.ApiTest - 测试结果:你被代理了 queryUserInfo
Process finished with exit code 0

复制代码

  • 从测试结果可以看到,我们已经可以通过注入到 Spring 的代理 Bean 对象,实现我们的预期结果。

  • 其实这个过程也是很多框架中用到的方式,尤其是在一些中间件开发,类似的 ORM 框架都需要使用到。

三、手写个 Mybatis

扩展上一篇源码分析工程;itstack-demo-mybatis,增加 like 包,模仿 Mybatis 工程。

itstack-demo-mybatis└── src    ├── main    │   ├── java    │   │   └── org.itstack.demo    │   │       ├── dao    │   │       │  ├── ISchool.java        │   │       │  └── IUserDao.java      │   │       ├── like    │   │       │  ├── Configuration.java    │   │       │  ├── DefaultSqlSession.java    │   │       │  ├── DefaultSqlSessionFactory.java    │   │       │  ├── Resources.java    │   │       │  ├── SqlSession.java    │   │       │  ├── SqlSessionFactory.java    │   │       │  ├── SqlSessionFactoryBuilder.java      │   │       │  └── SqlSessionFactoryBuilder.java      │   │       └── interfaces         │   │           ├── School.java      │   │          └── User.java    │   ├── resources      │   │   ├── mapper    │   │   │   ├── School_Mapper.xml    │   │   │   └── User_Mapper.xml    │   │   ├── props      │   │   │   └── jdbc.properties    │   │   ├── spring    │   │   │   ├── mybatis-config-datasource.xml    │   │   │   └── spring-config-datasource.xml    │   │   ├── logback.xml    │   │   ├── mybatis-config.xml    │   │   └── spring-config.xml    │   └── webapp    │       └── WEB-INF    └── test         └── java             └── org.itstack.demo.test                 ├── ApiLikeTest.java                 ├── MybatisApiTest.java                 └── SpringApiTest.java

复制代码

关于整个 Demo 版本,并不是把所有 Mybatis 全部实现一遍,而是拨丝抽茧将最核心的内容展示给你,从使用上你会感受一模一样,但是实现类已经全部被替换,核心类包括;

  • Configuration

  • DefaultSqlSession

  • DefaultSqlSessionFactory

  • Resources

  • SqlSession

  • SqlSessionFactory

  • SqlSessionFactoryBuilder

  • XNode

1. 先测试下整个 DemoJdbc 框架

ApiLikeTest.test_queryUserInfoById()

@Testpublic void test_queryUserInfoById() {    String resource = "spring/mybatis-config-datasource.xml";    Reader reader;    try {        reader = Resources.getResourceAsReader(resource);        SqlSessionFactory sqlMapper = new SqlSessionFactoryBuilder().build(reader);        SqlSession session = sqlMapper.openSession();            try {            User user = session.selectOne("org.itstack.demo.dao.IUserDao.queryUserInfoById", 1L);            System.out.println(JSON.toJSONString(user));        } finally {            session.close();            reader.close();        }    } catch (Exception e) {        e.printStackTrace();    }}

复制代码

一切顺利结果如下(新人往往会遇到各种问题);

{"age":18,"createTime":1576944000000,"id":1,"name":"水水","updateTime":1576944000000}
Process finished with exit code 0

复制代码

可能乍一看这测试类完全和 MybatisApiTest.java 测试的代码一模一样呀,也看不出区别。其实他们的引入的包是不一样;

MybatisApiTest.java 里面引入的包

import org.apache.ibatis.io.Resources;import org.apache.ibatis.session.SqlSession;import org.apache.ibatis.session.SqlSessionFactory;import org.apache.ibatis.session.SqlSessionFactoryBuilder;

复制代码

ApiLikeTest.java 里面引入的包

import org.itstack.demo.like.Resources;import org.itstack.demo.like.SqlSession;import org.itstack.demo.like.SqlSessionFactory;import org.itstack.demo.like.SqlSessionFactoryBuilder;

复制代码

好!接下来我们开始分析这部分核心代码。

2. 加载 XML 配置文件

这里我们采用 mybatis 的配置文件结构进行解析,在不破坏原有结构的情况下,最大可能的贴近源码。mybatis 单独使用的使用的时候使用了两个配置文件;数据源配置、Mapper 映射配置,如下;

mybatis-config-datasource.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://127.0.0.1:3306/itstack?useUnicode=true"/>                <property name="username" value="root"/>                <property name="password" value="123456"/>            </dataSource>        </environment>    </environments>
    <mappers>        <mapper resource="mapper/User_Mapper.xml"/>        <mapper resource="mapper/School_Mapper.xml"/>    </mappers>
</configuration>

复制代码

User_Mapper.xml & Mapper 映射配置

<?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="org.itstack.demo.dao.IUserDao">
    <select id="queryUserInfoById" parameterType="java.lang.Long" resultType="org.itstack.demo.po.User">        SELECT id, name, age, createTime, updateTime        FROM user        where id = #{id}    </select>
    <select id="queryUserList" parameterType="org.itstack.demo.po.User" resultType="org.itstack.demo.po.User">        SELECT id, name, age, createTime, updateTime        FROM user        where age = #{age}    </select>
</mapper>

复制代码

这里的加载过程与 mybaits 不同,我们采用 dom4j 方式。在案例中会看到最开始获取资源,如下;

ApiLikeTest.test_queryUserInfoById() & 部分截取

String resource = "spring/mybatis-config-datasource.xml";  Reader reader;  try {    reader = Resources.getResourceAsReader(resource);  ...

复制代码

从上可以看到这是通过配置文件地址获取到了读取流的过程,从而为后面解析做基础。首先我们先看 Resources 类,整个是我们的资源类。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值