第20章 注解

注解（也被称为元数据）为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便的使用这些数据。

• 20.1.1 定义注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test{}

注解的定义看起来很像接口的定义，注解也将会编译成class文件。

在注解中，一般都会包含一些元素以表示某些值，注解的元素看起来就像接口的方法，唯一的区别就是你可以指定默认值。

没有元素的注解称为标记注解(marker annotation)，例如上例中的@Test。

• 20.1.2 元注解

Java目前（Java SE5）内置了3种标准注解（@Override、@Deprecated、@SuppressWarnings），以及4中元注解。元注解专职负责注解其他的注解：

名称	作用
@Target	表示该注解可以用于什么地方。可能的参数包括：CONTRUCTOR(构造器的声明)；FIELD(域声明（包括enum实例）)；LOCAL_VARIABLE(局部变量声明)；METHOD(方法声明)；PACKAGE(包声明)；PARAMETER(参数声明)；TYPE(类、接口（包括注解类型）或enum声明)
@Retention	表示需要在什么级别保存该注解信息。可能的参数包括：SOURCE:注解将被编译器丢弃；CLASS：注解在class文件中可以用，但被VM丢弃；RUNTIME：VM将在运行时期也保留注解，因此可以通过反射机制读取注解的信息
@Documented	将此注解包含在Javadoc中
@Inherited	允许子类继承父类中的注解

• 20.2 编写注解处理器

如果没有用来读取注解的工具，那注解也不会比注释更有用。使用注解的过程中，很重要的一个部分就是创建与使用注解处理器。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
    public int id();
    public String desciption() default "no description";
}


public static void trackUseCases(List<Integer> useCases, Class<?> cl){
        for(Method m : cl.getDeclaredMethods()){
            UseCase uc = m.getAnnotation(UseCase.class);
            if(null != uc){
                System.out.println("Found Use Case" + uc.id()
                + " " + uc.desciption());
                useCases.remove(new Integer(uc.id()));
            }
        }
        for(int i : useCases){
            System.out.println("Warning: Missing use case-" + i);
        }
    }

• 20.2.1 注解元素

注解元素可用的类型包括以下：
1. 所有基本类型（int float boolean等）
2. String
3. Class
4. enum
5. Annotation
6. 以上类型的数组

如果你使用了其他类型，那编译器就会报错，并且也不允许使用任何包装类型。

• 20.2.2 默认值限制

元素不能有不确定的值，也就是说，元素必须要么具有默认值，要么在使用注解时提供元素的值。

对于非基本类型的元素，不能以null作为元素的值，无论实在源代码声明时，或是在注解接口中定义默认值时。

• 20.2.3 生成外部文件

如果注解中定义了名为value的元素，并且在应用该注解的时候，如果该元素是唯一需要赋值的一个元素，那么此时无需使用名-值对的这种语法，而只需要在括号内给出value元素所需要的值即可。