當前位置:
首頁 >
java简单自定义Annotation
發布時間:2025/3/8
30
豆豆
生活随笔
收集整理的這篇文章主要介紹了
java简单自定义Annotation
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
為什么80%的碼農都做不了架構師?>>> ??
原文內容比較多,這里就簡單地說一下。java 5以后增加了3個annotation,@Override
@Deprecated
@SuppressWarnings
????? 以上annotation用途就不說了。java中自定義annotation需要@interface關鍵字和用到幾個內置annotation。原文提到“sun有點吝嗇,偏偏搞得與interface這么像”,其實也可以理解為,正好說明接口和注解還有一些類似的。用到的元注解有@Target ,@Retention,@Documented,@Inherited ,用途如下:
??? @Target 表示該注解用于什么地方,可能的 ElemenetType 參數包括:?
??????? ElemenetType.CONSTRUCTOR 構造器聲明?
??????? ElemenetType.FIELD 域聲明(包括 enum 實例)?
??????? ElemenetType.LOCAL_VARIABLE 局部變量聲明?
??????? ElemenetType.METHOD 方法聲明?
??????? ElemenetType.PACKAGE 包聲明?
??????? ElemenetType.PARAMETER 參數聲明?
??????? ElemenetType.TYPE 類,接口(包括注解類型)或enum聲明?
?????????
??? @Retention 表示在什么級別保存該注解信息。可選的 RetentionPolicy 參數包括:?
??????? RetentionPolicy.SOURCE 注解將被編譯器丟棄?
??????? RetentionPolicy.CLASS 注解在class文件中可用,但會被VM丟棄?
??????? RetentionPolicy.RUNTIME VM將在運行期也保留注釋,因此可以通過反射機制讀取注解的信息。?
?????????
??? @Documented 將此注解包含在 javadoc 中?
?????
??? @Inherited 允許子類繼承父類中的注解
????? 先來了解下各自的意義
?? 1、源文件Target.java?
?? @Documented??
?? @Retention(RetentionPolicy.RUNTIME)??
?? @Target(ElementType.ANNOTATION_TYPE)??
?? public @interface Target {??
????? ElementType[] value();??
?? }??
?? 其中的@interface是一個關鍵字,在設計annotations的時候必須把一個類型定義為@interface.?
???
?? 2、源文件Retention.java?
?? @Documented??
?? @Retention(RetentionPolicy.RUNTIME)??
?? @Target(ElementType.ANNOTATION_TYPE)??
?? public @interface Retention {??
????? RetentionPolicy value();??
?? }??
?? 在上面的文件都用到了RetentionPolicy,ElementType這兩個字段,這兩個文件的源代碼如下:?
???
?? 3、源文件RetentionPolicy.java?
?? public enum RetentionPolicy {??
??? SOURCE,??
??? CLASS,??
??? RUNTIME??
?? }??
?? 這是一個enum類型,共有三個值,分別是SOURCE,CLASS 和 RUNTIME.?
?? SOURCE代表的是這個Annotation類型的信息只會保留在程序源碼里,源碼如果經過了編譯之后,Annotation的數據就會消失,并不會保留在編譯好的.class文件里面。?
?? ClASS的意思是這個Annotation類型的信息保留在程序源碼里,同時也會保留在編譯好的.class文件里面,在執行的時候,并不會把這一些信息加載到虛擬機(JVM)中去.注意一下,當你沒有設定一個Annotation類型的Retention值時,系統默認值是CLASS.?
?? 第三個,是RUNTIME,表示在源碼、編譯好的.class文件中保留信息,在執行的時候會把這一些信息加載到JVM中去的.?
舉一個例子,如@Override里面的Retention設為SOURCE,編譯成功了就不要這一些檢查的信息;相反,@Deprecated里面的 Retention設為RUNTIME,表示除了在編譯時會警告我們使用了哪個被Deprecated的方法,在執行的時候也可以查出該方法是否被 Deprecated.?
?? 4、源文件ElementType.java?
?? public enum ElementType {??
??? TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,??
??? LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE??
?? }??
?? @Target里面的ElementType是用來指定Annotation類型可以用在哪一些元素上的.說明一下:TYPE(類型), FIELD(屬性), METHOD(方法), PARAMETER(參數), CONSTRUCTOR(構造函數),LOCAL_VARIABLE(局部變量), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(類型)是指可以用在Class,Interface,Enum和 Annotation類型上.?
?? 另外,從1的源代碼可以看出,@Target自己也用了自己來聲明自己,只能用在ANNOTATION_TYPE之上.?
?? 如果一個Annotation類型沒有指明@Target使用在哪些元素上,那么它可以使用在任何元素之上,這里的元素指的是上面的八種類型.?
?? 面一下1和2的源文件,它們都使用了@Documented,@Documented的目的就是讓這一個Annotation類型的信息能夠顯示在javaAPI說明文檔上;沒有添加的話,使用javadoc生成API文檔的時候就會找不到這一個類型生成的信息.?
?? 另外一點,如果需要把Annotation的數據繼承給子類,那么就會用到@Inherited這一個。
????? 下面自定義兩個簡單的annatation。
package?com.zhangshengqiang.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Description {
??? String value() default "no description";
}
//
package com.zhangshengqiang.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Name {
??? String originate();
??? String community();
}
//
package?com.zhangshengqiang.annotation;
@Description("javaeye, to be best")
public class JavaEyer {
??? @Name(originate = "創始人:張升強", community = "javaeye")
??? public String getEyeName() {
??? ??? return null;
??? }
??? @Name(originate = "創始人:張升強", community = "springside")
??? public String getSideName() {
??? ??? return "excuse me";
??? }
}
測試類///
package com.zhangshengqiang.annotation;
import java.lang.reflect.Method;
import java.util.HashSet;
import java.util.Set;
public class AnnotationTest {
??? @SuppressWarnings("unchecked")
??? public static void main(String[] args) throws ClassNotFoundException {
??? ??? final String CLASS_NAME = "annotation.JavaEyer";
??? ??? Class test = Class.forName(CLASS_NAME);
??? ??? Method[] methods = test.getMethods();
??? ??? boolean flag = test.isAnnotationPresent(Description.class);
??? ??? if (flag) {
??? ??? ??? Description des = (Description) test.getAnnotation(Description.class);
??? ??? ??? System.out.println("描述:" + des.value());
??? ??? ??? System.out.println("-----------------");
??? ??? }
??? ??? Set<Method> set = new HashSet<Method>();
??? ??? for (int i = 0; i < methods.length; i++) {
??? ??? ??? boolean otherflag = methods[i].isAnnotationPresent(Name.class);
??? ??? ??? if (otherflag) {
??? ??? ??? ??? set.add(methods[i]);
??? ??? ??? }
??? ??? }
??? ??? for (Method method : set) {
??? ??? ??? Name name = method.getAnnotation(Name.class);
??? ??? ??? System.out.println(name.originate());
??? ??? ??? System.out.println("創建的社區:" + name.community());
??? ??? }
??? }
}
//
測試結果:
描述:javaeye, to be best
轉載于:https://my.oschina.net/004/blog/176473
總結
以上是生活随笔為你收集整理的java简单自定义Annotation的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: php __FILE__和$_SERVE
- 下一篇: 组策略应用规则示例