使用SpringAop动态获取mapper执行的SQL,并保存SQL到Log表中
作者:麦兜仔
这篇文章主要介绍了使用SpringAop动态获取mapper执行的SQL,并保存SQL到Log表中问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
1.背景
工作的时候遇到一个这样的需要,在多机环境下,使用Mysql作为参数库。因为某些原因不能使用Mysql自带的数据同步,所以需要自己实现一个多节点的Mysql数据同步程序。
所以打算人为的设定主Mysql可读可写,备Mysql只能读。为了保证各个Mysql数据的同步,有一个Log表,用于记录操作主Mysql的SQL语句,从而其他备Mysql只需要通过Log表来进行数据同步。
更新:本文章已替换成自定义注解的模式(上版本是基于指定方法名作为切入点)
2.难点
(1)由于项目使用的是Mybatis,不是使用原生的jdbc,所以需要在不影响其他人使用Mybatis开发的同时,获取SQL语句并写入log表
(2)需要保证mapper的操作和log的insert在同一个事务中
3.实现
3.1ModelSumbit.java
自定义注解,用于Aop切入点
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
主要看环绕通知方法
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(){ } //前置通知 //指定该方法是前置通知,并指定切入点 @Before("MyAdvice.pc()") public void before(){ // System.out.println("这是前置通知!!!!!"); } //后置通知 @AfterReturning("MyAdvice.pc()") public void afterReturning(){ // System.out.println("这是后置通知!(如果出现异常,将不会调用)!!!!"); } //环绕通知 @Around("MyAdvice.pc()") public Object around(ProceedingJoinPoint pjp) throws Throwable{ //1.从redis中获取主数据库,若获取不到直接退出,否则判断当前数据源是会否为主,若不为主,则切换到主数据源 //2.调用目标方法 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("这是后置通知!(无论是否出现异常都会调用)!!!!"); } }
3.3SqlUtils.java
用于获取SQL语句
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语句 * @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.根据namespace+methdoName获取相对应的MappedStatement Configuration configuration = sqlSessionFactory.getConfiguration(); MappedStatement mappedStatement = configuration.getMappedStatement(namespace+"."+methodName); // //3.获取方法参数列表名 // Parameter[] parameters = method.getParameters(); //4.形参和实参的映射 Object[] objects = pjp.getArgs(); //获取实参 Annotation[][] parameterAnnotations = method.getParameterAnnotations(); for (int i = 0;i<parameterAnnotations.length;i++){ Object object = objects[i]; if (parameterAnnotations[i].length == 0){ //说明该参数没有注解,此时该参数可能是实体类,也可能是Map,也可能只是单参数 if (object.getClass().getClassLoader() == null && object instanceof Map){ map.putAll((Map<? extends String, ?>) object); System.out.println("该对象为Map"); }else{//形参为自定义实体类 map.putAll(objectToMap(object)); System.out.println("该对象为用户自定义的对象"); } }else{//说明该参数有注解,且必须为@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语句 * @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; } /** * 若为字符串或者日期类型,则在参数两边添加'' * @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; } /** * 获取利用反射获取类里面的值和名称 * * @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.注意事项
- Mapper接口的增删改方法上面加上@ModelSumbit注解,才会进入模型数据提交AOP
- Mapper接口方法的形参,可以有如下三种形式
①形参为自定义实体类
@ModelSumbit void insert(User user);
②形参为Map
@ModelSumbit void insert(Map<String,Object> map);
③形参为单个或多个参数,需要使用@Param注解
@ModelSumbit void insert(@Param("userName") String userName, @Param("age")Integer age);
注意:即便只有一个参数,采用第③方式的时候,仍然需要使用@Param注解
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。