後端JAVA：說說你對【註解】的理解

本文主要內容如下：

背景

現在已經處於註解盛行時代，註解@Override ，這個註解是再熟悉不過了，還有@Controller、@RequestMapping、@Service.....

註解已經是作爲一個開發中必備的技能了。

如果在面試中被問到註解，說不出個123，就只能回去等通知了。

什麼是註解？

註解annotation是JavaSE5.0中新增功能。可以理解爲註解是一種標記，這種標記可以在編譯、類加載、運行時被讀取，並執行相應的處理。

它可以添加到程序的任何元素上：包聲明、類型聲明、構造方法、普通方法、成員變量、參數。

註解的老大：

    package java.lang.annotation;
    //是個接口
    public interface Annotation {    
        boolean equals(Object obj);
        int hashCode(); 
        String toString(); 
        //獲取註解類型
        Class<? extends Annotation> annotationType();
    }

JDK自帶爲我們提供了元註解，下面就來聊聊JDK的元註解。

元註解有哪些？

JDK爲我們提供五個元註解，位於java.lang.annotation 包目錄下。分別爲：

@Retention
@Target
@Documented
@Inherited
@Repeatable

Retention註解

字面翻譯：

該註解就是定義該註解是作用於什麼階段。

編譯、類加載、運行（使用最多）

註解源碼：

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.ANNOTATION_TYPE)
    public @interface Retention {
        /**
         * Returns the retention policy.
         * @return the retention policy
         */
        RetentionPolicy value();
    }

保留策略

    package java.lang.annotation;
    public enum RetentionPolicy { 
        SOURCE, 
        CLASS, 
        RUNTIME
    }

SOURCE：只在Java源代碼中，編譯器編譯的時候會把它直接丟棄。

CLASS：編譯器將註解記錄在.class文件中。當運行Java程序時，JVM不能獲取註解信息。這是默認值。

RUNTIME：編譯器將註解記錄在.class文件中。當運行Java程序時，JVM也能獲取註解信息。程序可以通過反射獲取註解信息。

注意：如果使用該註解的時候必須指定value的值。

Target註解

字面意義爲目標，下面來看看器源碼：

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.ANNOTATION_TYPE)
    public @interface Target {
        //元素類型
        ElementType[] value();
    }
    public enum ElementType { 
        TYPE, 
        FIELD, 
        METHOD, 
        PARAMETER, 
        CONSTRUCTOR, 
        LOCAL_VARIABLE, 
        ANNOTATION_TYPE, 
        PACKAGE, 
        /** @since 1.8*/
        TYPE_PARAMETER,
        /** @since 1.8*/
        TYPE_USE
    }

Target註解是在聲明創建一個註解的時候，指示該註解可以作用於程序中的哪些元素。

它裏邊也包含一個名爲value的成員變量，value成員變量的值有如下幾種

ANNOTATION_TYPE：指定當前註解只能修飾其它註解
CONSTRUCTOR：指定當前註解只能修飾構造方法
FIELD：指定當前註解只能修飾成員變量
LOCAL_VARIABLE：指定當前註解只能修飾局部變量
METHOD：指定當前註解只能修飾方法
PACKAGE：指定當前註解只能修飾包
PARAMETER：指定當前註解只能修飾參數
TYPE：指定當前註解可以修飾類，接口，其它註解，枚舉等類型

比如說：常用的Spring的註解@Controller，是用來作用於類上的。

Documented 註解

字面意義就是文檔。@Documented用於描述其它類型的annotation應該被作爲被標註的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化。Documented是一個標記註解，沒有成員。

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}

主要是用來生成文檔的，工作中基本上很少使用，作爲了解就可以了。

Inherited 註解

字面意義：

@Inherited註解是在聲明創建一個註解的時候，指定該註解將具有繼承性。

Inherited 源碼：

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.ANNOTATION_TYPE)
    public @interface Inherited {
    }

如果某個類使用了該註解@Xx，則其子類也將自動被此註解@Xx所修飾。

使用模板：

    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @Inherited
    public @interface A {
        
    }
    @A
    public class Base {
        
    }
    //Sub也帶有@A
    public class Sub extends Base {
    }

Repeatable註解

@Repeatable元註解，顧名思義，重複註解，就是在聲明創建註解的時候，指定該註解可以被同一個程序元素多次使用。這是JDK8新增的註解，重複註解只是一種簡單化寫法，這種簡單化寫法是一種假象。多個重複註解其實會被作爲“容器”註解的value成員變量的數組元素。

比如下面Spring中註解ComponentScan：

    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @Documented
    @Repeatable(ComponentScans.class)
    public @interface ComponentScan {
    }
    
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @Documented
    public @interface ComponentScans {
     ComponentScan[] value();
    }

使用案例

    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.ComponentScan;
    import org.springframework.context.annotation.ComponentScans;
    
    @ComponentScans(value = {
            @ComponentScan(value = "com.tian.pakage0"),
            @ComponentScan(value = "com.tian.pakage1")})
    public class MainConfig {
        @Bean
        public User person() {
            return new User();
        }
    }

