【java总结】注解Annotation

注解（Annotation）

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

注解不能直接干扰程序代码的运行，无论增加或者删除注解，代码都能正常运行。
java自身提供了3种标准注解，Override注解，Deprecated注解，SuppressWarnings注解
Override注解：用在方法上，如果该方法没有正确重写父类的方法，会抛出异常。
Deprecated注解：对不应该再使用的方法添加注释，如果使用这些方法，在编译时会显示提示信息。
SuppressWarnings注解：通过添加不同的参数，可以屏蔽特定的警告信息。

除了这三个标准注解，还有四种元注解，他们的作用是注解其他注解，我们可以利用这四种元注解来自定义新的注解。

@Retention

定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）
取值（RetentionPoicy）有：
1.SOURCE:在源文件中有效（即源文件保留）
2.CLASS:在class文件中有效（即class保留）
3.RUNTIME:在运行时有效（即运行时保留）

@Target

说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）

、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target
可更加明晰其修饰的目标。
作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）
取值(ElementType)有：
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

@Inherited 

元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。

如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。
注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口
继承annotation，方法并不从它所重载的方法继承annotation。

@Documented

用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

自定义注解：

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。
定义注解格式：public @interface 注解名 {定义体}
注解参数的可支持数据类型：
1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)
2.String类型
3.Class类型
4.enum类型
5.Annotation类型
6.以上所有类型的数组
Annotation类型里面的参数该怎么设定: 
第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；　
第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型
和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组
例如,String value();这里的参数成员就为String;

下面看一个自定义注解的例子：

@Target(ElementType.FIELD)//该注解作用于field，即属性上
@Retention(RetentionPolicy.RUNTIME)//该注解RUNTIME:在运行时有效，可以被反射机制利用
@Documented
public @interface FruitColor {
	public enum Color{ BULE,RED,GREEN};
	Color fruitColor() default Color.GREEN;
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
    String value() default "";//该注解有一个String类型的参数,当注解只有一个并且名称为value时，使用的时候可以省略"value=";
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
	public int id() default -1;
	public String name() default "";
	public String address() default "";
	/*
	 * 注解元素的默认值：
	 * 注解元素必须有确定的值，要么在定义注解的默认值中指定，要么在使用注解时指定，
	 * 非基本类型的注解元素的值不可为null。因此, 使用空字符串或0作为默认值是一种常用的做法。
	 * 这个约束使得处理器很难表现一个元素的存在或缺失的状态，因为每个注解的声明中，所有元素都存在
	 * ，并且都具有相应的值，为了绕开这个约束，我们只能定义一些特殊的值，例如空字符串或者负数，一
	 * 次表示某个元素不存在，在定义注解时，这已经成为一个习惯用法。
	 */
}

public class Apple {
	@FruitName("Apple")
	private String appleName;
	
	@FruitColor(fruitColor=Color.RED)
    private String appleColor;
	
	 @FruitProvider(id=1,name="陕西红富士集团",address="陕西省西安市延安路89号红富士大厦")
	    private String appleProvider;
	
	public void setAppleColor(String appleColor) {
        this.appleColor = appleColor;
    }
    public String getAppleColor() {
        return appleColor;
    }
    
    
    public void setAppleName(String appleName) {
        this.appleName = appleName;
    }
    public String getAppleName() {
        return appleName;
    }
    
    public void setAppleProvider(String appleProvider) {
        this.appleProvider = appleProvider;
    }
    public String getAppleProvider() {
        return appleProvider;
    }
    
    public void displayName(){
        System.out.println("水果的名字是：苹果");
    }
}

java.lang.reflect 包下主要包含一些实现反射功能的工具类，实际上，java.lang.reflect 包所有提供的反射API扩充了读取运行时Annotation信息的能力。当一个Annotation类型被定义为运 行时的Annotation后，该注解才能是运行时可见，当class文件被装载时被保存在class文件中的Annotation才会被虚拟机读取。AnnotatedElement 接口是所有程序元素（Class、Method和Constructor）的父接口，所以程序通过反射获取了某个类的AnnotatedElement对象之后，程序就可以调用该对象的如下四个个方法来访问Annotation信息：

