java自定義注解

本文轉載自查看原文 2017-12-04 09:49 1800 j2SE

Java注解是附加在代碼中的一些元信息，用於一些工具在編譯、運行時進行解析和使用，起到說明、配置的功能。

注解不會也不能影響代碼的實際邏輯，僅僅起到輔助性的作用。包含在 java.lang.annotation 包中。

1、元注解

元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四種。

1.1、@Retention: 定義注解的保留策略

@Retention(RetentionPolicy.SOURCE) //注解僅存在於源碼中，在class字節碼文件中不包含

@Retention(RetentionPolicy.CLASS) // 默認的保留策略，注解會在class字節碼文件中存在，但運行時無法獲得，

@Retention(RetentionPolicy.RUNTIME) // 注解會在class字節碼文件中存在，在運行時可以通過反射獲取到

1.2、@Target：定義注解的作用目標

其定義的源碼為：

1 @Documented
2 @Retention(RetentionPolicy.RUNTIME)
3 @Target(ElementType.ANNOTATION_TYPE)
4 public @interface Target {
5     ElementType[] value();
6 }

@Target(ElementType.TYPE) //接口、類、枚舉、注解

@Target(ElementType.FIELD) //字段、枚舉的常量

@Target(ElementType.METHOD) //方法

@Target(ElementType.PARAMETER) //方法參數

@Target(ElementType.CONSTRUCTOR) //構造函數

@Target(ElementType.LOCAL_VARIABLE)//局部變量

@Target(ElementType.ANNOTATION_TYPE)//注解

@Target(ElementType.PACKAGE) ///包

由以上的源碼可以知道，他的elementType 可以有多個，一個注解可以為類的，方法的，字段的等等

1.3、@Document：說明該注解將被包含在javadoc中

1.4、@Inherited：說明子類可以繼承父類中的該注解

2、java 注解的自定義

下面是自定義注解的一個例子

@Documented
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Yts {
    public enum YtsType{util,entity,service,model};
   public YtsType classType() default YtsType.util;
}

1 @Documented
2 @Retention(RetentionPolicy.RUNTIME)
3 @Target(ElementType.METHOD)
4 @Inherited
5 public @interface HelloWorld {
6    public String name()default "";
7 }

@Retention(RetentionPolicy.RUNTIME)

定義的這個注解是注解會在class字節碼文件中存在，在運行時可以通過反射獲取到。

@Target({ElementType.TYPE,ElementType.METHOD})

因此這個注解可以是類注解，也可以是方法的注解

這樣一個注解就自定義好了，當然注解里面的成員可以為基本的數據類型，也可以為數據，Object等等

3 注解是定義好了，那么怎么來得到，解析注解呢？

java的反射機制可以幫助，得到注解，代碼如下：

 1 public class ParseAnnotation {
 2 
 3      public void parseMethod(Class clazz) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, SecurityException, NoSuchMethodException, InstantiationException{
 4   Object obj = clazz.getConstructor(new Class[]{}).newInstance(new Object[]{});
 5     for(Method method : clazz.getDeclaredMethods()){
 6         HelloWorld say = method.getAnnotation(HelloWorld.class);
 7         String name = "";
 8         if(say != null){
 9            name = say.name();
10            method.invoke(obj, name);
11         }
12        Yts yts = (Yts)method.getAnnotation(Yts.class);
13        if(yts != null){
14           if(YtsType.util.equals(yts.classType())){
15           System.out.println("this is a util method");
16         }else{
17             System.out.println("this is a other method");
18             }
19         }
20       }
21     }
22     @SuppressWarnings("unchecked")
23     public void parseType(Class clazz) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException{
24         Yts yts = (Yts) clazz.getAnnotation(Yts.class);
25         if(yts != null){
26             if(YtsType.util.equals(yts.classType())){
27                 System.out.println("this is a util class");
28             }else{
29                 System.out.println("this is a other class");
30             }
31         }
32     }
33     
34 }

前一個方法是解析得到方法注解的，后一個方法是得到類注解的

以下是測試方法類

 1 @Yts(classType =YtsType.util)
 2 public class SayHell {
 3 
 4     @HelloWorld(name = " 小明 ")
 5     @Yts
 6     public void sayHello(String name){
 7         if(name == null || name.equals("")){
 8             System.out.println("hello world!");
 9         }else{
10             System.out.println(name + "say hello world!");
11         }
12     }
13 }