基本註解

註解必須使用工具來處理，工具負責提取註解中包含的元數據，工具還會根據這些元數據增加額外的功能。下面我們先來了解一下5個基本註解的用法。

Override
SafeVarargs
SuppressWarnings
FunctionalInterface
Deprecated

下面我們就來說說這五個註解。

Override

用於標識方法，標識該方法屬於重寫父類的方法。

    //只能用於方法上
    @Target(ElementType.METHOD)
    //源碼中編譯時就會使用
    @Retention(RetentionPolicy.SOURCE)
    public @interface Override {
    }

此註解表面是重寫父類的方法，只能用於方法上，並且用於編譯階段，我們在開發的時候，如果註解使用不當，在源碼編譯時立馬就會做出提示。

SafeVarargs

@SafeVarargs註解是在JDK7中引入的。此註解適用於接受varargs參數的final和static方法或構造函數。此註解用於確保方法不會對其varargs參數執行不安全的操作。從Java9開始，@SafeVarargs註解也適用於私有實例方法。

@SafeVarargs源碼

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.CONSTRUCTOR, ElementType.METHOD})
    public @interface SafeVarargs {}

使用案例

如果不使用此註解

public class SafevarargsTest {
    public static void main(String[] args) {
        // 傳遞可變參數，參數是泛型集合
        display(10, 20, 30);
        // 傳遞可變參數，參數是非泛型集合
        display("10", 20, 1000L); // 會有編譯警告
    }

    public static <T> void display(T... array) {
        for (T arg : array) {
            System.out.println(arg.getClass().getName() + ":" + arg);
        }
    }
}

display方法會提示

如果我們給這個方法添加此註解後

上面的代碼在可變參數display前添加了@SafeVarargs註解，當然也可以使用 @SuppressWarnings("unchecked") 註解，可是，兩者相比較來說的話@SafeVarargs註解更適合。

注意：@SafeVarargs註解不適用於非static或非final聲明的方法，對於未聲明爲static或final的方法，假如，要抑制unchecked警告，可以使用@SuppressWarnings註解。

SuppressWarnings

用於有選擇的關閉編譯器對類、方法、成員變量、變量初始化的警告。

    @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
    @Retention(RetentionPolicy.SOURCE)
    public @interface SuppressWarnings {
        String[] value();
    }

編譯時期就會做出提示，使用範圍也是比較廣泛，可以適用於類、接口、枚舉、方法、字段等。

我們開發過程中見過最多的應該是集合存放數據的時候，比如下面的例子。

但是如果我們把第一行代碼註釋放開。

這樣就不會提示了。

FunctionalInterface

JDK8新增註解。@FunctionalInterface標記在接口上，“函數式接口”是指僅僅只包含一個抽象方法的接口。

源碼

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    public @interface FunctionalInterface {}

1、該註解只能標記在”有且僅有一個抽象方法”的接口上。

2、JDK8接口中的靜態方法和默認方法，都不算是抽象方法。

3、接口默認繼承java.lang.Object，所以如果接口顯示聲明覆蓋了Object中方法，那麼也不算抽象方法。

4、該註解不是必須的，如果一個接口符合”函數式接口”定義，那麼加不加該註解都沒有影響。加上該註解能夠更好地讓編譯器進行檢查。如果編寫的不是函數式接口，但是加上了@FunctionInterface，那麼編譯器會報錯。

5、@FunctionalInterface 註解的interface。它的特點是其中只有一個子類必須要實現的abstract方法。

使用場景

Callable、Runnable等就有使用到。

    @FunctionalInterface
    public interface Callable<V> {
        V call() throws Exception;
    }

    @FunctionalInterface
    public interface Runnable {
        public abstract void run();
    }

Deprecated

用於標識方法或類，標識該類或方法已過時，建議不要使用。

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
    public @interface Deprecated {
    }

使用範圍就想到廣泛了，構造方法、字段、方法等。

注意：只是提示過時了，不建議使用，不代表不能用，但是我們如果想用某個使用此註解標記的方法或者類的時候，建議找找有沒有替換方案，實在沒有替換方案，搞清楚爲什麼它會被設置成過時，使用不當可能會對我們的程序造成你意想不到問題，也可能會挖坑。

自定義註解

終於來到自定義了，下面我們來自定義一個註解。

使用@interface自定義註解時，自動繼承了java.lang.annotation.Annotation接口，由編譯程序自動完成其他細節。在定義註解時，不能繼承其他的註解或接口。@interface用來聲明一個註解，其中的每一個方法實際上是聲明瞭一個配置參數。方法的名稱就是參數的名稱，返回值類型就是參數的類型（返回值類型只能是基本類型、Class、String、enum）。可以通過default來聲明參數的默認值。

格式

    public @interface 註解名 {定義體}

