spring 如何实现原生的 aspectj 支持

一、简述原生AspectJ优势:

  1. 拓展织入方法范围:
    能够对 private 方法、本类内部调用的其他方法进行切面(spring-aop 无法做到)

  2. 提高性能:
    不用继承、实现spring的代理类、拦截器,而是直接将代码写入字节码中,提高了运行性能;

准备:

  1. spring-instrument-5.0.7.RELEASE.jar
  2. aspectjweaver-1.8.13.jar
    上述2个包用于和 aspectj 搭配使用,实现原生的 aspectj(性能高,功能全)
  3. 将他们放到指定位置(VM 依赖于该位置)
    下方【启动原生 AspectJ 的方式】是放入了微服务的 common 包的resources/tools/下(无 main,作为 jar 依赖存在)

二、启动原生 AspectJ 的方式

  1. 在要使用的微服务模块的配置类上:(尽量别在 common 包,否则其他人协同开发,可能花很久排错)
    注释:@EnableLoadTimeWeaving

说明:当要调用 spring 提供的相关 aop 类如 @Async、@EnableTransactionManagement 时,应该要将 mode 设置为 AdviceMode.ASPECTJ,才能使用原生 AspectJ;

  1. 在 IDEA 中,启动 JVM 时,增加 VM 选项:


    idea配置示意图.png
-javaagent:common/src/main/resources/tools/aspectjweaver-1.8.13.jar\
-javaagent:common/src/main/resources/tools/spring-instrument-5.0.7.RELEASE.jar

三、开发

  1. 在项目 resources/META-INF/ 目录下,新建或修改 aop.xml 文件,增加自定义切面类、织入目标的配置:
    简单但完整的示例:
    切面类:
package com.aspect;

import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;

import java.lang.reflect.Method;

@Aspect
@AllArgsConstructor
@NoArgsConstructor
public class LogExecutiomTimeAspect {

   private static final Logger LOGGER = LoggerFactory.getLogger(com.aspect.LogExecutiomTimeAspect.class);

   @Value("${logTimeAdvise.log.level:info}")
   private String logLevel = "info";

   @Pointcut("@annotation(com.annotation.LogExecutionTime)")
   public void cut() {
   }

   @Around("cut()")
   public Object doLogExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {

      long beforeInMethod = System.currentTimeMillis();

      Object proceed = joinPoint.proceed();

      Method method = getMethod(joinPoint);

      String promptMsg = "==> 执行方法[" + method.getDeclaringClass().getSimpleName() + "." + method.getName() + "]耗时:" + (System.currentTimeMillis() - beforeInMethod) + " ms";

      switch (logLevel) {
         case "debug":
            LOGGER.debug(promptMsg);
            break;
         case "info":
            LOGGER.info(promptMsg);
            break;
         case "warn":
            LOGGER.warn(promptMsg);
            break;
         case "error":
            LOGGER.error(promptMsg);
            break;
         default:
            LOGGER.info(promptMsg);
            break;
      }

      return proceed;
   }

   private Method getMethod(ProceedingJoinPoint joinPoint) {
      return ((MethodSignature) joinPoint.getSignature()).getMethod();
   }
}

注释:

package com.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogExecutionTime {
}

aop 配置:

<!DOCTYPE aspectj PUBLIC "-//AspectJ//DTD//EN" "https://www.eclipse.org/aspectj/dtd/aspectj.dtd">
<aspectj>
    <!-- 无配置 -->
    <!--    <weaver options="-showWeaveInfo">-->
    <!-- 打印完整信息 -->
    <weaver options="-showWeaveInfo -XnoInline -Xset:weaveJavaxPackages=true -Xlint:ignore -verbose -XmessageHandlerClass:org.springframework.aop.aspectj.AspectJWeaverMessageHandler">
        <!-- only weave classes in our application-specific packages -->
        <include within="com..*"/>
    </weaver>

    <aspects>
        <!-- 切面类 -->
        <aspect name="com.aspect.LogExecutiomTimeAspect"/>
    </aspects>

</aspectj>

说明:可以放在 common 包,只要其他微服务没有注释@EnableLoadTimeWeaving,就不会启用 aspectj 的 loadtime weaving,自然也不会启动报错

参考资料:

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容