Mybatis插件运行原理及自定义插件

笑的像个child2024-01-02 9:58

引言

MyBatis是一个流行的持久层框架，它提供了许多强大的功能来简化数据库访问和映射。其中一个非常重要的特性是插件（Interceptor），它允许开发者在MyBatis的执行过程中插入自定义逻辑，以实现对SQL执行过程的定制化。

本文将深入探讨MyBatis插件的运行原理，解释插件是如何在MyBatis执行过程中发挥作用的。通过深入理解MyBatis插件的内部工作原理，开发者可以更好地利用插件来扩展和定制MyBatis的功能，满足特定的需求和场景。

在本文中，我们将探讨MyBatis插件的核心概念和原理，帮助读者深入理解插件的工作机制，并学会如何编写和使用自定义插件来增强MyBatis的功能。

Mybatis插件运行原理

MyBatis插件是MyBatis框架提供的一种扩展机制，可以在MyBatis的执行过程中插入自定义的逻辑。插件的运行原理主要涉及到MyBatis的拦截器机制。

Mybatis只支持针对ParameterHandler、ResultSetHandler、StatementHandler、Executor这4种接口

MyBatis插件通过实现Interceptor接口（或者使用配置文件），并重写intercept方法来实现自定义的逻辑。在intercept方法中，可以对MyBatis的执行过程进行拦截，并在特定的时机插入自定义的逻辑。比如在SQL语句执行前后、参数处理前后等时机。

当MyBatis执行SQL语句时，插件会拦截这个过程，并执行自定义的逻辑。这样就可以在不修改MyBatis源代码的情况下，对MyBatis的执行过程进行扩展和定制化。

ParameterHandler接口

ParameterHandler

ParameterHandler是MyBatis框架中的一个接口，用于处理SQL语句中的参数。它负责将用户传入的参数设置到SQL语句中，以便执行SQL操作。

ParameterHandler接口的主要方法包括：

  1. setParameters(PreparedStatement ps)：该方法用于设置SQL语句中的参数。在执行SQL语句之前，ParameterHandler会调用setParameters方法，将用户传入的参数设置到PreparedStatement中。

  2. getParameterObject()：该方法用于获取用户传入的参数对象。

ParameterHandler的实现类会根据不同的参数类型，将参数设置到SQL语句中，比如基本类型、Map类型、JavaBean类型等。它可以处理各种不同类型的参数，并将它们设置到SQL语句中，以便执行数据库操作。

在MyBatis中，ParameterHandler通常与其他组件一起工作，比如StatementHandler、ResultSetHandler等，共同完成SQL语句的执行和结果的处理。ParameterHandler在MyBatis框架中扮演着重要的角色，负责处理SQL语句中的参数，确保SQL语句的正确执行。

java 复制代码 
package com.example.interviewtest.handler;

import org.apache.ibatis.executor.parameter.ParameterHandler;

import java.sql.PreparedStatement;
import java.sql.SQLException;

public class MyParameterHandler implements ParameterHandler {

    @Override
    public Object getParameterObject() {
        return null;
    }

    @Override
    public void setParameters(PreparedStatement ps) throws SQLException {

    }
}

在配置文件中配置

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>
    <plugins>
        <plugin interceptor="com.example.interviewtest.handler.MyParameterHandler"/>
    </plugins>
</configuration>

ResultSetHandler接口

ResultSetHandler

ResultSetHandler是MyBatis框架中的一个接口，用于处理SQL查询结果集。它负责将数据库返回的结果集转换为Java对象，并提供给用户使用。

ResultSetHandler接口的主要方法包括：

  1. handleResultSets(Statement stmt)：该方法用于处理SQL查询返回的结果集。ResultSetHandler会将结果集转换为Java对象，并返回给用户。
  2. handleOutputParameters(CallableStatement cs)：该方法用于处理存储过程的输出参数。
  3. handleCursorResultSets(Statement stmt)：用于处理SQL查询返回的游标结果集。在某些数据库中，查询结果可能是一个游标，而不是一次性返回所有数据。

ResultSetHandler的实现类会根据用户的需求，将数据库返回的结果集转换为不同的Java对象，比如List、Map、JavaBean等。它可以处理各种不同类型的查询结果，并将它们转换为用户需要的数据结构。

