詳解Java如何實現(xiàn)自定義注解
概念
概念:說明程序的。給計算機看的
注釋:用文字描述程序的。給程序員看的
定義:注解(Annotation),也叫元數(shù)據(jù)。一種代碼級別的說明。它是JDK1.5及以后版本引入的一個特性,與類、接口、枚舉是在同一個層次。它可以聲明在包、類、字段、方法、局部變量、方法參數(shù)等的前面,用來對這些元素進行說明,注釋。
作用
作用分類:
- 編寫文檔:通過代碼里標識的注解生成文檔【生成文檔doc文檔】
- 代碼分析:通過代碼里標識的注解對代碼進行分析【使用反射】
- 編譯檢查:通過代碼里標識的注解讓編譯器能夠?qū)崿F(xiàn)基本的編譯檢查【Override】
JDK中預定義的一些注解
@Override:檢測被該注解標注的方法是否是繼承自父類(接口)的
@Deprecated:該注解標注的內(nèi)容,表示已過時
@SuppressWarnings:壓制警告
一般傳遞參數(shù)all @SuppressWarnings("all")
注解生成文檔案例
要生成doc文檔的api類案例:
/** * 注解javadoc演示 * * @author zjq * @version 1.0 * @since 1.5 */ public class AnnoDoc { /** * 計算兩數(shù)的和 * @param a 整數(shù) * @param b 整數(shù) * @return 兩數(shù)的和 */ public int add(int a, int b ){ return a + b; } }
在對應的類目錄進入cmd,執(zhí)行如下命令
javadoc AnnoDoc.java
執(zhí)行完成后可以看到生成了很多html和js等前端文件,點擊index.html??梢钥吹饺缦滦Ч?/p>
自定義注解
格式
元注解
public @interface 注解名稱{
屬性列表;
}
本質(zhì)
注解本質(zhì)上就是一個接口,該接口默認繼承Annotation接口
public interface MyAnno extends java.lang.annotation.Annotation {}
屬性:接口中的抽象方法
要求:
1.屬性的返回值類型有下列取值
基本數(shù)據(jù)類型
String
枚舉
注解
以上類型的數(shù)組
2.定義了屬性,在使用時需要給屬性賦值
- 如果定義屬性時,使用default關鍵字給屬性默認初始化值,則使用注解時,可以不進行屬性的賦值。
- 如果只有一個屬性需要賦值,并且屬性的名稱是value,則value可以省略,直接定義值即可。
- 數(shù)組賦值時,值使用{}包裹。如果數(shù)組中只有一個值,則{}可以省略
案例:
定義
public @interface MyAnno { int value(); Person per(); MyAnno2 anno2(); String[] strs(); } public enum Person { P1,P2; }
使用
@MyAnno(value=12,per = Person.P1,anno2 = @MyAnno2,strs="bbb") public class Worker { }
元注解:用于描述注解的注解
@Target:描述注解能夠作用的位置
- ElementType取值:
- TYPE:可以作用于類上
- METHOD:可以作用于方法上
- FIELD:可以作用于成員變量上
@Retention:描述注解被保留的階段
@Retention(RetentionPolicy.RUNTIME):當前被描述的注解,會保留到class字節(jié)碼文件中,并被JVM讀取到,自定義注解一般用這個。
@Documented:描述注解是否被抽取到api文檔中
@Inherited:描述注解是否被子類繼承
在程序使用(解析)注解:獲取注解中定義的屬性值
之前我們在反射中有通過讀取配置文件來創(chuàng)建任意類的對象,執(zhí)行任意方法。具體反射內(nèi)容可以看我的這篇文章:Java框架設計靈魂之反射的示例詳解
之前反射中我們通過讀取對應的配置文件然后創(chuàng)建類和執(zhí)行方法,代碼如下:
/** 前提:不能改變該類的任何代碼??梢詣?chuàng)建任意類的對象,可以執(zhí)行任意方法 */ //1.加載配置文件 //1.1創(chuàng)建Properties對象 Properties pro = new Properties(); //1.2加載配置文件,轉換為一個集合 //1.2.1獲取class目錄下的配置文件 ClassLoader classLoader = ReflectTest.class.getClassLoader(); InputStream is = classLoader.getResourceAsStream("pro.properties"); pro.load(is); //2.獲取配置文件中定義的數(shù)據(jù) String className = pro.getProperty("className"); String methodName = pro.getProperty("methodName"); //3.加載該類進內(nèi)存 Class cls = Class.forName(className); //4.創(chuàng)建對象 Object obj = cls.newInstance(); //5.獲取方法對象 Method method = cls.getMethod(methodName); //6.執(zhí)行方法 method.invoke(obj);
我們可以通過注解替換上述讀取配置文件相關操作。具體代碼如下:
注解定義如下:
/** * 描述需要執(zhí)行的類名,和方法名 * @author zjq */ @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface Pro { String className(); String methodName(); }
通過解析注解配置,執(zhí)行相關對象創(chuàng)建和執(zhí)行對象方法。
- 獲取注解定義的位置的對象 (Class,Method,Field)
- 獲取指定的注解
- 調(diào)用注解中的抽象方法獲取配置的屬性值
代碼如下:
@Pro(className = "com.zjq.javabase.base25.annotation.Demo1",methodName = "show") public class ReflectTest { public static void main(String[] args) throws Exception { /** * 前提:不能改變該類的任何代碼??梢詣?chuàng)建任意類的對象,可以執(zhí)行任意方法 */ //1.解析注解 //1.1獲取該類的字節(jié)碼文件對象 Class<ReflectTest> reflectTestClass = ReflectTest.class; //2.獲取上邊的注解對象 //其實就是在內(nèi)存中生成了一個該注解接口的子類實現(xiàn)對象 /* public class ProImpl implements Pro{ public String className(){ return "com.zjq.javabase.base25.annotation.Demo1"; } public String methodName(){ return "show"; } } */ Pro an = reflectTestClass.getAnnotation(Pro.class); //3.調(diào)用注解對象中定義的抽象方法,獲取返回值 String className = an.className(); String methodName = an.methodName(); System.out.println(className); System.out.println(methodName); //4.加載該類進內(nèi)存 Class cls = Class.forName(className); //5.創(chuàng)建對象 Object obj = cls.newInstance(); //6.獲取方法對象 Method method = cls.getMethod(methodName); //7.執(zhí)行方法 method.invoke(obj); } }
案例:通過自定義注解定義一個簡單的測試框架
定義一個測試注解
@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface Check { }
定義一個計算器工具類,并在方法上使用@Check注解
/** * 小明定義的計算器類 * @author zjq */ public class Calculator { //加法 @Check public void add(){ String str = null; str.toString(); System.out.println("1 + 0 =" + (1 + 0)); } //減法 @Check public void sub(){ System.out.println("1 - 0 =" + (1 - 0)); } //乘法 @Check public void mul(){ System.out.println("1 * 0 =" + (1 * 0)); } //除法 @Check public void div(){ System.out.println("1 / 0 =" + (1 / 0)); } public void show(){ System.out.println("永無bug..."); } }
定義測試框架類并執(zhí)行測試,把測試異常記錄到bug.txt文件中,代碼如下:
/** * 簡單的測試框架 * 當主方法執(zhí)行后,會自動自行被檢測的所有方法(加了Check注解的方法),判斷方法是否有異常, * 記錄到文件中 * * @author zjq */ public class TestCheck { public static void main(String[] args) throws IOException { //1.創(chuàng)建計算器對象 Calculator c = new Calculator(); //2.獲取字節(jié)碼文件對象 Class cls = c.getClass(); //3.獲取所有方法 Method[] methods = cls.getMethods(); int number = 0;//出現(xiàn)異常的次數(shù) BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt")); for (Method method : methods) { //4.判斷方法上是否有Check注解 if (method.isAnnotationPresent(Check.class)) { //5.有,執(zhí)行 try { method.invoke(c); } catch (Exception e) { //6.捕獲異常 //記錄到文件中 number++; bw.write(method.getName() + " 方法出異常了"); bw.newLine(); bw.write("異常的名稱:" + e.getCause().getClass().getSimpleName()); bw.newLine(); bw.write("異常的原因:" + e.getCause().getMessage()); bw.newLine(); bw.write("--------------------------"); bw.newLine(); } } } bw.write("本次測試一共出現(xiàn) " + number + " 次異常"); bw.flush(); bw.close(); } }
執(zhí)行測試后可以在src同級目錄查看到bug.txt文件內(nèi)容如下:
add 方法出異常了
異常的名稱:NullPointerException
異常的原因:null
--------------------------
div 方法出異常了
異常的名稱:ArithmeticException
異常的原因:/ by zero
--------------------------
本次測試一共出現(xiàn) 2 次異常
總結
1.大多數(shù)時候,我們只是使用注解,而不是自定義注解。
2.注解不是程序的一部分,可以理解為注解就是一個標簽。
3.注解給誰用?
編譯器
給解析程序用
到此這篇關于詳解Java如何實現(xiàn)自定義注解的文章就介紹到這了,更多相關Java自定義注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
Java lambda list轉換map時,把多個參數(shù)拼接作為key操作
這篇文章主要介紹了Java lambda list轉換map時,把多個參數(shù)拼接作為key操作,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-08-08SpringBoot整合Netty實現(xiàn)WebSocket的示例代碼
本文主要介紹了SpringBoot整合Netty實現(xiàn)WebSocket的示例代碼,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2022-05-05詳解Java如何優(yōu)雅的調(diào)用dubbo同時不使用其它jar包
這篇文章主要介紹了如何在不使用他人jar包的情況下優(yōu)雅的進行dubbo調(diào)用,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習吧2023-02-02springboot3請求參數(shù)種類及接口測試案例小結
這篇文章主要介紹了springboot3請求參數(shù)種類及接口測試案例小結,本文通過實例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友參考下吧2023-10-10