java中注解机制及其原理的详解

java中注解机制及其原理的详解

什么是注解

注解也叫元数据，例如我们常见的@override和@deprecated，注解是jdk1.5版本开始引入的一个特性，用于对代码进行说明，可以对包、类、接口、字段、方法参数、局部变量等进行注解。它主要的作用有以下四方面：

• 生成文档，通过代码里标识的元数据生成javadoc文档。
• 编译检查，通过代码里标识的元数据让编译器在编译期间进行检查验证。
• 编译时动态处理，编译时通过代码里标识的元数据动态处理，例如动态生成代码。
• 运行时动态处理，运行时通过代码里标识的元数据动态处理，例如使用反射注入实例。
  

一般注解可以分为三类：

• 一类是java自带的标准注解，包括@override、@deprecated和@suppresswarnings，分别用于标明重写某个方法、标明某个类或方法过时、标明要忽略的警告，用这些注解标明后编译器就会进行检查。
• 一类为元注解，元注解是用于定义注解的注解，包括@retention、@target、@inherited、@documented，@retention用于标明注解被保留的阶段，@target用于标明注解使用的范围，@inherited用于标明注解可继承，@documented用于标明是否生成javadoc文档。
• 一类为自定义注解，可以根据自己的需求定义注解，并可用元注解对自定义注解进行注解。
  

注解的使用

注解的使用非常简单，只需在需要注解的地方标明某个注解即可，例如在方法上注解：

public class test {
  @override
  public string tostring() {
    return "override it";
  }
}

例如在类上注解：

@deprecated
public class test {
}

所以java内置的注解直接使用即可，但很多时候我们需要自己定义一些注解，例如常见的spring就用了大量的注解来管理对象之间的依赖关系。下面看看如何定义一个自己的注解，下面实现这样一个注解：通过@test向某类注入一个字符串，通过@testmethod向某个方法注入一个字符串。

①创建test注解，声明作用于类并保留到运行时，默认值为default。

@target({elementtype.type})
@retention(retentionpolicy.runtime)
public @interface test {
  string value() default "default";
}

②创建testmethod注解，声明作用于方法并保留到运行时。

@target({elementtype.method})
@retention(retentionpolicy.runtime)
public @interface testmethod {
  string value();
}

③测试类，运行后输出default和tomcat-method两个字符串，因为@test没有传入值，所以输出了默认值，而@testmethod则输出了注入的字符串。

@test()
public class annotationtest {
  @testmethod("tomcat-method")
  public void test(){
  }
  public static void main(string[] args){
    test t = annotationtest.class.getannotation(test.class);
    system.out.println(t.value());
    testmethod tm = null;
    try {
      tm = annotationtest.class.getdeclaredmethod("test",null).getannotation(testmethod.class);
    } catch (exception e) {
      e.printstacktrace();
    }
    system.out.println(tm.value());
  }
}

注解的原理

前面介绍了如何使用java内置的注解以及如何自定义一个注解，接下去看看注解实现的原理，看看在java的大体系下面是如何对注解的支持的。还是回到上面自定义注解的例子，对于注解test，如下，如果对annotationtest类进行注解，则运行时可以通过annotationtest.class.getannotation(test.class)获取注解声明的值，从上面的句子就可以看出，它是从class结构中获取出test注解的，所以肯定是在某个时候注解被加入到class结构中去了。

@test("test")
public class annotationtest {
  public void test(){
  }
}

从java源码到class字节码是由编译器完成的，编译器会对java源码进行解析并生成class文件，而注解也是在编译时由编译器进行处理，编译器会对注解符号处理并附加到class结构中，根据jvm规范，class文件结构是严格有序的格式，唯一可以附加信息到class结构中的方式就是保存到class结构的attributes属性中。我们知道对于类、字段、方法，在class结构中都有自己特定的表结构，而且各自都有自己的属性，而对于注解，作用的范围也可以不同，可以作用在类上，也可以作用在字段或方法上，这时编译器会对应将注解信息存放到类、字段、方法自己的属性上。

在我们的annotationtest类被编译后，在对应的annotationtest.class文件中会包含一个runtimevisibleannotations属性，由于这个注解是作用在类上，所以此属性被添加到类的属性集上。即test注解的键值对value=test会被记录起来。而当jvm加载annotationtest.class文件字节码时，就会将runtimevisibleannotations属性值保存到annotationtest的class对象中，于是就可以通过annotationtest.class.getannotation(test.class)获取到test注解对象，进而再通过test注解对象获取到test里面的属性值。

这里可能会有疑问，test注解对象是什么？其实注解被编译后的本质就是一个继承annotation接口的接口，所以@test其实就是“public interface test extends annotation”，当我们通过annotationtest.class.getannotation(test.class)调用时，jdk会通过动态代理生成一个实现了test接口的对象，并把将runtimevisibleannotations属性值设置进此对象中，此对象即为test注解对象，通过它的value()方法就可以获取到注解值。

java注解实现机制的整个过程如上面所示，它的实现需要编译器和jvm一起配合。

如有疑问请留言或者到本站社区交流讨论，感谢阅读，希望能帮助到大家，谢谢大家对本站的支持！