mybatis采用責任鏈模式，通過動態代理組織多個攔截器（插件），通過這些攔截器可以改變mybatis的默認行為（諸如sql重寫之類的），由于插件會深入到mybatis的核心，因此在編寫自己的插件前最好了解下它的原理，以便寫出安全高效的插件。
攔截器（interceptor）在 mybatis 中被當做插件（plugin）對待，官方文檔提供了 executor，parameterhandler，resultsethandler，statementhandler 共4種，并且提示“這些類中方法的細節可以通過查看每個方法的簽名來發現，或者直接查看 mybatis 發行包中的源代碼”。
攔截器的使用場景主要是更新數據庫的通用字段，分庫分表，加解密等的處理。
1. interceptor
攔截器均需要實現該 org.apache.ibatis.plugin.interceptor 接口。
2. intercepts 攔截器
|
1
2
3
|
@intercepts({ @signature(type = executor.class, method = "update", args = {mappedstatement.class, object.class})}) |
攔截器的使用需要查看每一個type所提供的方法參數。
signature 對應 invocation 構造器，type 為 invocation.object，method 為 invocation.method，args 為 invocation.object[]。
method 對應的 update 包括了最常用的 insert/update/delete 三種操作，因此 update 本身無法直接判斷sql為何種執行過程。
args 包含了其余所有的操作信息, 按數組進行存儲, 不同的攔截方式有不同的參數順序, 具體看type接口的方法簽名, 然后根據簽名解析。
3. object 對象類型
args 參數列表中，object.class 是特殊的對象類型。如果有數據庫統一的實體 entity 類，即包含表公共字段，比如創建、更新操作對象和時間的基類等，在編寫代碼時盡量依據該對象來操作，會簡單很多。該對象的判斷使用
|
1
2
3
4
|
object parameter = invocation.getargs()[1];if (parameter instanceof baseentity) { baseentity entity = (baseentity) parameter;} |
即可，根據語句執行類型選擇對應字段的賦值。
如果參數不是實體，而且具體的參數，那么 mybatis 也做了一些處理，比如 @param("name") string name 類型的參數，會被包裝成 map 接口的實現來處理，即使是原始的 map 也是如此。使用
|
1
2
3
4
|
object parameter = invocation.getargs()[1];if (parameter instanceof map) { map map = (map) parameter;} |
即可，對具體統一的參數進行賦值。
4. sqlcommandtype 命令類型
executor 提供的方法中，update 包含了 新增，修改和刪除類型，無法直接區分，需要借助 mappedstatement 類的屬性 sqlcommandtype 來進行判斷，該類包含了所有的操作類型
|
1
2
3
|
public enum sqlcommandtype { unknown, insert, update, delete, select, flush;} |
畢竟新增和修改的場景，有些參數是有區別的，比如創建時間和更新時間，update 時是無需兼顧創建時間字段的。
|
1
2
|
mappedstatement ms = (mappedstatement) invocation.getargs()[0];sqlcommandtype commandtype = ms.getsqlcommandtype(); |
5. 實例
自己編寫的小項目中，需要統一給數據庫字段屬性賦值：
|
1
2
3
4
5
6
7
|
public class baseentity { private int id; private int creator; private int updater; private long createtime; private long updatetime;} |
dao 操作使用了實體和參數的方式，個人建議還是統一使用實體比較簡單，易讀。
使用實體：
|
1
|
int add(bookentity entity); |
使用參數：
完整的例子：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
package com.github.zhgxun.talk.common.plugin;import com.github.zhgxun.talk.common.util.dateutil;import com.github.zhgxun.talk.common.util.userutil;import com.github.zhgxun.talk.entity.baseentity;import com.github.zhgxun.talk.entity.userentity;import lombok.extern.slf4j.slf4j;import org.apache.ibatis.executor.executor;import org.apache.ibatis.mapping.mappedstatement;import org.apache.ibatis.mapping.sqlcommandtype;import org.apache.ibatis.plugin.interceptor;import org.apache.ibatis.plugin.intercepts;import org.apache.ibatis.plugin.invocation;import org.apache.ibatis.plugin.plugin;import org.apache.ibatis.plugin.signature;import org.springframework.stereotype.component;import java.util.map;import java.util.properties;/** * 全局攔截數據庫創建和更新 * <p> * signature 對應 invocation 構造器, type 為 invocation.object, method 為 invocation.method, args 為 invocation.object[] * method 對應的 update 包括了最常用的 insert/update/delete 三種操作, 因此 update 本身無法直接判斷sql為何種執行過程 * args 包含了其余多有的操作信息, 按數組進行存儲, 不同的攔截方式有不同的參數順序, 具體看type接口的方法簽名, 然后根據簽名解析, 參見官網 * * @link http://www.mybatis.org/mybatis-3/zh/configuration.html#plugins 插件 * <p> * mappedstatement 包括了sql具體操作類型, 需要通過該類型判斷當前sql執行過程 */@component@intercepts({ @signature(type = executor.class, method = "update", args = {mappedstatement.class, object.class})})@slf4jpublic class normalplugin implements interceptor { @override @suppresswarnings("unchecked") public object intercept(invocation invocation) throws throwable { // 根據簽名指定的args順序獲取具體的實現類 // 1. 獲取mappedstatement實例, 并獲取當前sql命令類型 mappedstatement ms = (mappedstatement) invocation.getargs()[0]; sqlcommandtype commandtype = ms.getsqlcommandtype(); // 2. 獲取當前正在被操作的類, 有可能是java bean, 也可能是普通的操作對象, 比如普通的參數傳遞 // 普通參數, 即是 @param 包裝或者原始 map 對象, 普通參數會被 mybatis 包裝成 map 對象 // 即是 org.apache.ibatis.binding.mappermethod$parammap object parameter = invocation.getargs()[1]; // 獲取攔截器指定的方法類型, 通常需要攔截 update string methodname = invocation.getmethod().getname(); log.info("normalplugin, methodname; {}, commandtype: {}", methodname, commandtype); // 3. 獲取當前用戶信息 userentity userentity = userutil.getcurrentuser(); // 默認測試參數值 int creator = 2, updater = 3; if (parameter instanceof baseentity) { // 4. 實體類 baseentity entity = (baseentity) parameter; if (userentity != null) { creator = entity.getcreator(); updater = entity.getupdater(); } if (methodname.equals("update")) { if (commandtype.equals(sqlcommandtype.insert)) { entity.setcreator(creator); entity.setupdater(updater); entity.setcreatetime(dateutil.gettimestamp()); entity.setupdatetime(dateutil.gettimestamp()); } else if (commandtype.equals(sqlcommandtype.update)) { entity.setupdater(updater); entity.setupdatetime(dateutil.gettimestamp()); } } } else if (parameter instanceof map) { // 5. @param 等包裝類 // 更新時指定某些字段的最新數據值 if (commandtype.equals(sqlcommandtype.update)) { // 遍歷參數類型, 檢查目標參數值是否存在對象中, 該方式需要應用編寫有一些統一的規范 // 否則均統一為實體對象, 就免去該重復操作 map map = (map) parameter; if (map.containskey("creator")) { map.put("creator", creator); } if (map.containskey("updatetime")) { map.put("updatetime", dateutil.gettimestamp()); } } } // 6. 均不是需要被攔截的類型, 不做操作 return invocation.proceed(); } @override public object plugin(object target) { return plugin.wrap(target, this); } @override public void setproperties(properties properties) { }} |
6. 感受
其它幾種類型，后面在看，尤其是分頁。
在編寫代碼的過程中，有時候還是需要先知道對象的類型，比如 object.class 跟 interface 一樣，很多時候僅僅代表一種數據類型，需要明確知道后再進行操作。
@param 標識的參數其實會被 mybatis 封裝成 org.apache.ibatis.binding.mappermethod$parammap 類型，一開始我就是使用
|
1
2
3
|
for (field field:parameter.getclass().getdeclaredfields()) {} |
的方式獲取，以為這些都是對象的屬性，通過反射獲取并修改即可，實際上發現對象不存在這些屬性，但是打印出的信息中，明確有這些字段的，網上參考一些信息后，才知道這是一個 map 類型，問題才迎刃而解。
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持服務器之家。
原文鏈接：https://segmentfault.com/a/1190000017393523