1 public static void main(String[] args) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, SecurityException, NoSuchMethodException, InstantiationException {
2         ParseAnnotation parse = new ParseAnnotation();
3         parse.parseMethod(SayHell.class);
4         parse.parseType(SayHell.class);
5     }

http://blog.csdn.net/yixiaogang109/article/details/7328466

1、Annotation的工作原理：

JDK5.0中提供了注解的功能，允許開發者定義和使用自己的注解類型。該功能由一個定義注解類型的語法和描述一個注解聲明的語法，讀取注解的API，一個使用注解修飾的class文件和一個注解處理工具組成。

Annotation並不直接影響代碼的語義，但是他可以被看做是程序的工具或者類庫。它會反過來對正在運行的程序語義有所影響。

Annotation可以沖源文件、class文件或者在運行時通過反射機制多種方式被讀取。

2、@Override注解：

java.lang
注釋類型 Override
@Target(value=METHOD)
@Retention(value=SOURCE)
public @interface Override

表示一個方法聲明打算重寫超類中的另一個方法聲明。如果方法利用此注釋類型進行注解但沒有重寫超類方法，則編譯器會生成一條錯誤消息。

@Override注解表示子類要重寫父類的對應方法。

Override是一個Marker annotation，用於標識的Annotation，Annotation名稱本身表示了要給工具程序的信息。

下面是一個使用@Override注解的例子：

class A {
    private String id; A(String id){ this.id = id; } @Override public String toString() { return id; } }

3、@Deprecated注解：

java.lang
注釋類型 Deprecated
@Documented
@Retention(value=RUNTIME)
public @interface Deprecated

用 @Deprecated 注釋的程序元素，不鼓勵程序員使用這樣的元素，通常是因為它很危險或存在更好的選擇。在使用不被贊成的程序元素或在不被贊成的代碼中執行重寫時，編譯器會發出警告。

@Deprecated注解表示方法是不被建議使用的。

Deprecated是一個Marker annotation。

下面是一個使用@Deprecated注解的例子：

class A {
    private String id; A(String id){ this.id = id; } @Deprecated public void execute(){ System.out.println(id); } public static void main(String[] args) { A a = new A("a123"); a.execute(); } }

4、@SuppressWarnings注解：

java.lang
注釋類型 SuppressWarnings
@Target(value={TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE})
@Retention(value=SOURCE)
public @interface SuppressWarnings

指示應該在注釋元素（以及包含在該注釋元素中的所有程序元素）中取消顯示指定的編譯器警告。注意，在給定元素中取消顯示的警告集是所有包含元素中取消顯示的警告的超集。例如，如果注釋一個類來取消顯示某個警告，同時注釋一個方法來取消顯示另一個警告，那么將在此方法中同時取消顯示這兩個警告。

根據風格不同，程序員應該始終在最里層的嵌套元素上使用此注釋，在那里使用才有效。如果要在特定的方法中取消顯示某個警告，則應該注釋該方法而不是注釋它的類。

@SuppressWarnings注解表示抑制警告。

下面是一個使用@SuppressWarnings注解的例子：

@SuppressWarnings("unchecked")
public static void main(String[] args) { List list = new ArrayList(); list.add("abc"); }

5、自定義注解：

使用@interface自定義注解時，自動繼承了java.lang.annotation.Annotation接口，由編譯程序自動完成其他細節。在定義注解時，不能繼承其他的注解或接口。

自定義最簡單的注解：

public @interface MyAnnotation { }

使用自定義注解：

public class AnnotationTest2 { @MyAnnotation public void execute(){ System.out.println("method"); } }

5.1、添加變量：

public @interface MyAnnotation { String value1(); }

使用自定義注解：

public class AnnotationTest2 { @MyAnnotation(value1="abc") public void execute(){ System.out.println("method"); } }

當注解中使用的屬性名為value時，對其賦值時可以不指定屬性的名稱而直接寫上屬性值接口；除了value意外的變量名都需要使用name=value的方式賦值。

5.2、添加默認值：

public @interface MyAnnotation { String value1() default "abc"; }

5.3、多變量使用枚舉：

public @interface MyAnnotation { String value1() default "abc"; MyEnum value2() default MyEnum.Sunny; } enum MyEnum{ Sunny,Rainy }

使用自定義注解：

public class AnnotationTest2 { @MyAnnotation(value1="a", value2=MyEnum.Sunny) public void execute(){ System.out.println("method"); } }

5.4、數組變量：

