Java注解Annotation解析

概述

       java在1.5版本引入注解annotation，又称java标注，注解是一种语法元数据，可以被直接使用到源代码中，类/方法/变量/参数/包名等都可以被注解。和javadoc标签不同，编译器在生成class文件时候能够保留注解代码，同时，可能为了在程序运行过程中（run-time）可以使用注解，java虚拟机会把注解保留，这样就可以通过反射获取注解annotation的相关信息。

内置注解

其实我们平时会经常遇见注解，例如@override、@deprecated等等，这些都是jdk中内置的注解，先来看看java内置的注解主要有哪些。
 •作用于java代码的注解
◦@override 检查某个方法是否是复写的方法，如果这个方法在父类或者实现的接口中未找到，编译会出错。
 ◦@deprecated 标记某个方法或者类被废弃，如果使用该类或者方法，编译过程会报警告
 ◦@suppresswarnings 通知编译器忽略关于被标注的参数的警告
 ◦@safevarargs 忽略关于调用含有泛型参数的方法或者构造器的警告，1.7新增注解
 ◦@functionalinterface 表明某一个声明的接口将被用作功能性接口，1.8新增注解

•作于其他注解的注解，被称为元注解（meta annotation）
◦@retention 指明被标注的注解在什么时候使用（也就是注解什么时候会被保留）
■仅仅在源代码中保留，在编译过程中丢弃（retentionpolicy.runtime）
 ■注解在编译过程中保存到class文件，在class文件被加载时候忽略（retentionpolicy.class）
 ■注解在class文件加载时候被读取，也就是运行中注解可用，可以通过反射获取注解信息（retentionpolicy.runtime）

 ◦@documented 指明在生成javadoc时候，被标注的注解将被写入javadoc文档中
 ◦@target 指明被标注的注解的作用范围
■elementtype.type:用于描述类、接口(包括注解类型) 或enum声明
 ■elementtype.field:用于描述域
 ■elementtype.method:用于描述方法
 ■elementtype.parameter:用于描述参数
 ■elementtype.constructor:用于描述构造器
 ■elementtype.local_variable:用于描述局部变量
 ■elementtype.annotation_type:用于描述注解
 ■elementtype.package:用于描述包

 ◦@inherited 指明被标注的注解是被继承的，也就是说如果一个@inherited修饰的annotation类型被用于一个类，则这个annotation也会作用于改类的子类。
 ◦@repeatable 指明被标注的注解可以多次作用于同一个对象，1.9新增注解

 自定义注解

上面说了那么多注解，大家集中关注元注解，我们自定义注解时候，通常会使用元注解来协助我们。自定义注解格式为public @interface 注解名 {定义体}，使用@interface自定义注解时，自动继承了java.lang.annotation.annotation接口。自定义注解时，不能继承其他的注解或接口。注解中声明的方法实际上是声明了一个注解参数，方法的名称就是参数的名称，返回值类型就是参数的类型，可以通过default来声明参数的默认值。

自定义注解很简单，使用@interface来定义一个注解，如下。

@retention(retentionpolicy.runtime)
@target(elementtype.type)
@documented
public @interface classinfo {
 string author() default "wang";
 string date();
 string comments();
}

自定义了一个名为classinfo的注解，根据@retention可以得知这个注解会一直存在，也就是在程序运行中时候，这个注解还是有效的；@target(elementtype.type)说明classinfo注解的是作用于类、接口或enum声明的；@documented
说明classinfo信息可以被写入javadoc文档中。

再来看一下自定义注解中的一些注解参数，里面有三个注解参数，注解参数是可以设置默认值，例如author注解参数，默认值为wang，其他两个参数就没有默认值。

再来看另一个自定义的注解。

@retention(retentionpolicy.runtime)
@target(elementtype.method)
public @interface methodinfo {
 string description() default "no description";
 string date();
}

这个自定义的注解methodinfo是作用于方法的，在程序运行中时候，这个注解也会存在；里面有两个注解参数。

注解参数的定义（方法的定义），只能用public或者default两个访问权限修饰符，参数的类型支持以下几种。
 •八种基本数据类型（byte，int，short，long，float，double，char，boolean）
 •string类型
 •class类型
 •enum类型
 •annotation类型
 •以上所有类型的数组

注解的使用

除了上面两个注解，又添加了一个field作用域的注解。

@retention(retentionpolicy.runtime)
@target(elementtype.field)
public @interface fieldinfo {
 string type();
 string name();
}

自定义的注解中的注解参数如果没有声明默认值，在使用自定义注解时候，必须给这些参数赋值，否则编译器会报错。

看一下注解使用的代码：

@classinfo(author = "wang",
  date = "2016/9/13",
  comments = "annotation demo")
public class annotationdemo {

 @fieldinfo(type = "public", name = "firstfield")
 public int firstfield;

 @fieldinfo(type = "private", name = "secondfield")
 private string secondfield;

 @methodinfo(description = "method in annotationdemo", name = "firstmethod")
 public void firstmethod(string value) {
  system.out.printf("first method involved");
 }

 @methodinfo(description = "method in annotationdemo", name="secondmethod")
 private void secondmethod() {
  system.out.printf("first method involved");
 }
}

获取注解信息

要获取注解信息，首先得保证注解在程序运行时候会存在，所以一般会给自定义的注解添加了@retention(retentionpolicy.runtime)元注解，这样在程序运行过程中，我们可以通过反射去获取一些注解信息，关于反射的说明，可以查看这篇文章。

public class annotationtest {
 public static void main(string[] args) {
  resolveclassannotationinfo(annotationdemo.class);
  resolvefieldannotationinfo(annotationdemo.class);
  resolvemethodannotationinfo(annotationdemo.class);
 }

 private static void resolveclassannotationinfo(class<?> clz) {
  // 判断该类是否有classinfo注解
  if(clz.isannotationpresent(classinfo.class)) {
   classinfo classinfo = (classinfo) clz.getannotation(classinfo.class);
   system.out.println(classinfo.author() + " " + classinfo.comments() + " " + classinfo.date());
  }
 }

 private static void resolvefieldannotationinfo(class<?> clz) {
  field[] fields = clz.getdeclaredfields();
  for (field field : fields) {
   if(field.isannotationpresent(fieldinfo.class)) {
    fieldinfo fieldinfo = (fieldinfo) field.getannotation(fieldinfo.class);
    system.out.println(fieldinfo.type() + " " + fieldinfo.name());
   }
  }
 }

 private static void resolvemethodannotationinfo(class<?> clz) {
  method[] methods = clz.getdeclaredmethods();
  for (method method : methods) {
   if(method.isannotationpresent(methodinfo.class)) {
    methodinfo methodinfo = (methodinfo) method.getannotation(methodinfo.class);
    system.out.println(methodinfo.name() + " " + methodinfo.description());
   }
  }
 }
}

通过反射获取类中的field/method等等，通过getannotation()或者getannotations()获取相关注解，拿到具体注解就可以获取具体的信息了。

运行结果输出如下：

图-1 运行结果图

总结

对于java的初学者甚至是有一定经验的java开发人员，对java注解的接触可能比较少，而在实际中，也很少用到注解，但是会经常会在代码里面看见，这篇文章算是对注解的浅显介绍，最起码在代码层面是阅读无压力的。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。