首页 > 其他分享 >『手写Mybatis』创建简单的映射器代理工厂

『手写Mybatis』创建简单的映射器代理工厂

时间:2024-06-16 20:44:21浏览次数:25  
标签:MapperProxy 映射器 数据库 代理 mapperInterface sqlSession Mybatis 操作 手写

前言

在阅读本文之前,我相信你已经是一个 Mybatis ORM 框架工具使用的熟练工了,那你是否清楚这个 ORM 框架是怎么屏蔽我们对数据库操作的细节的?

比如我们使用 JDBC 的时候,需要手动建立数据库链接、编码 SQL 语句、执行数据库操作、自己封装返回结果等。

但在使用 ORM 框架后,只需要通过简单配置即可对定义的 DAO 接口进行数据库的操作了。

设计

通常如果能找到大家所在事情的共性内容,具有统一的流程处理,那么它就是可以被凝聚和提炼的,做成通用的组件或者服务,被所有人进行使用,减少重复的人力投入。

而参考我们最开始使用 JDBC 的方式,从连接、查询、封装、返回,其实都一个固定的流程,那么这个过程就可以被提炼以及封装和补全大家所需要的功能。

当我们来设计一个 ORM 框架的过程中,首先要考虑怎么把用户定义的数据库操作接口、xml 配置的 SQL 语句、数据库三者联系起来。其实最适合的操作就是使用代理的方式进行处理,因为代理可以封装一个复杂的流程,来作用于接口的实现类,设计图如下:

来看一下这个设计图的流程:

  1. 首先提供一个映射器的代理实现类 MapperProxy,通过代理类包装对数据库的操作,目前我们本章节会先提供一个简单的包装,模拟对数据库的调用。
  2. 之后对 MapperProxy 代理类,提供工厂实例化操作 MapperProxyFactory#newInstance #newInstance 意思是 MapperProxyFactory 中有一个 newInstance 方法,用来创建 MapperProxy 实例,为每个 IDAO 接口生成代理类。这块其实用到的就是一个简单工厂模式。

接下来我们就按照这个设计实现一个简单的映射器代理操作,编码过程比较简单。如果对代理知识不熟悉可以先补充下代理的知识。

实现

工程结构

step-01
└─src
    ├─main
    │  ├─java
    │  │  └─top
    │  │      └─it6666
    │  │          └─mybatis
    │  │              └─binding
    │  └─resources
    └─test
        └─java
            └─top
                └─it6666
                    └─test
                        └─dao

工程源码:https://github.com/BNTang/Java-All/tree/main/mybatis-source-code/step-01

MyBatis 映射器代理类关系:

  • 目前这个 MyBatis 框架的代理操作实现的还只是最核心的功能,相当于是光屁股的娃娃,还没有添加衣服。不过这样渐进式的实现可以让大家先了解到最核心的内容,后续我们在陆续的完善。
  • MapperProxy 负责实现 InvocationHandler 接口的 invoke 方法,最终所有的实际调用都会调用到这个方法包装的逻辑。

  • MapperProxyFactory 是对 MapperProxy 的包装,对外提供实例化对象的操作。

当我们后面开始给每个操作数据库的接口映射器注册代理的时候,就需要使用到这个工厂类了。

映射器代理类

源码详见:top.it6666.mybatis.binding.MapperProxy

/**
 * 映射器代理类
 *
 * @author BNTang
 */
public class MapperProxy<T> implements InvocationHandler, Serializable {

    private static final long serialVersionUID = -6424540398559729838L;

    private final Map<String, String> sqlSession;
    private final Class<T> mapperInterface;

    public MapperProxy(Map<String, String> sqlSession, Class<T> mapperInterface) {
        this.sqlSession = sqlSession;
        this.mapperInterface = mapperInterface;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        if (Object.class.equals(method.getDeclaringClass())) {
            return method.invoke(this, args);
        } else {
            return "你的被代理了!" + sqlSession.get(mapperInterface.getName() + "." + method.getName());
        }
    }
}
  1. 通过实现 InvocationHandler#invoke(#后面紧跟的是方法名,意思说的是 InvocationHandler 接口中的 invoke 方法)代理类接口,封装操作逻辑的方式,对外接口提供数据库操作对象。
  2. 目前这里只是简单的封装了一个 sqlSessionMap 对象,你可以想象成所有的数据库语句操作,都是通过 接口名称+方法名 称作为 key,操作作为逻辑的方式进行使用的。那么在反射调用中则获取对应的操作直接执行并返回结果即可。当然这还只是最核心的简化流程,后续不断补充内容后,会看到对数据库的操作。
  3. 另外这里要注意如果是 Object 提供的 toString、hashCode 等方法是不需要代理执行的,所以添加 Object.class.equals(method.getDeclaringClass()) 判断。

