注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,
用来对这些元素进行说明,注释。作用分类:
编写文档:通过代码里标识的元数据生成文档【生成文档doc文档】
代码分析:通过代码里标识的元数据对代码进行分析【使用反射】
编译检查:通过代码里标识的元数据让编译器能够实现基本的编译检查【Override】
注解不会改变程序的语义,只是作为注解(标识)存在,我们可以通过反射机制编程实现对这些元数据(用来描述数据的数据)的访问
分类
运行期注解 程序运行时才会被解析到的注解,一般通过反射机制来实现,很多框架中都会用到,经常会看到一个注解和一些简单的配置来实现非常复杂的功能,编译期注解 一般用来解析类型元数据,根据特定注解解析并生成代码,或者生成一些描述性文件,比如properties、json等,比如为Pojo生成getter和setter方法
关键注解
@java.lang.annotation.Retention定义注解的有效时期
相关参数:
RetentionPolicy.SOURCE: 编译期生效,编译器会丢弃,编译后的class文件并不包含该注解
RetentionPolicy.CLASS: 注解会被保留在class文件中,但是运行期不会生效,被JVM忽略
RetentionPolicy.RUNTIME: 注解会被保留在class文件中,并且会在运行期生效,JVM会读取
@Target定义注解作用对象,也就是注解是可以用在类、方法、参数还是其他等待
相关参数:
ElementType.TYPE: 该注解只能运用到Class, Interface, enum上
ElementType.FIELD: 该注解只能运用到Field上
ElementType.METHOD: 该注解只能运用到方法上
ElementType.PARAMETER: 该注解只能作用在参数上
ElementType.CONSTRUCTOR: 该注解只能作用在构造方法上
ElementType.LOCAL_VARIABLE: 该注解作用在本地变量或catch语句
ElementType.ANNOTATION_TYPE: 该注解只能作用在注解上(注解的注解)
ElementType.PACKAGE: 该注解只能用在包上
继承关系
@Inherited
如果某个注解上有@Inherited注解,当查找该类型的注解时,会先查找目标类型是否存在注解,如果有,直接返回;否则,继续在父类上寻找注解,
停止的条件为在父类上找到该类型的注解或者父类为Object类型。
@Document 定义生产文档时是否包含注解信息
案例1 获取类上注解的值
package com.study.annotation;
public class AnnoTest {
public static void main(String[] args) throws ClassNotFoundException {
//获取类上的注解
Class<?> class1 = Class.forName("com.study.annotation.Student");
TableName tableNameAnnotation = class1.getAnnotation(TableName.class);
if(tableNameAnnotation != null){
String tableName = tableNameAnnotation.value();
System.out.println("tableName Annotation is :"+tableNameAnnotation +" tableName is:"+tableName);
}
}
}
注意:
//基本数据类型的注解属性只能使用非封装类型,使用封装类型编译报错
public @interface Student {
String name();
// Double 会报错
double LchangesPrice() default 10.0; //基本数据类型的注解属性只能使用非封装类型,使用封装类型编译报错
String[] hobbies();
}
获取field 上的注解和字段信息
package com.study.annotation;
import java.lang.reflect.Field;
public class AnnoTest2 {
public static void main(String[] args) throws ClassNotFoundException {
//获取field 上的注解和字段信息
Class<?> class1 = Class.forName("com.study.annotation.Student");
Field[] fields = class1.getDeclaredFields();
for (Field field : fields) {
Column column = field.getAnnotation(Column.class);
if (column != null) {
System.out.println("type is:"+ column.annotationType() + " and value is:"+column.value()+ " field name is:"+field.getName());
}
}
}
}