Java基础：注解

前言

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

注解是那些插入到源代码中使用其他工具可以对其进行处理的标签。这些工具可以在源码层次上进行操作，或者可以处理编译器在其中放置了注解的类文件。注解不会改变程序的编译方式。Java编译器对于包含注解和不包含注解的代码会生成相同的虚拟机指令。为了能够受益于注解，需要选择一个处理工具，然后向你的处理工具可以理解的代码中插入注解，之后运行该处理工具处理代码。

（元数据(meta data)——“data about data” 关于数据的数据，一般是结构化数据（如存储在数据库里的数据，规定了字段的长度、类型等）。元数据是指从信息资源中抽取出来的用于说明其特征、内容的结构化的(如题名,版本、出版数据、相关说明,包括检索点等)，用于组织、描述、检索、保存、管理信息和知识资源。）

正题

注解在一定程度上是在把元数据与源代码文件结合在一起，而不是保存在外部文档中这一大趋势下所催生的。注解是众多引入到Java SE5中的重要的语言变化之一。它们可以提供用来完整描述程序所需的信息，而这些信息是无法用Java来表达的。因此，注解使得我们能够以将由编译器来测试和验证的格式，存储有关程序的额外信息。注解可以用来生成描述符文件，甚至或是新的类定义，并且有助于减轻编写“样板”代码的负担。通过使用注解，我们可以将这些元数据保存在Java源代码中，并利用annotation API为自己的注解构造处理工具，同时，注解的优点还包括：更加干净易读的代码以及编译器类型检查等。虽然Java SE5预定义了一些元数据，但一般来说，主要还是需要程序员添加新的注解，并且按照自己的方式使用它们。

注解的使用范围很广泛，并且这种广泛性让人觉得有些杂乱无章。下面是关于注解的一些可能的用法：

• 附属文件的自动生成，例如部署描述符或者bean信息类。
• 测试、日记、事务语义等代码的自动生成。
  

在Java中，注解是当作一个修饰符来使用的，它被置于被注解项之前，中间没有分号。（修饰符就是诸如public和static之类的关键词。）每一个注解的名称前面都加上了@符号，这有点类似于Javadoc的注释。然而，Javadoc注释出现在/**...*/定界符的内部，而注解是代码的一部分。

注解的语法比较简单，除了@符号的使用之外，它基本与Java固有的语法一致。Java SE5内置了三种，定义在Java.lang中的注解：

• @Override，表示当前的方法定义将覆盖超类中的方法。

• @Deprecated，如果程序员使用了注解为它的元素，那么编译器会发出警告信息。

• @SuppressWarnings，关闭不当的编译器警告信息。在Java SE5之前的版本中，也可以使用该注解，不过会被忽略不起作用

元注解

Java目前只内置了三种标准注解，以及四种元注解。元注解专职负责注解其它的注解：

大多数时候，程序员主要是定义自己的注解，并编写自己的处理器来处理它们。

定义注解

注解的定义看起来很像接口的定义。事实上，与其他任何Java接口一样，注解也会编译成class文件。在注解中，一般都会包含一些元素以表示以表示某些值。当分析处理注解时，程序或工具可以利用这些值。注解的元素看起来就像接口的方法，唯一的区别是你可以为其指定默认值。

每一个注解都必须通过一个注解接口进行定义。这些接口中的方法与注解中的元素相对应。

@Target(ElementType.METHOD)//①声明可以使用该注解的目标类型@Retention(RetentionPolicy.RUNTIME)//②声明注解的保留期限public @interface Test {//③定义注解public int id();//④声明注解成员public String description() default "no description";}

@interface声明创建了一个真正的Java接口。处理注解的工具将接收那些实现了这个注解接口的对象。这类工具可以调用id方法来检索某个特定Test注解的id元素。

Java新语法规定用@interface修饰符定义注解类。一个注解可以拥有多个成员，成员声明和接口方法声明类似。成员声明有一下几点限制：

