Spring AOP 實(shí)現(xiàn)自定義注解的示例
自工作后,除了一些小項(xiàng)目配置事務(wù)使用過(guò) AOP,真正自己寫(xiě) AOP 機(jī)會(huì)很少,另一方面在工作后還沒(méi)有寫(xiě)過(guò)自定義注解,一直很好奇注解是怎么實(shí)現(xiàn)他想要的功能的,剛好做項(xiàng)目的時(shí)候,經(jīng)常有人日志打得不夠全,經(jīng)常出現(xiàn)問(wèn)題了,查日志的才發(fā)現(xiàn)忘記打了,所以趁此機(jī)會(huì),搜了一些資料,用 AOP + 自定義注解,實(shí)現(xiàn)請(qǐng)求攔截,自定義打日志,玩一下這兩個(gè)東西,以下是自己完的一個(gè)小例子,也供需要的同學(xué)參考。
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. 這是一個(gè)切面類(lèi)
*/
@Aspect
@Component
@Slf4j
public class MyLogAspect {
/**
* 2. PointCut表示這是一個(gè)切點(diǎn),@annotation表示這個(gè)切點(diǎn)切到一個(gè)注解上,后面帶該注解的全類(lèi)名
* 切面最主要的就是切點(diǎn),所有的故事都圍繞切點(diǎn)發(fā)生
* logPointCut()代表切點(diǎn)名稱(chēng)
*/
@Pointcut("@annotation(cn.bridgeli.demo.annotation.MyLog)")
public void logPointCut() {
}
/**
* 3. 環(huán)繞通知
*
* @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();
// 獲取參數(shù)
String params = StringUtils.join(joinPoint.getArgs(), ";");
Principal currentUser = AuthorizeUtil.getCurrentUser();
log.info("當(dāng)前登陸用戶(hù):" + (null == currentUser ? "" : currentUser.toString()) + ",進(jìn)入 [ " + methodFullPathName + " ] 方法, 方法的描述:" + myLog.desc() + ",參數(shù)為:" + params);
// 繼續(xù)執(zhí)行方法
long startTime = System.currentTimeMillis();
Object result = null;
try {
result = joinPoint.proceed();
} catch (Throwable e) {
log.error("切面執(zhí)行報(bào)錯(cuò),參數(shù):" + params, e);
}
long elapsed = System.currentTimeMillis() - startTime;
log.info("[ " + methodFullPathName + " ] 方法執(zhí)行結(jié)束,返回值為:" + (null == result ? "" : result.toString()) + ",用時(shí):" + elapsed);
return result;
}
}
然后只需要在想使用的地方 @MyLog 就可以了,當(dāng)然也可以加上 @MyLog(desc = “這是方法描述”),這樣打出來(lái)的日志還會(huì)有方法是做什么的,別人看日志的時(shí)候能夠一目了然。
需要說(shuō)明的是,我在寫(xiě)這個(gè)切面的時(shí)候遇到的一個(gè)小問(wèn)題,在網(wǎng)上看 AOP 的注解,很多人在舉例子的時(shí)候都是不關(guān)注 @Around 的返回值,所以方法的返回值都寫(xiě)的 void,因?yàn)槲覍?duì) AOP 也不是很熟,所以當(dāng)時(shí)同樣寫(xiě)了一個(gè) void,結(jié)果寫(xiě)好一測(cè)試,返回?cái)r截也正常,日志也打印了,被攔截的方法執(zhí)行也挺正常,但是就是沒(méi)有了返回值,當(dāng)時(shí)還很奇怪,然后隨便試了下返回值改成 Object,竟然對(duì)了,所以這是一個(gè)小坑,也是很多人沒(méi)有說(shuō)明的一點(diǎn),大家可以注意下,其實(shí)這個(gè)問(wèn)題也很容易想到,@Around 是環(huán)繞攔截,在執(zhí)行完被攔截的方法之后,會(huì)繼續(xù)執(zhí)行切面方法,如果切面方法沒(méi)有返回值,那么自然而然就沒(méi)有返回值了,同理 @After 攔截個(gè)人猜測(cè)也應(yīng)該有同樣的問(wèn)題,大家可以測(cè)試下。
以上就是Spring AOP 實(shí)現(xiàn)自定義注解的示例的詳細(xì)內(nèi)容,更多關(guān)于Spring AOP 實(shí)現(xiàn)自定義注解的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Spring RestTemplate簡(jiǎn)化HTTP通信實(shí)現(xiàn)功能探究
這篇文章主要為大家介紹了Spring框架中的RestTemplate,如果你是個(gè)Java程序員,那么你肯定知道Spring框架的重要性,在Spring的眾多工具中,RestTemplate是用來(lái)簡(jiǎn)化HTTP通信的一個(gè)強(qiáng)大工具2024-01-01
如何將默認(rèn)的maven倉(cāng)庫(kù)改為阿里的maven倉(cāng)庫(kù)
這篇文章主要介紹了如何將默認(rèn)的maven倉(cāng)庫(kù)改為阿里的maven倉(cāng)庫(kù),本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-12-12
JAVA遞歸與非遞歸實(shí)現(xiàn)斐波那契數(shù)列
這篇文章主要為大家詳細(xì)介紹了JAVA遞歸與非遞歸實(shí)現(xiàn)斐波那契數(shù)列,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-02-02
淺談java object對(duì)象在heap中的結(jié)構(gòu)
本文主要介紹了淺談java object對(duì)象在heap中的結(jié)構(gòu),感興趣的同學(xué),可以參考下。2021-06-06
java數(shù)據(jù)庫(kù)連接池的特點(diǎn)及步驟
大家好,本篇文章主要講的是數(shù)據(jù)庫(kù)連接池的特點(diǎn)及步驟,感興趣的同學(xué)趕快來(lái)看一看吧,對(duì)你有幫助的話(huà)記得收藏一下,方便下次瀏覽2021-12-12
SpringBoot項(xiàng)目中集成Apollo的方法步驟
本文主要介紹了SpringBoot項(xiàng)目中集成Apollo的方法步驟,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-10-10

