JZTXT

spring-transaction源码分析(2)EnableTransactionManagement注解

发布时间 2023-05-06 12:20:48作者: 用户不存在！

概述(Java doc)

该注解开启spring的注解驱动事务管理功能，通常标注在@Configuration类上面用于开启命令式事务管理或响应式事务管理。

@Configuration
@EnableTransactionManagement
public class AppConfig {

    @Bean
    public FooRepository fooRepository() {
        // configure and return a class having @Transactional methods
        return new JdbcFooRepository(dataSource());
    }

    @Bean
    public DataSource dataSource() {
        // configure and return the necessary JDBC DataSource
    }

    @Bean
    public PlatformTransactionManager txManager() {
        return new DataSourceTransactionManager(dataSource());
    }
}

The example above can be compared to the following Spring XML configuration:

<beans>
    <tx:annotation-driven/>

    <bean id="fooRepository" class="com.foo.JdbcFooRepository">
        <constructor-arg ref="dataSource"/>
    </bean>

    <bean id="dataSource" class="com.vendor.VendorDataSource"/>

    <bean id="transactionManager" class="org.sfwk...DataSourceTransactionManager">
        <constructor-arg ref="dataSource"/>
    </bean>
</beans>

添加该注解之后，spring-tx会注册必要的spring组件，这些组件支持注解驱动的事务管理，例如TransactionInterceptor和基于proxy(jdk/cglib)或aspectJ的advice，当调用@Transactional标注的方法时，这些advice将通过拦截器被调用。

注解属性

proxyTargetClass

boolean proxyTargetClass() default false;

设置为true时，创建基于子类的(CGLIB)代理。设置为false时，使用JDK Proxy创建代理。默认值为false。

该属性仅在mode属性设置为AdviceMode.PROXY时生效。

将此属性设置为true将影响所有需要代理的spring bean，而不仅仅是那些用@Transactional标记的bean。

例如，标记有@Async注解bean将同时升级为子类(CGLIB)代理，这个特性实际上没有负面影响，除非明确期望使用某种类型的代理。

mode

/**
 * PROXY: JDK/CGLIB proxy-based advice
 * ASPECTJ: AspectJ weaving-based advice
 */
AdviceMode mode() default AdviceMode.PROXY;

指明使用哪种代理方式嵌入事务通知。

默认AdviceMode.PROXY模式。

PROXY模式只允许通过代理对象调用。同一个类中的本地调用(即this.方法名方式)不能被拦截，本地调用时Transactional注解不会生效，因为spring aop在拦截逻辑执行之后使用原始bean对象调用目标方法，所以this.方法名方式调用会使Transactional注解失效。如果要解决这个问题，可以考虑将其切换到AdviceMode.ASPECTJ。

如果设置为AdviceMode.ASPECTJ模式，proxyTargetClass属性的值将被忽略。在这种情况下，需要依赖spring-aspects模块，该模块又依赖了AspectJ，AspectJ会在编译或加载时将事务拦截逻辑应用到@Transactional标记的类。在这种情况下没有代理，本地调用也将被拦截。

order

// Integer.MAX_VALUE
int order() default Ordered.LOWEST_PRECEDENCE;

指示在特定joinpoint应用多个通知时执行事务通知的顺序。

EnableTransactionManagement源码

@Import(TransactionManagementConfigurationSelector.class)
public @interface EnableTransactionManagement {

	boolean proxyTargetClass() default false;

	AdviceMode mode() default AdviceMode.PROXY;

	int order() default Ordered.LOWEST_PRECEDENCE;
}

TransactionManagementConfigurationSelector

