SpringBoot中自定义注解

2023-12-31 11:01:22

文章目录

注解

注解

1. 元注解

元注解就是定义注解的注解，是Java提供的用于定义注解的基本注解

注解	说明
@Retention	是注解类，实现声明类Class，声明类别，声明拓展
@Target	放在自定义注解的上边，表明该注解可以使用的范围
@Inherited	允许子类继承父类的注解，在子类中可以获取使用父类的注解
@Documented	表明这个注解是由javadoc记录的
@interface	用来自定义注解的类型

1.1 @Target

该注解的作用是告诉java将自定义的注解放在什么地方，比如类、方法、构造器、变量上等

它的值是一个枚举类型，有以下属性值

ElementType.CONSTRUCTOR:用于描述构造器
ElementType.FIELD:用于描述成员变量、对象、属性
ElementType.LOCAL_VARIABLE:用于描述局部变量
ElementType.METHOD:用于描述方法
ElementType.PACKAGE:用于描述包
ElementType.PARAMETER:用于描述参数
ElementType.TYPE:用于描述类、接口或enum枚举声明

1.2 @Retention

该注解用于说明自定义注解的生命周期，在注解中有三个生命周期

RetentionPolicy.RUNTIME：始终不会丢弃，运行期也保留该注解，可以使用反射机制读取该注解的信息
RetentionPolicy.CLASS：类加载时丢弃，默认使用这种方式
RetentionPolicy.SOURCE：编译阶段丢弃，自定义注解在编译结束之后就没有意义，所以不会写进字节码，熟悉的

@Override就属于这种

1.3 @Inherited

该注解是一个标记注解，表明被标记的类型是可以被继承的。如果一个使用这个标记的注解被使用了，那么该类的子类也会用到这个注解

1.4 @Documented

该注解表示是否将注解信息添加在java文档中

1.5 @interface

该注解用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数，方法名称就是参数名称，返回值类型就是参数的类型

2. 实现一个自定义注解

首先创建一个自定义注解

package com.example.demo;


import org.springframework.stereotype.Component;

import java.lang.annotation.*;

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface MyAnnotation {
    String value();
}

然后编写一个业务逻辑，这里就是拦截被自定义注解的方法，然后在控制台打印注解参数

package com.example.demo;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

@Aspect
@Component
public class TestAnnotationAspect {
    @Pointcut("@annotation(com.example.demo.MyAnnotation)")
    public void myAnnotationPointCut(){}

    @Before("myAnnotationPointCut()")
    public void before(JoinPoint joinPoint)throws Throwable{
        MethodSignature sign=(MethodSignature) joinPoint.getSignature();
        Method method=sign.getMethod();
        MyAnnotation annotation=method.getAnnotation(MyAnnotation.class);
        System.out.println("Test Annotation参数："+annotation.value());
    }
}

最后实现一个Controller，访问页面的时候查看业务逻辑是否被打印

package com.example.demo;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestAnnotationController {
    @GetMapping("/test")
    @MyAnnotation("测试自定义注解")
    public String test(){
        return "shelgi";
    }
}

运行结果如下

码农公寓