java:aocache 与Spring Aop兼容问题

本文适用于所有AspectJ与Spring AOP混用的场景。

Spring AOP 是基于动态代理的实现AOP，基于 JDK代理和CGLib代理实现运行时织入（runtime weaving）。

Spring AOP的切面定义沿用了ASpectJ的注解体系，所以在Spring体系中注解定义切面的方式与ASpectJ完全兼容， 但如果一个项目中有Spring 切面定义又要使用aocache静态态织入(CTW)的情况下，就会存在冲突问题。

如下面的示例，项目中定义了一个Spring AOP切面，拦截所有带@RestController注解的服务方法

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

/**
 * 
 * 服务上下文切面
 *
 */
@Aspect
@Component
public class ServiceContextAop {
    @Before("restControllerAspect()")
	public void doServiceContextBefore(JoinPoint joinPoint) throws Throwable {
        // DO SOMETHING
    }
	/**
	 * 定义切入点为有注解{@link org.springframework.web.bind.annotation.RestController}下的所有类
	 */
	@Pointcut("@within(org.springframework.web.bind.annotation.RestController)")
	public void restControllerAspect() {
	}

}

pom.xml中如下定义了aspectj-maven-plugin插件在项目编译时静态织入aocache定义的切面

	<build>
		<plugins>
			<plugin>
				<groupId>org.codehaus.mojo</groupId>
				<artifactId>aspectj-maven-plugin</artifactId>
				<version>1.10</version>
				<configuration>
					<source>1.8</source>
					<target>1.8</target>
					<encoding>UTF-8</encoding>
					<complianceLevel>1.8</complianceLevel>
					<verbose>true</verbose>
					<showWeaveInfo>true</showWeaveInfo>
					<aspectLibraries>
						<aspectLibrary>
							<groupId>com.gitee.l0km</groupId>
							<artifactId>aocache</artifactId>
						</aspectLibrary>
					</aspectLibraries>
				</configuration>
				<executions>
					<execution>
						<goals>
							<goal>compile</goal>
						</goals>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>

编译时不会有任何问题，但是在程序运行时，就会发现ServiceContextAop定义的切面没有起作用。

因为aspectj-maven-plugin插件识别到了ServiceContextAop类上的@Aspect注解，将本该由Spring AOP管理的切面也执行了静态织入。如下为ServiceContextAop.class反编译显示的代码，可以看到ASpectJ在类中增加了额外代码。

为解决ASpectJ CTW模式与Spring AOP的共存问题，就要在插件中aspectj-maven-plugin插件中使用 <exclude></exclude>参数指定在执行静态织入时排除ServiceContextAop.java

<build>
	<plugins>
		<plugin>
			<groupId>org.codehaus.mojo</groupId>
			<artifactId>aspectj-maven-plugin</artifactId>
			<version>1.10</version>
			<configuration>
				<source>1.8</source>
				<target>1.8</target>
				<encoding>UTF-8</encoding>
				<complianceLevel>1.8</complianceLevel>
				<verbose>true</verbose>
				<showWeaveInfo>true</showWeaveInfo>
				<aspectLibraries>
					<aspectLibrary>
						<groupId>com.gitee.l0km</groupId>
						<artifactId>aocache</artifactId>
					</aspectLibrary>
				</aspectLibraries>
    			<!-- 排除 ServiceContextAop.java，避免因为插件对之误织入导致的Spring AOP失效问题 -->
                <excludes>
	                <exclude>**/ServiceContextAop.java</exclude>
                </excludes>
			</configuration>
			<executions>
				<execution>
					<goals>
						<goal>compile</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
	</plugins>
</build>

参考资料

关于 <exclude></exclude>参数说明参见

《Using includes/excludes》