Annotation 介绍@interface

梦里梦外; 2022-07-15 22:59 167阅读 0赞

参考：

[http://blog.csdn.net/liuwenbo0920/article/details/7290586/][http_blog.csdn.net_liuwenbo0920_article_details_7290586]

[http://blog.csdn.net/foamflower/article/details/5946451][http_blog.csdn.net_foamflower_article_details_5946451]

【一】

定义：

注解（Annotation），也叫**元数据**。一种**代码级别**的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。——百度

Annotation是继承自java.lang.annotation.Annotation的类,用于向程序分析工具或虚拟机提供package class field methed 等方面的信息,它和其他类没什么区别,除了使用方式。

Annotation的一般形式是 :

public @interface MyAnnotation {   
        String value() default "hahaha";   
    }

我认为和它等价的java类为:

public class MyAnnotation extends java.lang.annotation.Annotation{   
         private String value = "hahaha";   
         public void setValue(String value){   
              this.value = value;   
         }   
         public String getValue(){   
              return value;   
          }   
    }

以上总结：java用  @interface Annotation\{ \} 定义一个注解 @Annotation，一个注解是一个类。

【二】

@Override，@Deprecated，@SuppressWarnings为常见的3个注解。

注解相当于一种标记，在程序中加上了注解就等于为程序加上了某种标记，以后，JAVAC编译器，开发工具和其他程序可以用反射来了解你的类以及各种元素上有无任何标记，看你有什么标记，就去干相应的事。

（1）注解@Override用在方法上，当我们想重写一个方法时，在方法上加@Override，当我们方法的名字出错时，编译器就会报错，如图：

![0_1320340910A8xa.gif][]

（2）注解@Deprecated，用来表示某个类的属性或方法已经过时，不想别人再用时，在属性和方法上用@Deprecated修饰，如图：

![0_1320340969Vgmw.gif][]

（3） 注解@SuppressWarnings用来压制程序中出来的警告，比如在没有用泛型或是方法已经过时的时候，如图：

![0_1320341021mJWH.gif][]

【三】

注解@Retention可以用来修饰注解，是注解的注解，称为元注解。

Retention注解有一个属性value，是 RetentionPolicy 类型的，Enum RetentionPolicy是一个枚举类型，这个枚举决定了Retention注解应该如何去保持，也可理解为Rentention 搭配 RententionPolicy使用。RetentionPolicy有3个值：CLASS，RUNTIME，SOURCE 。

用@Retention(RetentionPolicy.CLASS)修饰的注解，表示注解的信息被保留在class文件(字节码文件)中当程序编译时，但不会被虚拟机读取在运行的时候；

用@Retention(RetentionPolicy.SOURCE )修饰的注解,表示注解的信息会被编译器抛弃，不会留在class文件中，注解的信息只会留在源文件中；

用@Retention(RetentionPolicy.RUNTIME )修饰的注解，表示注解的信息被保留在class文件(字节码文件)中当程序编译时，会被虚拟机保留在运行时，所以他们可以用反射的方式读取。RetentionPolicy.RUNTIME 可以让你从JVM中读取Annotation注解的信息，以便在分析程序的时候使用。

package com.self;  
    import java.lang.annotation.Retention;  
    import java.lang.annotation.RetentionPolicy;  
      
    @Retention(RetentionPolicy.RUNTIME)  
    public @interface MyTarget  
    { }

以上定义个一注解@MyTarget，用RetentionPolicy.RUNTIME修饰；

package com.self;  
    import java.lang.reflect.Method;
    
    public class MyTargetTest{
    
        @MyTarget
        public void doSomething(){
            System.out.println("hello world");
        }
       
        public static void main(String[] args) throws Exception{
    
            Method method = MyTargetTest.class.getMethod("doSomething",null);
    
            //如果doSomething方法上存在注解@MyTarget，则为true
            if(method.isAnnotationPresent(MyTarget.class)){
                System.out.println(method.getAnnotation(MyTarget.class));
            }
        }
    }

以上程序打印：@com.self.MyTarget()，如果RetentionPolicy值不为RUNTIME,则不打印。

【四】

@Retention(RetentionPolicy.SOURCE )    
public @interface Override    
    
@Retention(RetentionPolicy.SOURCE )    
public @interface SuppressWarnings    
    
@Retention(RetentionPolicy.RUNTIME )    
public @interface Deprecated    
由上可以看出，只有注解@Deprecated在运行时可以被JVM读取到 。

【五】

注解中可以定义属性，看例子：

@Retention(RetentionPolicy.RUNTIME)  
    public @interface MyAnnotation{  
        String hello() default "gege";
        String world();
        int[] array() default { 2, 4, 5, 6 };
        EnumTest.TrafficLamp lamp();
        TestAnnotation lannotation() default @TestAnnotation(value = "ddd");
        Class style() default String.class;
    }

上面程序中，定义一个注解@MyAnnotation，定义了6个属性，他们的名字为：hello,world,array,lamp,lannotation,style。

属性hello类型为String,默认值为gege；

属性world类型为String,没有默认值；

属性array类型为数组,默认值为2，4，5，6；

属性lamp类型为一个枚举,没有默认值；

属性lannotation类型为注解,默认值为@TestAnnotation，注解里的属性是注解；

属性style类型为Class,默认值为String类型的Class类型。

看下面例子:定义了一个MyTest类，用注解@MyAnnotation修饰，注解@MyAnnotation定义的属性都赋了值 ：

@MyAnnotation(hello = "beijing", world="shanghai",array={},lamp=TrafficLamp.RED,style=int.class)  
    public class MyTest{  
        @MyAnnotation(lannotation=@TestAnnotation(value="baby"), world = "shanghai",array={1,2,3},lamp=TrafficLamp.YELLOW)  
        @Deprecated  
        @SuppressWarnings("")  
        public void output(){  
            System.out.println("output something!");  
        }  
    }

接着通过反射读取注解的信息：

public class MyReflection{
    
        public static void main(String[] args) throws Exception{  
    
            MyTest myTest = new MyTest();  
            Class<MyTest> c = MyTest.class;  
            Method method = c.getMethod("output", new Class[] {}); 
     
            //如果MyTest类名上有注解@MyAnnotation修饰，则为true  
            if(MyTest.class.isAnnotationPresent(MyAnnotation.class)){  
                System.out.println("have annotation");  
            }
     
            if (method.isAnnotationPresent(MyAnnotation.class)){
    
                method.invoke(myTest, null); //调用output方法  
                //获取方法上注解@MyAnnotation的信息  
                MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class);  
                String hello = myAnnotation.hello();  
                String world = myAnnotation.world();  
                System.out.println(hello + ", " + world);//打印属性hello和world的值  
                System.out.println(myAnnotation.array().length);//打印属性array数组的长度  
                System.out.println(myAnnotation.lannotation().value()); //打印属性lannotation的值  
                System.out.println(myAnnotation.style());  
            }
    
            //得到output方法上的所有注解，当然是被RetentionPolicy.RUNTIME修饰的  
            Annotation[] annotations = method.getAnnotations();  
            for (Annotation annotation : annotations){ 
                System.out.println(annotation.annotationType().getName());  
            }  
        }  
    }

以上程序打印结果如下：

have annotation    
output something!    
gege, shanghai    
3    
baby    
class java.lang.String    
com.heima.annotation.MyAnnotation    
java.lang.Deprecated

【五-2】

如果注解中有一个属性名字叫value,则在应用时可以省略属性名字不写。    
可见，@Retention(RetentionPolicy.RUNTIME )注解中，RetentionPolicy.RUNTIME是注解属性值，属性名字是value,    
属性的返回类型是RetentionPolicy，如下：

public @interface MyTarget{  
        String value();  
    }

可以这样用：

@MyTarget("aaa")  
    public void doSomething(){
        System.out.println("hello world");  
    }

【六】

注解@Target也是用来修饰注解的元注解，它有一个属性ElementType也是枚举类型，值为：ANNOTATION\_TYPE，CONSTRUCTOR，FIELD LOCAL\_VARIABLE，METHOD，PACKAGE，PARAMETER，TYPE。

如@Target(ElementType.METHOD) 修饰的注解表示该注解只能用来修饰在方法上。

@Target(ElementType.METHOD)  
    @Retention(RetentionPolicy.RUNTIME)  
    public @interface MyTarget{  
        String value() default "hahaha";  
    }

如把@MyTarget修饰在类上，则程序报错，如：

@MyTarget  
    public class MyTargetTest

【其他】

@interface实际上是继承了java.lang.annotation.Annotation,所以定义annotation时不能继承其他annotation或interface。

java.lang.annotation.Retention告诉编译器如何对待 Annotation,使用Retention时,需要提供java.lang.annotation.RetentionPolicy的枚举值。

public enum RetentionPolicy {   
        SOURCE, // 编译器处理完Annotation后不存储在class中   
        CLASS, // 编译器把Annotation存储在class中，这是默认值   
        RUNTIME // 编译器把Annotation存储在class中，可以由虚拟机读取,反射需要   
    }

java.lang.annotation.Target告诉编译器Annotation使用在哪些地方,使用需要指定java.lang.annotation.ElementType的枚举值。

public enum ElementType {   
        TYPE, // 指定适用点为 class, interface, enum   
        FIELD, // 指定适用点为 field   
        METHOD, // 指定适用点为 method   
        PARAMETER, // 指定适用点为 method 的 parameter   
        CONSTRUCTOR, // 指定适用点为 constructor   
        LOCAL_VARIABLE, // 指定使用点为 局部变量   
        ANNOTATION_TYPE, //指定适用点为 annotation 类型   
        PACKAGE // 指定适用点为 package   
    }

java.lang.annotation.Documented用于指定该Annotation是否可以写入javadoc中.。  
java.lang.annotation.Inherited用于指定该Annotation用于父类时是否能够被子类继承。

import java.lang.annotation.ElementType;   
    import java.lang.annotation.Retention;   
    import java.lang.annotation.RetentionPolicy;   
    import java.lang.annotation.Target;   
      
    @Documented  //这个Annotation可以被写入javadoc   
    @Inherited       //这个Annotation 可以被继承   
    @Target({ElementType.CONSTRUCTOR,ElementType.METHOD}) //表示这个Annotation只能用于注释 构造子和方法   
    @Retention(RetentionPolicy.CLASS) //表示这个Annotation存入class但vm不读取   
    public @interface MyAnnotation {   
        String value() default "hahaha";   
    }

java.lang.reflect.AnnotatedElement接口提供了四个方法来访问Annotation。

public Annotation getAnnotation(Class annotationType);   
    public Annotation[] getAnnotations();   
    public Annotation[] getDeclaredAnnotations();   
    public boolean isAnnotationPresent(Class annotationType);

[http_blog.csdn.net_liuwenbo0920_article_details_7290586]: http://blog.csdn.net/liuwenbo0920/article/details/7290586/
[http_blog.csdn.net_foamflower_article_details_5946451]: http://blog.csdn.net/foamflower/article/details/5946451
[0_1320340910A8xa.gif]: /images/20220716/9d95bc19ece845078f44fd13595c7055.png
[0_1320340969Vgmw.gif]: /images/20220716/c2370b7bb8b64264be34542338cb003e.png
[0_1320341021mJWH.gif]: /images/20220716/4dba72207db24657a4911223d0a7e9e9.png