用AOP攔截自定義注解並獲取注解屬性與上下文參數（基於Springboot框架）

目錄

• 自定義注解
• 定義切面
  • 獲取上下文信息JoinPoint
  • ProceedingJoinPoint
• 定義測試方法
• 測試結果
• 小結

AOP可以用於日志的設計，這樣話就少不了要獲取上下文的信息，博主在設計日志模塊時考慮了一下此法，整理了一下如何用AOP來攔截你自定義的注解。

自定義注解

首先先自定義一個注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Axin {
    /**
     * 所屬模塊
     * @return
     */
    String module()  default "日志模塊";

    /**
     * 動作描述
     * @return
     */
    String desc()  default "無動作";
}

• @Documented：注解表明制作javadoc時，是否將注解信息加入文檔。如果注解在聲明時使用了@Documented，則在制作javadoc時注解信息會加入javadoc。
• @Target：用來說明該注解可以被聲明在那些元素之前
  • @Target(ElementType.TYPE) //接口、類、枚舉、注解
  • @Target(ElementType.FIELD) //字段、枚舉的常量
  • @Target(ElementType.METHOD) //方法
  • @Target(ElementType.PARAMETER) //方法參數
  • @Target(ElementType.CONSTRUCTOR) //構造函數
  • @Target(ElementType.LOCAL_VARIABLE)//局部變量
  • @Target(ElementType.ANNOTATION_TYPE)//注解
  • @Target(ElementType.PACKAGE) ///包
• @Retention：用來說明該注解類的生命周期。
  • @Retention(RetentionPolicy.SOURCE) —— 這種類型的Annotations只在源代碼級別保留,編譯時就會被忽略
  • @Retention(RetentionPolicy.CLASS) —— 這種類型的Annotations編譯時被保留,在class文件中存在,但JVM將會忽略
  • @Retention(RetentionPolicy.RUNTIME) —— 這種類型的Annotations將被JVM保留,所以他們能在運行時被JVM或其他使用反射機制的代碼所讀取和使用.

定義切面

/**
 * @author Axin
 */
@Aspect
@Component
public class AxinAspect {

    /**
     * 這里定義了一個總的匹配規則，以后攔截的時候直接攔截log()方法即可，無須去重復寫execution表達式
     */
    @Pointcut("@annotation(Axin)")
    public void log() {
    }

    @Before("log()&&@annotation(axin)")
    public void doBefore(JoinPoint joinPoint,Axin axin) {
        System.out.println("******攔截前的邏輯******");
        System.out.println("目標方法名為:" + joinPoint.getSignature().getName());
        System.out.println("目標方法所屬類的簡單類名:" + joinPoint.getSignature().getDeclaringType().getSimpleName());
        System.out.println("目標方法所屬類的類名:" + joinPoint.getSignature().getDeclaringTypeName());
        System.out.println("目標方法聲明類型:" + Modifier.toString(joinPoint.getSignature().getModifiers()));
        //獲取傳入目標方法的參數
        Object[] args = joinPoint.getArgs();
        for (int i = 0; i < args.length; i++) {
            System.out.println("第" + (i + 1) + "個參數為:" + args[i]);
        }
        System.out.println("被代理的對象:" + joinPoint.getTarget());
        System.out.println("代理對象自己:" + joinPoint.getThis());

        System.out.println("攔截的注解的參數：");
        System.out.println(axin.module());
        System.out.println(axin.desc());
    }

    @Around("log()&&@annotation(axin)")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint,Axin axin) throws Throwable {
        System.out.println("環繞通知：");
        System.out.println(axin.module());
        System.out.println(axin.desc());
        Object result = null;
        result = proceedingJoinPoint.proceed();
        return result;
    }

    @After("log()")
    public void doAfter() {
        System.out.println("******攔截后的邏輯******");
    }
}

匹配規則：

