【Java基础篇】注解
注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。
作用分类
- 编写文档:通过代码里标识的注解生成文档【生成文档doc文档】
- 代码分析:通过代码里标识的注解对代码进行分析【使用反射】
- 编译检查:通过代码里标识的注解让编译器能够实现基本的编译检查【Override】
JDK中预定义的一些注解
- @Override:检测被该注解标注的方法是否是继承自父类(接口)的
- @Deprecated:该注解标注的内容,表示已过时
- @SuppressWarnings:压制警告,一般传递参数all @SuppressWarnings(“all”)
自定义注解
public @interface 注解名称{
属性列表;
}
本质: 注解本质上就是一个接口,该接口默认继承Annotation
接口
public interface MyAnno extends java.lang.annotation.Annotation {}
属性: 接口中的抽象方法
要求:
- 属性的返回值类型有下列取值
- 基本数据类型
- String
- 枚举
- 注解
- 以上类型的数组
- 定义了属性,在使用时需要给属性赋值
- 如果定义属性时,使用
default
关键字给属性默认初始化值,则使用注解时,可以不进行属性的赋值。 - 如果只有一个属性需要赋值,并且属性的名称是
value
,则value
可以省略,直接定义值即可。 - 数组赋值时,值使用
{}
包裹。如果数组中只有一个值,则{}
可以省略
元注解
用于描述注解的注解
- @Target:描述注解能够作用的位置
- @Retention:描述注解被保留的阶段
- @Documented:描述注解是否被抽取到api文档中
- @Inherited:描述注解是否被子类继承
@Target
@Target:描述注解能够作用的位置,如:类,方法,属性,参数…
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD})
使用枚举类ElementType
取值:
- TYPE:可以作用于类上
- METHOD:可以作用于方法上
- FIELD:可以作用于成员变量上
- PARAMETER: 形参声明
- CONSTRUCTOR: 构造函数声明
- LOCAL_VARIABLE: 局部变量声明
- ANNOTATION_TYPE: 注解类型声明
- PACKAGE: 包声明
- TYPE_PARAMETER: jdk1.8 类型参数声明
- TYPE_USE: jdk1.8类型的使用
@Retention
@Retention:描述注解被保留的阶段。比如某些注解仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中; 编译在class文件中的注解可能会被虚拟机忽略,而另一些在class被装载运行时将被读取。
@Retention(RetentionPolicy.RUNTIME)
使用枚举类RetentionPolicy取值:
- @Retention(RetentionPolicy.RUNTIME):在运行时有效(即运行时保留)。当前被描述的注解,会保留到
class
字节码文件中,并被JVM
读取到 - SOURCE: 在源文件中有效(即源文件保留)
- CLASS: 在class文件中有效(即class保留)
为何要分字节码文件中有还是没有呢?如果没有时,反射技术就拿不到,从而就无法去识别处理。
测试
预先定义Demo1.java与Demo2.java,解析注解,获取注解中定义的属性值
Demo1.java
public class Demo1 {
public void show(){
System.out.println("demo1...show...");
}
}
Demo2.java
public class Demo2 {
public void show(){
System.out.println("demo2...show...");
}
}
再自定义一个注解Pro.java
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
String className();
String methodName();
}
接下来通过注解加载类与方法
@Pro(className = "annotation.Demo1",methodName = "show")
public class ReflectTest {
public static void main(String [] args) throws Exception {
Class<ReflectTest> reflectTestClass = ReflectTest.class;
Pro an = reflectTestClass.getAnnotation(Pro.class);
String className=an.className();
String methodName = an.methodName();
System.out.println(className);
System.out.println(methodName);
Class cls = Class.forName(className);
Object obj = cls.newInstance();
Method method = cls.getMethod(methodName);
method.invoke(obj);
}
}