java 复制代码 
package com.example.interviewtest.handler;

import org.apache.ibatis.cursor.Cursor;
import org.apache.ibatis.executor.resultset.ResultSetHandler;

import java.sql.CallableStatement;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.List;

public class MyResultSetHandler implements ResultSetHandler {
    @Override
    public <E> List<E> handleResultSets(Statement stmt) throws SQLException {
        return null;
    }

    @Override
    public <E> Cursor<E> handleCursorResultSets(Statement stmt) throws SQLException {
        return null;
    }

    @Override
    public void handleOutputParameters(CallableStatement cs) throws SQLException {
        // 处理存储过程的输出参数
    }
}

配置文件中配置该插件

xml 复制代码 
<plugin interceptor="com.example.interviewtest.handler.MyResultSetHandler"/>

StatementHandler接口

StatementHandler

StatementHandler接口，用于处理SQL语句的执行过程。它在MyBatis的执行过程中起着关键的作用，负责对SQL语句的执行过程进行拦截和处理。

StatementHandler接口定义了对SQL语句的执行过程进行拦截和处理的方法，主要包括以下几个方法：

  1. prepare：用于在SQL语句执行之前进行准备工作，比如对SQL语句进行预处理、参数的设置等。

  2. parameterize：用于对SQL语句的参数进行处理，比如对参数进行转换、验证等。

  3. batch：用于批量执行SQL语句。

  4. update：用于执行更新操作的SQL语句。

  5. query：用于执行查询操作的SQL语句。

  6. queryCursor：用于执行查询并返回一个游标（Cursor）。

  7. getBoundSql：用于获取绑定的SQL对象，该对象包含了SQL语句以及绑定的参数信息。

  8. getParameterHandler：用于获取参数处理器对象，该对象负责处理SQL语句中的参数。

通过实现StatementHandler接口，可以自定义对SQL语句执行过程的拦截和处理逻辑，从而实现对SQL语句执行过程的定制化。

在MyBatis中，可以通过自定义插件来实现对StatementHandler的定制化处理。通过自定义插件，可以在SQL语句执行过程中插入自定义的逻辑，比如对SQL语句进行修改、参数的处理等。这样可以实现对MyBatis的功能进行扩展和定制，满足特定的需求。

java 复制代码 
package com.example.interviewtest.handler;

import org.apache.ibatis.cursor.Cursor;
import org.apache.ibatis.executor.parameter.ParameterHandler;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.session.ResultHandler;

import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.List;

/**
 * @Author YZK
 * @Date 2024/1/1
 * @Desc
 */
public class MyStatementHandler implements StatementHandler {
    @Override
    public Statement prepare(Connection connection, Integer transactionTimeout) throws SQLException {
        return null;
    }

    @Override
    public void parameterize(Statement statement) throws SQLException {

    }

    @Override
    public void batch(Statement statement) throws SQLException {

    }

    @Override
    public int update(Statement statement) throws SQLException {
        return 0;
    }

    @Override
    public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException {
        return null;
    }

    @Override
    public <E> Cursor<E> queryCursor(Statement statement) throws SQLException {
        return null;
    }

    @Override
    public BoundSql getBoundSql() {
        return null;
    }

    @Override
    public ParameterHandler getParameterHandler() {
        return null;
    }
}

配置方式与上文相同

Executor接口

Executor

MyBatis中的Executor是一个关键接口（该接口方法较多，只陈述其主要职责），负责执行SQL语句、管理事务以及处理缓存。它是MyBatis中负责实际执行数据库操作的组件之一。Executor接口有多种实现，包括SimpleExecutor、ReuseExecutor和BatchExecutor，每种实现都有其特定的特性和行为。

以下是Executor接口的主要职责：

  1. 执行SQL语句：Executor负责执行SQL语句，包括插入、更新、删除和查询操作。它与StatementHandler交互，准备和参数化SQL语句，然后执行它。

  2. 管理事务：Executor负责管理事务的提交、回滚和关闭。它与Transaction接口交互，确保事务的一致性和持久性。

  3. 处理缓存：Executor负责处理一级缓存和二级缓存。它会根据配置和需求来管理缓存的生命周期，以提高性能并确保数据的一致性。

  4. 处理结果集：Executor负责处理从数据库返回的结果集，将结果映射为Java对象，并将其返回给调用方。