public @interface MyAnnotation { String[] value1() default "abc"; }

使用自定義注解：

public class AnnotationTest2 { @MyAnnotation(value1={"a","b"}) public void execute(){ System.out.println("method"); } }

6、設置注解的作用范圍：

@Documented
@Retention(value=RUNTIME)
@Target(value=ANNOTATION_TYPE)
public @interface Retention

指示注釋類型的注釋要保留多久。如果注釋類型聲明中不存在 Retention 注釋，則保留策略默認為 RetentionPolicy.CLASS。

只有元注釋類型直接用於注釋時，Target 元注釋才有效。如果元注釋類型用作另一種注釋類型的成員，則無效。

public enum RetentionPolicy
extends Enum<RetentionPolicy>

注釋保留策略。此枚舉類型的常量描述保留注釋的不同策略。它們與 Retention 元注釋類型一起使用，以指定保留多長的注釋。

CLASS
編譯器將把注釋記錄在類文件中，但在運行時 VM 不需要保留注釋。
RUNTIME
編譯器將把注釋記錄在類文件中，在運行時 VM 將保留注釋，因此可以反射性地讀取。
SOURCE
編譯器要丟棄的注釋。

@Retention注解可以在定義注解時為編譯程序提供注解的保留策略。

屬於CLASS保留策略的注解有@SuppressWarnings，該注解信息不會存儲於.class文件。

6.1、在自定義注解中的使用例子：

@Retention(RetentionPolicy.CLASS)
public @interface MyAnnotation { String[] value1() default "abc"; }

7、使用反射讀取RUNTIME保留策略的Annotation信息的例子：

java.lang.reflect
        接口 AnnotatedElement
所有已知實現類：
        AccessibleObject, Class, Constructor, Field, Method, Package

表示目前正在此 VM 中運行的程序的一個已注釋元素。該接口允許反射性地讀取注釋。由此接口中的方法返回的所有注釋都是不可變並且可序列化的。調用者可以修改已賦值數組枚舉成員的訪問器返回的數組；這不會對其他調用者返回的數組產生任何影響。

如果此接口中的方法返回的注釋（直接或間接地）包含一個已賦值的 Class 成員，該成員引用了一個在此 VM 中不可訪問的類，則試圖通過在返回的注釋上調用相關的類返回的方法來讀取該類，將導致一個 TypeNotPresentException。

isAnnotationPresent
boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)

如果指定類型的注釋存在於此元素上，則返回 true，否則返回 false。此方法主要是為了便於訪問標記注釋而設計的。

參數：

annotationClass - 對應於注釋類型的 Class 對象

如果指定注釋類型的注釋存在於此對象上，則返回 true，否則返回 false

拋出：

NullPointerException - 如果給定的注釋類為 null

從以下版本開始：

1.5

getAnnotation
<T extends Annotation> T getAnnotation(Class<T> annotationClass)

如果存在該元素的指定類型的注釋，則返回這些注釋，否則返回 null。

參數：

annotationClass - 對應於注釋類型的 Class 對象

如果該元素的指定注釋類型的注釋存在於此對象上，則返回這些注釋，否則返回 null

拋出：

NullPointerException - 如果給定的注釋類為 null

從以下版本開始：

1.5

getAnnotations
Annotation[] getAnnotations()

返回此元素上存在的所有注釋。（如果此元素沒有注釋，則返回長度為零的數組。）該方法的調用者可以隨意修改返回的數組；這不會對其他調用者返回的數組產生任何影響。

此元素上存在的所有注釋

從以下版本開始：

1.5

getDeclaredAnnotations
Annotation[] getDeclaredAnnotations()

返回直接存在於此元素上的所有注釋。與此接口中的其他方法不同，該方法將忽略繼承的注釋。（如果沒有注釋直接存在於此元素上，則返回長度為零的一個數組。）該方法的調用者可以隨意修改返回的數組；這不會對其他調用者返回的數組產生任何影響。

直接存在於此元素上的所有注釋

從以下版本開始：

1.5

下面是使用反射讀取RUNTIME保留策略的Annotation信息的例子：

自定義注解：

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation { String[] value1() default "abc"; }

使用自定義注解：

public class AnnotationTest2 { @MyAnnotation(value1={"a","b"}) @Deprecated public void execute(){ System.out.println("method"); } }

讀取注解中的信息：

