一、簡(jiǎn)介
注解是Java 1.5引入的,可以提供代碼的額外信息,目前正在被廣泛應(yīng)用。除了Java內(nèi)置注解,我們也可以自定義注解。
以下就是一個(gè)自定義注解的簡(jiǎn)單例子:
@Target(ElementType.TYPE) //注解作用于類型(類,接口,注解,枚舉)@Retention(RetentionPolicy.RUNTIME) //運(yùn)行時(shí)保留,運(yùn)行中可以處理@Inherited// 注解將被用于該類的子類@Documented// 生成javadoc文件public @interfaceJsAnnotation { String DEFAULT_VALUE = "JS"; /** * 創(chuàng)建此value方法,則使用注解時(shí)可直接傳參,如 @JsAnnotation("msg") * * @return */ String value default DEFAULT_VALUE;
}
自定義注解關(guān)鍵點(diǎn):
@interface關(guān)鍵字定義注解
注解可以被其它注解修飾,最重要的就是元注解
注解和接口類似,內(nèi)部可以定義常量和方法
注解定義的方法有一些限制:方法不能有參數(shù);返回值只能是基本類型、字符串、Class、枚舉、注解、及以上類型的數(shù)組;可以包含默認(rèn)值
小編是一個(gè)有著5年工作經(jīng)驗(yàn)的java程序員,對(duì)于java,自己有做資料的整合,一個(gè)完整學(xué)習(xí)java的路線,學(xué)習(xí)資料和工具,相信這里有很多學(xué)習(xí)java的小伙伴,我創(chuàng)立了一個(gè)2000人學(xué)習(xí)扣群,479121291。每晚都有java的直播課程。無論是初級(jí)還是進(jìn)階的小伙伴小編我都?xì)g迎!
二、元注解介紹
元注解就是定義注解的注解。
包含@Target、@Retention、@Inherited、@Documented這四種
1、@Target
描述注解的使用目標(biāo)。
其源碼為:
@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceTarget { ElementType[] value;
}
注解方法返回值是ElementType[],ElementType枚舉類型,枚舉值就是@Target注解的可取值。
方法名value,這樣在使用注解時(shí),可以不需要指定方法名。
可取的值有:
取值含義
ElementType.PACKAGE注解作用于包
ElementType.TYPE注解作用于類型(類,接口,注解,枚舉)
ElementType.ANNOTATION_TYPE注解作用于注解
ElementType.CONSTRUCTOR注解作用于構(gòu)造方法
ElementType.METHOD注解作用于方法
ElementType.PARAMETER注解作用于方法參數(shù)
ElementType.FIELD注解作用于屬性
ElementType.LOCAL_VARIABLE注解作用于局部變量
注意:默認(rèn)可以作用于以上任何目標(biāo)。
2、@Retention
描述注解的生命周期。
其源碼為:
@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceRetention { RetentionPolicy value;
}
注解方法返回值是枚舉類型RetentionPolicy,枚舉值就是@Retention注解的可取值。
可取的值有:
取值含義
RetentionPolicy.SOURCE源碼中保留,編譯期可以處理
RetentionPolicy.CLASSClass文件中保留,Class加載時(shí)可以處理
RetentionPolicy.RUNTIME運(yùn)行時(shí)保留,運(yùn)行中可以處理
默認(rèn)RetentionPolicy.CLASS 值。
3、@Documented
描述注解可以文檔化,是一個(gè)標(biāo)記注解。
在生成javadoc的時(shí)候,是不包含注釋的,但是如果注解被@Documented修飾,則生成的文檔就包含該注解。
其源碼為:
@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceDocumented { }
4、@Inherited
標(biāo)記注解,使用@Inherited修飾的注解作用于一個(gè)類,則該注解將被用于該類的子類。
其源碼為:
@Documented@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.ANNOTATION_TYPE}) public @interfaceInherited { }
三、自定義注解示例
1、定義注解
@Target(ElementType.TYPE) //注解作用于類型(類,接口,注解,枚舉)@Retention(RetentionPolicy.RUNTIME) //運(yùn)行時(shí)保留,運(yùn)行中可以處理@Inherited// 注解將被用于該類的子類@Documented// 生成javadoc文件public @interfaceJsAnnotation { String DEFAULT_VALUE = "JS"; /** * 顏色枚舉 * * @author peida */enum Color {
BULE, RED, GREEN
} /** * 創(chuàng)建此value方法,則使用注解時(shí)可直接傳參,如 @JsAnnotation("msg") * * @return */ String value default DEFAULT_VALUE; /** * 此方法返回為枚舉類型,使用注解時(shí),如 @JsAnnotation(color=Color.BLUE) * * @return */ Color color default Color.BULE; int num default -1;
}
其中:定義了三個(gè)方法,三個(gè)方法都有默認(rèn)返回值。定義了Color枚舉(因?yàn)樽⒔獾姆椒梢苑祷孛杜e類型)
這里注意:
- value方法:使用注解時(shí)可直接傳參,如 @JsAnnotation(“msg”)
- 普通方法:使用注解時(shí),如 @JsAnnotation(color=Color.BLUE)
2、使用注解
@JsAnnotation("jia shuai") publicclass AnnotationTest {
}
或
@JsAnnotation(num = 100) publicclass AnnotationTest {
}
或
@JsAnnotation(color = Color.BLUE) publicclass AnnotationTest {
}
3、獲取注解
public static void main(String[] args) {
AnnotationTest test = new AnnotationTest; Class tClass = test.getClass; JsAnnotation jsAnnotation = (JsAnnotation) tClass.getAnnotation(JsAnnotation.class); System.out.println(jsAnnotation.value); System.out.println(jsAnnotation.color); System.out.println(jsAnnotation.num); }