2. 程式人生 > >一起來學Java註解（Annotation）

一起來學Java註解（Annotation）

阿新 • • 發佈：2019-10-05

目錄

  • 一. 什麼是Annotation
  • 二. Annotation的作用
    • 2.1 編譯器使用到的註解
    • 2.2 .class檔案使用到的註解
    • 2.3 執行期讀取的註解
  • 三. 定義Annotation
    • 3.1 元註解
    • 3.2 定義註解小結
  • 四. Annotation處理
  • 五. 總結

一. 什麼是Annotation

我們在平時的開發過程中看到很多如@Override，@SuppressWarnings，@Test等樣式的程式碼就是註解，註解是放到類、構造器、方法、屬性、引數前的標記。

二. Annotation的作用

給某個類、方法..添加了一個註解，這個環節僅僅是做了一個標記，對程式碼本身並不會造成任何影響，需要後續環節的配合，需要其他方法對該註解賦予業務邏輯處理。就如同我們在微信上發了一個共享定位，此時並沒有什麼用，只有當後面其他人都進入了這個共享定位，大家之間的距離才能明確，才知道該怎麼聚在一起。

註解分為三類：

2.1 編譯器使用到的註解

如@Override，@SuppressWarnings都是編譯器使用到的註解，作用是告訴編譯器一些事情，而不會進入編譯後的.class檔案。

@Override：告訴編譯器檢查一下是否重寫了父類的方法；

@SuppressWarnings：告訴編譯器忽略該段程式碼產生的警告；

對於開發人員來說，都是直接使用，無需進行其他操作

2.2 .class檔案使用到的註解

需要通過工具對.class位元組碼檔案進行修改的一些註解，某些工具會在類載入的時候，動態修改用某註解標註的.class檔案，從而實現一些特殊的功能，一次性處理完成後，並不會存在於記憶體中，都是非常底層的工具庫、框架會使用，對於開發人員來說，一般不會涉及到。

2.3 執行期讀取的註解

一直存在於JVM中，在執行期間可以讀取的註解，也是最常用的註解，如Spring的@Controller，@Service，@Repository，@AutoWired，Mybatis的@Mapper，Junit的@Test等，這類註解很多都是工具框架自定義在執行期間發揮特殊作用的註解，一般開發人員也可以自定義這類註解。

三. 定義Annotation

我們使用@interface來定義一個註解

/**
 * 定義一個Table註解
 */
public @interface Table {
    String value() default "";
}
/**
 * 定義一個Colum註解
 */
public @interface Colum {
    String value() default "";
    String name() default "";
    String dictType() default "";
}

這樣就簡單地將一個註解定義好了

我們上面定義的註解主要用到了String型別，但實際上還可以是基本資料型別（不能為包裝類）、列舉型別。

註解也有一個約定俗成的東西，最常用的引數應該命名為value，同時一般情況下我們都會通過default引數設定一個預設值。

但這樣是不是就滿足於我們的使用了呢，我想把@Table註解僅用於類上，@Colum註解僅用於屬性上，怎麼辦？而且開始提到的三類註解，一般開發人員用的都是執行期的註解，那我們定義的是嗎？

要回答這些問題，就需要引入一個概念“元註解”。

3.1 元註解

可以修飾註解的註解即為元註解，Java已經定義了一些元註解，我們可以直接使用。

3.1.1 @Target

顧名思義指定註解使用的目標物件，引數為ElementType[]

public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();
}

而下面是ElementType列舉中定義的屬性，不設定Target的時候，除了TYPE_PARAMETER，TYPE_USE，其他地方都相當於配置上了。

public enum ElementType {
    /** 通過ElementType.TYPE可以修飾類、介面、列舉 */
    TYPE,

    /** 通過ElementType.FIELD可以修飾類屬性 */
    FIELD,

    /** 通過ElementType.METHOD可以修飾方法 */
    METHOD,

    /** 通過ElementType.PARAMETER可以修飾引數（如構造器或者方法中的） */
    PARAMETER,

    /** 通過ElementType.CONSTRUCTOR可以修改構造器 */
    CONSTRUCTOR,

    /** 通過ElementType.LOCAL_VARIABLE可以修飾方法內部的區域性變數 */
    LOCAL_VARIABLE,

