@Target()，@Retention()，@Document，@Inherited元注解的使用+自定义注解的创建和使用

秒速五厘米 2023-10-14 19:48 126阅读 0赞

## 什么是元注解 ##

*  元注解是用于注解的注解，对注解进行解释，同时可以对注解进行一系列的规范化处理

### @Target() ###

*  @Target()是对于注解的作用范围进行解释，规定对应注解的作用范围，可以单独只限于作用于类，方法或者多种同时可用。
    
    1.  @Target(value=ElementType.TYPE)=>作用于类
    2.  @Target(value=ElementType.FIELD)=>作用于字段，包括枚举常量。
    3.  @Target(value=ElementType.METHOD)=>作用于方法
    4.  @Target(value=ElementType.PARAMETER)=>作用于形参  
        …

### @Retention() ###

*  @Retention()对于注解的作用时间进行解释，使得某注释在某个时间段可用
    
    1.  @Retention(value=RetentionPolicy.SOURCE)=>源码阶段对应注释有用。
    2.  @Retention(value=RetentionPolicy.CLASS)=>class编码阶段对应注释有用
    3.  @Retention(value=RetentionPolicy.RUNTIME)=>程序阶段对应注释有用，自定义注解一般使用此作用时间范围

### @Document ###

*  @Document将对应的注解包含在javaDoc中

### @Inherited ###

*  @Inherited说明对应的子类可以继承父类中的注解

### 代码实例 ###

package com.Annotation;
    
    import java.lang.annotation.*;
    
    /**
     * 元注解的使用
     *    元注解是对注解进行注解的注解，简单来说就是对注解进行解释的注解
     *      @Target()：表示某个注解的作用范围，使用在类上，方法上，或者其他的地方
     *      @Retention()：表示对应的注解在什么时候有效；运行时，源码阶段还是class阶段==》RUNTIME(运行时)>Class(编码阶段)>SOUCER(源码时)
     *      @Document：该注解对应的注解会被包含在javaDoc中。
     *      @Inherited：说明子类可以继承父类中的对应的注解
     */
    public class MetaAnnotation {
        
        //定义方法
        @MyAnnotation
        public static void test(){
        
            System.out.println("12");
        }
        public static void main(String[] args) {
        
            test();
        }
    }
    //自定义注解：@interface  注解名
    //@Target(value = {ElementType.TYPE(作用在类上),ElementType.METHOD(作用在方法上)})
    @Target(value = {
        ElementType.TYPE,ElementType.METHOD})
    //规定作用时间
        @Retention(value = RetentionPolicy.RUNTIME)
    //规定子类是否能继承父类的注释
        @Inherited
    @interface MyAnnotation{
        
    
    }

### 自定义注解的编写 ###

1.  需要使用public @interface 对自定义注解进行声明：public @interface 自定义注解名；在类中进行声明时可不写public
2.  在自定义注解中可自定义参数，返回值类型就是参数类型，参数类型只能是基本数据类型，Class，String，enum
3.  可以通过default声明参数的默认值
4.  只有一个参数时，参数名一般是value，且只有一个参数时，在引用参数时，可以不对value再次声明，可直接输入对应的值。

//自定义注解：@interface  注解名
    //@Target(value = {ElementType.TYPE(作用在类上),ElementType.METHOD(作用在方法上)})
    @Target(value = {
        ElementType.TYPE,ElementType.METHOD})
    //规定作用时间
        @Retention(value = RetentionPolicy.RUNTIME)
    //规定子类是否能继承父类的注释
        @Inherited
    @interface MyAnnotation{
        
        //自定义注解参数  数据类型 注解参数名();
        //    String name() default "he";表示name这个注解参数默认为he
        String name() default "he";
        int num() default 0;
        String[] str();//没有使用default时，注解参数需要在使用注解时添加
        String value();//在参数名为value时，在使用注解时可以不对value进行声明，可直接对value进行赋值,但只限于该注解只有一个注解参数时
        
    }
    @Target(value = {
        ElementType.TYPE,ElementType.METHOD})
    //规定作用时间
    @Retention(value = RetentionPolicy.RUNTIME)
    //规定子类是否能继承父类的注释
    @interface MyAnnotation2{
        
        String value();
    }

#### 对自定义注解的声明和使用 ####

public class MetaAnnotation {
        
        //定义方法
        @MyAnnotation(str={
        "afd","afg"},value = "value")
        public static void test(){
        
            System.out.println("12");
        }
        @MyAnnotation2("value")//自定义注解只有一个参数时，可以不对value进行声明
        public static void test2(){
        
            System.out.println("34");
        }
    
        public static void main(String[] args) {
        
            test();
            test2();
        }
    }