Java 注解
注解可以理解成标签.
注解的概念
Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。注解是不能继承也不能实现其他类或接口的
Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同,Java 标注可以通过反射获取标注内容。在编译器生成类文件时,标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容,在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。
注解的使用
Annotation使用
@TestAnnotation
public class TargetTest<@TestAnnotation T> {
@TestAnnotation
private String value;
}
内置的注解
作用在代码的注解
- @Override - 检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。
- @Deprecated - 标记过时方法。如果使用该方法,会报编译警告。
- @SuppressWarnings - 指示编译器去忽略注解中声明的警告。
元注解
作用在其他注解的注解称为元注解
- @Retention - 标识这个注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。
- @Documented - 标记这些注解是否包含在用户文档中。
- @Target注解 - 标记这个注解应该是哪种 Java 成员。
- @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)
从 Java 7 开始,额外添加了 3 个注解: - @SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
- @FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。
- @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。
自定义注解
@Documented // @Documented表示该Annotation可以出现在 javadoc 中。
@Target({ElementType.TYPE_USE, ElementType.METHOD}) // @Target表示该Annotation类型的注解可以用于修饰哪些程序元素
@Retention(RetentionPolicy.RUNTIME) // @Retention表示需要在什么级别保存该 Annotation 信息
public @interface TestAnnotation {
String value() default "test";
}
利用反射获取注解
必须被@Retention表示为RUNTIME的才可以在运行时通过反射获取注解
@Deprecated
public class ReflectTest {
public static class Test { }
public static void main(String[] args) {
ReflectTest test = new ReflectTest();
//通过反射获取子类的注解
System.out.println("child class Annotations" + test.getClass().getAnnotation(Deprecated.class));
}
}
设置注解内字段
注解本质上是接口,因此没有真正的字段,而是用带默认值的方法作为字段。
注解内方法支持的返回类型:
- 基本类型 int float boolean byte double char logn short
- String
- Class
- Enum
- Annotation
- 以上所有类型的数组类型
注解内方法样例:
public class RetentionTest {
@RuntimeRetentionAnnotation(times=3)
public void runtimeRetentionTest() {
System.out.println("runtime retention");
}
public static void main(String[] args) throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
RetentionTest test = new RetentionTest();
// 获取方法上的注解的值
Method method = test.getClass().getDeclaredMethod("runtimeRetentionTest");
RuntimeRetentionAnnotation annotation = method.getAnnotation(RuntimeRetentionAnnotation.class);
for(int i=0; i<method.getAnnotation(RuntimeRetentionAnnotation.class).times(); i++) {
method.invoke(test);
}
}
}
// 会调用三次runtimeRetentionTest方法