Mybatis之攔截器--獲取執行SQL實現多客戶端數據同步
本文通過在客戶端攔截SQL的操作介紹Mybatis攔截器的使用方法.
1. 項目需求
客戶分店較多且比較分散, 部分店內網絡不穩定, 客戶要求每個分店在無網絡的情況下也能正常使用系統, 同時所有店面數據需要進行匯總分析. 綜合客戶的需求, 項目架構如下:
將WEB項目及其運行環境通過NSIS制作安裝包在各分店進行安裝, 每個分店是一個獨立的WEB服務, 這樣就保證店內在無網絡(有局域網,無法訪問互聯網)的情況下也可以正常使用系統. 此時每個分店的數據庫保存自己店內的運營數據, 各店之間的數據相互隔離.
但運營方無法分析所有店面的匯總數據(如商品整體銷售情況等), 因此需要將每個店面的數據定期同步至服務器的數據庫中.
由於店內可能無網絡(無網時不能受數據同步影響,系統需正常運行), 實時同步方案被排除.
為保證數據庫安全性, 服務器數據庫不能對外暴露, 使用數據庫的同步機制方案被排除.
部分業務需要記錄數據變化日誌(數據從1到0又到1, 需記錄過程), 增量同步方案被排除.
最終采用了將客戶端所有更新(增,刪,改)的SQL按照執行順序保存至數據庫中, 定期同步並在服務器的數據庫按照順序執行SQL, 以此來保證服務器數據庫的數據是各客戶端數據的匯總.
2. 解決方案
項目采用Mybatis, Mapper 中定義SQL時可以使用Mybatis的標簽及參數標識符, Mybatis會解析標簽替換參數生成最終的SQL在數據庫中執行, 而我們需要的是最終在數據庫中執行的SQL.
Mybatis中SQL的寫法:
<insert id="insert">
INSERT INTO atd681_mybatis_test ( dv ) VALUES ( #{dv} )
</insert>
復制代碼
需要同步至服務器執行的SQL:
INSERT INTO atd681_mybatis_test ( dv ) VALUES ( ‘aaa‘ )
復制代碼
3. 攔截器
3.1 什麽是攔截器
想這樣一個場景, 你做飯的時候可能需要以下步驟:
買菜>> 洗菜 >> 切菜 >> 做菜 >> 上菜 >> 洗碗
開始洗菜前, 買菜操作已經完成, 可以知道買了什麽菜.
洗菜時還未開始做菜, 因此不知道菜是什麽口味的.
在上菜前(此時做菜已經完成), 可以知道菜的口味.
在上菜時不知道有沒有剩菜
在洗碗時我們可以知道有沒有剩菜.
上面的做飯流程是按照步驟一步一步的進行, 我們既可以在其中的某個步驟中獲取前幾步的成果, 也可以在某個步驟開始之前做些額外的事情, 比如: 切菜前對菜稱重等.
Mybatis提供了這樣一個組件: 他可以在某個步驟執行之前先執行自定義的操作. 這個組件叫做 攔截器 . 所謂攔截器, 顧名思義: 需要定義攔截哪個操作步驟及攔截後做什麽事情.
3.2 定義攔截器
攔截器需要實現 org.apache.ibatis.plugin.Interceptor 接口並指定攔截的方法.
// 攔截器
@Intercepts(@Signature(type = StatementHandler.class,
method = "update",
args = Statement.class)
)
public class SQLInterceptor implements Interceptor {
// 攔截方法後執行的邏輯
@Override
public Object intercept(Invocation invocation) throws Throwable {
// 繼續執行Mybatis原有的邏輯
// proceed中通過反射執行被攔截的方法
return invocation.proceed();
}
// 返回當前攔截的對象(StatementHandler)的動態代理
// 當攔截對象的方法被執行時, 動態代理中執行攔截器intercept方法.
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
// 設置屬性
@Override
public void setProperties(Properties properties) {
}}
復制代碼
@Intercepts 為Mybatis提供的攔截器註解, @Signature 指定攔截的方法.
如果一個攔截器攔截多個方法時, 在 @Intercepts 中配置多個 @Signature (數組)即可.
由於JAVA的方法可以重載, 確定唯一方法需要指定類(type), 方法(method), 參數(args).
攔截器可攔截 Executor , ParameterHandler , ResultSetHandler , StatementHandler 下的方法.
3.3 配置攔截器
在Spring配置文件中, 聲明攔截器並將其配置到 SqlSessionFactoryBean 中 plugins 屬性中
// Mybatis攔截器
sqlInterceptor(SQLInterceptor)
// Mybatis配置
sqlSessionFactory(SqlSessionFactoryBean) {
dataSource = ref("dataSource")
mapperLocations = "classpath:/com/atd681/mybatis/interceptor/_mapper.xml"
// 配置Mybatis攔截器
plugins = [
sqlInterceptor
] }
復制代碼
4. 獲取並保存SQL
Mybatis處理SQL的大致流程如下:
加載SQL>> 解析SQL >> 替換SQL參數 >> 執行SQL >> 獲取返回結果
攔截[ 執行SQL ]操作, 此時Mybatis已經完成SQL解析及替換參數, 所得的SQL即為發送數據庫執行的SQL. 我們只需要獲取該SQL並保存至數據庫即可.
// Mybatis攔截器:攔截所有的增刪改SQL,將SQL保持至數據庫
// 攔截StatementHandler.update方法
@Intercepts(@Signature(type = StatementHandler.class,
method = "update",
args = Statement.class)
)
public class SQLInterceptor implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
// invocation.getArgs()可以獲取到被攔截方法的參數
// StatementHandler.update(Statement s)的參數為Statement
Statement s = (Statement) invocation.getArgs()[0];
// 數據源為DRUID, Statement為DRUID的Statement
Statement stmt = ((DruidPooledPreparedStatement) s).getStatement();
// 配置druid連接時使用filters: stat配置
if (stmt instanceof PreparedStatementProxyImpl) {
stmt = ((PreparedStatementProxyImpl) stmt).getRawObject();
}
// 數據庫提供的Statement可獲取參數替換後的SQL(JDBC和DRUID獲取的是帶?的)
// 數據庫為MySQL,可以直接強制轉換為MySQL的PreparedStatement獲取SQL
// SQL在書寫時為了格式容器閱讀會有換行符(多個空格)存在
// 為了保存和查看方便去除SQL中的換行及多個空格
String sql = ((com.mysql.jdbc.PreparedStatement) stmt).asSql().replaceAll("\\s+", " ");
// 保存SQL的操作必須和當前執行的SQL在同一事務中
// 使用當前SQL所在的數據庫連接執行保存操作即可
// 目標sql成功時保存sql的方法也同步成功
Connection conn = stmt.getConnection();
// 將SQL保存至數據庫中
PreparedStatement ps = null;
try {
ps = conn.prepareStatement("INSERT INTO atd681_mybatis_sql (v_sql) VALUES (?)");
ps.setString(1, sql);
// 因為和Mybatis的操作在同一事務中
// 如果本次操作如果失敗, 所有操作都回滾
ps.execute();
}
finally {
if (ps != null) {
ps.close();
}
}
// 繼續執行StatementHandler.update方法
return invocation.proceed();
}}
復制代碼
只有MySQL提供的PreparedStatement對象中可以獲取到最終的SQL.
保存SQL操作需要和Mybatis的操作在同一事務中, 必須同時成功或失敗.
- 測試
在數據庫中創建兩張表:
atd681_mybatis_test
atd681_mybatis_sql
創建 DAO 和 Mapper , 創建增加, 刪除, 修改的方法及SQL
// 數據DAO@Repository
br/>@Repository
// 添加數據
void insert(String dv);
// 更新數據
void update(String dv);
// 刪除數據
void delete();}
復制代碼
<mapper namespace="com.atd681.mybatis.interceptor.DataDAO">
<!-- 添加數據,內容為參數i的值 -->
<insert id="insert">
INSERT INTO atd681_mybatis_test ( dv ) VALUES ( #{dv} )
</insert>
<!-- 更新數據,更新為參數u的值 -->
<update id="update">
UPDATE atd681_mybatis_test1 SET dv = #{dv}
</update>
<!-- 刪除數據 -->
<delete id="delete">
DELETE FROM atd681_mybatis_test
</delete></mapper>
復制代碼
控制器中添加方法, 依次調用刪除, 添加, 更新. 保證三個操作在同一個事務中.
@RestController
public class DataController {
// 註入DAO
@Autowired
private DataDAO dao;
// 分別執行刪除,插入,更新操作
// 參數i: 插入時的字符串
// 參數u: 更新時的字符串
@GetMapping("/mybatis/test")
@Transactional
public String excuteSql(String i, String u) {
// 刪除數據後將參數i的內容插件數據庫,將數據更新成參數u的內容
// 該方法添加了事務,3次數據庫操作會在同一個事務中執行.
// Mybatis攔截器會捕獲三次數據庫SQL插入至數據庫中(詳見攔截器)
dao.delete();
dao.insert(i);
dao.update(u);
return "success";
}}
復制代碼
啟動服務, 訪問 http://localhost:3456/mybatis/test?i=insert&u=update
程序依次執行刪除、添加(內容為 "insert" )、更新(內容為 "update" )三個操作, 執行完成後數據庫中有一條記錄(內容為 "update" ). 由於配置了攔截器, 在每個操作執行前將SQL保持至數據庫中, 因此三條SQL也被保存至數據庫中.
上述過程中除了3次業務操作, 還有3次保持SQL的操作, 因此數據庫總共會執行6條SQL.
執行DELETE操作
保存1中DELETE操作的SQL
執行INSERT SQL
保存3中INSERT操作的SQL
執行UPDATE SQL
保存5中UPDATE操作的SQL
上述6次數據庫操作必須在同一事務中, 否則一旦出現業務操作成功但保存SQL失敗的情況. 服務器端同步的數據就會與客戶端本地不一致.
Mybatis之攔截器--獲取執行SQL實現多客戶端數據同步