java annotations basics

What are Anotations?

如果用一个单词来描述Annotation那就是Metadata, Metadata是描述数据的数据，所以Annotation可以理解为code的元数据描述。Annotation在JDK5.0版本被引入，大概是如下图这样的

@Override
public String toString() {
    return "This is String Representation of current object."
}

这里重载了toString()方法，用到了@Override注解。如果去掉了@Override，代码也能正常运行。那为什么还要用它呢？@Override注解告诉编译器这是一个重载方法，是关于method的描述。如果父类中没有这个方法，那么编译器会报错,如下:

Error:(8, 5) java: 方法不会覆盖或实现超类型的方法

重新定义：
Annotation是用来装饰class、method、field、parameter、variable、constructor和package的一种特殊Java结构体。

How Annotations Work

Java内置的Override注解源码如下:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

可以看出Override没有什么东西，又怎么做到检验重载方法是否定义在父类中。原因是Annotation只是metadata,不包含任何的业务逻辑。可以这么来理解，Annotation是class、method、package、field的装饰信息的生产者，对应的还有一个信息的消费者。那这里的@Override的问题就好理解了，Override是信息的提供者，JVM是信息的消费者，在二进制层面来检测重载方法的是否存在于父类中。

How to Write Custom Annotations

JDK提供了4中内置的元注解，作用是注解其他的注解，分别是

@Documented - Whether to put the annotation in Javadocs
@Retention - When the annotation is needed
@Target? - Places the annotation can go
@Inherited - Whether subclasses get the annotation

@Retention - Annotation被保留的时间长短，标注注解的生命周期。3种RetentionPolicy的取值说明如下

RetentionPolicy.SOURCE - 在编译期间就被抛弃。这类注解在编译完成后就没有任何意义了，不会被写到字节码里。比如@Override、@SuppressWarnings

RetentionPolicy.CLASS - 在class加载时被抛弃。适合在编译成字节码后做一些处理，而且是Retention的默认值。

RetentionPolicy.RUNTIME - 不抛弃。这类注解适用于运行时反射

@Target - 注解放置的位置
如果不指定@Target的话，可以放到任何地方，一般的使用如下

ElementType.TYPE (class, interface, enum)
ElementType.FIELD (instance variable)
ElementType.METHOD
ElementType.PARAMETER
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE
ElementType.ANNOTATION_TYPE (on another annotation)
ElementType.PACKAGE (remember package-info.java)

@Inherited – 控制是否影响子类

注解的内容（属性）仅支持String和enum类型，所有属性被定义成方法，还可以提供默认值

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Todo {
public enum Priority {LOW, MEDIUM, HIGH}
public enum Status {STARTED, NOT_STARTED}
String author() default "Yash";
Priority priority() default Priority.LOW;
Status status() default Status.NOT_STARTED;
}

那么@Todo注解的使用方式是怎么呢，如下

@Todo(priority = Todo.Priority.MEDIUM, author = "Yashwant", status = Todo.Status.STARTED)
public void incompleteMethod1() {
//Some business logic is written
//But it’s not complete yet
}

如果Annotation里面仅有一个属性，可以命名为"value",如下

@interface Author{
String value();
}
@Author("Yashwant")
public void someMethod() {
}

How to use custom Annotations

1, 反射

反射会提供Class、Method和Field对象，这些对象都有共同的方法getAnnotation()，强转成自定义的Annotation后就可以使用在Annotation内部定义的属性,如下

Class businessLogicClass = BusinessLogic.class;
for(Method method : businessLogicClass.getMethods()) {
Todo todoAnnotation = (Todo)method.getAnnotation(Todo.class);
if(todoAnnotation != null) {
System.out.println(" Method Name : " + method.getName());
System.out.println(" Author : " + todoAnnotation.author());
System.out.println(" Priority : " + todoAnnotation.priority());
System.out.println(" Status : " + todoAnnotation.status());
}
}
## 2,Android里的@StringDef@IntDef代替Enum
[点这查看](http://tools.android.com/tech-docs/support-annotations)