//匹配AOP對象的目標對象為指定類型的方法，即DemoDao的aop的代理對象
@Pointcut("this(com.hhu.DemaoDao)")
public void thisDemo() {
    ...
}

通知類別：

• 前置通知（Before advice）- 在目標方便調用前執行通知
• 后置通知（After advice）- 在目標方法完成后執行通知
• 返回通知（After returning advice）- 在目標方法執行成功后，調用通知
• 異常通知（After throwing advice）- 在目標方法拋出異常后，執行通知
• 環繞通知（Around advice）- 在目標方法調用前后均可執行自定義邏輯

獲取上下文信息JoinPoint

JoinPoint對象封裝了SpringAop中切面方法的信息,在切面方法中添加JoinPoint參數,就可以獲取到封裝了該方法信息的JoinPoint對象. 注意：這用於非環繞通知

方法名	功能
Signature getSignature();	獲取封裝了署名信息的對象,在該對象中可以獲取到目標方法名,所屬類的Class等信息
Object[] getArgs();	獲取傳入目標方法的參數對象
Object getTarget();	獲取被代理的對象
Object getThis();	獲取代理對象

方法使用模板：

public void doBefore(JoinPoint joinPoint) {
System.out.println("******攔截前的邏輯******");
System.out.println("目標方法名為:" + joinPoint.getSignature().getName());
System.out.println("目標方法所屬類的簡單類名:" + joinPoint.getSignature().getDeclaringType().getSimpleName());
    System.out.println("目標方法所屬類的類名:" + joinPoint.getSignature().getDeclaringTypeName());
    System.out.println("目標方法聲明類型:" + Modifier.toString(joinPoint.getSignature().getModifiers()));
    //獲取傳入目標方法的參數
    Object[] args = joinPoint.getArgs();
    for (int i = 0; i < args.length; i++) {
        System.out.println("第" + (i + 1) + "個參數為:" + args[i]);
    }
    System.out.println("被代理的對象:" + joinPoint.getTarget());
    System.out.println("代理對象自己:" + joinPoint.getThis());
}

ProceedingJoinPoint

ProceedingJoinPoint對象是JoinPoint的子接口,該對象只用在@Around的切面方法中

方法名	功能
Object proceed() throws Throwable	執行目標方法
Object proceed(Object[] var1) throws Throwable	傳入的新的參數去執行目標方法

定義測試方法

//Service接口
public interface AxinService {
    String axinRun(String arg1, User user);
}

//實現類
/**
 * @author Axin
 */
@Component
public class AxinServiceImpl implements AxinService {

    @Axin(module = "print",desc = "打印")
    @Override
    public String axinRun(String arg1, User user) {
        String res = arg1 + user.getName() + user.getAge();
        return res;
    }

    public String axinRun(String arg1, Person person) {
        String res = arg1 + person.getName() + person.getAge();
        return res;
    }
}

//控制類
/**
 * @author Axin
 */
@RestController
public class HelloController {
    @Autowired
    AxinService axinService;

    @RequestMapping("/hello")
    public String hello() {
        User user = new User();
        user.setAge(10);
        user.setName("張三");
        String res = axinService.axinRun("Test:", user);

        return "Hello Spring Boot!<br>"+res;
    }
}

測試結果

環繞通知：
print
打印
******攔截前的邏輯******
目標方法名為:axinRun
目標方法所屬類的簡單類名:AxinService
目標方法所屬類的類名:com.axin.springboot.service.AxinService
目標方法聲明類型:public abstract
第1個參數為:Test:
第2個參數為:User(id=null, name=張三, age=10, date=null)
被代理的對象:com.axin.springboot.service.AxinServiceImpl@ac2ddcc
代理對象自己:com.axin.springboot.service.AxinServiceImpl@ac2ddcc
攔截的注解的參數：
print
打印
******攔截后的邏輯******

小結

通過上述的代碼演示，我們可以自定義一個注解，然后配置切面來攔截有注解的方法，同時也可以獲得方法傳入的參數來完成你的業務需求。