Spring AOP 實現自定義註解的示例
自工作後，除瞭一些小項目配置事務使用過 AOP，真正自己寫 AOP 機會很少，另一方面在工作後還沒有寫過自定義註解，一直很好奇註解是怎麼實現他想要的功能的，剛好做項目的時候，經常有人日志打得不夠全，經常出現問題瞭，查日志的才發現忘記打瞭，所以趁此機會，搜瞭一些資料，用 AOP + 自定義註解，實現請求攔截，自定義打日志，玩一下這兩個東西，以下是自己完的一個小例子，也供需要的同學參考。
1. 註解如下：
package cn.bridgeli.demo.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author bridgeli
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
/**
* 方法描述
*
* @return
*/
String desc() default "";
}
2. 切面
package cn.bridgeli.demo.annotation;
import cn.bridgeli.utils.AuthorizeUtil;
import cn.bridgeli.entity.Principal;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
/**
* @author bridgeli
* 1. 這是一個切面類
*/
@Aspect
@Component
@Slf4j
public class MyLogAspect {
/**
* 2. PointCut表示這是一個切點，@annotation表示這個切點切到一個註解上，後面帶該註解的全類名
* 切面最主要的就是切點，所有的故事都圍繞切點發生
* logPointCut()代表切點名稱
*/
@Pointcut("@annotation(cn.bridgeli.demo.annotation.MyLog)")
public void logPointCut() {
}
/**
* 3. 環繞通知
*
* @param joinPoint
* @param myLog
* @return
*/
@Around(value = "logPointCut() && @annotation(myLog)", argNames = "joinPoint,myLog")
public Object logAround(ProceedingJoinPoint joinPoint, MyLog myLog) {
// 獲取方法名
String methodFullPathName = joinPoint.getTarget().getClass().getName() + "#" + joinPoint.getSignature().getName();
// 獲取參數
String params = StringUtils.join(joinPoint.getArgs(), ";");
Principal currentUser = AuthorizeUtil.getCurrentUser();
log.info("當前登陸用戶：" + (null == currentUser ? "" : currentUser.toString()) + "，進入 [ " + methodFullPathName + " ] 方法, 方法的描述：" + myLog.desc() + "，參數為:" + params);
// 繼續執行方法
long startTime = System.currentTimeMillis();
Object result = null;
try {
result = joinPoint.proceed();
} catch (Throwable e) {
log.error("切面執行報錯，參數：" + params, e);
}
long elapsed = System.currentTimeMillis() - startTime;
log.info("[ " + methodFullPathName + " ] 方法執行結束，返回值為：" + (null == result ? "" : result.toString()) + "，用時：" + elapsed);
return result;
}
}
然後隻需要在想使用的地方 @MyLog 就可以瞭，當然也可以加上 @MyLog(desc = “這是方法描述”)，這樣打出來的日志還會有方法是做什麼的，別人看日志的時候能夠一目瞭然。
需要說明的是，我在寫這個切面的時候遇到的一個小問題，在網上看 AOP 的註解，很多人在舉例子的時候都是不關註 @Around 的返回值，所以方法的返回值都寫的 void，因為我對 AOP 也不是很熟，所以當時同樣寫瞭一個 void，結果寫好一測試，返回攔截也正常，日志也打印瞭，被攔截的方法執行也挺正常，但是就是沒有瞭返回值，當時還很奇怪，然後隨便試瞭下返回值改成 Object，竟然對瞭，所以這是一個小坑，也是很多人沒有說明的一點，大傢可以註意下，其實這個問題也很容易想到，@Around 是環繞攔截，在執行完被攔截的方法之後，會繼續執行切面方法，如果切面方法沒有返回值，那麼自然而然就沒有返回值瞭，同理 @After 攔截個人猜測也應該有同樣的問題，大傢可以測試下。
以上就是Spring AOP 實現自定義註解的示例的詳細內容，更多關於Spring AOP 實現自定義註解的資料請關註WalkonNet其它相關文章！
推薦閱讀：
- None Found