目录
Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。 注解相关类都包含在java.lang.annotation包中。
JDK基本注解
@Override:重写
@SuppressWarnings(value = "unchecked");压制编辑器警告
JDK元注解
@Retention:定义注解的保留策略
@Retention(RetentionPolicy.SOURCE) //注解仅存在于源码中,在class字节码文件中不包含
@Retention(RetentionPolicy.CLASS) //默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得,
@Retention(RetentionPolicy.RUNTIME) //注解会在class字节码文件中存在,在运行时可以通过反射获取到
@Target:指定被修饰的Annotation可以放置的位置(被修饰的目标)
@Target(ElementType.TYPE) //接口、类
@Target(ElementType.FIELD) //属性
@Target(ElementType.METHOD) //方法
@Target(ElementType.PARAMETER) //方法参数
@Target(ElementType.CONSTRUCTOR) //构造函数
@Target(ElementType.LOCAL_VARIABLE) //局部变量
@Target(ElementType.ANNOTATION_TYPE) //注解
@Target(ElementType.PACKAGE) //包
注:可以指定多个位置
例如:
- @Target({ElementType.METHOD, ElementType.TYPE}),也就是此注解可以在方法和类上面使用
-
- @Inherited:指定被修饰的Annotation将具有继承性
-
- @Documented:指定被修饰的该Annotation可以被javadoc工具提取成文档.
注解分类(根据Annotation是否包含成员变量,可以把Annotation分为两类):
标记Annotation:
没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息元数据Annotation:
包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;
如何自定义注解?
使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:
Annotation的成员变量在Annotation定义中是以无参的方法形式来声明的, 其方法名和返回值类型定义了该成员变量的名字和类型,而且我们还可以使用default关键字为这个成员变量设定默认值;
代码演示
案例一(获取类与方法上的注解值)
- package com.dengxiyan.annotation.pi;
-
- public enum TranscationModel {
- Read, Write, ReadWrite
- }
- package com.dengxiyan.annotation.pi;
-
- import java.lang.annotation.*;
-
- /**
- * TestAnnotation1注解可以用在类、接口、属性、方法上
- * 注解运行期也保留
- * 不可继承
- */
- @Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
- @Retention(RetentionPolicy.RUNTIME)
- @Documented
- public @interface TestAnnotation1 {
- String name();
- }
- package com.dengxiyan.annotation.pi;
-
- import java.lang.annotation.*;
-
- /**
- * TestAnnotation2注解可以用在方法上
- * 注解运行期也保留
- * 不可继承
- */
- @Target(ElementType.METHOD)
- @Retention(RetentionPolicy.RUNTIME)
- @Documented
- public @interface TestAnnotation2{
- TranscationModel model() default TranscationModel.ReadWrite;
- }
- package com.dengxiyan.annotation.pi;
-
- import java.lang.annotation.*;
-
- /**
- * TestAnnotation3注解可以用在方法上
- * 注解运行期也保留
- * 可继承
- */
- @Target(ElementType.METHOD)
- @Retention(RetentionPolicy.RUNTIME)
- @Inherited
- @Documented
- public @interface TestAnnotation3 {
- TranscationModel[] models() default TranscationModel.ReadWrite;
- }
测试
- package com.dengxiyan.annotation.pi;
-
- /**
- * 获取类与方法上的注解值
- */
- @TestAnnotation1(name = "aaa")
- public class Demo1 {
-
- @TestAnnotation1(name = "dxy")
- private Integer age;
-
- @TestAnnotation2(model = TranscationModel.Read)
- public void list() {
- System.out.println("list");
- }
-
- @TestAnnotation3(models = {TranscationModel.Read, TranscationModel.Write})
- public void edit() {
- System.out.println("edit");
- }
- }
- package com.dengxiyan.annotation.pi;
-
- import org.junit.Test;
-
- public class Demo1Test {
- @Test
- public void list() throws Exception {
- // 获取类上的注解
- TestAnnotation1 annotation1 = Demo1.class.getAnnotation(TestAnnotation1.class);
- System.out.println(annotation1.name());
-
- // 获取方法上的注解
- TestAnnotation2 testAnnotation2 = Demo1.class.getMethod("list").getAnnotation(TestAnnotation2 .class);
- System.out.println(testAnnotation2 .model());
-
- // 获取属性上的注解
- TestAnnotation1 testAnnotation1 = Demo1.class.getDeclaredField("age").getAnnotation(testAnnotation1 .class);
- System.out.