方法1：<T extends Annotation> T getAnnotation(Class<T> annotationClass):

返回改程序元素上存在的、指定类型的注解，如果该类型注解不存在，则返回null。

方法2：Annotation[] getAnnotations():

返回该程序元素上存在的所有注解。

方法3：boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):

判断该程序元素上是否包含指定类型的注解，存在则返回true，否则返回false.

方法4：Annotation[] getDeclaredAnnotations()：

返回直接存在于此元素上的所有注释。与此接口中的其他方法不同，该方法将忽略继承的注释。（如果没有注释直接存在于此元素上，则返回长度为零的一个数组。）该方法的调用者可以随意修改返回的数组；这不会对其他调用者返回的数组产生任何影响。

package Annotation.MyAnnotation;
import java.lang.reflect.*;
/*
 * 注解处理器类库(java.lang.reflect.AnnotatedElement)：
 * 
 * Java使用Annotation接口来代表程序元素前面的注解，该接口是所有Annotation类型的父接口。
 * 除此之外，Java在java.lang.reflect 包下新增了AnnotatedElement接口，该接口代
 * 表程序中可以接受注解的程序元素，该接口主要有如下几个实现类：
 * 
 * Class：类定义
 * Constructor：构造器定义
 * Field：累的成员变量定义
 * Method：类的方法定义
 * Package：类的包定义
 * java.lang.reflect 包下主要包含一些实现反射功能的工具类，实际上，java.lang.reflect 
 * 包所有提供的反射API扩充了读取运行时Annotation信息的能力。当一个Annotation类型被定义为运
 * 行时的Annotation后，该注解才能是运行时可见，当class文件被装载时被保存在class文件中的
 * Annotation才会被虚拟机读取。
 * AnnotatedElement 接口是所有程序元素（Class、Method和Constructor）的父接口，所以程
 * 序通过反射获取了某个类的AnnotatedElement对象之后，程序就可以调用该对象的如下四个个方法来访问
 * Annotation信息：f
 * 方法1：<T extends Annotation> T getAnnotation(Class<T> annotationClass):
 *  返回改程序元素上存在的、指定类型的注解，如果该类型注解不存在，则返回null。
 * 方法2：Annotation[] getAnnotations():返回该程序元素上存在的所有注解。
 * 方法3：boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):
 * 判断该程序元素上是否包含指定类型的注解，存在则返回true，否则返回false.
 * 方法4：Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的所有注释。与此接口中的
 * 其他方法不同，该方法将忽略继承的注释。（如果没有注释直接存在于此元素上，则返回长度为零的一个数组。）该方法的调用
 * 者可以随意修改返回的数组；这不会对其他调用者返回的数组产生任何影响。
 */
public class FruitInfoUtil {
	public static void getFruitInfo(Class<?> clazz){
		String strFruitName=" 水果名称：";
        String strFruitColor=" 水果颜色：";
        String strFruitProvicer="供应商信息：";
        Field[] fields = clazz.getDeclaredFields();
        for(Field field :fields){
        	if(field.isAnnotationPresent(FruitName.class)){
                FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class);
                strFruitName=strFruitName+fruitName.value();
                System.out.println(strFruitName);
            }
            else if(field.isAnnotationPresent(FruitColor.class)){
                FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class);
                strFruitColor=strFruitColor+fruitColor.fruitColor().toString();
                System.out.println(strFruitColor);
            }
            else if(field.isAnnotationPresent(FruitProvider.class)){
                FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class);
                strFruitProvicer=" 供应商编号："+fruitProvider.id()+" 供应商名称："+fruitProvider.name()+" 供应商地址："+fruitProvider.address();
                System.out.println(strFruitProvicer);
            }
        }
	}
}

public class Test {
	public static void main(String[] args) {
        FruitInfoUtil.getFruitInfo(Apple.class);
    }
}