    /** 通過ElementType.ANNOTATION_TYPE可以修飾註解 */
    ANNOTATION_TYPE,

    /** 通過ElementType.PACKAGE可以修飾包 */
    PACKAGE,

    /**
     * 可以用在Type的宣告式前
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * 可以用在所有使用Type的地方（如泛型、型別轉換等）
     *
     * @since 1.8
     */
    TYPE_USE
}

我們主要說一下ElementType.PACKAGE和1.8新增的ElementType.TYPE_PARAMETER和ElementType.TYPE_USE

ElementType.PACKAGE

@Target(ElementType.PACKAGE)
public @interface Table {
    String value() default "";
}

含義是用來修飾包，但我們用來修飾包的時候卻提示錯誤

我們按照提示建立package-info.java檔案，這裡需要注意一下，通過IDE 進行new --> Java Class是建立不了的，需要通過new File檔案建立

@Table
package annotation;
class PackageInfo {
    public void hello() {
        System.out.println("hello");
    }
}

ElementType.TYPE_PARAMETER和ElementType.TYPE_USE

這兩個一起說，因為它們有相似之處。都是Java1.8後新增的

@Target(ElementType.TYPE_USE)
public @interface NoneEmpty {
    String value() default "";
}
@Target(ElementType.TYPE_PARAMETER)
public @interface NoneBlank {
    String value() default "";
}

很明顯使用ElementType.TYPE_PARMETER修飾的註解@NoneBlank無法在泛型使用的時候編譯通過，僅能用於類的泛型宣告，而通過ElementType.TYPE_USE修飾的註解@NoneEmpty可以。

3.1.2 @Retention

可以用於定義註解的生命週期，引數為列舉RetentionPolicy，包括了SOURCE,CLASS,RUNTIME

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
    /**
     * Returns the retention policy.
     * @return the retention policy
     */
    RetentionPolicy value();
}
public enum RetentionPolicy {
    /**
     * 僅存在於原始碼中，編譯階段會被丟棄，不會包含於class位元組碼檔案中.
     */
    SOURCE,

    /**
     * 【預設策略】，在class位元組碼檔案中存在，在類載入的時被丟棄，執行時無法獲取到
     */
    CLASS,

    /**
     * 始終不會丟棄，可以使用反射獲得該註解的資訊。自定義的註解最常用的使用方式。
     */
    RUNTIME
}

3.1.3 @Documented

表示是否將此註解的相關資訊新增到javadoc文件中

3.1.4 @Inherited

定義該註解和子類的關係，使用此註解宣告出來的自定義註解，在使用在類上面時，子類會自動繼承此註解，否則，子類不會繼承此註解。注意，使用@Inherited宣告出來的註解，只有在類上使用時才會有效，對方法，屬性等其他無效。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Person {
    String value() default "man";
}
@Person
public class Parent {
}
//子類也擁有@Person註解
class Son extends Parent {

}

3.2 定義註解小結

用@interface定義註解

可以新增多個引數，核心引數按約定用value，為每個引數可以設定預設值，引數型別包括基本型別、String和列舉

可以使用元註解來修飾註解，元註解包括多個，必須設定@Target和@Retention，@Retention一般設定為RUNTIME。

四. Annotation處理

我們前面已經提到光配置了註解，其實沒有作用，需要通過相應的程式碼來實現該註解想要表達的邏輯。

註解定義後也是一種class，所有的註解都繼承自java.lang.annotation.Annotation，因此，讀取註解，需要使用反射API。

//定義的註解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Colum {
    String value() default "";
    //用於表示某個屬性代表的中文含義
    String name() default "";
}

用註解@Colum來修飾某個類的屬性

public class Person {

    @Colum(name = "姓名")
    private String name;

    @Colum(name = "性別")
    private String gender;

    @Colum(name = "年齡")
    private int age;

    @Colum(name = "住址")
    private String address;

    public String getName() {return name;}
    public void setName(String name) {this.name = name;}
    public String getGender() {return gender;}
    public void setGender(String gender) {this.gender = gender;}
    public int getAge() {return age;}
    public void setAge(int age) {this.age = age;}
    public String getAddress() {return address;}
    public void setAddress(String address) {this.address = address;}
}

