Mybatis中攔截器的使用場景和技巧分享

更新時間：2023年10月23日 11:40:09 作者：襄垣

Mybatis提供了一些機制,可以允許我們在做數據庫操作的時候進行我們額外的一些程序,當然,這看起來并沒有JPA的EntityListener好用,本文小編將給大家詳細的介紹了Mybatis中攔截器的使用場景和技巧,需要的朋友可以參考下

場景描述

中小業(yè)務系統中，有時候會面臨一些比較相似的業(yè)務場景。

當XXX創(chuàng)建成功后，需要給XXX推送一條業(yè)務消息；
當XXX更新的時候，需要給XXX推送一條業(yè)務提醒；
當XXX創(chuàng)建OR更新的時候，需要將最新的數據推送到搜索引擎中，以方便其他業(yè)務系統在搜索引擎中能查詢到；
當XXX更新的時候，需要更新分布式緩存的XXX數據；
……

這些場景都有相似的特征，如下

特征	描述
異步	實際上與主流程關系不大，可以作為附屬流程異步執(zhí)行
事務	大多在事務結束之后執(zhí)行
并行	可以串行執(zhí)行，也可以并行執(zhí)行，對最終結果影響不大

Mybatis攔截器

Mybatis提供了一些機制，可以允許我們在做數據庫操作的時候進行我們額外的一些程序。當然，這看起來并沒有JPA的EntityListener好用。

但是通過這些機制，我們可以達成我們主要的目的，解耦合。（解耦合的好處顯而易見，我們在關注主流程業(yè)務的時候，附屬流程的業(yè)務也更容易擴展）

下面是我們即將用到的一些簡單概念，如下

概念	描述
解耦	解耦的本質就是將類之間的直接關系轉換成間接關系
觀察者模式	一種行為設計模式，允許你定義一種訂閱機制，可在對象事件發(fā)生時通知多個“觀察”該對象的其他對象。
EventBus	基于事件驅動，觀察者們監(jiān)聽自己感興趣的特定事件，進行相應的處理。

錨定事件發(fā)生

首先，我們要找到事件發(fā)生的地方，通常來說我們更愿意在業(yè)務代碼里寫

Company company = new Company();
company.setCompanyName(companyName);
companyMapper.insert(company);
// 創(chuàng)建XXX成功后，觸發(fā)了一些操作；
doSomething(company);

但是，這種方式是耦合的，我們在doSomething() 里發(fā)生的一些異常會影響到主流程，而每一次增加附屬流程的改動，都會產生影響范圍的蔓延。

這里，我們使用Mybatis提供的一種方式來錨定事件發(fā)生

@Component
@Intercepts( {
    @Signature(method = "update", type = Executor.class, args = {
        MappedStatement.class,
        Object.class
    })
})
public class EntityInterceptor implements Interceptor {
    private static final Logger LOGGER = LoggerFactory.getLogger(EntityInterceptor.class);

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object proceed = invocation.proceed();
        try {
            Object[] args = invocation.getArgs();
            MappedStatement ms = (MappedStatement) args[0];
            Object params = args[1];
            if (SqlCommandType.INSERT.equals(ms.getSqlCommandType())) {
                insertCommond(params);
            }
            if (SqlCommandType.UPDATE.equals(ms.getSqlCommandType())) {
                updateCommond(params);
            }
        } catch (Exception e) {
            LOGGER.warn("entity change warning: {}", e.getMessage());
        } finally {
            return proceed;
        }
    }
    
        private void insertCommond(Object params) {
        if (Objects.isNull(params)) {
            return;
        }
        // 插入Company的事件
        if (params instanceof Company) {
            Company company = (Company) params;
            CompanyEvent companyEvent =
                new CompanyEvent(CompanyEvent.TOPIC_ADD, WebUtils.getOpenId(), CompanyVo.from(company));
            SpringUtil.getApplicationContext().publishEvent(companyEvent);
            LOGGER.info("[發(fā)布事件:{}] - [事件內容:{}]", CompanyEvent.TOPIC_ADD, JSON.toJSONString(companyEvent));
        }
    }
}

在這里，我們監(jiān)聽了Mybatis的Executor對象的update方法，來監(jiān)聽對象的新增和修改。

package org.apache.ibatis.executor;

public interface Executor {

  int update(MappedStatement ms, Object parameter) throws SQLException;
}

當 Company 的 insert 事件發(fā)生時，我們發(fā)布了一條 CompanyEvent 的事件。

訂閱事件

我們使用發(fā)布-訂閱模型實現了解耦合，針對剛才發(fā)布的 CompanyEvent 事件，我們來寫一個事件消費者。

@Component
public class CompanyListener {

    /**
     * 監(jiān)聽事件 - 公司.
     *
     * @param companyEvent 事件.
     */
    @Lazy
    @Async
    @TransactionalEventListener(
        fallbackExecution = true,
        phase = TransactionPhase.AFTER_COMPLETION,
        classes = CompanyEvent.class)
    public void doAsync(CompanyEvent companyEvent) {
        LOGGER.info("[Company 訂閱:{}] - [開始執(zhí)行:{}]",
            companyEvent.getTopic(), JSON.toJSONString(companyVo));
    }
}

代碼中涉及到一些注解，簡單介紹下

注解	介紹
@Component	會注冊為Spring的一個Bean
@Lazy	該方法會異步執(zhí)行
@TransactionalEventListener	在事務的不同階段去觸發(fā)執(zhí)行該監(jiān)聽

我們標注了該事件是在TransactionPhase.AFTER_COMPLETION（事務提交完成）這個事務節(jié)點進行事件處理。