SpringBoot + AOP + MySQL监控系统数据变更实战

Java框架

浏览数:65

2019-11-2

记录一下Spring AOP切入DAO层,进行数据监控。
在写这个需求时,从网上找了很多的资料,大部分都是没有解决相关问题的。当然也有少数部分解决,但用的还是SSM架构的xml配置。一开始我的出发点是通过注解@annotation的方式来切入DAO需要监控的方法,但是并没有用。接下来剖析下个人的实现和思路。

相关依赖

  • spring-boot-starter-web
  • mysql-connector-java
  • lombok
  • spring-boot-starter-aop
  • mybatis-spring-boot-starter

Spring AOP两种代理

  • jdk代理
    使用Java动态代理来创建AOP代理,在程序运行期间由JVM根据反射等机制动态的生成(当然此接口要有实现类)。
  • cglib代理
    代理类不是接口时,Spring会切换为使用CGLIB代理,它的工作原理是:直接在class字节码文件添加增强的代码。

思路

在这里只针对ADD、UPDATE、DELETE做相关数据处理。
直接使用注解@annotation的方式是不能实现,所以我先通过execution的方式切到DAO层,再通过一个自定义注解区分数据操作的类型以及区分所操作的是哪一张表,具体详情如下:
  • 记录ADD操作:使用@After注解,由于新增一条数据中如果有自增的值,也需要把自增对应字段的值也要记录,所有在执行完之后记录
  • 记录DELETE操作:使用@Before注解,在执行删除之前,记录原数据。如果在删除之后再记录的话,那条数据已经没有了
  • 记录UPDATE操作:使用@Around注解,记录更新前后的数据,旧数据与新数据有父子关系,这样数据才能一一对应。

主要核心代码

  • 自定义注解类
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface AuditAction {
    /**
     * 操作类型
     */
    Action action() default Action.GET;

    /**
     * 目标table
     */
    String targetTable() default "";
}
  • 操作类型枚举类
public enum Action {
    ADD,
    DELETE,
    UPDATE,
    GET
}
  • 相关DAO层接口中,在需要监控的方法上加上注解
@Mapper
public interface CompanyDao {

    Company getCompanyByNum(int companyNum);

    @AuditAction(action = Action.ADD, targetTable = "company")
    int addCompany(Company company);

    @AuditAction(action = Action.UPDATE, targetTable = "company")
    int updateCompany(Company company);

    @AuditAction(action = Action.DELETE, targetTable = "company")
    int deleteCompany(int companyNum);
}
  • 定义切面类
@Slf4j
@Aspect
@Component
public class SystemAudioAspect {
    // 省略相关业务代码,详细代码请看博客末尾
}
  • 切面类: 监控DELETE操作
    • 对应DELETE操作,这里我采用在执行之前拦截@Before,@Before(value = “execution(public * com.jtcoding.auditlog.dao...delete(..))”)** 拦截所有的delete*方法,通过@AuditAction注解来判定是否需要监控,再通过注解中的targetTable来区分对应是对哪个表的操作,具体代码如下:
/**
 * 拦截DELETE操作,记录被删除的数据
 * @param joinPoint
 */
@Before(value = "execution(public * com.jtcoding.auditlog.dao..*.delete*(..))")
public void doBefore(JoinPoint joinPoint) {
    // 获取方法中的参数
    Object[] args = joinPoint.getArgs();
    // 获取该方法上的 @AuditAction注解
    AuditAction audioAction = this.getAudioActionByJoinPoint(joinPoint);
    if (audioAction != null && audioAction.action() == Action.DELETE) {
        Object obj = null;
        String targetTable = audioAction.targetTable();
        switch (targetTable) {
            case "company":
                int companyNum = (int) args[0];
                obj = companyService.getCompanyByNum(companyNum);
                break;
            case "plan":
                int planNum = (int) args[0];
                obj = planService.getPlanByNum(planNum);
                break;
        }
        if (obj != null) {
            this.addAudioLog(obj, AuditLogDao.DELETE, targetTable, null);
        }
    }
}
  • 切面类: 监控ADD操作
    • 原理与DELETE类似
