詳解Java如何實現自定義註解

2022-06-21 22:02:16

概念

概念：說明程式的。給計算機看的

註釋：用文字描述程式的。給程式設計師看的

定義：註解（Annotation），也叫後設資料。一種程式碼級別的說明。它是JDK1.5及以後版本引入的一個特性，與類、介面、列舉是在同一個層次。它可以宣告在包、類、欄位、方法、區域性變數、方法引數等的前面，用來對這些元素進行說明，註釋。

作用

作用分類：

編寫檔案：通過程式碼裡標識的註解生成檔案【生成檔案doc檔案】
程式碼分析：通過程式碼裡標識的註解對程式碼進行分析【使用反射】
編譯檢查：通過程式碼裡標識的註解讓編譯器能夠實現基本的編譯檢查【Override】

JDK中預定義的一些註解

@Override：檢測被該註解標註的方法是否是繼承自父類別(介面)的

@Deprecated：該註解標註的內容，表示已過時

@SuppressWarnings：壓制警告

一般傳遞引數all @SuppressWarnings("all")

註解生成檔案案例

要生成doc檔案的api類案例：

/**
 * 註解javadoc演示
 *
 * @author zjq
 * @version 1.0
 * @since 1.5
 */
public class AnnoDoc {
 
    /**
     * 計算兩數的和
     * @param a 整數
     * @param b 整數
     * @return 兩數的和
     */
    public int add(int a, int b ){
        return a + b;
    }
}

在對應的類目錄進入cmd，執行如下命令

javadoc AnnoDoc.java

執行完成後可以看到生成了很多html和js等前端檔案，點選index.html。可以看到如下效果：

自定義註解

格式

元註解
public @interface 註解名稱{
屬性列表;
}

本質

註解本質上就是一個介面，該介面預設繼承Annotation介面

public interface MyAnno extends java.lang.annotation.Annotation {}

屬性：介面中的抽象方法

要求：

1.屬性的返回值型別有下列取值

基本資料型別

String

列舉

註解

以上型別的陣列

2.定義了屬性，在使用時需要給屬性賦值

如果定義屬性時，使用default關鍵字給屬性預設初始化值，則使用註解時，可以不進行屬性的賦值。
如果只有一個屬性需要賦值，並且屬性的名稱是value，則value可以省略，直接定義值即可。
陣列賦值時，值使用{}包裹。如果陣列中只有一個值，則{}可以省略

案例：

定義

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位元組碼檔案中，並被JVM讀取到，自定義註解一般用這個。

@Documented：描述註解是否被抽取到api檔案中

@Inherited：描述註解是否被子類繼承

在程式使用(解析)註解：獲取註解中定義的屬性值

之前我們在反射中有通過讀取組態檔來建立任意類的物件，執行任意方法。具體反射內容可以看我的這篇文章：Java框架設計靈魂之反射的範例詳解

之前反射中我們通過讀取對應的組態檔然後建立類和執行方法，程式碼如下：

/**
前提：不能改變該類的任何程式碼。可以建立任意類的物件，可以執行任意方法
*/
 
//1.載入組態檔
//1.1建立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.獲取組態檔中定義的資料
String className = pro.getProperty("className");
String methodName = pro.getProperty("methodName");
 
 
//3.載入該類進記憶體
Class cls = Class.forName(className);
//4.建立物件
Object obj = cls.newInstance();
//5.獲取方法物件
Method method = cls.getMethod(methodName);
//6.執行方法
method.invoke(obj);

我們可以通過註解替換上述讀取組態檔相關操作。具體程式碼如下：

註解定義如下：

/**
 * 描述需要執行的類名，和方法名
 * @author zjq
 */
 
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
 
    String className();
    String methodName();
}

通過解析註解設定，執行相關物件建立和執行物件方法。

獲取註解定義的位置的物件（Class，Method,Field）
獲取指定的註解
呼叫註解中的抽象方法獲取設定的屬性值

程式碼如下：

@Pro(className = "com.zjq.javabase.base25.annotation.Demo1",methodName = "show")
public class ReflectTest {
    public static void main(String[] args) throws Exception {
 
        /**
         * 前提：不能改變該類的任何程式碼。可以建立任意類的物件，可以執行任意方法
         */
 
        //1.解析註解
        //1.1獲取該類的位元組碼檔案物件
        Class<ReflectTest> reflectTestClass = ReflectTest.class;
        //2.獲取上邊的註解物件
        //其實就是在記憶體中生成了一個該註解介面的子類實現物件
        /*
            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.呼叫註解物件中定義的抽象方法，獲取返回值
        String className = an.className();
        String methodName = an.methodName();
        System.out.println(className);
        System.out.println(methodName);
 
 
        //4.載入該類進記憶體
        Class cls = Class.forName(className);
        //5.建立物件
        Object obj = cls.newInstance();
        //6.獲取方法物件
        Method method = cls.getMethod(methodName);
        //7.執行方法
        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...");
    }
 
}

定義測試框架類並執行測試,把測試異常記錄到bug.txt檔案中，程式碼如下：

/**
 * 簡單的測試框架
 * 當主方法執行後，會自動自行被檢測的所有方法(加了Check註解的方法)，判斷方法是否有異常，
 * 記錄到檔案中
 *
 * @author zjq
 */
public class TestCheck {
 
    public static void main(String[] args) throws IOException {
        //1.建立計算器物件
        Calculator c = new Calculator();
        //2.獲取位元組碼檔案物件
        Class cls = c.getClass();
        //3.獲取所有方法
        Method[] methods = cls.getMethods();
 
        int number = 0;//出現異常的次數
        BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));
 
 
        for (Method method : methods) {
            //4.判斷方法上是否有Check註解
            if (method.isAnnotationPresent(Check.class)) {
                //5.有，執行
                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("本次測試一共出現 " + number + " 次異常");
 
        bw.flush();
        bw.close();
 
    }
 
}

執行測試後可以在src同級目錄檢視到bug.txt檔案內容如下：

add 方法出異常了
異常的名稱:NullPointerException
異常的原因:null
--------------------------
div 方法出異常了
異常的名稱:ArithmeticException
異常的原因:/ by zero
--------------------------
本次測試一共出現 2 次異常