學好Java MyBatis攔截器,提高工作效率

Posted on by

場景：

在後端服務開發時，現在很流行的框架組合就是SSM（SpringBoot + Spring + MyBatis），在我們進行一些業務系統開發時，會有很多的業務數據表，而表中的信息從新插入開始，整個生命周期過程中可能會進行很多次的操作。

比如：我們在某網站購買一件商品，會生成一條訂單記錄，在支付完金額後訂單狀態會變為已支付，等最後我們收到訂單商品，這個訂單狀態會變成已完成等。

假設我們的訂單表t_order結果如下：

當訂單創建時，需要設置insert_by，insert_time，update_by，update_time的值；

在進行訂單狀態更新時，則隻需要更新update_by，update_time的值。

那應該如何處理呢？

1.麻瓜做法

最簡單的做法，也是最容易想到的做法，就是在每個業務處理的代碼中，對相關的字段進行處理。

比如訂單創建的方法中，如下處理：

public void create(Order order){
    // ...其他代碼
    // 設置審計字段
    Date now = new Date();
    order.setInsertBy(appContext.getUser());
    order.setUpdateBy(appContext.getUser());
    order.setInsertTime(now);
    order.setUpdateTime(now);
    orderDao.insert(order);
}

訂單更新方法則隻設置updateBy和updateTime：

public void update(Order order){
    // ...其他代碼

    // 設置審計字段
    Date now = new Date();
    order.setUpdateBy(appContext.getUser());
    order.setUpdateTime(now);
    orderDao.insert(order);
}

這種方式雖然可以完成功能，但是存在一些問題：

需要在每個方法中按照不同的業務邏輯決定設置哪些字段；
在業務模型變多後，每個模型的業務方法中都要進行設置，重復代碼太多。
那我們知道這種方式存在問題以後，就得找找有什麼好方法對不對，往下看！

2.優雅做法

因為我們持久層框架更多地使用MyBatis，那我們就借助於MyBatis的攔截器來完成我們的功能。

首先我們來瞭解一下，什麼是攔截器？

3.什麼是攔截器？

MyBatis的攔截器顧名思義，就是對某些操作進行攔截。通過攔截器可以對某些方法執行前後進行攔截，添加一些處理邏輯。

MyBatis的攔截器可以對Executor、StatementHandler、PameterHandler和ResultSetHandler 接口進行攔截，也就是說會對這4種對象進行代理。

攔截器設計的初衷就是為瞭讓用戶在MyBatis的處理流程中不必去修改MyBatis的源碼，能夠以插件的方式集成到整個執行流程中。

比如MyBatis中的Executor有BatchExecutor、ReuseExecutor、SimpleExecutor和CachingExecutor，如果這幾種實現的query方法都不能滿足你的需求，我們可以不用去直接修改MyBatis的源碼，而通過建立攔截器的方式，攔截Executor接口的query方法，在攔截之後，實現自己的query方法邏輯。

在MyBatis中的攔截器通過Interceptor接口表示，該接口中有三個方法。

public interface Interceptor {

  Object intercept(Invocation invocation) throws Throwable;

  Object plugin(Object target);

  void setProperties(Properties properties);

}

plugin方法是攔截器用於封裝目標對象的，通過該方法我們可以返回目標對象本身，也可以返回一個它的代理。

當返回的是代理的時候我們可以對其中的方法進行攔截來調用intercept方法，當然也可以調用其他方法。

setProperties方法是用於在Mybatis配置文件中指定一些屬性的。

4.使用攔截器更新審計字段

那麼我們應該如何通過攔截器來實現我們對審計字段賦值的功能呢？

在我們進行訂單創建和修改時，本質上是通過MyBatis執行insert、update語句，MyBatis是通過Executor來處理的。

我們可以通過攔截器攔截Executor，然後在攔截器中對要插入的數據對象根據執行的語句設置insert_by,insert_time,update_by,update_time等屬性值就可以瞭。

5.自定義攔截器

自定義Interceptor最重要的是要實現plugin方法和intercept方法。

在plugin方法中我們可以決定是否要進行攔截進而決定要返回一個什麼樣的目標對象。

在intercept方法就是要進行攔截的時候要執行的方法。

對於plugin方法而言，其實Mybatis已經為我們提供瞭一個實現。Mybatis中有一個叫做Plugin的類，裡面有一個靜態方法wrap(Object target,Interceptor interceptor)，通過該方法可以決定要返回的對象是目標對象還是對應的代理。

但是這裡還存在一個問題，就是我們如何在攔截器中知道要插入的表有審計字段需要處理呢？

因為我們的表中並不是所有的表都是業務表，可能有一些字典表或者定義表是沒有審計字段的，這樣的表我們不需要在攔截器中進行處理。

也就是說我們要能夠區分出哪些對象需要更新審計字段。

這裡我們可以定義一個接口，讓需要更新審計字段的模型都統一實現該接口，這個接口起到一個標記的作用。

public interface BaseDO {
}

public class Order implements BaseDO{

    private Long orderId;

    private String orderNo;

    private Integer orderStatus;

    private String insertBy;

    private String updateBy;

    private Date insertTime;

    private Date updateTime;
    //... getter ,setter
}

