Java中的注解是如何工作的？

原文链接：http://idlebrains.org/tutorials/java-tutorials/how-annotations-work-java/

翻译：人晓

译文链接：http://www.importnew.com/10294.html

自 Java5.0 版本引入注解之后，它就成为了 Java 平台中非常重要的一部分。开发过程中，我们也时常在应用代码中会看到诸如 @Override，@Deprecated 这样的注解。这篇文章中，我将向大家讲述到底什么是注解，为什么要引入注解，注解是如何工作的，如何编写自定义的注解 (通过例子)，什么情况下可以使用注解以及最新注解和 ADF(应用开发框架)。这会花点儿时间，所以为自己准备一杯咖啡，让我们来进入注解的世界吧。

什么是注解？

用一个词就可以描述注解，那就是元数据，即一种描述数据的数据。所以，可以说注解就是源代码的元数据。比如，下面这段代码：

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

上面的代码中，我重写了 toString() 方法并使用了 @Override 注解。

但是，即使我不使用 @Override 注解标记代码，程序也能够正常执行。那么，该注解表示什么？这么写有什么好处吗？

事实上，@Override 告诉编译器这个方法是一个重写方法 (描述方法的元数据)，如果父类中不存在该方法，编译器便会报错，提示该方法没有重写父类中的方法。如果我不小心拼写错误，例如将 toString() 写成了 toStrring(){double r}，而且我也没有使用 @Override 注解，那程序依然能编译运行。但运行结果会和我期望的大不相同。现在我们了解了什么是注解，并且使用注解有助于阅读程序。

Annotation 是一种应用于类、方法、参数、变量、构造器及包声明中的特殊修饰符。它是一种由 JSR-175 标准选择用来描述元数据的一种工具。

为什么要引入注解？

使用 Annotation 之前 (甚至在使用之后)，XML 被广泛的应用于描述元数据。不知何时开始一些应用开发人员和架构师发现 XML 的维护越来越糟糕了。他们希望使用一些和代码紧耦合的东西，而不是像 XML 那样和代码是松耦合的(在某些情况下甚至是完全分离的) 代码描述。如果你在 Google 中搜索“XML vs. annotations”，会看到许多关于这个问题的辩论。最有趣的是 XML 配置其实就是为了分离代码和配置而引入的。上述两种观点可能会让你很疑惑，两者观点似乎构成了一种循环，但各有利弊。下面我们通过一个例子来理解这两者的区别。

假如你想为应用设置很多的常量或参数，这种情况下，XML 是一个很好的选择，因为它不会同特定的代码相连。如果你想把某个方法声明为服务，那么使用 Annotation 会更好一些，因为这种情况下需要注解和方法紧密耦合起来，开发人员也必须认识到这点。

另一个很重要的因素是 Annotation 定义了一种标准的描述元数据的方式。在这之前，开发人员通常使用他们自己的方式定义元数据。例如，使用标记 interfaces，注释，transient 关键字等等。每个程序员按照自己的方式定义元数据，而不像 Annotation 这种标准的方式。

目前，许多框架将 XML 和 Annotation 两种方式结合使用，平衡两者之间的利弊。

Annotation 是如何工作的？怎么编写自定义的 Annotation？

在讲述这部分之前，建议你首先下载 Annotation 的示例代码 AnnotationsSample.zip 。下载之后放在你习惯使用的 IDE 中，这些代码会帮助你更好的理解 Annotation 机制。

编写 Annotation 非常简单，可以将 Annotation 的定义同接口的定义进行比较。我们来看两个例子：一个是标准的注解 @Override，另一个是用户自定义注解 @Todo。

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

对于 @Override 注释你可能有些疑问，它什么都没做，那它是如何检查在父类中有一个同名的函数呢。当然，不要惊讶，我是逗你玩的。@Override 注解的定义不仅仅只有这么一点代码。这部分内容很重要，我不得不再次重复：Annotations 仅仅是元数据，和业务逻辑无关。理解起来有点困难，但就是这样。如果 Annotations 不包含业务逻辑，那么必须有人来实现这些逻辑。元数据的用户来做这个事情。Annotations 仅仅提供它定义的属性 (类 / 方法 / 包 / 域) 的信息。Annotations 的用户 (同样是一些代码) 来读取这些信息并实现必要的逻辑。

当我们使用 Java 的标注 Annotations(例如 @Override) 时，JVM 就是一个用户，它在字节码层面工作。到这里，应用开发人员还不能控制也不能使用自定义的注解。因此，我们讲解一下如何编写自定义的 Annotations。

