Java注解

注解是什么

對(duì)于很多初次接觸的開發(fā)者來(lái)說(shuō)應(yīng)該都有這個(gè)疑問?Annontation是Java5開始引入的新特征,中文名稱叫注解。它提供了一種安全的類似注釋的機(jī)制,用來(lái)將任何的信息或元數(shù)據(jù)(metadata)與程序元素(類、方法、成員變量等)進(jìn)行關(guān)聯(lián)。為程序的元素(類、方法、成員變量)加上更直觀更明了的說(shuō)明,這些說(shuō)明信息是與程序的業(yè)務(wù)邏輯無(wú)關(guān),并且供指定的工具或框架使用。Annontation像一種修飾符一樣,應(yīng)用于包、類型、構(gòu)造方法、方法、成員變量、參數(shù)及本地變量的聲明語(yǔ)句中。
  Java注解是附加在代碼中的一些元信息,用于一些工具在編譯、運(yùn)行時(shí)進(jìn)行解析和使用,起到說(shuō)明、配置的功能。注解不會(huì)也不能影響代碼的實(shí)際邏輯,僅僅起到輔助性的作用。包含在 java.lang.annotation 包中。

注解的用處

1、生成文檔。這是最常見的,也是java 最早提供的注解。常用的有@param @return 等
2、跟蹤代碼依賴性,實(shí)現(xiàn)替代配置文件功能。比如Dagger 2依賴注入,未來(lái)java開發(fā),將大量注解配置,具有很大用處;
3、在編譯時(shí)進(jìn)行格式檢查。如@override 放在方法前,如果你這個(gè)方法并不是覆蓋了超類方法,則編譯時(shí)就能檢查出。

注解的原理

注解本質(zhì)是一個(gè)繼承了Annotation的特殊接口,其具體實(shí)現(xiàn)類是Java運(yùn)行時(shí)生成的動(dòng)態(tài)代理類。而我們通過反射獲取注解時(shí),返回的是Java運(yùn)行時(shí)生成的動(dòng)態(tài)代理對(duì)象$Proxy1。通過代理對(duì)象調(diào)用自定義注解(接口)的方法,會(huì)最終調(diào)用AnnotationInvocationHandler的invoke方法。該方法會(huì)從memberValues這個(gè)Map中索引出對(duì)應(yīng)的值。而memberValues的來(lái)源是Java常量池。

元注解

java.lang.annotation提供了四種元注解,專門注解其他的注解(在自定義注解的時(shí)候,需要使用到元注解):
@Documented –注解是否將包含在JavaDoc中
@Retention –什么時(shí)候使用該注解
@Target –注解用于什么地方
@Inherited – 是否允許子類繼承該注解

1.@Retention– 定義該注解的生命周期
● RetentionPolicy.SOURCE : 在編譯階段丟棄。這些注解在編譯結(jié)束之后就不再有任何意義,所以它們不會(huì)寫入字節(jié)碼。@Override, @SuppressWarnings都屬于這類注解。
● RetentionPolicy.CLASS : 在類加載的時(shí)候丟棄。在字節(jié)碼文件的處理中有用。注解默認(rèn)使用這種方式
● RetentionPolicy.RUNTIME : 始終不會(huì)丟棄,運(yùn)行期也保留該注解,因此可以使用反射機(jī)制讀取該注解的信息。我們自定義的注解通常使用這種方式。

2.Target – 表示該注解用于什么地方。默認(rèn)值為任何元素,表示該注解用于什么地方??捎玫腅lementType參數(shù)包括
● ElementType.CONSTRUCTOR:用于描述構(gòu)造器
● ElementType.FIELD:成員變量、對(duì)象、屬性(包括enum實(shí)例)
● ElementType.LOCAL_VARIABLE:用于描述局部變量
● ElementType.METHOD:用于描述方法
● ElementType.PACKAGE:用于描述包
● ElementType.PARAMETER:用于描述參數(shù)
● ElementType.TYPE:用于描述類、接口(包括注解類型) 或enum聲明

3.@Documented–一個(gè)簡(jiǎn)單的Annotations標(biāo)記注解,表示是否將注解信息添加在java文檔中。

4.@Inherited – 定義該注釋和子類的關(guān)系
@Inherited 元注解是一個(gè)標(biāo)記注解,@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的。如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class,則這個(gè)annotation將被用于該class的子類。

自定義注解

自定義注解類編寫的一些規(guī)則:

  1. Annotation型定義為@interface, 所有的Annotation會(huì)自動(dòng)繼承java.lang.Annotation這一接口,并且不能再去繼承別的類或是接口.
  2. 參數(shù)成員只能用public或默認(rèn)(default)這兩個(gè)訪問權(quán)修飾
  3. 參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和String、Enum、Class、annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.
  4. 要獲取類方法和字段的注解信息,必須通過Java的反射技術(shù)來(lái)獲取 Annotation對(duì)象,因?yàn)槟愠酥鉀]有別的獲取注解對(duì)象的方法
  5. 注解也可以沒有定義成員, 不過這樣注解就沒啥用了

自定義注解示例

@Target(value = ElementType.FIELD)
@Retention(value = RetentionPolicy.RUNTIME)
@Documented
public @interface Column {

    String name();
}

@Target(value = ElementType.TYPE)
@Inherited
@Retention(value = RetentionPolicy.RUNTIME)
@Documented
public @interface Table {

    String tableName();
}

@Table(tableName = "d_xiaow_entity")
public class TableEntity {

    @Column(name = "ID")
    private Long id;

    @Column(name = "NAME")
    private String name;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

public static void main(String [] args) throws Exception{
        Class entityClass = Class.forName("com.xiaow.learn.Annotion.TableEntity");
        if (entityClass.isAnnotationPresent(Table.class)) {
            Table T = (Table) entityClass.getAnnotation(Table.class);
            String tableName = T.tableName();
            System.out.print(tableName);
        }
        Field[] fields = entityClass.getFields();
        for (Field field: fields) {
            if (field.isAnnotationPresent(Column.class)) {
                String columnName = ((Column)field.getAnnotation(Column.class)).name();
                System.out.print(columnName);
            }
        }
    }
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容