java实现自定义注解

注解是spring boot核心理念，是一种能被添加到java源代码的元数据，方法、类、参数和包都可以用注解来修饰。注解可以作是一种特殊的标记，可以用在方法、类、参数和包上，程序在译或者运行时可以检测到这些标记而进行一些特殊的处理，核心是通过cglib动态代理去实现。

1. 注解的基本元素

声明一个注解要用到的东西

修饰符

访问修饰符必须为public, 不写默认为pubic；

关键字

关键字为@interface；

注解名称

注解名称为自定义注解的名称，使用时还会用到；

注解类型元素

注解类型元素是注解中内容，可以理解成自定义接口的实现部分；

public @interface Info {
  String value() default "tracy";
  boolean isDelete();
}

2. 使用元注解修饰注解

JDK中有一些元注解，主要有@Target，@Retention, @Document, @Inherited用来修饰注解。

@Target

表明该注解可以应用的java元素类型

Target类型	描述
ElementType. TYPE	应用于类、接口（包括注解类型）、枚举
ElementType. FIELD	应用于属性（包括枚举中的常量）
ElementType. METHOD	应用于方法
ElementType. PARAMETER	应用于方法的形参
ElementType. CONSTRUCTOR	应用于构造函数
ElementType. LOCAL_VARIABLE	应用于局部变量
ElementType. ANNOTATION_TYPE	应用于注解类型
ElementType. PACKAGE	应用于包
ElementType. TYPE_PARAMETER	1.8版本新增，应用于类型变量）
ElementType. TYPE_USE	1.8版本新增，应用于任何使用类型的语句中（例如声明语句、泛型和强制转换语句中的类型）

@Retention

表明该注解的生命周期

生命周期类型	描述
RetentionPolicy.SOURCE	编译时被丢弃，不包含在类文件中
RetentionPolicy.CLASS	JVM加载时被丢弃，包含在类文件中，默认值
RetentionPolicy.RUNTIME	由JVM 加载，包含在类文件中，在运行时可以被获取到

@Document

表明该注解标记的元素可以被Javadoc 或类似的工具文档化

@Inherited

表明使用了@Inherited注解的注解，所标记的类的子类也会拥有这个注解

@Target({ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Info {
    String value() default "tracy";
    boolean isDelete();
}

使用自定义注解

配置注解

定义了一个Person类

@Data
@Builder
// 为Person类配置了刚刚定义的注解@Info
@Info(isDelete = true)
public class Person {

  /**
   * 姓名
   */
  private String name;

  /**
   * 年龄
   */
  private int age;

  /**
   * 是否有效
   */
  private boolean isDelete;
}

利用反射解析注解

public class AnnotationTest {
  public static void main(String[] args) {
      try {
          //获取Person的Class对象
          Person person = Person.builder().build();
          Class clazz = person.getClass();
          //判断person对象上是否有Info注解
          if (clazz.isAnnotationPresent(Info.class)) {
              System.out.println("Person类上配置了Info注解！");
              //获取该对象上Info类型的注解
              Info infoAnno = (Info) clazz.getAnnotation(Info.class);
              System.out.println("person.name :" + infoAnno.value() + ",person.isDelete:" + infoAnno.isDelete());
          } else {
              System.out.println("Person类上没有配置Info注解！");
          }
      } catch (Exception e) {
          e.printStackTrace();
      }
  }
}

运行结果

对于一个类或者接口来说，Class类(java.lang包下)中提供了一些方法用于反射注解，当然对于字段、方法来说反射注解的方式很类似。

//返回指定的注解
getAnnotation
//判断当前元素是否被指定注解修饰
isAnnotationPresent
//返回所有的注解
getAnnotations

文章目录