疯狂java


您现在的位置: 疯狂软件 >> 新闻资讯 >> 正文

Java注解Annotation浅析


 

   

  1. 概述

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

  2. 内置注解

  其实我们平时会经常遇见注解,例如@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新增注解

  3. 自定义注解

  上面说了那么多注解,大家集中关注元注解,我们自定义注解时候,通常会使用元注解来协助我们。自定义注解格式为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类型

  以上所有类型的数组

  4. 注解的使用

  除了上面两个注解,又添加了一个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");

  }

  }

  5. 获取注解信息

  要获取注解信息,首先得保证注解在程序运行时候会存在,所以一般会给自定义的注解添加了@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 运行结果图

  6. 总结

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