注解
- 概念:说明程序的。给计算机看的
注释:用文字描述程序的。给程序员看的
定义:注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。
- 概念描述:
- JDK1.5之后的新特性
- 说明程序的
- 使用注解:@注解名称
- 作用分类:
- 编写文档:通过代码里标识的注解生成文档【生成文档doc文档】
- 代码分析:通过代码里标识的注解对代码进行分析【使用反射】
- 编译检查:通过代码里标识的注解让编译器能够实现基本的编译检查【Override】
- JDK中预定义的一些注解
Java 定义了一套注解,共有 7 个,3 个在 java.lang
中,剩下 4 个在 java.lang.annotation
中
作用在代码的注解
@Deprecated
:该注解注解的内容,表示已过时@Override
- 检查该方法是否是重载方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。@SuppressWarnings
- 指示编译器去忽略注解中声明的警告。- 一般传递参数all
@SuppressWarnings("all")
- 一般传递参数all
元注解(元注解的作用就是负责注解其他注解)
@Retention
- 标识这个注解怎么保存,是只在代码中,还是编入 class 文件中,或者是在运行时可以通过反射访问。@Documented
- 标记这些注解是否包含在用户文档中。@Target
- 标记这个注解应该是哪种 Java 成员。@Inherited
- 标记这个注解是继承于哪个注解类 (默认 注解并没有继承于任何子类)
从 Java 7 开始,额外添加了 3 个注解:
@SafeVarargs
- Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。@FunctionalInterface
- Java 8 开始支持,标识一个匿名函数或函数式接口。@Repeatable
- Java 8 开始支持,标识某注解可以在同一个声明上使用多次。
实例
1 | public class Test { |
自定义注解
格式:
- 元注解
1
2
3
4
5public 注解名称{
int age(); //定义一个名为age,数据类型为int的属性
String sex() default "未知";//定义一个默认值为"未知",数据类型为 String 的属性.
}
本质:注解本质上就是一个接口,该接口默认继承 Annotation
接口
public interface 注解名称 extends java.lang.annotation.Annotation {}
属性:接口中的抽象方法
要求:
属性的返回值类型有下列取值
- 基本数据类型
- String
- 枚举
- 注解
- 以上类型的数组
定义了属性,在使用时需要给属性赋值
- 如果定义属性时,使用default关键字给属性默认初始化值,则使用注解时,可以不进行属性的赋值。
- 如果只有一个属性需要赋值,并且属性的名称是value,则value可以省略,直接定义值即可。
- 数组赋值时,值使用{}包裹。如果数组中只有一个值,则{}可以省略
元注解:用于描述注解的注解
- @Target:描述注解能够作用的位置
- ElementType取值:
- TYPE:可以作用于类上
- METHOD:可以作用于方法上
- FIELD:可以作用于成员变量上
- ElementType取值:
- @Retention:描述注解被保留的阶段
- @Retention(RetentionPolicy.RUNTIME):当前被描述的注解,会保留到class字节码文件中,并被JVM读取到
- @Documented:描述注解是否被抽取到api文档中
- @Inherited:描述注解是否被子类继承
在程序使用(解析)注解:获取注解中定义的属性值
- 获取注解定义的位置的对象 (Class,Method,Field)
获取指定的注解
- getAnnotation(Class)
//其实就是在内存中生成了一个该注解接口的子类实现对象1
2
3
4
5
6
7
8public class ProImpl implements Pro{
public String className(){
return "cn.itcast.annotation.Demo1";
}
public String methodName(){
return "show";
}
}
- getAnnotation(Class)
调用注解中的抽象方法获取配置的属性值