AOP_自定义注解+枚举类

我不是女神ヾ 2022-12-13 01:39 140阅读 0赞

# 自定义注解 #

## 一、元注解 ##

元注解：**专门修饰注解的注解**  
java中元注解有四个： @Retention @Target @Document @Inherited

### @Retention：注解的保留位置 ###

@Retention(RetentionPolicy.SOURCE) //注解仅存在于源码中，在class字节码文件中不包含

@Retention(RetentionPolicy.CLASS) // *默认的保留策略*，注解会在class字节码文件中存在，但运行时无法获得，

@Retention(RetentionPolicy.RUNTIME) // 注解会在class字节码文件中存在，在运行时可以通过反射获取到

如果一个注解被定义为RetentionPolicy.RUNTIME，那么这个注解可以在运行期的加载阶段被加载到Class对象中。那么在程序运行阶段，我们可以通过反射得到这个注解，并通过判断是否有这个注解或这个注解中属性的值，从而执行不同的程序代码段。**我们实际开发中的自定义注解几乎都是使用的RetentionPolicy.RUNTIME**

### @Target：用于描述注解的使用范围（即：被描述的注解可以用在什么地方） ###

@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.PARAMETER)\* ####

//自定义注解类
    @Target({ ElementType.PARAMETER})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    public @interface OperationId { 
    
        //通过反射获取操作参数的定义
        String name() default "";
    }
    
    ************************ElementType.PARAMETER使用范围******************************
        @GetMapping("/test1")
        public BaseResult threadTest(@RequestParam @OperationId(name = "入参1：")  String x1,@OperationId(name = "入参2：") Integer i2) { 
            System.out.println("test1");
            return BaseResult.success();
        }

#### @Target(ElementType.FIELD) ####

//自定义注解类
    @Target({ ElementType.FIELD})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    public @interface OperationId { 
    
        //通过反射获取操作参数的定义
        String name() default "";
    }
    
    ************************ElementType.FIELD 使用范围******************************
    @Data
    public class AreaTreeDTO { 
    
        @OperationId(name = "区域树编号")
        private Integer id;
    
        @OperationId(name = "区域树名")
        private String name;
        
        private Integer pid;
    
        @Override
        public String toString() { 
            return ReflectUtils.getOperationParameters(this.getClass().getName(), this);
        }
    }

### @Document：说明该注解将被包含在javadoc中 ###

@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。  
　  
*即：指定自定义注解是否能随着被定义的java文件生成到JavaDoc文档当中。*

### @Inherited：说明子类可以继承父类中的该注解 ###

@Inherited注解，是指定某个自定义注解如果写在了父类的声明部分，那么子类的声明部分也能自动拥有该注解。@Inherited注解只对那些@Target被定义为ElementType.TYPE的自定义注解起作用。  
　通俗来讲就是，当@InheritedAnno注解加在某个类A上时，假如类B继承了A，则B也会带上该注解  
　  
**总结**

1.  List item

**1、类继承关系中@Inherited的作用**

类继承关系中，子类会继承父类使用的注解中被@Inherited修饰的注解

**2、接口继承关系中@Inherited的作用**

接口继承关系中，子接口不会继承父接口中的任何注解，不管父接口中使用的注解有没有被@Inherited修饰

**3、类实现接口关系中@Inherited的作用**

类实现接口时不会继承任何接口中定义的注解

## 二、自定义注解 ##

使用\*\*@interface\*\*自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。  
1、在定义注解时，不能继承其他的注解或接口。  
2、@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

定义注解格式：

public @interface 注解名 { 定义体}

例子：

@Target({ ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface OperationLog { 
    
        //用户名
        String username() default "";
    
        //记录操作类型
        OperationType type();
    
        //记录操作内容
        String content() default "";
    
    }

### 参数的可支持数据类型 ###

1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)  
2.String类型  
3.Class类型  
4.enum类型  
5.Annotation类型  
6.以上所有类型的数组

### Annotation的参数设定规则 ###

<table> 
 <thead> 
  <tr> 
   <th align="left"></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">1、访问修饰符必须为public，不写默认为public</td> 
  </tr> 
  <tr> 
   <td align="left">2、参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组</td> 
  </tr> 
  <tr> 
   <td align="left">3、元素的名称一般定义为名词，如果注解中只有一个元素，请把名字起为value（后面使用会带来便利操作）</td> 
  </tr> 
  <tr> 
   <td align="left">4、()不是定义方法参数的地方，也不能在括号中定义任何参数，仅仅只是一个特殊的语法； default代表默认值，值必须和第2点定义的类型一致</td> 
  </tr> 
  <tr> 
   <td align="left">5、<strong>如果没有默认值，代表后续使用注解时必须给该类型元素赋值。</strong></td> 
  </tr> 
 </tbody> 
</table>

# 枚举类 #

向enum类添加方法与自定义属性和构造函数 重新定义一个枚举类，带有message成员变量同时定义一个getMessage方法，自定义构造函数，在声明枚举实例时传入对应的中文描述，代码如下：

public enum OperationType { 
    
        ADD("新增"),
        DELETE("删除"),
        UPDATE("更新"),
        SELECT("查询"),
        LOGIN("登录"),
        EXIT("退出"),
        HANDLE("报警处理");//记住要用分号结束
    
        private String message;
      
        /**
          * 构造函数
         */
        OperationType(String message){ 
            this.message = message;
        }
    
        public String getMessage() { 
            return message;
        }
    }
    
    ****************************主函数*********************************
    public static void main(String[] args) { 
    		SpringApplication.run(AsyncApplication.class, args);
    		for(OperationType type:OperationType.values()){ 
                System.out.println("message: " + type.getMessage());
            }
    	}
    ***************************执行结果**************************************
    message: 新增
    message: 删除
    message: 更新
    message: 查询
    message: 登录
    message: 退出
    message: 报警处理

优秀链接：  
https://blog.csdn.net/xsp\_happyboy/article/details/80987484