public class TransactionManagementConfigurationSelector 
    extends AdviceModeImportSelector<EnableTransactionManagement> {

	@Override
	protected String[] selectImports(AdviceMode adviceMode) {
		switch (adviceMode) {
			case PROXY:
				return new String[] {AutoProxyRegistrar.class.getName(),
						ProxyTransactionManagementConfiguration.class.getName()};
			case ASPECTJ:
				return new String[] {determineTransactionAspectClass()};
			default:
				return null;
		}
	}

	private String determineTransactionAspectClass() {
		return (ClassUtils.isPresent("javax.transaction.Transactional", getClass().getClassLoader()) ?
				TransactionManagementConfigUtils.JTA_TRANSACTION_ASPECT_CONFIGURATION_CLASS_NAME :
				TransactionManagementConfigUtils.TRANSACTION_ASPECT_CONFIGURATION_CLASS_NAME);
	}
}

PROXY模式

EnableTransactionManagement注解的mode属性设置为PROXY模式(默认)时，会Import两个组件：

  • AutoProxyRegistrar
  • ProxyTransactionManagementConfiguration

AutoProxyRegistrar

Object mode = candidate.get("mode");
Object proxyTargetClass = candidate.get("proxyTargetClass");
if (mode != null && proxyTargetClass != null && AdviceMode.class == mode.getClass() &&
		Boolean.class == proxyTargetClass.getClass()) {
	candidateFound = true;
	if (mode == AdviceMode.PROXY) {
		// 注册InfrastructureAdvisorAutoProxyCreator组件
		AopConfigUtils.registerAutoProxyCreatorIfNecessary(registry);
		if ((Boolean) proxyTargetClass) {
			// 设置proxyTargetClass为true
			AopConfigUtils.forceAutoProxyCreatorToUseClassProxying(registry);
			return;
		}
	}
}

AutoProxyRegistrar会向容器注册InfrastructureAdvisorAutoProxyCreator组件，InfrastructureAdvisorAutoProxyCreator继承了AbstractAutoProxyCreator，用于创建Advisor代理，但是它只考虑基础架构Advisor bean，会忽略@Aspect组件。

若需要支持@Aspect组件，需要使用@EnableAspectJAutoProxy注解开启AspectJ支持，EnableAspectJAutoProxy注解会注册AnnotationAwareAspectJAutoProxyCreator组件，AnnotationAwareAspectJAutoProxyCreator也继承了AbstractAutoProxyCreator，支持Advisor和@Aspect组件。这个内容在之前的AOP源码分析中记录过，此处不再展开分析。

参考AOP源码分析：

https://blog.csdn.net/xuguofeng2016/article/details/128114972

AnnotationAwareAspectJAutoProxyCreator的优先级比InfrastructureAdvisorAutoProxyCreator高，所以当同时注册时，会使用AnnotationAwareAspectJAutoProxyCreator作为Advisor代理创建器。

继承关系：

ProxyTransactionManagementConfiguration

注入事务通知相关组件：

  • BeanFactoryTransactionAttributeSourceAdvisor - 实现了PointcutAdvisor接口

  • TransactionInterceptor - 实现了MethodInterceptor接口

Advisor、Advice、Pointcut是spring aop的三组件，aop中已重点分析过，此处不再记录。

ASPECTJ模式

如果EnableTransactionManagement注解的mode属性设置为ASPECTJ模式，会导入AspectJTransactionManagementConfiguration组件。

该模式需要依赖spring-aspects模块。

AspectJTransactionManagementConfiguration

org.springframework.transaction.aspectj.AspectJTransactionManagementConfiguration

@Configuration class that registers the Spring infrastructure beans necessary to enable AspectJ-based annotation-driven transaction management for Spring's own org.springframework.transaction.annotation.Transactional annotation.

这个类会装配AnnotationTransactionAspect对象，AnnotationTransactionAspect是一个原生AspectJ组件，该组件使用原生AspectJ在类加载阶段为目标方法嵌入事务拦截逻辑以实现事务管理。

在启动时需要添加以下参数：

-javaagent:path/to/aspectjweaver-${version}.jar

AspectJ参考资料

https://javadoop.com/post/aspectj

https://www.eclipse.org/aspectj/docs.php