Spring之LoadTimeWeaver——一个需求引起的思考---转

原文地址：http://www.myexception.cn/software-architecture-design/602651.html

Spring之LoadTimeWeaver——一个需求引起的思考

最近有个需求——记录应用中某些接口被调用的轨迹，说白了，记录下入参、出参等便可。

 

我选用ApsectJ解决这个问题，前期讨论说在接口层埋点，但这样有个问题，代码侵入比较严重，须要修改每一个须要关注的接口实现类。通过一番讨论，决定使用AOP拦截全部这样的接口。

 

后面又有个新的要求——沙箱环境拦截，生产环境不予拦截。

 

这样就有个眼前的问题须要咱们解决，就是同一份应用包如何区分沙箱环境和生产环境并执行不一样的行为。同事提醒我能够考虑Spring的LTW，即Load Time Weaving。

 

在Java 语言中，从织入切面的方式上来看，存在三种织入方式：编译期织入、类加载期织入和运行期织入。编译期织入是指在Java编译期，采用特殊的编译器，将切面织入到Java类中；而类加载期织入则指经过特殊的类加载器，在类字节码加载到JVM时，织入切面；运行期织入则是采用CGLib工具或JDK动态代理进行切面的织入。 

AspectJ采用编译期织入和类加载期织入的方式织入切面，是语言级的AOP实现，提供了完备的AOP支持。它用AspectJ语言定义切面，在编译期或类加载期将切面织入到Java类中。 

 

AspectJ提供了两种切面织入方式，第一种经过特殊编译器，在编译期，将AspectJ语言编写的切面类织入到Java类中，能够经过一个Ant或Maven任务来完成这个操做；第二种方式是类加载期织入，也简称为LTW（Load Time Weaving）。 

 

如何使用Load Time Weaving？首先，须要经过JVM的-javaagent参数设置LTW的织入器类包，以代理JVM默认的类加载器；第二，LTW织入器须要一个 aop.xml文件，在该文件中指定切面类和须要进行切面织入的目标类。 

 

下面我将经过一个简单的例子在描述如何使用LTW。

 

例子所做的是记录被调用方法的执行时间和CPU使用率。其实这在实际生产中颇有用，与其拉一堆性能测试工具，不如动手作个简单的分析切面，使咱们能很快获得一些性能指标。我指的是没有硬性的性能测试需求下。

 

首先咱们编写一个被织入的受体类，也就是被拦截的对象。

 

 

public class DemoBean {
    public void run() {
       System.out.println("Run");
    }
}

   

接着，咱们编写分析方法执行效率的切面。

 

@Aspect
public class ProfilingAspect {
    @Around("profileMethod()")
    public Object profile(ProceedingJoinPoint pjp) throws Throwable {
       StopWatch sw = new StopWatch(getClass().getSimpleName());
       try {
           sw.start(pjp.getSignature().getName());
           return pjp.proceed();
       } finally {
           sw.stop();
           System.out.println(sw.prettyPrint());
       }
    }
    @Pointcut("execution(public * com.shansun..*(..))")
    public void profileMethod() {}
}

 

前文提到，咱们还须要一个aop.xml。这个文件要求放在META-INF/aop.xml路径下，以告知AspectJ Weaver咱们须要把ProfilingAspect织入到应用的哪些类中。

 

<!DOCTYPE aspectj PUBLIC "-//AspectJ//DTD//EN" "http://www.eclipse.org/aspectj/dtd/aspectj.dtd">
<aspectj>
    <weaver>
       <include within="com.shansun..*" />
    </weaver>
    <aspects>
       <!-- weave in just this aspect -->
       <aspect name="com.shansun.multidemo.spring.ltw.ProfilingAspect" />
    </aspects>
</aspectj>

 

目前为止，本次切面的“攻”和“受”都准备好了，咱们还须要一个中间媒介——LoadTimeWeaver。咱们将Spring的配置文件添加红色标识内容。

 

<?xml version="1.0" encoding="GBK"?>
 
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
    xmlns:context="http://www.springframework.org/schema/context" xmlns:tx="http://www.springframework.org/schema/tx"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd">
    <context:load-time-weaver aspectj-weaving="autodetect" />
 
    <context:component-scan base-package="com.shansun.multidemo"></context:component-scan>
</beans>

 

经过 <context:load-time-weaver  aspectj-weaving="on" /> 使 spring 开启 loadtimeweaver, 注意aspectj-weaving 有三个选项 : on, off, auto-detect, 若是设置为 auto-detect, spring 将会在 classpath 中查找 aspejct 须要的 META-INF/aop.xml， 若是找到则开启 aspectj weaving, 这个逻辑在LoadTimeWeaverBeanDefinitionParser#isAspectJWeavingEnabled 方法中：

 