public static void main(String[] args) throws SecurityException, NoSuchMethodException, IllegalArgumentException, IllegalAccessException, InvocationTargetException { AnnotationTest2 annotationTest2 = new AnnotationTest2(); //獲取AnnotationTest2的Class實例 Class<AnnotationTest2> c = AnnotationTest2.class; //獲取需要處理的方法Method實例 Method method = c.getMethod("execute", new Class[]{}); //判斷該方法是否包含MyAnnotation注解 if(method.isAnnotationPresent(MyAnnotation.class)){ //獲取該方法的MyAnnotation注解實例 MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class); //執行該方法 method.invoke(annotationTest2, new Object[]{}); //獲取myAnnotation String[] value1 = myAnnotation.value1(); System.out.println(value1[0]); } //獲取方法上的所有注解 Annotation[] annotations = method.getAnnotations(); for(Annotation annotation : annotations){ System.out.println(annotation); } }

8、限定注解的使用：

限定注解使用@Target。

@Documented
@Retention(value=RUNTIME)
@Target(value=ANNOTATION_TYPE)
public @interface Target

指示注釋類型所適用的程序元素的種類。如果注釋類型聲明中不存在 Target 元注釋，則聲明的類型可以用在任一程序元素上。如果存在這樣的元注釋，則編譯器強制實施指定的使用限制。例如，此元注釋指示該聲明類型是其自身，即元注釋類型。它只能用在注釋類型聲明上：

@Target(ElementType.ANNOTATION_TYPE)
    public @interface MetaAnnotationType { ... }

此元注釋指示該聲明類型只可作為復雜注釋類型聲明中的成員類型使用。它不能直接用於注釋：

@Target({}) 
    public @interface MemberType { ... }

這是一個編譯時錯誤，它表明一個 ElementType 常量在 Target 注釋中出現了不只一次。例如，以下元注釋是非法的：

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.FIELD})
    public @interface Bogus { ... }

public enum ElementType
extends Enum<ElementType>

程序元素類型。此枚舉類型的常量提供了 Java 程序中聲明的元素的簡單分類。

這些常量與 Target 元注釋類型一起使用，以指定在什么情況下使用注釋類型是合法的。

ANNOTATION_TYPE
注釋類型聲明
CONSTRUCTOR
構造方法聲明
FIELD
字段聲明（包括枚舉常量）
LOCAL_VARIABLE
局部變量聲明
METHOD
方法聲明
PACKAGE
包聲明
PARAMETER
參數聲明
TYPE
類、接口（包括注釋類型）或枚舉聲明

注解的使用限定的例子：

@Target(ElementType.METHOD)
public @interface MyAnnotation { String[] value1() default "abc"; }

9、在幫助文檔中加入注解：

要想在制作JavaDoc文件的同時將注解信息加入到API文件中，可以使用java.lang.annotation.Documented。

在自定義注解中聲明構建注解文檔：

@Documented
public @interface MyAnnotation { String[] value1() default "abc"; }

使用自定義注解：

public class AnnotationTest2 { @MyAnnotation(value1={"a","b"}) public void execute(){ System.out.println("method"); } }

10、在注解中使用繼承：

默認情況下注解並不會被繼承到子類中，可以在自定義注解時加上java.lang.annotation.Inherited注解聲明使用繼承。

@Documented
@Retention(value=RUNTIME)
@Target(value=ANNOTATION_TYPE)
public @interface Inherited

指示注釋類型被自動繼承。如果在注釋類型聲明中存在 Inherited 元注釋，並且用戶在某一類聲明中查詢該注釋類型，同時該類聲明中沒有此類型的注釋，則將在該類的超類中自動查詢該注釋類型。此過程會重復進行，直到找到此類型的注釋或到達了該類層次結構的頂層 (Object) 為止。如果沒有超類具有該類型的注釋，則查詢將指示當前類沒有這樣的注釋。

注意，如果使用注釋類型注釋類以外的任何事物，此元注釋類型都是無效的。還要注意，此元注釋僅促成從超類繼承注釋；對已實現接口的注釋無效。

除了文章中有特別說明，均為IT宅原創文章，轉載請以鏈接形式注明出處。
本文鏈接： http://www.itzhai.com/java-based-notebook-annotation-annotation-introduction-and-use-custom-annotations.html

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 Java自定義注解 Java自定義注解 java自定義注解 java自定義注解 Java注解之自定義注解實現 Java自定義注解的定義與使用【JAVA】java注解的自定義和使用 java內置注解、元注解和自定義注解 Java自定義注解的實現 Java自定義注解Annotation詳解