Spring AOP：日志记录和嵌套方法

Question

我编写了一个简单的 Spring2.5 应用程序来演示/测试 AOP；具体来说，我想记录特定包中每个类的每个方法的进入和退出。这就是我所拥有的...

（注意：我正在使用注释控制器；我省略了与 aop 不直接相关的细节，因为我的基本设置工作正常——我只包括与 aop 相关的细节——如果你需要查看更多）

---

applicationContext.xml ：

(...)
<bean id="loggerInterceptor" class="aspect.LoggerInterceptor" />
(...)

dispatcher-servlet.xml ：

(...)
<aop:aspectj-autoproxy proxy-target-class="true" />
(...)

HomeController.java :

public class HomeController() {

    public HomeController() { }

    public ModelAndView get() {
        System.out.println("In HomeController#get()...");

        this.somePrivateMethod();
        this.somePublicMethod();

        return new ModelAndView( "home" );
    }

    private void somePrivateMethod() {
        System.out.println("In HomeController#somePrivateMethod()...");
    }

    public void somePublicMethod() {
        System.out.println("In HomeController#somePublicMethod()...");
    }
}

LoggerInterceptor.java :

public class LoggerInterceptor {

    @Pointcut("execution(* controller.*.*(..))")
    private void anyOperationInControllerPackage() {
        /* nothing to do here;
         * this just defines that we want to catch all methods
         * in the controller-package
         */
    }

    @Around("anyOperationInControllerPackage()")
    public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {

        System.out.println("Entering " + joinPoint.getSignature().getDeclaringTypeName() + "#" + joinPoint.getSignature().getName() + "() using arguments: " + Arrays.toString( joinPoint.getArgs() ) );

        try {

            Object result = joinPoint.proceed();

            System.out.println("Leaving " + joinPoint.getSignature().getDeclaringTypeName() + "#" + joinPoint.getSignature().getName() + "()." );

            return result;

        } catch (Throwable ex) {

            ex.printStackTrace();
            throw ex;

        }

    }

}

---

这是调用 HomeController#get() 时得到的结果：

Entering controller.HomeController#get() using arguments: []
In HomeController#get()...
In HomeController#somePrivateMethod()...
In HomeController#somePublicMethod()...
Leaving controller.HomeController#get().

如您所见，唯一被拦截的方法是 HomeController#get()。当 #get() 调用 #somePrivateMethod() 或 #somePublicMethod() 时，拦截器不会捕获这些内容。我预计，至少 #somePublicMethod() 也会被捕获（并且由于我使用的是 cglib，我也预计 #somePrivateMethod() 也会被捕获）。

所以我想我的问题是我需要更改/添加什么才能允许（至少）控制器包中的所有公共方法被捕获，即使该包中的另一个方法调用它们并且本身首先被捕获？ ??

我希望这是有道理的。 :D

---

编辑(25APR2011 @ 1:13PM)

applicationContext.xml :

(...)
<context:load-time-weaver />  <!-- added -->
<bean id="loggerInterceptor"... />
(...)

---

aop.xml :

<!DOCTYPE aspectj PUBLIC
    "-//AspectJ//DTD//EN" "http://www.eclipse.org/aspectj/dtd/aspectj.dtd">
<aspectj>
    <weaver>
        <!-- only weave classes in this package -->
        <include within="controller.*" />
    </weaver>
    <aspects>
        <!-- use only this aspect for weaving -->
        <aspect name="aspect.LoggerInterceptor" />
    </aspects>
</aspectj>

---

< strong>在 Netbean 的“项目属性”中的“运行”选项卡下，我将此行添加到“VM 选项”：

-javaagent:C:\Users\bgresham\Documents\libraries\spring-framework-2.5\dist\weaving\spring-agent.jar

---

和以前一样，我没有收到任何错误 - 我只是没有获取我正在寻找的“嵌套”日志记录。

???

Answer 1

如果您使用 Spring AOP，则必须仅调用通过 Spring 返回的引用应用了切面的方法，不能通过 this，而且我认为您也不能将切入点应用于私有方法（最后一部分可能是错误的）。这是因为 Spring AOP 通过代理对象应用切入点，而不是通过类重写（AspectJ 就是这么做的）。这种严格限制的好处是，让它在容器中工作要容易得多（我从经验中知道 Spring AOP 在 Tomcat 中工作得很好），因为没有关于哪些位插入到哪里的争论。

最好的方法是拆分类定义，这样您就永远不会通过 this 调用方法，但如果不可能，那么您始终可以尝试为 bean 提供对自身的 Spring 派生引用：

private HomeController self;
@Required
public void setSelf(HomeController self) { this.self = self; }

public ModelAndView get() {
    System.out.println("In HomeController#get()...");

    self.somePrivateMethod();
    self.somePublicMethod();

    return new ModelAndView( "home" );
}

（这非常简洁；self 是多种语言中的关键字，但 Java 中不是这样，因此相对容易记住它的用途。）

Answer 2

您正在使用 spring aop 来支持方面。 Spring aop 仅适用于 spring beans。因此，切入点不适用于实际的类实例，即当控制器调用其任何公共或私有方法时。为了记录控制器中的所有方法，您需要通过启用您想要拦截的所有类的加载时或编译时编织来使用 AspectJ 来支持 aop。
编辑：

您需要以下内容来进行加载时编织：

aop.xml

<!DOCTYPE aspectj PUBLIC "-//AspectJ//DTD//EN" "http://www.eclipse.org/aspectj/dtd/aspectj.dtd">    
<aspectj>    
    <weaver options="-Xset:weaveJavaxPackages=true -verbose -showWeaveInfo -debug">    
        <include within="*"/>
    </weaver>
    <aspects>
        <!-- weave in just this aspect -->
        <aspect name="your.logger.impl.LoggingImpl"/>
    </aspects>
  </aspectj>

这意味着使用指定的方面编织所有文件（'within=*'，根据需要修改）。在加载时，您应该看到有关类编织的详细信息。

Spring 配置中的配置：

<context:load-time-weaver aspectj-weaving="autodetect" 

            weaver-class="org.springframework.instrument.classloading.ReflectiveLoadTimeWeaver"/>

请注意，编织类必须位于服务器库路径中，而不是您的应用程序路径中。

上述配置应该可以满足您的要求。