java注解 -- 自定义java注解

我不是女神ヾ 2024-03-27 09:48 88阅读 0赞

## 一、自定义注解的基本元素 ##

> 修饰符：访问修饰符必须为public，不写默认为public
> 
> 关键字：@interface
> 
> 注解名称：自定义注解的名称
> 
> 注解类型元素：注解类型元素是注解中内容，即自定义接口的实现部分

public @interface MyAnnotation {
        long timeout() default 1000L;
    }

## 二、自定义注解用到的元注解 ##

JDK提供了四个元注解用来修饰注解:

@Documented

> 1.类和方法的Annotation在缺省情况下是不会出现在javadoc中的，如果使用@Documented修饰该Annotation，则表示该注解可以出现在javadoc中。
> 
> 2.定义Annotation时，@Documented可有可无，若没有定义，则Annotation不会出现在Javadoc中

@Target

> 1.@Target用来指定Annotation的类型属性ElementType
> 
> 2.定义Annotation时，@Target可有可无，若有@Target，则该Annotation只能用于它所指定的地方，若没有@Target，则该Annotation可以用于任何地方。

<table style="width:660px;"> 
 <thead> 
  <tr> 
   <th style="text-align:center;">Target类型</th> 
   <th style="text-align:center;">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="text-align:center;">ElementType.TYPE</td> 
   <td style="text-align:center;">类、接口（包括注解类型）、枚举</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">ElementType.FIELD</td> 
   <td style="text-align:center;">属性（包括枚举中的常量）</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">ElementType.METHOD</td> 
   <td style="text-align:center;">方法</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">ElementType.PARAMETER</td> 
   <td style="text-align:center;">参数</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">ElementType.CONSTRUCTOR</td> 
   <td style="text-align:center;">构造函数</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">ElementType.LOCAL_VARIABLE</td> 
   <td style="text-align:center;">局部变量</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">ElementType.ANNOTATION_TYPE</td> 
   <td style="text-align:center;">注解类型</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">ElementType.PACKAGE</td> 
   <td style="text-align:center;">包</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">ElementType.TYPE_PARAMETER</td> 
   <td style="text-align:center;">类型变量</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">ElementType.TYPE_USE</td> 
   <td style="text-align:center;">应用于任何使用类型的语句中（声明语句、泛型、强制类型转换语句中的类型）</td> 
  </tr> 
 </tbody> 
</table>

@Retention

> 1.@Retention用于指定Annotation的策略属性RetentionPolicy
> 
> 2.定义Annotation时，@Retention可有可无，若没有@Retention，则默认是Retention.CLASS

<table style="width:500px;"> 
 <thead> 
  <tr> 
   <th style="text-align:center;">生命周期类型</th> 
   <th style="text-align:center;">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="text-align:center;">RetentionPolicy.SOURCE</td> 
   <td style="text-align:center;">Annotation仅存在于编译器处理期间，编译器处理完后，该Annotation就没用了</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">RetentionPolicy.CLASS</td> 
   <td style="text-align:center;">编译器将Annotation存储于类对应的.class文件中（默认值）</td> 
  </tr> 
  <tr> 
   <td style="text-align:center;">RetentionPolicy.RUNTIME</td> 
   <td style="text-align:center;">编译器将Annotation存储于class文件中，并且可由JVM读取</td> 
  </tr> 
 </tbody> 
</table>

@Inherited

> 1.控制父类类上的注解能否被子类继承
> 
> 2.若父类上的注解使用了@Inherited，则子类可以继承父类中的该注解

## 三、自定义注解及使用 ##

### 1、自定义注解 ###

@Documented
    @Target({ElementType.TYPE,ElementType.FIELD})
    @Retention(RetentionPolicy.RUNTIME)
    @Inherited
    public @interface MyAnnotation {
        String name() default "jack";
        String sex();
    }

### 2、定义实体类Emp使用注解 ###

@Builder
    @MyAnnotation(sex = "男")
    public class Emp {
        private String name;
        private String sex;
    
        public Emp() {
        }
    
        public Emp(String name, String sex) {
            this.name = name;
            this.sex = sex;
        }
    }

注意：

自定义注解中，设置了默认值的属性在使用时可以不用定义值，但是没有设置默认值的属性必须要定义属性值。

### 3、测试自定义注解 ###

public class Test {
        public static void main(String[] args) {
            //获取Emp的Class对象
            Emp emp = Emp.builder().build();
            Class cls = emp.getClass();
            if(cls.isAnnotationPresent(MyAnnotation.class)) {
                System.out.println("Emp类上配置了MyAnnotation注解！");
                //获取该对象上指定的注解内容
                MyAnnotation annotation = (MyAnnotation) cls.getAnnotation(MyAnnotation.class);
                System.out.println("name:" + annotation.name());
                System.out.println("sex:" +annotation.sex());
            }else {
                System.out.println("Emp类上没有配置MyAnnotation注解！");
            }
        }
    }

此处使用的各类方法详见：