快捷導(dǎo)航

MyBatis插件開發(fā)的完整詳細例子(附注釋和總結(jié))

更新時間：2025年04月27日 10:28:40 作者：愛的嘆息

這篇文章主要介紹了MyBatis插件開發(fā)的完整詳細例子,通過示例代碼和詳細注釋,展示了如何在不同接口和方法中實現(xiàn)自定義邏輯,如日志記錄、SQL修改、參數(shù)處理和結(jié)果集處理,文中給出了詳細的代碼示例,需要的朋友可以參考下

1. MyBatis 插件基礎(chǔ)

MyBatis 允許攔截以下接口的方法：

Executor：update, query, flushStatements, commit, rollback, getTransaction, close, isClosed
ParameterHandler：getParameterObject, setParameters
ResultSetHandler：handleResultSets, handleCursorResultSets, handleOutputParameters
StatementHandler：prepare, parameterize, batch, update, query

2. 插件開發(fā)示例

2.1. 自定義插件類

創(chuàng)建一個自定義插件類 MyPlugin，該插件將攔截 Executor 的 query 方法和 StatementHandler 的 prepare 方法。

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.statement.StatementHandler;

import java.sql.Connection;
import java.sql.Statement;
import java.util.Properties;

@Intercepts({
    @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
    @Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})
})
public class MyPlugin implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 獲取被攔截方法的參數(shù)
        Object[] args = invocation.getArgs();

        // 攔截 Executor.query 方法
        if (invocation.getTarget() instanceof Executor) {
            MappedStatement ms = (MappedStatement) args[0];
            Object parameter = args[1];
            RowBounds rowBounds = (RowBounds) args[2];
            ResultHandler resultHandler = (ResultHandler) args[3];

            BoundSql boundSql = ms.getBoundSql(parameter);
            String sql = boundSql.getSql();
            System.out.println("Executing SQL: " + sql);

            // 執(zhí)行原方法
            return invocation.proceed();
        }

        // 攔截 StatementHandler.prepare 方法
        if (invocation.getTarget() instanceof StatementHandler) {
            StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
            Connection connection = (Connection) args[0];
            Integer integer = (Integer) args[1];

            // 獲取原始 SQL
            BoundSql boundSql = statementHandler.getBoundSql();
            String originalSql = boundSql.getSql();
            System.out.println("Original SQL: " + originalSql);

            // 修改 SQL（例如添加注釋）
            String newSql = "/* MyPlugin */ " + originalSql;
            BoundSql newBoundSql = new BoundSql(
                boundSql.getMappedStatement().getConfiguration(),
                newSql,
                boundSql.getParameterMappings(),
                boundSql.getParameterObject()
            );
            MetaObject metaObject = SystemMetaObject.forObject(statementHandler);
            metaObject.setValue("delegate.boundSql", newBoundSql);

            // 執(zhí)行原方法
            return invocation.proceed();
        }

        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        // 使用 Plugin.wrap 包裝目標對象
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
        // 設(shè)置插件屬性（可選）
    }
}

2.2. 配置插件

在 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>
    <!-- 配置插件 -->
    <plugins>
        <plugin interceptor="com.example.plugin.MyPlugin">
            <!-- 可以設(shè)置插件屬性 -->
            <!-- <property name="propertyName" value="propertyValue"/> -->
        </plugin>
    </plugins>

    <!-- 其他配置... -->
</configuration>

2.3. 測試插件

編寫測試代碼來驗證插件的功能：

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.Reader;

public class PluginTest {
    public static void main(String[] args) throws Exception {
        // 讀取 MyBatis 配置文件
        Reader reader = Resources.getResourceAsReader("mybatis-config.xml");
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);

        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);

            // 執(zhí)行查詢操作，觸發(fā)插件攔截
            User user = mapper.selectUserById(1L);
            System.out.println("User: " + user.getName());
        }
    }
}

3. 核心使用場景

3.1. 日志記錄

在 Executor 的 query 和 update 方法中添加日志記錄，便于調(diào)試和監(jiān)控。

3.2. SQL 修改

在 StatementHandler 的 prepare 方法中修改 SQL 語句，例如添加統(tǒng)一的注釋或進行性能優(yōu)化。

3.3. 參數(shù)處理

在 ParameterHandler 的 setParameters 方法中對參數(shù)進行預(yù)處理，如加密、格式化等。

3.4. 結(jié)果集處理

在 ResultSetHandler 的 handleResultSets 方法中對結(jié)果集進行后處理，如數(shù)據(jù)脫敏、緩存等。

4. 表格整理總結(jié)

場景	攔截接口及方法	具體應(yīng)用	示例代碼片段
日志記錄	`Executor.query`, `Executor.update`	在執(zhí)行 SQL 前后記錄日志	`System.out.println("Executing SQL: " + sql);`
SQL 修改	`StatementHandler.prepare`	修改或優(yōu)化 SQL 語句	`String newSql = "/* MyPlugin */ " + originalSql;`
參數(shù)處理	`ParameterHandler.setParameters`	對參數(shù)進行預(yù)處理（如加密）	`preparedStatement.setString(1, encrypt(parameter));`
結(jié)果集處理	`ResultSetHandler.handleResultSets`	對查詢結(jié)果進行后處理（如脫敏）	`resultList.forEach(item -> item.setEmail(maskEmail(item.getEmail())));`
性能監(jiān)控	`Executor.query`, `Executor.update`	記錄 SQL 執(zhí)行時間	`long startTime = System.currentTimeMillis(); ... long endTime = ...`
分頁支持	`StatementHandler.parameterize`	動態(tài)添加分頁參數(shù)	`preparedStatement.setInt(1, offset); preparedStatement.setInt(2, limit);`