• 成员以无入参、无抛出异常的方式声明，如boolean value(String str)、boolean value() throws Exception等方式是非法的。
• 可以通过default为成员指定一个默认值，如String level() default "LOW_LEVEL"、int hight() default 2是合法的，当然也可以不指定默认值。
• 成员类型是受限的，合法的类型包括原始类型及封装类、String、Class、enums、注解类型，以及上述类型的数组，如ForumService value、List foo()是非法的。
  

定义注解时，会需要一些元注解（meta-annotation），如@Target和@Retention。@Target用来定义你的注解将应用于什么地方（例如是一个方法或者一个域）。@Retention用来定义该注解在哪一个级别可用，在源码中（SOURCE）、类文件中（CLASS）或者运行时（RUNTIME）。

Constant pool:   #1 = Class              #20            // com/annotation/Test   #2 = Class              #21            // java/lang/Object   #3 = Class              #22            // java/lang/annotation/Annotation   #4 = Utf8               id   #5 = Utf8               ()I   #6 = Utf8               description   #7 = Utf8               ()Ljava/lang/String;   #8 = Utf8               AnnotationDefault   #9 = Utf8               no description  #10 = Utf8               SourceFile  #11 = Utf8               Test.java  #12 = Utf8               RuntimeVisibleAnnotations  #13 = Utf8               Ljava/lang/annotation/Target;  #14 = Utf8               value  #15 = Utf8               Ljava/lang/annotation/ElementType;  #16 = Utf8               METHOD  #17 = Utf8               Ljava/lang/annotation/Retention;  #18 = Utf8               Ljava/lang/annotation/RetentionPolicy;  #19 = Utf8               RUNTIME  #20 = Utf8               com/annotation/Test  #21 = Utf8               java/lang/Object  #22 = Utf8               java/lang/annotation/Annotation{  public abstract int id();    descriptor: ()I    flags: ACC_PUBLIC, ACC_ABSTRACT  public abstract java.lang.String description();    descriptor: ()Ljava/lang/String;    flags: ACC_PUBLIC, ACC_ABSTRACT    AnnotationDefault:default_value: s#9}SourceFile: "Test.java"RuntimeVisibleAnnotations:  0: #13(#14=[e#15.#16])  1: #17(#14=e#18.#19)

注解的访问标志位：26 01；从注解的访问标志位可以看出：在虚拟机的内部标志注解也是接口。

所有的注解接口都隐式地扩展自java.lang.annotation.Annotation接口。这个接口是一个常规接口，不是一个注解接口。你无法扩展注解接口，换句话说，所有的注解接口都直接扩展自java.lang.annotation.Annotation。

从字节码的接口索引集合可以看出有实现了一个接口：00 01 00 03

description注解的默认值对应的字节码：00 08 00 03 73 00 09；在常量池里会存在对应的AnnotationDefault属性。

注解里的每一元素都被虚拟机解析为一个abstract、public方法。

Test注解使用：

public class AnnotationTest {@Test(id = 47,description = "calls A()")public void A(){}public static void main(String[] args) {}}

注解中的元素在使用时表现为名—值对的形式，并需要置于@Test声明之后的括号内。

class文件常量池：

Constant pool:   #1 = Methodref          #3.#19         //  java/lang/Obj   #2 = Class              #20            //  com/annotatio   #3 = Class              #21            //  java/lang/Obj   #4 = Utf8               <init>   #5 = Utf8               ()V   #6 = Utf8               Code   #7 = Utf8               LineNumberTable   #8 = Utf8               A   #9 = Utf8               RuntimeInvisibleAnnotations  #10 = Utf8               Lcom/annotation/Test;  #11 = Utf8               id  #12 = Integer            47  #13 = Utf8               description  #14 = Utf8               calls A()  #15 = Utf8               main  #16 = Utf8               ([Ljava/lang/String;)V  #17 = Utf8               SourceFile  #18 = Utf8               AnnotationTest.java  #19 = NameAndType        #4:#5          //  "<init>":()V  #20 = Utf8               com/annotation/AnnotationTest  #21 = Utf8               java/lang/Object