通過反射讀取這個類的所有欄位的中文含義，並儲存到list中，然後打印出來

public static void main(String[] args) throws ClassNotFoundException {
    List<String> columNames = new ArrayList<>();
    Class clazz = Class.forName("annotation.Person");
    //獲取Person類所有屬性
    Field[] fields = clazz.getDeclaredFields();
    for (Field field : fields){
        //獲取該屬性的Colum註解
        Colum colum = field.getAnnotation(Colum.class);
        //或者可以先判斷有無該註解
        field.isAnnotationPresent(Colum.class);
        //將該屬性通過註解配置好的中文含義取出來放到集合中
        columNames.add(colum.name());
    }

    //列印集合
    columNames.forEach((columName) -> System.out.println(columName));
}

結果如下：

姓名
性別
年齡
住址

比如我們有一些常見的應用場景，需要把網站上的列表匯出成excel表格，我們通過註解的方式把列名配置好，再通過反射讀取實體需要匯出（是否需要匯出，也可通過註解配置）的每個欄位的值，從而實現excel匯出的元件。

五. 總結

本文只是拋磚引玉地講解了註解的基本概念，註解的作用，幾種元註解的功用以及使用方法，並通過一個簡單的例子講解了一下註解的處理，並不全面，文中通過Field講解了註解的基本Api，但註解還可以修飾類、構造器、方法等，也有相對應的註解處理方法，大家可自行查一下API手冊相關內容，大同小異，有不對之處，請批評指正，望共同進步，謝

相關推薦

一起來學Java註解（Annotation）

目錄 一. 什麼是Annotation 二. Annotation的作用 2.1 編譯器使用到的註解 2.2 .class檔案使用到的註解 2.3 執行期讀取的註解

秒懂，Java 註解 （Annotation）你可以這樣學

face 幹什麽 有一種 博客 作用 習慣 lis 如果 手機 這處圖片引自老羅的博客。為了避免不必要的麻煩，首先聲明我個人比較尊敬老羅的。至於為什麽放這張圖，自然是為本篇博文服務，接下來我自會說明。好了，可以開始今天的博文了。 Annotation 中文譯過來就是註解、

Java 註解 （Annotation）你可以這樣學

這處圖片引自老羅的部落格。為了避免不必要的麻煩，首先宣告我個人比較尊敬老羅的。至於為什麼放這張圖，自然是為本篇博文服務，接下來我自會說明。好了，可以開始今天的博文了。Annotation 中文譯過來就是註解、標釋的意思，在 Java 中註解是一個很重要的知識點，但經常還是有點

Java 註解 （Annotation）

null lambda roi 實例 cut exce runt 比較 符號 Java 註解用於為 Java 代碼提供元數據。作為元數據，註解不直接影響你的代碼執行，但也有一些類型的註解實際上可以用於這一目的。Java 註解是從 Java5 開始添加到 Java 的。

秒懂Java 註解 （Annotation）

能夠 extend tty 來講 hub 開頭 arrays term con 文章開頭先引入一處圖片。 這處圖片引自老羅的博客。為了避免不必要的麻煩，首先聲明我個人比較尊敬老羅的。至於為什麽放這張圖，自然是為本篇博文服務，接下來我自會說明。好了，可以開始今天的博文了。 A

java註解（Annotation）總結

java註解（Annotation）總結 吐糟時間 註解是什麼 註解有什麼用 註解的分類 怎麼自定義註解 新增屬性 註解的使用 解析執行時（RUNTIME）註解 解析編譯時（CLASS）註解

Java 註解 （Annotation）淺入深出

Java 註解 （Annotation）淺入深出 本文主要參考與借鑑frank909 文章，但更為簡單，詳細。 Annotation 中文譯過來就是註解、標釋的意思。Annotation是一種應用於類、方法、引數、變數、構造器及包宣告中的特殊修飾符。它是一種由JSR-175標準選擇用來描述元資料的一種工具

Java註解（Annotation）學習總結

註解的定義 註解通過 @interface 關鍵字進行定義。 public @interface TestAnnotation { } 它的形式跟介面很類似，不過前面多了一個 @ 符號。上面的程式碼就建立了一個名字為 TestAnnotaion 的註解。你可以簡