/**
 * 拦截ADD操作,记录新增的数据
 * @param joinPoint
 */
@After(value = "execution(public * com.jtcoding.auditlog.dao..*.add*(..))")
public void doAfter(JoinPoint joinPoint) {
    // 获取该方法上的 @AuditAction注解
    AuditAction audioAction = this.getAudioActionByJoinPoint(joinPoint);
    if (audioAction != null && audioAction.action() == Action.ADD) {
        Object obj = joinPoint.getArgs()[0];
        this.addAudioLog(obj, AuditLogDao.ADD, audioAction.targetTable(), null);
    }
}
  • 切面类: 监控UPDATE操作
/**
 * 拦截UPDATE操作,记录更新前后的数据
 * @param pjp
 * @return
 * @throws Throwable
 */
@Around(value = "execution(public * com.jtcoding.auditlog.dao..*.update*(..))")
public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
    AuditAction audioAction = this.getAudioActionByJoinPoint(pjp);
    Object proceed = null;
    if (audioAction != null && audioAction.action() == Action.UPDATE) {
        String uuid = UUID.randomUUID().toString();
        Object originalObj = null;
        Object arg = pjp.getArgs()[0];
        String targetTable = audioAction.targetTable();
        switch (targetTable) {
            case "company":
                Company company = (Company) arg;
                originalObj = companyService.getCompanyByNum(company.getCompanyNum());
                break;
            case "plan":
                Plan plan = (Plan) arg;
                originalObj = planService.getPlanByNum(plan.getPlanNum());
                break;
        }
        AuditLog auditLog = null;
        if (originalObj != null) {
            // TODO 在执行原方法之前,记录旧数据
            auditLog = this.addAudioLog(originalObj, AuditLogDao.UPDATE, targetTable, null);
        }
        // 执行原方法
        proceed = pjp.proceed();
        // TODO 在执行原方法之后,记录新数据
        if (auditLog != null) {
            this.addAudioLog(arg, AuditLogDao.UPDATE, targetTable, auditLog.getLogNum());
        }
    }
    if (proceed == null) {
        return pjp.proceed();
    }
    return proceed;
}

至此,有关切面核心的逻辑已经代码已经完成,相关Service和Controller代码,请看这里(源码)

测试

  • 通过Postman进行相关API测试
    • Add Company : /companies POST Request
    • Delete Company : /companies/{companyNum} DELETE Request
    • Update Company : /companies PUT Request
    • …………
  • 具体请求如下图

    新增Company
    删除Company
    获取某一个Company
    修改Company

DB结果

数据库数据

  • 由上图可以看出:
    • 新增操作:记录新增的数据
    • 删除操作:记录原来的数据
    • 更新操作:记录原数据与新数据,两条数据有一个父子关系,方便数据的关联
    • log_type与log_table_name:可以非常清晰的看出操作的是哪张表以及操作类型
    • src_num:可以找到UPDATE操作,前后数据的关联

遗留问题

  • 问题1:监控变更的数据,这里使用的是MySQL数据库,存储类型是VARCHAR(255),所以很容易超出上限。
  • 问题2:如果项目中使用会更改IoC容器加载顺序的Jar,导致切入点无效,可以在使用到DAO接口的地方,加上@Lazy 懒加载注解即可。(该问题纯属本人猜测,还需深度研究)

最后

本人在实际项目中使用的是PostgreSQL数据库,该数据库支持JSON数据格式,后期会更一章整合PostgreSQL的博客,主要新增的内容就是Mybatis处理PostgreSQL中JSON类型的数据方案。以上是个人的思路实现,有不对或者需要优化之处,请指出,谢谢。

源码在这里

作者:JasonDev