注解 - 類型注解滴某、重復(fù)注解磅摹、一些限制

類型注解

原來注解只能用于聲明滋迈,從JDK 8開始,注解還可以用于大多數(shù)使用類型的地方户誓,這種注解稱為類型注解饼灿。類型注解允許工具對(duì)代碼執(zhí)行額外的檢查,從而幫助避免錯(cuò)誤帝美。javac本身一般不執(zhí)行這些檢查碍彭,這種工具需要作為編譯器插件發(fā)揮作用。

例子

@Target(ElementType.TYPE_USE)
public @interface TypeAnno {
}

@Target(ElementType.TYPE_USE)
public @interface MaxLen {

    int value();

}

@Target(ElementType.TYPE_USE)
public @interface Unique {
}

@Target(ElementType.TYPE_PARAMETER)
public @interface What {

    String description();

}

@Target(ElementType.FIELD)
public @interface NotNull {
}

@Target(ElementType.METHOD)
public @interface Recommended {
}

// 注解類型參數(shù)
public class TypeTest<@What(description = "Generic data type") T> {

    // 注解字段類型
    private @TypeAnno String first;

    // 注解字段聲明
    private @NotNull String second;

    // 注解數(shù)組元素類型
    private @TypeAnno Integer[] nums;

    // 注解數(shù)組級(jí)別
    private String @MaxLen(5) [] @MaxLen(10) [] data;

    // 注解構(gòu)造函數(shù)
    public @Unique TypeTest() {
    }

    // 注解this的類型
    public int f1(@TypeAnno TypeTest<T> this, int x) {
        return 10;
    }

    // 注解方法返回類型
    public @TypeAnno Integer f2(int j, int k) {
        return j + k;
    }

    // 注解方法聲明
    public @Recommended Integer f3(String str) {
        return str.length() / 2;
    }

    // 注解異常類型
    public void f4() throws @TypeAnno NullPointerException {
        // ...
    }

    public static void test() {
        TypeTest<@TypeAnno Integer> obj1 = new TypeTest<>(); // 注解實(shí)際類型參數(shù)
        @TypeAnno TypeTest<Integer> obj2 = new @TypeAnno TypeTest<>(); // 注解實(shí)例類型

        Object x = new Integer(10);
        Integer y;

        y = (@TypeAnno Integer) x; // 注解強(qiáng)制類型轉(zhuǎn)換
    }

}

// 注解被繼承的類型
public class SubTypeTest extends @TypeAnno TypeTest<Integer> {
    // ...
}

注意

  • 類型注解必須包含ElementType.TYPE_USE作為目標(biāo)证舟。
  • 類型注解需要放到應(yīng)用該注解的類型前面硕旗。
  • 不能對(duì)void返回類型添加注解。
  • @Target可以用于消除聲明注解和類型注解的模糊性問題女责,比如上面例子中@TypeAnno注解字段類型而@NotNull注解字段聲明漆枚;@TypeAnno注解方法返回類型而@Recommended注解方法聲明。

this對(duì)象

this是所有實(shí)例方法的隱式參數(shù)抵知,它的類型必須是其類的類型墙基。類型注解可以注解this的類型,但是需要使用JDK 8的一個(gè)新特性刷喜,從JDK 8開始可以顯式地將this聲明為方法的第一個(gè)參數(shù)残制。

除非是要注解this的類型,否則沒必要聲明this掖疮。并且顯示聲明this沒有改變方法簽名初茶,因?yàn)槟J(rèn)也會(huì)隱式聲明this。


重復(fù)注解

JDK 8新增了另一種注解特性浊闪,這種特性稱為重復(fù)注解恼布,它允許在相同元素上重復(fù)應(yīng)用同一個(gè)注解。

@Repeatable注解

可重復(fù)的注解必須用@Repeatable進(jìn)行注解搁宾。@Repeatable定義在java.lang.annotation中折汞,它的value域指定了重復(fù)注解的容器類型。源碼如下所示:

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

    /**
     * Indicates the <em>containing annotation type</em> for the
     * repeatable annotation type.
     * @return the containing annotation type
     */
    Class<? extends Annotation> value();
    
}

容器注解

重復(fù)注解的容器類型被指定為注解盖腿。容器注解的value域是重復(fù)注解類型的數(shù)組爽待。要?jiǎng)?chuàng)建重復(fù)注解,必須創(chuàng)建容器注解翩腐,然后將該容器注解的類型作為@Repeatable注解的參數(shù)鸟款。

