欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

springboot aop 不生效的原因和解决方案

程序员文章站 2022-04-12 18:32:33
一天不码点代码,心里就难受,度娘一波,copy了如下一段简单的aop代码,run起来,惊讶了,竟然没有生效。package com.foo.bar.aspect;import cn.hutool.json.JSONUtil;import java.util.Map;import java.util.Objects;import javax.servlet.http.HttpServletRequest;import javax.validation.constraints.NotNull....

一天不码点代码,心里就难受,度娘一波,copy了如下一段简单的aop代码,run起来,惊讶了,竟然没有生效。

package com.foo.bar.aspect;

import cn.hutool.json.JSONUtil;
import java.util.Map;
import java.util.Objects;
import javax.servlet.http.HttpServletRequest;
import javax.validation.constraints.NotNull;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

/**
 * controller aop log
 * @author foobar
 */
@Aspect
@Component
@Order(Ordered.LOWEST_PRECEDENCE - 2)
@Slf4j
public class LogAspect {

  private static final String START_TIME = "request-start";

  /**
   * 切面
   */
  @Pointcut(value = "execution(public * com.foo.bar.controller.*.*(..))")
  public void log() {

  }

  /**
   * 前置操作
   *
   * @param point 切入点
   */
  @Before("log()")
  public void beforeLog(@NotNull JoinPoint point) {
    ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();
    Map<String, String[]> parameterMap = request.getParameterMap();
    log.info("【请求 URL】:{},【请求 IP】:{},【请求参数】:{}", request.getRequestURL(), request.getRemoteAddr(), JSONUtil.toJsonStr(parameterMap));
    Long start = System.currentTimeMillis();
    request.setAttribute(START_TIME, start);
  }

  /**
   * 环绕操作
   *
   * @param point 切入点
   * @return 原方法返回值
   * @throws Throwable 异常信息
   */
  @Around("log()")
  public Object aroundLog(@NotNull ProceedingJoinPoint point) throws Throwable {
    Object result = point.proceed();
    log.info("【返回值】:{}", JSONUtil.toJsonStr(result));
    return result;
  }

  /**
   * 后置操作
   */
  @AfterReturning("log()")
  public void afterReturning() {
    ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();

    Long start = (Long) request.getAttribute(START_TIME);
    Long end = System.currentTimeMillis();
    log.info("【请求耗时】:{}毫秒", end - start);
  }
} 

心里慌的一批,难道是时代变化太快,版本更新太多,这么经典的一段aop代码怎能不生效呢,于是度娘 “springboot aop 不生效”。

开始一一尝试:

1.检查依赖包,这个一般不需要主动引入,比如这里spring-boot-starter-web就包含了aop的依赖

 <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
      <exclusions>
        <exclusion>
          <artifactId>spring-boot-starter-tomcat</artifactId>
          <groupId>org.springframework.boot</groupId>
        </exclusion>
      </exclusions>
    </dependency>
    <dependency>

springboot aop 不生效的原因和解决方案

2.检查有没有引入aspectjrt与aspectjweaver

没有引入aspectjweaver的话,

 <!-- 切面 start -->
    <!-- 可不引入,已被aspectjweaver包含 -->
<!--    <dependency>-->
<!--      <groupId>org.aspectj</groupId>-->
<!--      <artifactId>aspectjrt</artifactId>-->
<!--      <version>1.9.6</version>-->
<!--    </dependency>-->
    <dependency>
      <groupId>org.aspectj</groupId>
      <artifactId>aspectjweaver</artifactId>
      <version>1.9.6</version>
    </dependency>
    <!-- 切面 end -->
可不引入aspectjrt,aspectjweaver已包含aspectjrt,如下图 

springboot aop 不生效的原因和解决方案

3.检查切面类上注解

springboot aop 不生效的原因和解决方案

注解齐全时:

对比下代理对象与非代理对象

springboot aop 不生效的原因和解决方案

缺少注解@Component时:

springboot aop 不生效的原因和解决方案

4.检查调用切面方法时,是否使用了代理类

比如是否采用了错误的this调用,我这里不存在这个

本着求实创新的精神主旨,咱也断点看一波

springboot aop 不生效的原因和解决方案

不要问我为什么能精确debug这行,想知道自己去看源码

比如看看这个 [强烈推荐]SpringMVC源码分析

5.检查切面表达式是否书写正确

 /**
   * 切面
   */
  @Pointcut(value = "execution(public * com.foo.bar.controller.*.*(..))")
  public void log() {

  }

随便找了一篇pointcut的表达式教学

spring aop中pointcut表达式完整版

6.最后的解决方案

奇葩原因还可能是这个

看到这里还没有解决问题的,我大概知道为啥了,可能是你手贱进行了红色字体不可思议的操作,可能只有上帝知道你为啥要这样做。

在创建AOP类时选择了Aspect类型,创建后又觉得不妥又把这个文件改为Class类型,最后死活怎么跑Aop就是不生效。springboot aop 不生效的原因和解决方案

这时你可能需要看下下面这张神奇的图

springboot aop 不生效的原因和解决方案

解决办法

重新创建一个Java Class类型的文件,把原来AOP的代码拷过去就可以了。

idea中Aspect是啥

这个问题很重要吗,我觉一点也不重要,网上都是使用class做aop,使用idea中Aspect做aop的应该是稀缺物种,至少我还没有建构,不过作为求实创新一代的传承人,我还是去度娘找了找。

本文地址:https://blog.csdn.net/Java_Chuck/article/details/108230907