自定义注解详细介绍

自定义注解详细介绍

 

 

  //注解，顾名思义，注解,就是对某一事物进行添加注释说明，会存放一些信息，这些信息可能对以后某个时段来说是很有用处的。
Java注解又叫java标注，java提供了一套机制，使得我们可以对方法、类、参数、包、域以及变量等添加标准(即附上某些信息)。且在以后某个时段通过反射将标注的信息提取出来以供使用。

版权声明：本文为CSDN博主「liukai6」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/liukai6/article/details/89854903

注解是一种能被添加到java代码中的元数据，类、方法、变量、参数和包都可以用注解来修饰。注解对于它所修饰的代码并没有直接的影响。

注解又许多用法，其中有：为编译器提供信息 - 注解能被编译器检测到错误或抑制警告。编译时和部署时的处理 - 软件工具能处理注解信息从而生成代码，XML文件等等。运行时的处理 - 有些注解在运行时能被检测到。

如何自定义注解

基于上一节，已对注解有了一个基本的认识：注解其实就是一种标记，可以在程序代码中的关键节点（类、方法、变量、参数、包）上打上这些标记，然后程序在编译时或运行时可以检测到这些标记从而执行一些特殊操作。因此可以得出自定义注解使用的基本流程：

 

第一步，定义注解——相当于定义标记；

第二步，配置注解——把标记打在需要用到的程序代码中；

第三步，解析注解——在编译期或运行时检测到标记，并进行特殊操作。

注解的基本元素：

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

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

关键字
  关键字为@interface；

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

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

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

使用元注解修饰注解

• @Target

@Target注解，是专门用来限定某个自定义注解能够被应用在哪些Java元素上面的。

  表明该注解可以应用的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

@Retention注解，  表明该注解的生命周期。

注解的生命周期有三个阶段：1、Java源文件阶段（RetentionPolicy.SOURCE）；2、编译到class文件阶段（RetentionPolicy.CLASS）；3、运行期阶段（RetentionPolicy.RUNTIME）。同样使用了RetentionPolicy枚举类型定义了三个阶段：

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

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

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

使用自定义注解

@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;
}