Java——註解（Annotation）

註解（Annotation） JDK提供的三個內建註解：@Override、@Deprecated、@SuppressWarnings 1.準確覆寫@Override 檢查當前類中的覆寫方法與父類中定義的同名方法是否相同，如果有任何一個地方不同，編譯報錯 2.過期處理

自定義Java註解（annotation）

https://www.imooc.com/learn/456  筆記 Java從1.5開始引進註解。 首先解決一個問題，為什麼要學習Java註解？ 1.看懂別人寫的程式碼，尤其是框架的程式碼 2.可以是自己寫的程式碼簡潔清晰   現在開始學習Java註解了。  

Java註解（Annotation）介紹

註解（Annotation）是Java5開始引入的新特性。他提供了一種安全的類似註釋的機制，用來將任何的資訊或元資料（metadata）與程式元素（類、方法、成員變數等）進行關聯。        註解

java 註解（annotation）

一、概念： 註解相當於一種標記，在某一個程式上加了註解就相當於為這部分程式打了標記，該標記用來表示該程式段的特徵或形態。我們可以通過javac編譯器、開發工具、程式等使用反射機制來處理這些標記，對不同的標記去做一些不同的事。註解可以加在包、類、方法、方法引數、欄位、區域性變

Java註解（Annotation）基本概念、自定義註解、註解解析器

什麼是註解（Annotation）：　　Annotation（註解）就是Java提供了一種元程式中的元素關聯任何資訊和著任何元資料（metadata）的途徑和方法。Annotion(註解)是一個介面，程式可以通過反射來獲取指定程式元素的Annotion物件，然後通過Annotion物件來獲取註解裡面的元資料。

Java註解（Annotation）——3 例項

本例子旨在使用自定義註解為實體打上標記，為自動生成 sql 提供依據，模擬 hibernate 的註解，至於註解的原理自己搜吧1.定義 Table 註解package test;  import java.lang.annotation.Documented;  import

Java註解（Annotation）：請不要小看我！

map 有意 rop turn 接口 string exceptio support nsh Java註解是一系列元數據，它提供數據用來解釋程序代碼，但是註解並非是所解釋的代碼本身的一部分。註解對於代碼的運行效果沒有直接影響。 網絡上對註解的解釋過於嚴肅、刻板，這

關於Java註解（annotation）的簡單理解

一、什麼是註解？ 　　從 JDK5 開始，Java增加對元資料的支援，也就是註解。簡單理解就是程式碼裡的特殊標誌，這些標誌可以在編譯，類載入，執行時被讀取，並執行相應的處理，以便於其他工具補充資訊或者進行部署。 二、為什麼要使用註解？ 　　註解可以被其他程式（比如：編譯器等）讀取，開發人員可以在不改變原有程式

深入理解Java：註解（Annotation）--註解處理器

fault this urn 復制代碼 lena ide set java lec 深入理解Java：註解（Annotation）--註解處理器 　　如果沒有用來讀取註解的方法和工作，那麽註解也就不會比註釋更有用處了。使用註解的過程中，很重要的一部分就是創建於

深入理解Java的註解（Annotation）：註解處理器（3）

isp 通過反射 out peid 擴展 .cn 自定義註解 忽略 否則 如果沒有用來讀取註解的方法和工作，那麽註解也就不會比註釋更有用處了。使用註解的過程中，很重要的一部分就是創建於使用註解處理器。Java SE5擴展了反射機制的API，以幫助程序員快速的構造自定義註解處

【Java基礎】註解（Annotation）

  Annotation，程式碼裡的特殊標記，在編譯、類載入、執行時被讀取，並執行相應的處理。 使用註解，在不改變原有邏輯的情況下，在原始檔中嵌入一些補充資訊。 Annotation提供了一種為程式元素設定元資料的方法。 Ann

一起來學JavaScript吧（JS兔子領進門）

  首先我們學習一門語言呢不一要學習它的所有歷史，但是一定要知道它的使用基本規則。不要在最基礎的部分出錯。不過胡蘿貝還是帶你瞭解JavaScript的歷史吧。   1994年網景公司（Netscape）釋出了Navigator瀏覽器0.9版（只能用於瀏覽訊息，無法與訪問者進行互動）。為了