Java中注解的工作原理

自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。如果我们有任何注解的用例可用，我们可能需要通过继承的方式实现。

希望你喜欢这篇文章，帮助大家更好的理解注解的意义！