A()方法对应的字节码：

 public void A();   flags: ACC_PUBLIC   Code:     stack=0, locals=1, args_size=1        0: return     LineNumberTable:       line 8: 0   RuntimeInvisibleAnnotations:0: #10(#11=I#12,#13=s#14)

对应的二进制格式：

00 09 00 00 00 10 00 01 00 0A  00 02 00 0B 49 00 0C 00 0D 73 00 0E

这些注解本身不会做任何事情，它们只是存在于源文件中。编译器将它们置于类文件中，并且虚拟机会将它们载入。

简化注解的快捷方式：

1、默认注解

如果没有指定元素，要么是因为注解中没有任何元素，要么是因为所有元素都使用默认值，那么就不需要使用圆括号了。例如：

@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)public @interface BugReport {int id() default 0;String assigned() default "none";}

使用默认的格式：

@BugReport

和下面这个注解是一样的：

@BugReport(id=0, assigned="none")

2、单值注解

如果一个元素具有特殊的名字value，并且没有指定其他元素，那么就可以忽略掉这个元素名以及等号。

public @interface ActionListenerFor {String value();}

那么就可以将这个注解书写成如下形式：

@ActionListenerFor("yellow")

而不是：

@ActionListenerFor(value="yellow")

注解的类型：

• 基本类型（int、short、long、byte、double、float、Boolean）
• String
• Class（具有一个可选的类型参数，例如Class<? extends MyClass>）
• enum类型
• 由前面所述类型组成的数组（由数组组成的数组不是合法的元素类型）

下面是一些合法的元素声明的例子：

public @interface BugReport {enum Status { UNCONFIRMED, CONFIRMED, FIXED, NOTABUG };boolean showStopper() default false;String assigned() default "none";Class<?> testCaseClass() default Void.class;Status status() default Status.UNCONFIRMED;Reference ref() default @Reference();String[] reportedBy();}

因为注解是由编译器计算而来的，因此，所有元素值必须是编译期常亮。

BugReport(showStopper = true,assigned="Harry",testCase=Test.class,status=BugReport.Status.CONFIRMED,..)

一个注解元素永远不能设置为null，甚至不允许期默认值为null。这样在实际应用中会相当不变。必须使用其他的默认值，例如“”或者Void.class。

既然一个注解元素可以是另一个注解，那么就可以创建出任意复杂的注解。例如：

@BugReport(ref=@Reference(id=10),...)

注意：在注解中引入循环依赖是一种错误。例如，因为BugReport具有一个注解类型为Reference的元素，所以Reference就不能再拥有一个类型为BugReport的元素。

可以向注解中添加如下一些项：

• 包
• 类（包括enum）
• 接口（包括注解接口）
• 方法
• 构造器
• 实例域（包含enum常亮）
• 局部变量
• 参数变量

不过，对局部变量的注解只能在源码级别上进行处理。类文件并不描述局部变量。因此，所有的局部变量注解在编译完一个类的时候就会被遗弃掉。同样的，对包的注解不能在源码级别之外存在。

编写注解处理器

注解自身并不会做任何事，它需要工具支持才会有用。如果没有用来读取注解的工具，那注解也不会比注释更有用。使用注解的过程中，很重要的一个部分就是创建与使用注释处理器。Java SE5扩展了反射机制的API，以帮助程序员构造这些工具。同时，它还提供了一个外部工具apt帮助程序员解析带有注解的Java源代码。

下面是一个非常简单的注解处理器，使用它来读取AnnotationTest类，并使用反射机制查找@Test标记。

public class TestTracker {public static void trackTest(List<Integer> mList, Class<?> cl){for(Method method : cl.getDeclaredMethods()) {Test test = method.getAnnotation(Test.class);if(null != test) {mList.remove(new Integer(test.id()));}}}public static void main(String[] args) {List<Integer> mList = new ArrayList<Integer>();Collections.addAll(mList, 47, 48, 49);System.out.println(mList);trackTest(mList, AnnotationTest.class);System.out.println(mList);}}

输出结果：

[47, 48, 49][48, 49]