Java 5之后可以在源代码中嵌入一些补充信息,这种补充信息称为注解(Annotation),例如在方法覆盖中使用过的@Override注解,注解都是@符号开头的。
注解并不能改变程序运行的结果,不会影响程序运行的性能。有些注解可以在编译时给用户提示或警告,有的注解可以在运行时读写字节码文件信息。
五个基本注解
无论是哪一种注解,本质上都一种数据类型,是一种接口类型。到Java 8为止Java SE提供11种内置注解。其中有 5 种是基本注解,它们来自于java.lang包。有6个是元注解(Meta Annotation),它们来自于java.lang.annotation包,自定义注解会用到元注解。
元注解就是负责注解其他的注解。
基本注解包括:@Override、@Deprecated、@SuppressWarnings、@SafeVarargs和@FunctionalInterface。下面逐一介绍一下。
@Override只能用于方法,子类覆盖父类方法(或者实现接口的方法)时可以@Override注解。编译器会检查被@Override注解的方法,确保该方法父类中存在的方法,否则会有编译错误。
package java.lang; @Target(ElementType.METHOD) @Retention(RetentionPolicy.SOURCE) public @interface Override { }
@Deprecated用来指示API已经过时了
package java.lang; @Documented @Retention(RetentionPolicy.RUNTIME) @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE}) public @interface Deprecated { }
@SuppressWarnings
用来抑制编译器警告,如果你确认程序中的警告没有问题,可以不用理会。但是就是不想看到这些警告,可以使用@SuppressWarnings注解消除这些警告。
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) @Retention(RetentionPolicy.SOURCE) public @interface SuppressWarnings { }
@SafeVarargs
例如在传递可变参数,参数是非泛型集合
public class HelloWorld { public static void main(String[] args) { // 传递可变参数,参数是泛型集合 display(10, 20, 30); // 传递可变参数,参数是非泛型集合 display("10", 20, 30);// 会有编译警告 ① } public static <T> void display(T... array) { ③ for (T arg : array) { System.out.println(arg.getClass().getName() + ":" + arg); } } }
在可变参数display前添加@SafeVarargs注解。当然可用也可以使用
@SuppressWarnings("unchecked")注解,但@SafeVarargs注解更适合。
@SafeVarargs public static <T> void display(T... array) { for (T arg : array) { System.out.println(arg.getClass().getName() + ":" + arg); } }
package java.lang; import java.lang.annotation.*; @Documented @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.CONSTRUCTOR, ElementType.METHOD}) public @interface SafeVarargs {}
@FunctionalInterface
在Java 8增加的,用于接口的注解,声明接口是函数式接口,在前面讲解Lambda表达式时介绍过函数式接口,有关@FunctionalInterface注解不再赘述。
@Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface FunctionalInterface {}
六个元注解
元注解包括:@Documented、@Target、@Retention、@Inherited、@Repeatable和@Native。元注解是为其他注解进行说明的注解,当自定义一个新的注解类型时,其中可以使用元注解。这一节先介绍一下这几种元注解含义,下一节在自定义注解中详细介绍它们的使用的。
- @Documented
如果在一个自定义注解中引用@Documented注解,那么该注解可以修饰代码元素(类、接口、成员变量和成员方法等),javadoc等工具可以提取这些注解信息。
- @Target
@Target注解用来指定一个新注解的适用目标。@Target注解有一个成员(value)用来设置适用目标,value是java.lang.annotation.ElementType枚举类型的数组,ElementType描述Java程序元素类型,它有10个枚举常量,如表所示。
- @Retention
@Retention注解用来指定一个新注解的有效范围,@Retention注解有一个成员(value)用来设置保留策略,value是java.lang.annotation.RetentionPolicy枚举类型,RetentionPolicy描述注解保留策略,它有3个枚举常量,如表所示。
RetentionPolicy枚举类型中的枚举常量
- @Inherited
@Inherited注解用来指定一个新注解可以被继承。假定一个类A被该新注解修饰,那么这个A类的子类会继承该新注解。
- @Repeatable
@Repeatable注解是Java 8新增加的,它允许在相同的程序元素中重复注释,可重复的注释必须使用@Repeatable进行注释。
- @Native
@Native注解一个成员变量,指示这个变量可以被本地代码引用。常常被代码生成工具使用。
自定义注解
如果前面的Java SE提供的11个内置注解不能满足你的需求,可以自定义注解,注解本质是一种接口,它是java.lang.annotation.Annotation接口的子接口,是引用数据类型。
新建注解类
声明自定义注解可以使用@interface关键字实现,最简单形式的注解示例代码如下:
package qy.likai.java; public @interface MyAnnotation { }
注意 关于注解源程序文件与类一样,一个源程序文件中可以声明多个注解,但只能有一个是公有访问权限的,源程序文件命名与公有访问权限的注解名一致。
Marker注解中不包含任何的成员,这种注解称为标记注解(Marked Annotation),基本注解中的@Override就属于标记注解。根据需要注解中可以包含一些成员,示例代码如下:
package qy.likai.java; public @interface MyAnnotation { String value(); // 注解中的成员也可以有默认值,示例代码如下: // int count() default 0; }
读取运行时注解信息
注解是为工具读取信息而准备的。有些工具可以读取源代码文件中的注解信息;有的可以读取字节码文件中的注解信息;有的可以在运行时读取注解信息。但是读取这些注解信息的代码都是一样的,区别只在于自定义注解中@Retention的保留策略不同。
读取注解信息需要反射相关API,Class类如下方法:
package qy.likai.java; import java.lang.annotation.Annotation; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.reflect.Field; import java.lang.reflect.Method; @MyAnnotation("type") public class AnnotationTest { @MyAnnotation("field") private String title; private String subtitle; @MyAnnotation("constructor") private AnnotationTest(){} public AnnotationTest(String title) { this.title = title; } public static void main(@MyAnnotation("parameter") String[] args) { testAnnotation(); } private static void testAnnotation() { @MyAnnotation("localVariable") String str = "hello MyAnnotation"; // 读取类注解 final Annotation[] annotations = AnnotationTest.class.getAnnotations(); if (AnnotationTest.class.isAnnotationPresent(MyAnnotation.class)) { MyAnnotation ann = AnnotationTest.class.getAnnotation(MyAnnotation.class); System.out.printf("类%s,读取注解描述: %s \n", AnnotationTest.class.getName(), ann.value()); } // 读取成员方法的注解信息 Method[] methods = AnnotationTest.class.getDeclaredMethods(); for (Method method : methods) { if (method.isAnnotationPresent(MyAnnotation.class)) { MyAnnotation ann = method.getAnnotation(MyAnnotation.class); System.out.printf("方法%s,读取注解描述: %s \n", method.getName(), ann.value()); } } // 读取成员变量的注解信息 Field[] fields = AnnotationTest.class.getDeclaredFields(); for (Field field : fields) { if (field.isAnnotationPresent(MyAnnotation.class)) { MyAnnotation ann = field.getAnnotation(MyAnnotation.class); System.out.printf("成员变量%s,读取注解描述: %s \n", field.getName(), ann.value()); } } } @MyAnnotation(value = "method") @Override public String toString() { return super.toString(); } } // 只有为 RUNTIME,才能动态读取信息。 默认级别为 CLASS @Retention(RetentionPolicy.RUNTIME) @interface MyAnnotation { String value(); }
元注解中RetentionPolicy的三个级别
1、RetentionPolicy.SOURCE:注解只保留在源文件,当Java文件编译成class文件的时候,注解被遗弃;
2、RetentionPolicy.CLASS:注解被保留到class文件,但jvm加载class文件时候被遗弃,这是默认的生命周期;
3、RetentionPolicy.RUNTIME:注解不仅被保存到class文件中,jvm加载class文件之后,仍然存在;
这3个生命周期分别对应于:Java源文件(.java文件) ---> .class文件 ---> 内存中的字节码。
源码下载
https://gitee.com/kaiLee/javabijifanshe/blob/master/src/main/java/qy/likai/java/AnnotationTest.java
参考
- Java从小白到大牛-关东升 (作者)-第 27 章 注解(Annotation)-图灵社区
https://www.ituring.com.cn/book/tupubarticle/17723
- 自定义注解之运行时注解(RetentionPolicy.RUNTIME)Rukey7的博客-CSDN博客@retention(retentionpolicy.runtime)
https://blog.csdn.net/github_35180164/article/details/52118286