我们来逐个讲述编写自定义 Annotations 的要点。上面的例子中，你看到一些注解应用在注解上。

J2SE5.0 版本在 java.lang.annotation 提供了四种元注解，专门注解其他的注解：

@Documented –注解是否将包含在 JavaDoc 中

@Retention –什么时候使用该注解

@Target? –注解用于什么地方

@Inherited – 是否允许子类继承该注解

@Documented–一个简单的 Annotations 标记注解，表示是否将注解信息添加在 java 文档中。

@Retention– 定义该注解的生命周期。

RetentionPolicy.SOURCE – 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings 都属于这类注解。

RetentionPolicy.CLASS – 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式。

RetentionPolicy.RUNTIME– 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

@Target – 表示该注解用于什么地方。如果不明确指出，该注解可以放在任何地方。以下是一些可用的参数。需要说明的是：属性的注解是兼容的，如果你想给 7 个属性都添加注解，仅仅排除一个属性，那么你需要在定义 target 包含所有的属性。

ElementType.TYPE: 用于描述类、接口或 enum 声明

ElementType.FIELD: 用于描述实例变量

ElementType.METHOD

ElementType.PARAMETER

ElementType.CONSTRUCTOR

ElementType.LOCAL_VARIABLE

ElementType.ANNOTATION_TYPE 另一个注释

ElementType.PACKAGE 用于记录 java 文件的 package 信息

@Inherited – 定义该注释和子类的关系

那么，注解的内部到底是如何定义的呢？Annotations 只支持基本类型、String 及枚举类型。注释中所有的属性被定义成方法，并允许提供默认值。

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

如果注解中只有一个属性，可以直接命名为 “value”，使用时无需再标明属性名。

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

但目前为止一切看起来都还不错。我们定义了自己的注解并将其应用在业务逻辑的方法上。现在我们需要写一个用户程序调用我们的注解。这里我们需要使用反射机制。如果你熟悉反射代码，就会知道反射可以提供类名、方法和实例变量对象。所有这些对象都有 getAnnotation()这个方法用来返回注解信息。我们需要把这个对象转换为我们自定义的注释 (使用 instanceOf() 检查之后)，同时也可以调用自定义注释里面的方法。看看以下的实例代码，使用了上面的注解:

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());
    }
}

注解用例

注解的功能很强大，Spring 和 Hebernate 这些框架在日志和有效性中大量使用了注解功能。注解可以应用在使用标记接口的地方。不同的是标记接口用来定义完整的类，但你可以为单个的方法定义注释，例如是否将一个方法暴露为服务。

在最新的 servlet3.0 中引入了很多新的注解，尤其是和 servlet 安全相关的注解。

HandlesTypes –该注解用来表示一组传递给 ServletContainerInitializer 的应用类。

HttpConstraint – 该注解代表所有 HTTP 方法的应用请求的安全约束，和 ServletSecurity 注释中定义的 HttpMethodConstraint 安全约束不同。

HttpMethodConstraint – 指明不同类型请求的安全约束，和 ServletSecurity 注解中描述 HTTP 协议方法类型的注释不同。

MultipartConfig –该注解标注在 Servlet 上面，表示该 Servlet 希望处理的请求的 MIME 类型是 multipart/form-data。

ServletSecurity 该注解标注在 Servlet 继承类上面，强制该 HTTP 协议请求遵循安全约束。

WebFilter – 该注解用来声明一个 Server 过滤器；

WebInitParam – 该注解用来声明 Servlet 或是过滤器的中的初始化参数，通常配合 @WebServlet 或者 @WebFilter 使用。

WebListener –该注解为 Web 应用程序上下文中不同类型的事件声明监听器。

WebServlet –该注解用来声明一个 Servlet 的配置。

ADF (应用程序框架) 和注解

现在我们开始讨论文章的最后一部分了。应用程序框架，被称为 ADF，由 Oracle 开发用来创建 Oracle 融合应用。我们已经了解了注解的优缺点，也知道如何编写自定义的注解，但我们应该将注解应用在 ADF 的哪部分呢？ADF 是否提供了一些朴素的注解？很好的问题，确实在 ADF 中大量使用注解有一些限制。之前提到的应用框架如 Spring 和 Hibernate 使用 AOP(面向侧面的程序设计)。在 AOP 中，框架提供了一种机制，在事件的预处理和后续处理中注入代码。例如：你有一个钩子用来在方法执行之前和之后添加代码，所以你可以在这些地方编写你的用户代码。ADF 不使用 AOP。如果我们有任何注解的用例可用，我们可能需要通过继承的方式实现。