Spring注解 AOP@Aspect的详细介绍

前言：在开发过程中，需要对每个方法执行时进行日志记录，故而整理一下有关AOP的相关知识点。

一、基本概念：

1、切面类 @Aspect： 定义切面类，加上@Aspect、@Component注解；//下文有展示

2、切点 @Pointcut：

// 指定切面方法
@Pointcut("execution(public * com.rest.module..*.*(..))")
public void getMethods() {
}

注：execution表达式第一个*表示匹配任意的方法返回值，..(两个点)表示零个或多个，第一个..表示module包及其子包,第二个*表示所有类, 第三个*表示所有方法，第二个..表示方法的任意参数个数

// 指定注解
@Pointcut("@annotation(com.rest.utils.SysPlatLog)")
public void withAnnotationMethods() {
}
注：在这里，自定义了一个注解类，方法加注解即可使用；

/**
 * 系统平台日志记录
 */
public @interface SysPlatLog {
    // 操作名称
    String operateName() default "";
    // 操作描述
    String logNote() default "";
}

3、Advice，在切入点上执行的增强处理，主要有五个注解：

　　@Before  在切点方法之前执行

       @After  在切点方法之后执行

       @AfterReturning 切点方法返回后执行

   　 @AfterThrowing 切点方法抛异常执行

   　 @Around 属于环绕增强，能控制切点执行前，执行后

4、JoinPoint ：方法中的参数JoinPoint为连接点对象，它可以获取当前切入的方法的参数、代理类等信息，因此可以记录一些信息，验证一些信息等；

5、使用&&、||、!、三种运算符来组合切点表达式，表示与或非的关系；

6、@annotation(annotationType) 匹配指定注解为切入点的方法；

7、//aop代理对象
Object aThis = joinPoint.getThis();
//被代理对象
Object target = joinPoint.getTarget();

8、调用切面注解：

@SysPlatLog(operateName = "查看详情",logNote = "查看详情")
@SneakyThrows
public Result getItem(@RequestParam(required = false) String bs){
}

二、代码展示：

package com.npc.rest.utils;

import com.npc.rest.common.properites.AppSupPlatProperties;
import com.sys.model.SysLog;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
import java.util.*;

@Aspect
@Slf4j
@Component
public class SysPlatLogAspect {
    
    /**
     * 指定切面
     */
    @Pointcut("execution(public * com.rest.module..*.*(..))")
    public void getMethods() {
　　 }
    /**
     * 指定注解
     */
    @Pointcut("@annotation(com.rest.utils.SysPlatLog)")
    public void withAnnotationMethods() {
    }
    
    /***
     * 拦截控制层的操作日志
     * @param joinPoint
     * @return
     * @throws Throwable
     */
    @After(value = "getMethods() && withAnnotationMethods()")
    public void recordLog(JoinPoint joinPoint) throws Throwable {
        SysLog sysLog = new SysLog();
        SysPlatLog sysPlatLog = getInter(joinPoint);
        sysLog.setOperateName(sysPlatLog.operateName());
        sysLog.setLogNote(sysPlatLog.logNote());
        sysLog.setLogTime(new Date());
        sysLog.setAppCode(AppSupPlatProperties.getAppCode());
    }

    public SysPlatLog getInter(JoinPoint joinPoint) throws ClassNotFoundException {
        String targetName = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        Object[] arguments = joinPoint.getArgs();
        Class targetClass = Class.forName(targetName);
        Method[] methods = targetClass.getMethods();
        for (Method method : methods) {
            if (method.getName().equals(methodName)) {
                Class[] clazzs = method.getParameterTypes();
                if (clazzs.length == arguments.length) {
                    SysPlatLog sysPlatLog = method.getAnnotation(SysPlatLog.class);
                    return sysPlatLog;
                }
            }
        }
        return null;
    }
}