18.注解

概念

Annotation（注解）是 Java 提供的一种对元程序中元素关联信息和元数据（metadata）的途径和方法。Annatation(注解)是一个接口，程序可以通过反射来获取指定程序中元素的 Annotation对象，然后通过该 Annotation 对象来获取注解中的元数据信息

1. 元注解：@Retention、@Target、@Document、@Inherited四种。

2. (1) 注解保留策略：@Retention

   @Retention(RetentionPolicy.CLASS) //在 class 文件中有效（即 class 保留）

   @Retention(RetentionPolicy.RUNTIME) //在运行时有效（即运行时保留）

   @Retention(RetentionPolicy.SOURCE) //在源文件中有效（即源文件保留）

   (2) 注解的作用范围：@Target

   @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) // 包

   (3) @Document 描述-javadoc

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

   (4) @Inherited 阐述了某个被标注的类型是被继承的

   @Inherited 元注解是一个标记注解，@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited 修饰的 annotation 类型被用于一个 class，则这个 annotation 将被用于该class 的子类

3. 注解处理器

   如果没有用来读取注解的方法和工作，那么注解也就不会比注释更有用处了。使用注解的过程中，

   很重要的一部分就是创建于使用注解处理器。Java SE5 扩展了反射机制的 API，以帮助程序员快速

   的构造自定义注解处理器。下面实现一个注解处理器。

 //1： 定义注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
 	//供应商编号
	public int id() default -1;
	//供应商名称
 	public String name() default ""；
    // 供应商地址
 	public String address() default "";
}


//2：注解使用
public class Apple {
    
 	@FruitProvider(id = 1, name = "陕西红富士集团", address = "陕西省西安市延安路")
 	private String appleProvider;
    
 	public void setAppleProvider(String appleProvider) {
 		this.appleProvider = appleProvider;
 	}
    
 	public String getAppleProvider() {
 		return appleProvider;
 	} 
}


//3 注解处理器，获取注解中的数据
public class FruitInfoUtil {
 	public static void getFruitInfo(Class<?> clazz) {
 		String strFruitProvicer = "供应商信息：";
 		Field[] fields = clazz.getDeclaredFields();//通过反射获取所有属性
 		for (Field field : fields) {
        	// 判断属性里是否被注解标注 
 			if (field.isAnnotationPresent(FruitProvider.class)) {
 				FruitProvider fruitProvider = 
            	(FruitProvider) field.getAnnotation(FruitProvider.class);
				//获取注解的数据
				strFruitProvicer = 
                	" 供应商编号：" + fruitProvider.id() + 
            		" 供应商名称："+ fruitProvider.name() + 
            		" 供应商地址："+ fruitProvider.address();
 				System.out.println(strFruitProvicer);
 			}
 		}
 	} 
}