protected boolean isAspectJWeavingEnabled(String value, ParserContext parserContext) {
       if ("on".equals(value)) {
           return true;
       }
       else if ("off".equals(value)) {
           return false;
       }
       else {
           // Determine default...
           ClassLoader cl = parserContext.getReaderContext().getResourceLoader().getClassLoader();
           return (cl.getResource(ASPECTJ_AOP_XML_RESOURCE) != null);
       }
}

 

一切都准备就绪——切面类、aop.xml、Spring的配置，咱们就建立一个main方法来掩饰LTW的功效吧。

 

public class Main {
    public static void main(String[] args) {
        ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
//      DemoBean bean = (DemoBean) ctx.getBean("demoBean");
        DemoBean bean = new DemoBean();
        bean.run();
    }
}

  

 

由于这个LTW使用成熟的AspectJ，咱们并不局限于通知Spring beans的方法。因此上述代码中从ApplicationContext中获取Bean和直接实例化一个Bean的效果是同样的。

        

注意，这里以使用Eclipse演示上述代码为例，须要在运行参数中稍做设置，即添加前文提到的-javaagent，来取代默认的类加载器。

 

 

 

输出结果以下：

Run

StopWatch 'ProfilingAspect': running time (millis) = 0

-----------------------------------------

ms     %     Task name

-----------------------------------------

      0001 100%  run

 

至此，LTW能够正常使用了，可是麻烦的是我须要在VM参数里加上-javaagent这么个东东，若是不加会如何呢？试试看。

 

Exception in thread "main" java.lang.IllegalStateException: Must start with Java agent to use InstrumentationLoadTimeWeaver. See Spring documentation.
    at org.springframework.instrument.classloading.InstrumentationLoadTimeWeaver.addTransformer(InstrumentationLoadTimeWeaver.java:88)
    at org.springframework.context.weaving.AspectJWeavingEnabler.postProcessBeanFactory(AspectJWeavingEnabler.java:69)
    at org.springframework.context.support.AbstractApplicationContext.invokeBeanFactoryPostProcessors(AbstractApplicationContext.java:553)
    at org.springframework.context.support.AbstractApplicationContext.invokeBeanFactoryPostProcessors(AbstractApplicationContext.java:536)
    at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:362)
    at org.springframework.context.support.ClassPathXmlApplicationContext.<init>(ClassPathXmlApplicationContext.java:139)
    at org.springframework.context.support.ClassPathXmlApplicationContext.<init>(ClassPathXmlApplicationContext.java:83)
    at com.shansun.multidemo.spring.Main.main(Main.java:25)

必需使用java agent么？仔细观察异常的出处InstrumentationLoadTimeWeaver。再深刻这个类的内容，发现异常是由下述方法抛出的。

 

public void addTransformer(ClassFileTransformer transformer) {
       Assert.notNull(transformer, "Transformer must not be null");
       FilteringClassFileTransformer actualTransformer =
              new FilteringClassFileTransformer(transformer, this.classLoader);
       synchronized (this.transformers) {
           if (this.instrumentation == null) {
              throw new IllegalStateException(
                     "Must start with Java agent to use InstrumentationLoadTimeWeaver. See Spring documentation.");
           }
           this.instrumentation.addTransformer(actualTransformer);
           this.transformers.add(actualTransformer);
       }
}

 

不难发现它在校验instrumentation是否为空的时候抛出的异常。有办法啦，重写InstrumentationLoadTimeWeaver的addTransformer方法，隐匿异常便可。

 

 

public class ExtInstrumentationLoadTimeWeaver extends
        InstrumentationLoadTimeWeaver {
 
    @Override
    public void addTransformer(ClassFileTransformer transformer) {
       try {
           super.addTransformer(transformer);
       } catch (Exception e) {}
    }
}

 

   

这时，咱们还须要作一件事，将Spring配置文件中的load-time-weaver入口设置为咱们刚自定义的ExtInstrumentationLoadTimeWeaver便可。

 

 

<?xml version="1.0" encoding="GBK"?>
 
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
    xmlns:context="http://www.springframework.org/schema/context" xmlns:tx="http://www.springframework.org/schema/tx"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd">
    <context:load-time-weaver weaver-class="com.shansun.multidemo.spring.ExtInstrumentationLoadTimeWeaver" aspectj-weaving="autodetect" />
 
    <context:component-scan base-package="com.shansun.multidemo"></context:component-scan>
</beans>

 

 

再次运行咱们的main方法，发现只输出了以下结果，切面没有起做用。

Run

 

看到了么，同一份代码、同一份配置，只须要在VM启动参数中稍加变化，便可实现同一个应用包在不一样环境下能够自由选择使用使用AOP功能。文章开头提到的那个需求也就迎刃而解了。

 

这只是一种解决途径，相信你们会有更好的方案。若是有，请您告诉我。J

 

参考文档：

一、使用AspectJ LTW(Load Time Weaving)

二、Spring LoadTimeWeaver 的那些事儿

三、在Spring应用中使用AspectJ