一文詳解Java如何實現(xiàn)自定義注解
一、@interface 關鍵字
我們想定義一個自己的注解 需要使用 @interface 關鍵字來定義。
如定義一個叫 MyAnnotation 的注解:
public @interface MyAnnotation { }
二、元注解
光加上 @interface 關鍵字 還不夠,我們還需要了解5大元注解
@Retention
@Target
@Documented
@Inherited(JDK8 引入)
@Repeatable(JDK8 引入)
1) @Retention 指定注解的生命周期
@Retention(RetentionPolicy.SOURCE)
其中Retention是一個枚舉類:
- RetentionPolicy.SOURCE : 注解只保留在源文件,當Java文件編譯成class文件的時候,注解被遺棄(.java文件)
- RetentionPolicy.CLASS :注解被保留到class文件,但jvm加載class文件時候被遺棄,這是默認的生命周期(.class文件)
- RetentionPolicy.RUNTIME: 注解不僅被保存到class文件中,jvm加載class文件之后,仍然存在(內(nèi)存中的字節(jié)碼)
2) @Target指定注解可以修飾的元素類型
@Target(ElementType.Field)
- ElementType.ANNOTATION_TYPE - 標記的注解可以應用于注解類型。
- ElementType.CONSTRUCTOR - 標記的注解可以應用于構造函數(shù)。
- ElementType.FIELD - 標記的注解可以應用于字段或屬性。
- ElementType.LOCAL_VARIABLE - 標記的注解可以應用于局部變量。
- ElementType.METHOD - 標記的注解可以應用于方法。
- ElementType.PACKAGE - 標記的注解可以應用于包聲明。
- ElementType.PARAMETER - 標記的注解可以應用于方法的參數(shù)。
- ElementType.TYPE - 標記的注解可以應用于類的任何元素。
3)@Documented指定注解會被JavaDoc工具提取成文檔。默認情況下,JavaDoc是不包括文檔的
4)@Inherited表示該注解會被子類繼承,注意,僅針對類,成員屬性、方法并不受此注釋的影響。
5)@Repeatable表示注解可以重復使用,為了解決同一個注解不能重復在同一類/方法/屬性上使用的問題。
其中最常用的就是 @Retention 跟 @Target。
三、簡單實現(xiàn)
例如實現(xiàn)一個簡單,在標記注解的地方打印一句日志。
定義一個 MyAnnotation 注解,并且定義一個屬性 message 默認值是 ”aaa“。先將該注解加到字段上,看能不能獲取到。
//注解用于字段上 @Target(ElementType.FIELD) //運行時使用 @Retention(RetentionPolicy.RUNTIME) public @interface MyAnnotation { String message() default "aaa"; }
定義一個Student類用于測試:
@Data public class Student { @JSONField(ordinal =0) @MyAnnotation(message = "AAAAAAAAA") public String name; @MyAnnotation(message = "AAAAAAAAA") public Integer score; }
在字段上標注該注解,然后編寫一個main方法獲取該注解的屬性:
public static void main(String[] args) { Class<?> studentClass = Student.class; Field[] fields = studentClass.getDeclaredFields();//獲取所有的類成員變量字段 for (Field field : fields) { String fieldName = field.getName(); //獲取該類成員變量的名字 System.out.println("成員變量名是:" + fieldName); Annotation[] annotations = field.getAnnotations(); //獲取該類成員變量上所有聲明周期是運行時的注解 for (Annotation annotation : annotations) { Class<? extends Annotation> annotationType = annotation.annotationType(); String annotationName = annotationType.getSimpleName();//注解的簡短名稱 System.out.println(" 使用的注解是:" + annotationName); //判斷該注解是不是 MyAnnotation 注解,是的話打印其 id 和 describe 屬性 if (annotationType.equals(MyAnnotation.class)) { MyAnnotation myAnnotation = field.getAnnotation(MyAnnotation.class); String message = myAnnotation.message(); System.out.println(" MyAnnotation注解中的message是:" + message); } } System.out.println(); } }
執(zhí)行后打印的內(nèi)容:
以上就是一個注解的簡單實現(xiàn)。
四、使用切面執(zhí)行自定義注解邏輯
在開發(fā)中一般加上注解之后會自動執(zhí)行一些邏輯,大部分實現(xiàn)的原理是使用切面來實現(xiàn)注解的邏輯的。
1) 首先將剛才的注解修改成放在方法上的:
//注解用于方法 @Target(ElementType.METHOD) //運行時使用 @Retention(RetentionPolicy.RUNTIME) public @interface MyAnnotation { String message() default "aaa"; }
2) 定義一個切面類:
@Component @Aspect @Slf4j public class MyAnnotationAspect { /* * 這是一個切入點 * */ @Pointcut("@annotation(com.demo.aaa.annotation.MyAnnotation)") public void cutMethod(){ } /** * 切點之前 */ @Before("cutMethod()") public void before(JoinPoint joinPoint) throws Throwable { log.info("============ before =========="); } /** * 切點之后 */ @After("cutMethod()") public void after() throws Throwable { log.info("============ after =========="); } /** * 切點返回內(nèi)容后 */ @AfterReturning("cutMethod()") public void afterReturning() throws Throwable { log.info("============ afterReturning =========="); } /** * 切點拋出異常后 */ @AfterThrowing("cutMethod()") public void afterThrowing() throws Throwable { log.info("============ afterThrowing =========="); } @Around("cutMethod() && @annotation(myAnnotation)") public Object around(ProceedingJoinPoint point, MyAnnotation myAnnotation) throws Throwable { log.info("============ around1 =========="); Object obj= point.proceed(point.getArgs()); log.info("============ around2 =========="); return obj; } }
在使用aop之前需要先引入一個依賴:
<dependency> <groupId>org.aspectj</groupId> <artifactId>aspectjweaver</artifactId> <version>1.8.13</version> </dependency>
簡單說一下各個注解代表什么含義:
- @Aspect:作用是把當前類標識為一個切面供容器讀取 ,也就是加上這個注解,spring才知道你這是一個切面類,用于處理切點的邏輯的。
- @Pointcut:切入點,@Pointcut切點表達式非常豐富,可以將 方法(method)、類(class)、接口(interface)、包(package) 等作為切入點,非常靈活,常用的有@annotation、@within、execution等方式,上面的示例使用的是@annotation方式,意思就是說被Spring掃描到方法上帶有@annotation中的注解 就會執(zhí)行切面通知。
- @Before:該注解標注的方法在業(yè)務模塊代碼執(zhí)行之前執(zhí)行,其不能阻止業(yè)務模塊的執(zhí)行,除非拋出異常;
- @AfterReturning:該注解標注的方法在業(yè)務模塊代碼執(zhí)行之后執(zhí)行;
- @AfterThrowing:該注解標注的方法在業(yè)務模塊拋出指定異常后執(zhí)行;
- @After:該注解標注的方法在所有的 Advice 執(zhí)行完成后執(zhí)行,無論業(yè)務模塊是否拋出異常,類似于 finally 的作用;
- @Around:該注解功能最為強大,其所標注的方法用于編寫包裹業(yè)務模塊執(zhí)行的代碼,通知的第一個參數(shù)必須是 ProceedingJoinPoint 類型。在通知體內(nèi),調(diào)用 ProceedingJoinPoint 的 proceed () 方法使得連接點方法執(zhí)行如果不調(diào)用 proceed () 方法,連接點方法則不會執(zhí)行。無論是調(diào)用前邏輯還是調(diào)用后邏輯,都可以在該方法中編寫,甚至其可以根據(jù)一定的條件而阻斷業(yè)務模塊的調(diào)用; 如果切面中使用了@Around 注解,如果不調(diào)用 ProceedingJoinPoint 的 proceed () 方法的話,那么 @Before 和 @After 直接標注的方法也不會被觸發(fā)。@Around 注解標注的方法,在 ProceedingJoinPoint 的 proceed () 方法 前的邏輯是比@Before的邏輯還要靠前, 在proceed () 方法之后的邏輯比 @After 的邏輯還要靠后。
- Joint Point:JointPoint是程序運行過程中可識別的點,這個點可以用來作為AOP切入點。JointPoint對象則包含了和切入相關的很多信息。比如切入點的對象,方法,屬性等。我們可以通過反射的方式獲取這些點的狀態(tài)和信息,用于追蹤tracing和記錄logging應用信息。
3)將注解放入到接口方法中測試:
@GetMapping("/aaa") @MyAnnotation(message = "成功拉!?。。。。。。。。。?!") public void test() { System.out.println("執(zhí)行代碼邏輯"); }
調(diào)用接口之后打印
上面就是自定義注解最簡單的示例。
五、切點表達式
我們定義切點除了使用 @Pointcut() 之外,我們還有豐富的切點表達式可以定義切點。
1)切點表達式簡介
2)通配符合與邏輯運算符
@AspectJ 支持三種通配符:
邏輯運算符: 切點表達式由切點函數(shù)組成,切點函數(shù)之間還可以進行邏輯運算,組成復合切點。
3)切點表達式:
1.arg() :匹配切入點方法的參數(shù)類型,匹配的上才是切點。
語法:args(param-pattern) param-pattern:參數(shù)類型的全路徑。
注意:要先匹配到某些類,不然會報錯,也就是不能單獨用
示例:
@Pointcut("args(java.lang.String)") //這樣就是錯的,不能單獨使用要匹配到某些類 @Pointcut("within(com.example.demo.service.impl.UserServiceImpl) && args(java.lang.String,java.lang.String)") //要像這樣使用 within 先匹配到某個具體的類,在使用args匹配到某個類型參數(shù)的方法
2.@args:匹配切入點方法上的參數(shù)的類上,參數(shù)的類必須要有指定的注解
語法:@args(annotation-type) annotation-type:注解類型的全路徑
注意:也不能單獨使用,必須先指定到類,而且匹配參數(shù)個數(shù)至少有一個且為第一個參數(shù)的類含有該注解才能匹配的上
示例:
@Pointcut("within(com.demo.RedisTest) && @args(com.demo.aaa.annotation.MyAnnotation)")
3.within:匹配切入點的指定類的任意方法,不能匹配接口。
語法:within(declaring-type) 參數(shù)為全路徑的類名(可使用通配符),表示匹配當前表達式的所有類都將被當前方法環(huán)繞
注意: 這個是指定到具體的類
示例:
//within表達式的粒度為類,其參數(shù)為全路徑的類名(可使用通配符),表示匹配當前表達式的所有類都將被當前方法環(huán)繞。如下是within表達式的語法: @Pointcut(within(declaring-type-pattern)) //within表達式只能指定到類級別,如下示例表示匹配com.spring.service.BusinessObject中的所有方法: @Pointcut(within(com.spring.service.BusinessObject)) //within表達式路徑和類名都可以使用通配符進行匹配,比如如下表達式將匹配com.spring.service包下的所有類,不包括子包中的類: @Pointcut(within(com.spring.service.*)) //如下表達式表示匹配com.spring.service包及子包下的所有類: @Pointcut(within(com.spring.service..*))
4.@within:表示匹配帶有指定注解的類。
語法:@within(annotation-type) 注解的全類名
注意:這個是指定到帶有某個注解的類
示例:
//如下所示示例表示匹配使用com.spring.annotation.BusinessAspect注解標注的類: @within(com.spring.annotation.BusinessAspect)
5.@annotation() :匹配帶有指定注解的連接點
語法:@annotation(annotation-type) annotation-type:注解類型的全路徑
示例:
@Pointcut("@annotation(com.test.annotations.LogAuto)")
6.execution() 用于匹配是連接點的執(zhí)行方法,Spring 切面粒度最小是達到方法級別,而 execution 表達式可以用于明確指定方法返回類型,類名,方法名和參數(shù)名等與方法相關的配置,所以是使用最廣泛的。
用法:
- modifiers-pattern:方法的可見性修飾符,如 public,protected,private;
- ret-type-pattern:方法的返回值類型,如 int,void 等;
- declaring-type-pattern:方法所在類的全路徑名,如 com.spring.Aspect;
- name-pattern:方法名,如 getOrderDetail();
- param-pattern:方法的參數(shù)類型,如 java.lang.String;
- throws-pattern:方法拋出的異常類型,如 java.lang.Exception;
示例:
modifiers-pattern:方法的可見性修飾符,如 public,protected,private; ret-type-pattern:方法的返回值類型,如 int,void 等; declaring-type-pattern:方法所在類的全路徑名,如 com.spring.Aspect; name-pattern:方法名,如 getOrderDetail(); param-pattern:方法的參數(shù)類型,如 java.lang.String; throws-pattern:方法拋出的異常類型,如 java.lang.Exception; 示例: // 匹配目標類的所有 public 方法,第一個 * 代表返回類型,第二個 * 代表方法名,..代表方法的參數(shù) execution(public * *(..)) // 匹配目標類所有以 User 為后綴的方法。第一個 * 代表返回類型,*User 代表以 User 為后綴的方法 execution(* *User(..)) // 匹配 User 類里的所有方法 execution(* com.test.demo.User.*(..)) // 匹配 User 類及其子類的所有方法 execution(* com.test.demo.User+.*(..)) : // 匹配 com.test 包下的所有類的所有方法 execution(* com.test.*.*(..)) // 匹配 com.test 包下及其子孫包下所有類的所有方法 execution(* com.test..*.*(..)) : // 匹配 getOrderDetail 方法,且第一個參數(shù)類型是 Long,第二個參數(shù)類型是 String execution(* getOrderDetail(Long, String))
六、切面中獲取各個參數(shù)
示例:
@Around(value = "@annotation(basisLogAnnotation)") public Object demoAop(ProceedingJoinPoint proceedingJoinPoint, final BasisLogAnnotation basisLogAnnotation) throws Throwable { logger.debug("執(zhí)行前:"); Object object = proceedingJoinPoint.proceed(); //執(zhí)行連接點方法,object:方法返回值 logger.debug("執(zhí)行后:"); // 類名 String className = proceedingJoinPoint.getTarget().getClass().getName(); //方法名 String methodName = proceedingJoinPoint.getSignature().getName(); //參數(shù)(我這里是對象,具體根據(jù)個人的參數(shù)類型來強轉) BasisUser basisUser = (BasisUser)proceedingJoinPoint.getArgs()[0]; return object; }
總結
到此這篇關于Java如何實現(xiàn)自定義注解的文章就介紹到這了,更多相關Java自定義注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
IntelliJ?IDEA2022.3?springboot?熱部署含靜態(tài)文件(最新推薦)
這篇文章主要介紹了IntelliJ?IDEA2022.3?springboot?熱部署含靜態(tài)文件,本文結合實例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-01-01基于Java?利用Mybatis實現(xiàn)oracle批量插入及分頁查詢
這篇文章主要介紹了基于Java?利用Mybatis實現(xiàn)oracle批量插入及分頁查詢,文章圍繞主題展開詳細的內(nèi)容介紹,需要的小伙伴可以參考一下2022-07-07Springcloud hystrix服務熔斷和dashboard如何實現(xiàn)
這篇文章主要介紹了Springcloud hystrix服務熔斷和dashboard如何實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-12-12全面匯總SpringBoot和SpringClould常用注解
Java注解是附加在代碼中的一些元信息,用于一些工具在編譯、運行時進行解析和使用,起到說明、配置的功能,這篇文章就帶你來了解一下2021-08-08Java多線程生產(chǎn)者消費者模式實現(xiàn)過程解析
這篇文章主要介紹了Java多線程生產(chǎn)者消費者模式實現(xiàn)過程解析,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-03-03java中計算字符串長度的方法及u4E00與u9FBB的認識
字符串采用unicode編碼的方式時,計算字符串長度的方法找出UNICODE編碼中的漢字的代表的范圍“\u4E00” 到“\u9FBB”之間感興趣的朋友可以參考本文,或許對你有所幫助2013-01-01