通过实现Executor接口或者使用其默认实现，可以对MyBatis的执行过程进行定制化，以满足特定的需求和场景。

java 复制代码 
package com.example.interviewtest.handler;

import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.cursor.Cursor;
import org.apache.ibatis.executor.BatchResult;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.transaction.Transaction;

import java.sql.SQLException;
import java.util.List;

/**
 * @Author YZK
 * @Date 2024/1/1
 * @Desc
 */
public class MyExecutorHandler implements Executor {
    @Override
    public int update(MappedStatement ms, Object parameter) throws SQLException {
        return 0;
    }

    @Override
    public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey cacheKey, BoundSql boundSql) throws SQLException {
        return null;
    }

    @Override
    public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
        return null;
    }

    @Override
    public <E> Cursor<E> queryCursor(MappedStatement ms, Object parameter, RowBounds rowBounds) throws SQLException {
        return null;
    }

    @Override
    public List<BatchResult> flushStatements() throws SQLException {
        return null;
    }

    @Override
    public void commit(boolean required) throws SQLException {

    }

    @Override
    public void rollback(boolean required) throws SQLException {

    }

    @Override
    public CacheKey createCacheKey(MappedStatement ms, Object parameterObject, RowBounds rowBounds, BoundSql boundSql) {
        return null;
    }

    @Override
    public boolean isCached(MappedStatement ms, CacheKey key) {
        return false;
    }

    @Override
    public void clearLocalCache() {

    }

    @Override
    public void deferLoad(MappedStatement ms, MetaObject resultObject, String property, CacheKey key, Class<?> targetType) {

    }

    @Override
    public Transaction getTransaction() {
        return null;
    }

    @Override
    public void close(boolean forceRollback) {

    }

    @Override
    public boolean isClosed() {
        return false;
    }

    @Override
    public void setExecutorWrapper(Executor executor) {

    }
}

参考文档

mybatis插件运行原理及开发流程_哔哩哔哩_bilibili

配置_MyBatis中文网

相关推荐
江-小北几秒前
Java基础面试题04：Iterator 和 ListIterator 的区别是什么？
java·开发语言
wmd131643067124 分钟前
IDEA插件CamelCase,快速转变命名格式
java·ide·intellij-idea
捂月38 分钟前
Spring Boot 核心逻辑与工作原理详解
java·spring boot·后端
埋头编程~40 分钟前
【C++】踏上C++学习之旅（十）：深入“类和对象“世界，掌握编程黄金法则（五）（最终篇，内含初始化列表、静态成员、友元以及内部类等等）
java·c++·学习
菜鸟起航ing1 小时前
Java中日志采集框架-JUL、Slf4j、Log4j、Logstash
java·开发语言·log4j·logback
Nightselfhurt1 小时前
RPC学习
java·spring boot·后端·spring·rpc
苹果醋31 小时前
vue3 在哪些方便做了性能提升？
java·运维·spring boot·mysql·nginx
孔汤姆1 小时前
部署实战(二)--修改jar中的文件并重新打包成jar文件
java·pycharm·jar
Abladol-aj2 小时前
并发和并行的基础知识
java·linux·windows
清水白石0082 小时前
从一个“支付状态不一致“的bug,看大型分布式系统的“隐藏杀机“
java·数据库·bug
热门推荐
01ICLR24大模型提示(1/11) | BadChain：大型语言模型的后门思维链提示02PyTorch机器学习实现液态神经网络03【HarmonyOS】HUAWEI DevEco Studio 下载地址汇总04【音视频 | opus】opus编解码库(opus-1.4)详细介绍以及使用——附带解码示例代码05Coze扣子平台完整体验和实践（附国内和国际版对比）06(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明07IT专业入门，高考假期预习指南08玄机平台应急响应—webshell查杀09RAG 实践- Ollama+RagFlow 部署本地知识库10微前端micro-app踩坑记录