一、Java 注解概述

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

注解在一定程度上是把元数据与源代码文件结合在一起，而不是保存在外部的文档中这一大的趋势之下所催生的。同时，注解也是来仔像 C# 之类的其他语言对 Java 造成的语言特性压力所做出的一种回应。

注解是众多引入到 Java SE5 中的重要的语言变化之一。它们可以提供用来完整的描述程序所需的信息，而这些信息是无法用 Java 来表达的。因此，注解是得我们能够以将由编译器来测试和验证的格式、存储有关程序的额外信息。

---《Java 编程思想 - 第 4 版》

注解的语法比较简单，以“@”符号开始，Java SE5 内置提供了三种，定义在 java.lang 中的注解：

• @Override，表示当前方法定义覆盖了父类中同名的方法，如果在这个注解下的方法在父类中没有出现过，就证明是程序员不小心写错了代码，这时由于有这个注解，编译器就会提示此处的代码有错。
• @Deprecated，如果程序员使用了注解为它的元素，那么编译器会发出警告信息。比如在不断更新的 JDK 中，有的类、方法会在将来的 JDK 版本中删除，过渡版本的 JDK 就会在将要废弃的方法上添加该注释，告诉你最好是不要调用该类、方法，但是你强行要调用用的话还是能够通过编译。
• @SuppressWarnings，关闭不当的编译器警告信息。要注意的是 SuppressWarnings 和前两个注释不一样。这个注释有一个属性。当然，还可以抑制其它警告，如:
  @SuppressWarnings (value={"unchecked", "fallthrough"})

二、定义注解

Java 还另外提供了四种注解，专门负责新注解的创建。注解的定义看起来很像接口发的定义，与其他任何 Java 接口一样，注解也将会编译成 class 文件：

package com.phpdragon.samples;
import java.lang.annotation;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {}

@Target 注解 , 表示注解可用于什么地方。可能的 ElementType 参数包括：

• CONSTRUCTOR：构造器的声明
• FIELD：域声明（包括 enum 的声明）
• LOCAL_VARIABLE：局部变量的声明
• METHOD：方法声明
• PACKAGE：包声明
• PARAMETER：参数声明
• TYPE：类、接口（包括注解类型）或 enum 声明

@Retention 注解 , 表示需要什么级别保存该注释信息。可选的 RetentionPolicy 参数包括：

• RetentionPolicy.SOURCE —— 这种类型的 Annotations 只在源代码级别保留, 编译时就会被忽略。
• RetentionPolicy.CLASS —— 这种类型的 Annotations 编译时被保留, 在 class 文件中存在, 但 JVM 将会忽略。
• RetentionPolicy.RUNTIME —— 这种类型的 Annotations 将被 JVM 保留, 所以他们能在运行时被 JVM 或其他使用反射机制的代码所读取和使用。

@Documented 注解

Documented 注解表明这个注解应该被 javadoc 工具记录。默认情况下,javadoc 是不包括注解的，但如果声明注解时指定了 @Documented，则它会被 javadoc 之类的工具处理,

所以注解类型信息也会被包括在生成的文档中，标注此类接口、方法、字段已经被废止。

@Inherited 注解

允许子类继承父类中的注解。

三、编写注解处理器

使用注解的过程中，很重要的一个部分就是创建与使用注解处理器。下面通过一个完整的例子来说明怎么定义与使用注解处理器。
1. 自定义注解类

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

2. 使用自定义注解

public class PasswordUtils {
    @UseCase(id=1,description = "Passwords must contain at least one numeric")
    public boolean validatePassword(String password){
        return (password.matches("\\w*\\d\\w*"));}
    @UseCase(id=2)
    public String encryptPassword(String password){
        return new StringBuilder(password).reverse().toString();
    }
    @UseCase(id=3,description = "New passwords can't equal previously used ones")
    public boolean checkForNewPassword(List<String> prevPasswords,String password){
        return !prevPasswords.contains(password);
    }
}

3. 自定义注解处理器

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
public class UseCaseTracker {
public static void trackUseCases(List<Integer> useCases,Class<?> cl){
for(Method m:cl.getDeclaredMethods()){
UseCase uc=m.getAnnotation(UseCase.class);
if(uc != null){
System.out.println("Found Use Case:"+uc.id()+" "+uc.description());
useCases.remove(new Integer(uc.id()));
}
}
for(int i:useCases){
System.out.println("Warning: Missing use case-"+i);
}
}
public static void main(String[] args){
List<Integer> useCases=new ArrayList<Integer>();
Collections.addAll(useCases,1,2,3,4);
trackUseCases(useCases,PasswordUtils.class);
}
}

4. 结果打印输出

注解的元素在使用时表现为名 - 值对的形式，并需要置于 @UseCase 声明之后的括号内。在 encryptPassword() 方法的注解中，并没有给出 description 元素的值，因此，在 UseCase 的注解处理器分析处理这个类时会使用该元素的默认值。

PS：

PHP 反射机制实现自动依赖注入

AOP 的实现机制

Spring AOP 实现原理

PHP 中的反射