使用SpringAop動(dòng)態(tài)獲取mapper執(zhí)行的SQL,并保存SQL到Log表中
1.背景
工作的時(shí)候遇到一個(gè)這樣的需要,在多機(jī)環(huán)境下,使用Mysql作為參數(shù)庫(kù)。因?yàn)槟承┰虿荒苁褂肕ysql自帶的數(shù)據(jù)同步,所以需要自己實(shí)現(xiàn)一個(gè)多節(jié)點(diǎn)的Mysql數(shù)據(jù)同步程序。
所以打算人為的設(shè)定主Mysql可讀可寫(xiě),備Mysql只能讀。為了保證各個(gè)Mysql數(shù)據(jù)的同步,有一個(gè)Log表,用于記錄操作主Mysql的SQL語(yǔ)句,從而其他備Mysql只需要通過(guò)Log表來(lái)進(jìn)行數(shù)據(jù)同步。
更新:本文章已替換成自定義注解的模式(上版本是基于指定方法名作為切入點(diǎn))
2.難點(diǎn)
(1)由于項(xiàng)目使用的是Mybatis,不是使用原生的jdbc,所以需要在不影響其他人使用Mybatis開(kāi)發(fā)的同時(shí),獲取SQL語(yǔ)句并寫(xiě)入log表
(2)需要保證mapper的操作和log的insert在同一個(gè)事務(wù)中
3.實(shí)現(xiàn)
3.1ModelSumbit.java
自定義注解,用于Aop切入點(diǎn)
package com.yjy.annotation;
?
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
?
?
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ModelSumbit{
? ?
? ? String value() default "";
}3.2LogAdvice.java
主要看環(huán)繞通知方法
package com.lyf.aspect;
import com.lyf.service.LogService;
import com.lyf.utils.SqlUtils;
import org.apache.ibatis.session.SqlSessionFactory;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Aspect
@Component
public class MyAdvice {
@Autowired
private LogService logService;
@Autowired
private SqlSessionFactory sqlSessionFactory;
@Pointcut("@annotation(com.yjy.annotation.ModelSumbit)")
private void pc(){
}
//前置通知
//指定該方法是前置通知,并指定切入點(diǎn)
@Before("MyAdvice.pc()")
public void before(){
// System.out.println("這是前置通知!?。。?!");
}
//后置通知
@AfterReturning("MyAdvice.pc()")
public void afterReturning(){
// System.out.println("這是后置通知!(如果出現(xiàn)異常,將不會(huì)調(diào)用)?。。?!");
}
//環(huán)繞通知
@Around("MyAdvice.pc()")
public Object around(ProceedingJoinPoint pjp) throws Throwable{
//1.從redis中獲取主數(shù)據(jù)庫(kù),若獲取不到直接退出,否則判斷當(dāng)前數(shù)據(jù)源是會(huì)否為主,若不為主,則切換到主數(shù)據(jù)源
//2.調(diào)用目標(biāo)方法
Object proceed = pjp.proceed();
//3.獲取SQL
String sql = SqlUtils.getMybatisSql(pjp,sqlSessionFactory);
System.out.println(sql);
//4.插入日志
logService.insert(sql);
//5.通知同步程序
return proceed;
}
//異常通知
@AfterThrowing("MyAdvice.pc()")
public void afterException(){
// System.out.println("出事了,拋異常了?。。?!");
}
//后置通知
@After("MyAdvice.pc()")
public void after(){
// System.out.println("這是后置通知!(無(wú)論是否出現(xiàn)異常都會(huì)調(diào)用)!?。?!");
}
}3.3SqlUtils.java
用于獲取SQL語(yǔ)句
package com.lyf.utils;
import com.sun.deploy.util.ArrayUtil;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.reflect.MethodSignature;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.text.DateFormat;
import java.util.*;
public class SqlUtils {
/**
* 獲取aop中的SQL語(yǔ)句
* @param pjp
* @param sqlSessionFactory
* @return
* @throws IllegalAccessException
*/
public static String getMybatisSql(ProceedingJoinPoint pjp, SqlSessionFactory sqlSessionFactory) throws IllegalAccessException {
Map<String,Object> map = new HashMap<>();
//1.獲取namespace+methdoName
MethodSignature signature = (MethodSignature) pjp.getSignature();
Method method = signature.getMethod();
String namespace = method.getDeclaringClass().getName();
String methodName = method.getName();
//2.根據(jù)namespace+methdoName獲取相對(duì)應(yīng)的MappedStatement
Configuration configuration = sqlSessionFactory.getConfiguration();
MappedStatement mappedStatement = configuration.getMappedStatement(namespace+"."+methodName);
// //3.獲取方法參數(shù)列表名
// Parameter[] parameters = method.getParameters();
//4.形參和實(shí)參的映射
Object[] objects = pjp.getArgs(); //獲取實(shí)參
Annotation[][] parameterAnnotations = method.getParameterAnnotations();
for (int i = 0;i<parameterAnnotations.length;i++){
Object object = objects[i];
if (parameterAnnotations[i].length == 0){ //說(shuō)明該參數(shù)沒(méi)有注解,此時(shí)該參數(shù)可能是實(shí)體類(lèi),也可能是Map,也可能只是單參數(shù)
if (object.getClass().getClassLoader() == null && object instanceof Map){
map.putAll((Map<? extends String, ?>) object);
System.out.println("該對(duì)象為Map");
}else{//形參為自定義實(shí)體類(lèi)
map.putAll(objectToMap(object));
System.out.println("該對(duì)象為用戶(hù)自定義的對(duì)象");
}
}else{//說(shuō)明該參數(shù)有注解,且必須為@Param
for (Annotation annotation : parameterAnnotations[i]){
if (annotation instanceof Param){
map.put(((Param) annotation).value(),object);
}
}
}
}
//5.獲取boundSql
BoundSql boundSql = mappedStatement.getBoundSql(map);
return showSql(configuration,boundSql);
}
/**
* 解析BoundSql,生成不含占位符的SQL語(yǔ)句
* @param configuration
* @param boundSql
* @return
*/
private static String showSql(Configuration configuration, BoundSql boundSql) {
Object parameterObject = boundSql.getParameterObject();
List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
String sql = boundSql.getSql().replaceAll("[\\s]+", " ");
if (parameterMappings.size() > 0 && parameterObject != null) {
TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
sql = sql.replaceFirst("\\?", getParameterValue(parameterObject));
} else {
MetaObject metaObject = configuration.newMetaObject(parameterObject);
for (ParameterMapping parameterMapping : parameterMappings) {
String propertyName = parameterMapping.getProperty();
String[] s = metaObject.getObjectWrapper().getGetterNames();
s.toString();
if (metaObject.hasGetter(propertyName)) {
Object obj = metaObject.getValue(propertyName);
sql = sql.replaceFirst("\\?", getParameterValue(obj));
} else if (boundSql.hasAdditionalParameter(propertyName)) {
Object obj = boundSql.getAdditionalParameter(propertyName);
sql = sql.replaceFirst("\\?", getParameterValue(obj));
}
}
}
}
return sql;
}
/**
* 若為字符串或者日期類(lèi)型,則在參數(shù)兩邊添加''
* @param obj
* @return
*/
private static String getParameterValue(Object obj) {
String value = null;
if (obj instanceof String) {
value = "'" + obj.toString() + "'";
} else if (obj instanceof Date) {
DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT, Locale.CHINA);
value = "'" + formatter.format(new Date()) + "'";
} else {
if (obj != null) {
value = obj.toString();
} else {
value = "";
}
}
return value;
}
/**
* 獲取利用反射獲取類(lèi)里面的值和名稱(chēng)
*
* @param obj
* @return
* @throws IllegalAccessException
*/
private static Map<String, Object> objectToMap(Object obj) throws IllegalAccessException {
Map<String, Object> map = new HashMap<>();
Class<?> clazz = obj.getClass();
System.out.println(clazz);
for (Field field : clazz.getDeclaredFields()) {
field.setAccessible(true);
String fieldName = field.getName();
Object value = field.get(obj);
map.put(fieldName, value);
}
return map;
}
}4.注意事項(xiàng)
- Mapper接口的增刪改方法上面加上@ModelSumbit注解,才會(huì)進(jìn)入模型數(shù)據(jù)提交AOP
- Mapper接口方法的形參,可以有如下三種形式
①形參為自定義實(shí)體類(lèi)
@ModelSumbit void insert(User user);
②形參為Map
@ModelSumbit void insert(Map<String,Object> map);
③形參為單個(gè)或多個(gè)參數(shù),需要使用@Param注解
@ModelSumbit
void insert(@Param("userName") String userName, @Param("age")Integer age);注意:即便只有一個(gè)參數(shù),采用第③方式的時(shí)候,仍然需要使用@Param注解
總結(jié)
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
實(shí)例講解分布式緩存軟件Memcached的Java客戶(hù)端使用
這篇文章主要介紹了分布式緩存軟件Memcached的Java客戶(hù)端使用,Memcached在GitHub上開(kāi)源,作者用其Windows平臺(tái)下的版本進(jìn)行演示,需要的朋友可以參考下2016-01-01
詳解Java中二叉樹(shù)的基礎(chǔ)概念(遞歸&迭代)
二叉樹(shù)(Binary?tree)是樹(shù)形結(jié)構(gòu)的一個(gè)重要類(lèi)型。本文將通過(guò)圖片和示例代碼詳細(xì)為大家講解一下Java中的二叉樹(shù)的基礎(chǔ)概念,需要的可以參考一下2022-03-03
IntelliJ IDEA 關(guān)閉多余項(xiàng)目的操作方法
這篇文章主要介紹了IntelliJ IDEA 關(guān)閉多余項(xiàng)目的操作方法,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-04-04
java使用文件流實(shí)現(xiàn)查看下載次數(shù)
這篇文章主要為大家詳細(xì)介紹了java使用文件流實(shí)現(xiàn)查看下載次數(shù),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-07-07
Java中的轉(zhuǎn)換流InputStreamReader解讀
InputStreamReader是Java.io包中的一個(gè)類(lèi),用于將字節(jié)輸入流轉(zhuǎn)換為字符輸入流,它繼承自java.io.Reader類(lèi),提供了兩種構(gòu)造方法,可以使用默認(rèn)或指定字符集創(chuàng)建實(shí)例,常用方法包括讀取字符、判斷是否準(zhǔn)備好讀取數(shù)據(jù)和關(guān)閉流2024-09-09
Java實(shí)現(xiàn)簡(jiǎn)單通訊錄管理系統(tǒng)
這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)簡(jiǎn)單通訊錄管理系統(tǒng),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-07-07
SpringBoot訪(fǎng)問(wèn)MongoDB數(shù)據(jù)庫(kù)的兩種方式
MongoDB是一種非關(guān)系型數(shù)據(jù)庫(kù),通過(guò)文檔存儲(chǔ)數(shù)據(jù),適用于大規(guī)模數(shù)據(jù)存儲(chǔ)和高并發(fā)訪(fǎng)問(wèn),這篇文章主要介紹了SpringBoot訪(fǎng)問(wèn)MongoDB數(shù)據(jù)庫(kù)的兩種方式,感興趣想要詳細(xì)了解可以參考下文2023-05-05
線(xiàn)程池中使用spring aop事務(wù)增強(qiáng)
這篇文章主要介紹了線(xiàn)程池中使用spring aop事務(wù)增強(qiáng),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-02-02

