SpringBoot 自定义注解+AOP进行方法增强

GitHub: link. 欢迎star

注意：本篇博客风格（不多比比就是撸代码!!!）

一、maven依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

二、DemoAnnotation.java

import java.lang.annotation.*;

/**
 * @author Andon
 * 2021/12/9
 * <p>
 * 自定义注解
 */
@Target(ElementType.METHOD) //定义注解使用位置
@Retention(RetentionPolicy.RUNTIME) //注解声明周期
@Documented //可以被工具文档化
public @interface DemoAnnotation {

    String testValue() default "testValue";
}

三、DemoAspect.java

import com.alibaba.fastjson.JSONObject;
import com.andon.springbootutil.annotation.DemoAnnotation;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Enumeration;

/**
 * @author Andon
 * 2021/12/9
 * <p>
 * 切面类
 */
@Slf4j
@Aspect //定义切面类
@Component //交给Spring来管理
public class DemoAspect {

    /**
     * 声明切入点，包名表达式或者注解路径
     */
    @Pointcut("@annotation(com.andon.springbootutil.annotation.DemoAnnotation)")
    public void pointCut() {
    }

    /**
     * 前置通知，关注点执行前运行的方法
     * && @annotation与参数上的注解参数名对应，则可以获取被增强方法上注解的属性
     */
    @Before("pointCut() && @annotation(demoAnnotation)")
    public void before(JoinPoint joinPoint, DemoAnnotation demoAnnotation) {
        String testValue = demoAnnotation.testValue();
        Object[] args = joinPoint.getArgs();
        log.info("before [{}-{}] 前置通知!! args:{} testValue:{}", Thread.currentThread().getName(), Thread.currentThread().getId(), JSONObject.toJSONString(args), testValue);
    }

    /**
     * 后置通知，不论一个方法是如何结束的，最终通知都会运行
     */
    @After("pointCut()")
    public void after(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs();
        log.info("after [{}-{}] 后置通知!! args:{}", Thread.currentThread().getName(), Thread.currentThread().getId(), JSONObject.toJSONString(args));
    }

    /**
     * 后置通知，获取方法的返回值
     * returning赋值的参数，用来接收被增强方法的任意类型的返回值
     */
    @AfterReturning(value = "pointCut()", returning = "returnValue")
    public Object afterReturning(JoinPoint joinPoint, Object returnValue) {
        Object[] args = joinPoint.getArgs();
        log.info("afterReturning [{}-{}] 返回后通知!! args:{} returnValue:{}", Thread.currentThread().getName(), Thread.currentThread().getId(), JSONObject.toJSONString(args), JSONObject.toJSONString(returnValue));
        return returnValue;
    }

    /**
     * 异常通知
     * 如果想要限制通知只在某种特定的异常被抛出的时候匹配，同时还想知道异常的一些信息。
     * 那我们就需要使用throwing属性声明响应
     */
    @AfterThrowing(value = "pointCut()", throwing = "exception")
    public void afterThrowing(JoinPoint joinPoint, Exception exception) {
        Object[] args = joinPoint.getArgs();
        log.info("afterThrowing [{}-{}] 异常通知!! args:{} error:{}", Thread.currentThread().getName(), Thread.currentThread().getId(), JSONObject.toJSONString(args), exception.getMessage());
    }

    /**
     * 环绕通知
     */
    @Around(value = "pointCut()")
    public Object around(ProceedingJoinPoint pjp) throws Throwable {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
        String remoteHost = request.getRemoteHost(); //访问者ip
        String method = request.getMethod(); //请求方式
        String uri = request.getRequestURI(); //请求路径
        String methodName = pjp.getSignature().getName(); //获取方法名
        Enumeration<String> headerNames = request.getHeaderNames();
        JSONObject headers = new JSONObject();
        while (headerNames.hasMoreElements()) {
            String s = headerNames.nextElement();
            headers.put(s, request.getHeader(s)); //请求头
        }
        Object[] args = pjp.getArgs(); //获取入参
        log.info("around [{}-{}] 环绕通知start!! remoteHost:{} method:{} uri:{} methodName:{} headers:{} args:{}", Thread.currentThread().getName(), Thread.currentThread().getId(), remoteHost, method, uri, methodName, headers.toJSONString(), JSONObject.toJSONString(args));
        Object obj = pjp.proceed();
        log.info("around [{}-{}] 环绕通知end!!", Thread.currentThread().getName(), Thread.currentThread().getId());
        return obj;
    }
}

四、TestAopController.java

import com.alibaba.fastjson.JSONObject;
import com.andon.springbootutil.annotation.DemoAnnotation;
import com.andon.springbootutil.vo.TestSwaggerTest2Req;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.*;

/**
 * @author Andon
 * 2021/12/9
 */
@Slf4j
@Api(tags = "aop")
@RestController
@RequestMapping(value = "/aop")
public class TestAopController {

    @DemoAnnotation(testValue = "test!!")
    @ApiOperation("测试")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "value", value = "值", required = true)
    })
    @GetMapping(value = "/test")
    public String test(String value) {
        log.info("test!! value:{}", value);
        return value;
    }

    @DemoAnnotation
    @ApiOperation("测试2")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "value", value = "值", required = true)
    })
    @GetMapping(value = "/test2")
    public String test2(String value) throws Exception {
        log.info("test!! value:{}", value);
        throw new Exception("throw new Exception!!");
    }

    @DemoAnnotation
    @ApiOperation("测试3")
    @PostMapping(value = "/test3")
    public TestSwaggerTest2Req test3(@RequestBody TestSwaggerTest2Req test) {
        log.info("test3!! test:{}", JSONObject.toJSONString(test));
        return test;
    }
}

五、测试

GitHub: link. 欢迎star