案例

自定義我們的註解

    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    public @interface  MyInterface {
        String value() default "";
    }

使用階段爲運行階段，目標是在方法上。定義一個屬性value默認值爲空字符串。

下面我們就來使用我們定義的註解。

    import java.lang.reflect.Method;
    
    public class InterfaceDemo {
    
        //@MyInterface("老田自定義的註解")
         //@MyInterface
        @MyInterface(value = "老田自定義的註解")
        public void test() {
            // TODO:
        }
    
        public static void main(String[] args) {
            InterfaceDemo interfaceDemo = new InterfaceDemo();
            Class<?> clazz = interfaceDemo.getClass();
            Method[] methods = clazz.getMethods();
            for (Method method : methods) {
                if ("test".contentEquals(method.getName())) {
                    System.out.println("方法名稱= " + method.getName());
                    MyInterface myInterface = method.getAnnotation(MyInterface.class);
                    System.out.println("方法上的註解= " + myInterface);
                    System.out.println("枚舉值= " + myInterface.value());
                }
            }
        }
    }

如果沒有指定value的值，那就使用默認值，value兩種方式賦值：

    @MyInterface("老田自定義的註解")
    @MyInterface(value = "老田自定義的註解")

然後我們運行上面的代碼，輸出結果爲：

以上我們就搞定了自定義註解以及使用，獲取屬性值。

註解是普通類還是接口？

使用javap查看我們自定義的註解.class文件內容。

這裏Annotation是接口：

    public interface Annotation {
    }

那麼證明，我們自定義的註解是extend接口Annotation，由此可知註解就是接口。

自定義註解注意點

解參數的可支持數據類型：

所有基本數據類型（int,float,boolean,byte,double,char,long,short)
String類型
Class類型
enum類型
Annotation類型
以上所有類型的數組

Annotation類型裏面的參數該怎麼設定：

只能用public或默認(default)這兩個訪問權修飾.例如,String value();這裏把方法設爲defaul默認類型。
參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和 String,Enum,Class,annotations等數據類型,以及這一些類型的數組.例如,String value();這裏的參數成員就爲String。
如果只有一個參數成員,最好把參數名稱設爲"value",後加小括號.例:下面的例子FruitName註解就只有一個參數成員。

如何獲取註解？

共有以下五種方式：

獲取類上的註解：Class類的getAnnotation()
獲取方法上的註解：Method類的getAnnotation()
獲取字段上的註解：Field類的 getAnnotation()
獲取構造方法上的註解：Constructor類的getAnnotation()
獲取包上的註解：Package類的getAnnotation()

如果此元素上存在指定的註釋類型，則此方法返回該元素的註釋，否則返回null。從上面的的集中方式中發現，都是使用getAnnotation()方法獲取的，相信大多數人都能猜到爲什麼都是同一個方法名稱。

下面就來說說Java中註解獲取的鼻祖：

java.lang.reflect.AnnotatedElement

此接口所有方法

看看AnnotatedElement類圖：

發現前面說的獲取註解的類，全部都實現了AnnotatedElement接口。

所以程序通過反射獲取了某個類的AnnotatedElement對象之後，程序就可以調用該對象的方法。

如下四個個方法來訪問Annotation信息：

「getAnnotation」

返回該程序元素上存在的、指定類型的註解，如果該類型註解不存在，則返回null。

「getAnnotations」

返回該程序元素上存在的所有註解。

「isAnnotationPresent」

判斷該程序元素上是否包指定類型的註解，存在則返回true，否則返回false。

「getDeclaredAnnotations」

返回直接存在於此元素上的所有註釋。與此接口中的其他方法不同，該方法將忽略繼承的註釋。（如果沒有註釋直接存在於此元素上，則返回長度爲零的一個數組。）該方法的調用者可以隨意修改返回的數組；這不會對其他調用者返回的數組產生任何影響

總結

爲什麼要學習註解？元註解有哪些？基本註解有哪些？如何自定義註解？註解是普通類還是接口？自定義註解需要注意些什麼？獲取獲取註解？

參考:

qqe2.com/java/post/1853.html cnblogs.com/peida/archive/2013/04/24/3036689.html

IT技術分享社區

個人博客網站：https://programmerblog.xyz

後端JAVA：說說你對【註解】的理解

背景

什麼是註解？

元註解有哪些？

Retention註解

Target註解

Documented 註解

Inherited 註解

Repeatable註解

基本註解

Override

SafeVarargs

SuppressWarnings

FunctionalInterface

Deprecated

自定義註解

格式

案例

註解是普通類還是接口？

自定義註解注意點

如何獲取註解？

總結

通過HPA+CronHPA組合應對業務複雜彈性伸縮場景

村莊裏有幾條瘋狗？

後端JAVA：說說你對【註解】的理解

港口定位項目開發筆記1·微信小程序端

JY03文件管理

【網絡工程師配置篇】——BGP路由基礎配置（eNSP）

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結