@Retention(RetentionPolicy.RUNTIME)
@Repeatable(RepeatedAnnos.class)
public @interface RepeatableAnno {

    String name() default "test";

    int value() default 100;

}

@Retention(RetentionPolicy.RUNTIME)
public @interface RepeatedAnnos {

    RepeatableAnno[] value();

}

獲取重復(fù)注解的方式

  • 使用getAnnotation()方法獲取重復(fù)注解,要使用容器注解作為參數(shù)茂卦,而不是重復(fù)注解何什。
public class RepeatableTest {

    @RepeatableAnno(name = "first annotation", value = 10)
    @RepeatableAnno(name = "second annotation", value = 20)
    public static void test() {
        RepeatableTest obj = new RepeatableTest();

        try {
            Class<?> c = obj.getClass();
            Method m = c.getMethod("test");
            Annotation anno = m.getAnnotation(RepeatedAnnos.class);
            System.out.println(anno);
        } catch (NoSuchMethodException e) {
            System.out.println("Method Not Found.");
        }
    }

    public static void main(String[] args) throws Exception {
        test();
    }

}

上面例子的輸出如下:
@RepeatedAnnos(value=[@RepeatableAnno(name=first annotation, value=10), @RepeatableAnno(name=second annotation, value=20)])

  • 獲取重復(fù)注解的另一種方式是使用JDK 8添加到AnnotatedElement中的新方法,它們能夠直接操作重復(fù)注解疙筹。這些方法包括getAnnotationsByType()和getDeclaredAnnotationsByType()富俄。
Annotation[] annos = m.getAnnotationsByType(RepeatableAnno.class);
for (Annotation anno : annos) {
    System.out.println(anno);
}

一些限制

使用注解聲明有一些限制:

  • 一個(gè)注解不能繼承另一個(gè)注解禁炒。
  • 注解聲明的成員方法不能帶參數(shù)。
  • 注解聲明的成員方法不能指定throws子句霍比。
  • 注解不能被泛型化幕袱。
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市悠瞬,隨后出現(xiàn)的幾起案子们豌,更是在濱河造成了極大的恐慌,老刑警劉巖浅妆,帶你破解...
    沈念sama閱讀 219,366評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件望迎,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡凌外,警方通過查閱死者的電腦和手機(jī)辩尊,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,521評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來康辑,“玉大人摄欲,你說我怎么就攤上這事〈保” “怎么了胸墙?”我有些...
    開封第一講書人閱讀 165,689評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)按咒。 經(jīng)常有香客問我迟隅,道長(zhǎng),這世上最難降的妖魔是什么励七? 我笑而不...
    開封第一講書人閱讀 58,925評(píng)論 1 295
  • 正文 為了忘掉前任智袭,我火速辦了婚禮,結(jié)果婚禮上呀伙,老公的妹妹穿的比我還像新娘补履。我一直安慰自己添坊,他們只是感情好剿另,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,942評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著贬蛙,像睡著了一般雨女。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上阳准,一...
    開封第一講書人閱讀 51,727評(píng)論 1 305
  • 那天氛堕,我揣著相機(jī)與錄音,去河邊找鬼野蝇。 笑死讼稚,一個(gè)胖子當(dāng)著我的面吹牛括儒,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播锐想,決...
    沈念sama閱讀 40,447評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼帮寻,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了赠摇?” 一聲冷哼從身側(cè)響起固逗,我...
    開封第一講書人閱讀 39,349評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎藕帜,沒想到半個(gè)月后烫罩,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,820評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡洽故,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,990評(píng)論 3 337
  • 正文 我和宋清朗相戀三年贝攒,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片时甚。...
    茶點(diǎn)故事閱讀 40,127評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡饿这,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出撞秋,到底是詐尸還是另有隱情长捧,我是刑警寧澤,帶...
    沈念sama閱讀 35,812評(píng)論 5 346
  • 正文 年R本政府宣布吻贿,位于F島的核電站串结,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏舅列。R本人自食惡果不足惜肌割,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,471評(píng)論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望帐要。 院中可真熱鬧把敞,春花似錦、人聲如沸榨惠。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,017評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)赠橙。三九已至耽装,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間期揪,已是汗流浹背掉奄。 一陣腳步聲響...
    開封第一講書人閱讀 33,142評(píng)論 1 272
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留凤薛,地道東北人姓建。 一個(gè)月前我還...
    沈念sama閱讀 48,388評(píng)論 3 373
  • 正文 我出身青樓诞仓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親速兔。 傳聞我的和親對(duì)象是個(gè)殘疾皇子狂芋,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,066評(píng)論 2 355