接下來，我們就可以實現我們的自定義攔截器瞭。

@Component("ibatisAuditDataInterceptor")
@Intercepts({@Signature(method = "update", type = Executor.class, args = {MappedStatement.class, Object.class})})
public class IbatisAuditDataInterceptor implements Interceptor {

    private Logger logger = LoggerFactory.getLogger(IbatisAuditDataInterceptor.class);

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 從上下文中獲取用戶名
        String userName = AppContext.getUser();
        
        Object[] args = invocation.getArgs();
        SqlCommandType sqlCommandType = null;
        
        for (Object object : args) {
            // 從MappedStatement參數中獲取到操作類型
            if (object instanceof MappedStatement) {
                MappedStatement ms = (MappedStatement) object;
                sqlCommandType = ms.getSqlCommandType();
                logger.debug("操作類型： {}", sqlCommandType);
                continue;
            }
            // 判斷參數是否是BaseDO類型
            // 一個參數
            if (object instanceof BaseDO) {
                if (SqlCommandType.INSERT == sqlCommandType) {
                    Date insertTime = new Date();
                    BeanUtils.setProperty(object, "insertedBy", userName);
                    BeanUtils.setProperty(object, "insertTimestamp", insertTime);
                    BeanUtils.setProperty(object, "updatedBy", userName);
                    BeanUtils.setProperty(object, "updateTimestamp", insertTime);
                    continue;
                }
                if (SqlCommandType.UPDATE == sqlCommandType) {
                    Date updateTime = new Date();
                    BeanUtils.setProperty(object, "updatedBy", userName);
                    BeanUtils.setProperty(object, "updateTimestamp", updateTime);
                    continue;
                }
            }
            // 兼容MyBatis的updateByExampleSelective(record, example);
            if (object instanceof ParamMap) {
                logger.debug("mybatis arg: {}", object);
                @SuppressWarnings("unchecked")
                ParamMap<Object> parasMap = (ParamMap<Object>) object;
                String key = "record";
                if (!parasMap.containsKey(key)) {
                    continue;
                }
                Object paraObject = parasMap.get(key);
                if (paraObject instanceof BaseDO) {
                    if (SqlCommandType.UPDATE == sqlCommandType) {
                        Date updateTime = new Date();
                        BeanUtils.setProperty(paraObject, "updatedBy", userName);
                        BeanUtils.setProperty(paraObject, "updateTimestamp", updateTime);
                        continue;
                    }
                }
            }
            // 兼容批量插入
            if (object instanceof DefaultSqlSession.StrictMap) {
                logger.debug("mybatis arg: {}", object);
                @SuppressWarnings("unchecked")
                DefaultSqlSession.StrictMap<ArrayList<Object>> map = (DefaultSqlSession.StrictMap<ArrayList<Object>>) object;
                String key = "collection";
                if (!map.containsKey(key)) {
                    continue;
                }
                ArrayList<Object> objs = map.get(key);
                for (Object obj : objs) {
                    if (obj instanceof BaseDO) {
                        if (SqlCommandType.INSERT == sqlCommandType) {
                            Date insertTime = new Date();
                            BeanUtils.setProperty(obj, "insertedBy", userName);
                            BeanUtils.setProperty(obj, "insertTimestamp", insertTime);
                            BeanUtils.setProperty(obj, "updatedBy", userName);
                            BeanUtils.setProperty(obj, "updateTimestamp", insertTime);
                        }
                        if (SqlCommandType.UPDATE == sqlCommandType) {
                            Date updateTime = new Date();
                            BeanUtils.setProperty(obj, "updatedBy", userName);
                            BeanUtils.setProperty(obj, "updateTimestamp", updateTime);
                        }
                    }
                }
            }
        }
        return invocation.proceed();
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
    }
}

通過上面的代碼可以看到，我們自定義的攔截器IbatisAuditDataInterceptor實現瞭Interceptor接口。

在我們攔截器上的@Intercepts註解，type參數指定瞭攔截的類是Executor接口的實現，method 參數指定攔截Executor中的update方法，因為數據庫操作的增刪改操作都是通過update方法執行。

6.配置攔截器插件

在定義好攔截器之後，需要將攔截器指定到SqlSessionFactoryBean的plugins中才能生效。所以要按照如下方式配置。

<bean id="transSqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="transDataSource" />
    <property name="mapperLocations">
        <array>
            <value>classpath:META-INF/mapper/*.xml</value>
        </array>
    </property>
    <property name="plugins">
        <array>
            <!-- 處理審計字段 -->
            <ref bean="ibatisAuditDataInterceptor" />
        </array>
    </property>

到這裡，我們自定義的攔截器就生效瞭，通過測試你會發現，不用在業務代碼中手動設置審計字段的值，會在事務提交之後，通過攔截器插件自動對審計字段進行賦值。

小結：

在本期內容中小黑給大傢介紹瞭對於我們日常開發中很頻繁的審計字段的更新操作，應該如何優雅地處理。

通過自定義MyBatis的攔截器，以插件的形式對一些有審計字段的業務模型自動賦值，避免重復編寫枯燥的重復代碼。

到此這篇關於學好Java MyBatis攔截器,提高工作效率的文章就介紹到這瞭,更多相關Java MyBatis攔截器內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：