代理类工厂

源码详见:top.it6666.mybatis.binding.MapperProxyFactory

/**
 * 代理类工厂
 * @author BNTang
 */
public class MapperProxyFactory<T> {
    private final Class<?> mapperInterface;

    public MapperProxyFactory(Class<?> mapperInterface) {
        this.mapperInterface = mapperInterface;
    }

    public T newInstance(Map<String, String> sqlSession) {
        final MapperProxy<T> mapperProxy = (MapperProxy<T>) new MapperProxy<>(sqlSession, mapperInterface);
        return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[]{mapperInterface}, mapperProxy);
    }
}
  1. 工厂操作相当于把代理的创建给封装起来了,如果不做这层封装,那么每一个创建代理类的操作,都需要自己使用 Proxy.newProxyInstance 进行处理,那么这样的操作方式就显得比较麻烦了。
  2. 另外如果你对代理不是太熟悉,可以着重把 JDK Proxy 的内容做几个案例补充下这块的内容,或者可以去看看我之前写的代理的文章。(https://www.cnblogs.com/BNTang/articles/13769281.html)

测试

事先准备

top.it6666.test.dao.IUserDao:

public interface IUserDao {
    String queryUserName(String uId);

    Integer queryUserAge(String uId);
}
  • 首先提供一个 DAO 接口,并定义2个接口方法,一个是查询用户名称,一个是查询用户年龄。

测试用例

top.it6666.test:

/**
 * @author BNTang
 * @version 1.0
 * @description 测试类
 * @since 2024/4/16 星期二
 **/
public class ApiTest {
    private final Logger logger = LoggerFactory.getLogger(ApiTest.class);

    @Test
    public void test_MapperProxyFactory() {
        MapperProxyFactory<IUserDao> factory = new MapperProxyFactory<>(IUserDao.class);
        Map<String, String> sqlSession = new HashMap<>();

        sqlSession.put("top.it6666.test.dao.IUserDao.queryUserName", "模拟执行 Mapper.xml 中 SQL 语句的操作:查询用户姓名");
        sqlSession.put("top.it6666.test.dao.IUserDao.queryUserAge", "模拟执行 Mapper.xml 中 SQL 语句的操作:查询用户年龄");
        IUserDao userDao = factory.newInstance(sqlSession);

        String res = userDao.queryUserName("10001");
        logger.info("测试结果:{}", res);
    }
}
  • 在单测中创建 MapperProxyFactory 工厂,并手动给 sqlSession Map 赋值,这里的赋值相当于模拟数据库中的操作。
  • 接下来再把赋值信息传递给代理对象实例化操作,这样就可以在我们调用具体的 DAO 方法时从 sqlSession 中取值了。

测试结果:

00:33:41.903 [main] INFO  top.it6666.test.ApiTest - 测试结果:你的被代理了!模拟执行 Mapper.xml 中 SQL 语句的操作:查询用户姓名

从测试结果可以看到,我们的接口已经被代理类实现了,同时我们可以在代理类中进行自己的操作封装。那么在我们后续实现的数据库操作中,就可以对这部分内容进行扩展了。

总结

  • 本章节我们初步对 MyBatis 框架中的数据库 DAO 操作接口和映射器通过代理类的方式进行链接,这一步也是 ORM 框架里非常核心的部分。有了这块的内容,就可以在代理类中进行自己逻辑的扩展了。
  • 在框架实现方面引入简单工厂模式包装代理类,屏蔽创建细节,这些也是大家在学习过程中需要注意的设计模式的点。
  • 目前内容还比较简单的,可以手动操作练习,随着我们内容的增加,会有越来越多的包和类引入,完善 ORM 框架功能。

结束语

着急和快,是最大的障碍!慢下来,慢下来,只有慢下来,你才能看到更全的信息,才能学到更扎实的技术。而那些满足你快的短篇内容虽然有时候更抓眼球,但也容易把人在技术学习上带偏,总想着越快越好。

如果您觉得文章对您有所帮助,欢迎您点赞、评论、转发,也欢迎您关注我的公众号『BNTang』,我会在公众号中分享更多的技术文章。

标签:MapperProxy,映射器,数据库,代理,mapperInterface,sqlSession,Mybatis,操作,手写
From: https://www.cnblogs.com/BNTang/p/18251216

相关文章

  • 『手写Mybatis』实现映射器的注册和使用
    前言如何面对复杂系统的设计?我们可以把Spring、MyBatis、Dubbo这样的大型框架或者一些公司内部的较核心的项目,都可以称为复杂的系统。这样的工程也不在是初学编程手里的玩具项目,没有所谓的CRUD,更多时候要面对的都是对系统分层的结构设计和聚合逻辑功能的实现,再通过层层转换......
  • 带你学习Mybatis之执行器Executor
    执行器ExecutorExecutor定义了数据库操作的基本方法,SqlSession接口中的功能都是基于Executor接口实现的,真正执行java和数据库交互的类,负责维护一级缓存和二级缓存,并提供事务管理的相关操作,会将数据库相关操作委托给StatementHandler完成public enum ExecutorType { ......
  • MyBatis 的缓存机制
    1.MyBatis的缓存机制@目录1.MyBatis的缓存机制2.准备工作3.MyBatis的一级缓存3.1一级缓存失效情况/条件4.MyBatis的二级缓存5.MyBatis集成EhCache第三方缓存6.总结:7.最后:缓存(Cache)缓存的作用:通过减少IO的方式,来提高程序的执行效率。MyBatis的缓存:将Sele......
  • mybatis plus 启用 mybatis插件
      mybatisplus启用mybatis插件在使用MyBatis-Plus时,要启用MyBatis插件,你需要遵循以下步骤:实现自定义插件:创建一个类,实现Interceptor接口。注册插件:在MyBatis配置文件中或通过Java配置方式注册插件。下面是一个简单的自定义MyBatis插件示例:imp......
  • MyBatis 特殊SQL执行技巧与注意事项
    在MyBatis中,处理特殊SQL查询时,需要格外注意SQL注入的风险以及参数的绑定方式。下面将详细介绍几种常见的特殊SQL执行场景,并提供相应的MyBatis实现方式及注意事项。一、模糊查询/***根据用户名进行模糊查询*@paramusername*@returnjava.util.List<com.exampl......
  • 实现一个简单的mybatis:SimpleMyBatis
    创建一个类似MyBatis的框架,主要涉及到几个关键部分:SQL语句的解析与存储,参数的绑定,以及最终的SQL执行。以下是一个简单的示例,使用Java、JDBC和SQLite数据库来实现:importjava.sql.Connection;importjava.sql.DriverManager;importjava.sql.PreparedStatement;importja......
  • Mybatis和Hibernate的作用区别及底层原理分析
    目录Mybatis的作用及底层原理Hibernate的作用及底层原理Mybatis与Hibernate的主要区别Mybatis和Hibernate都是Java应用程序中常用的ORM(Object-RelationalMapping,对象关系映射)框架,它们的主要作用是简化数据库访问层的开发,将数据库操作映射为面向对象的编程方式,从而提高......
  • Mybatis框架中结果映射resultMap标签方法属性收录
    Mybatis框架中结果映射resultMap标签收录在MyBatis框架中,resultMap是一种强大的机制,用于将数据库结果集映射到Java对象上。它允许你定义如何将查询结果中的列映射到Java对象的属性上,尤其是当数据库表的字段名与Java对象的属性名不一致时,或者需要进行复杂的映射(如一对一、......
  • springboot+vue+mybatis家电系统+PPT+论文+讲解+售后
    随着信息互联网购物的飞速发展,一般企业都去创建属于自己的电商平台以及购物管理系统。本文介绍了家电销售系统的开发全过程。通过分析企业对于家电销售系统的需求,创建了一个计算机管理家电销售系统的方案。文章介绍了家电销售系统的系统分析部分,包括可行性分析等,系统设计部分主......
  • mybatis之特殊SQL的执行
    1.1模糊查询尝试://模糊查询用户List<User>getUserByLike(@Param("mohu")Stringmohu);<selectid="getUserByLike"resultType="user">select*fromuserwhereusernamelike'%#{mohu}%'</select>@Testpub......