Spring的TransactionEventListener

1. 问题背景:

在之前的项目中,有遇到这样一个使用场景:
在一个TransactionA中,我们先向数据库中插入了一条数据EntityA,之后起了一个线程池,而在线程池中我们需要读取数据库中EntityA。这时候就有个问题了,由于我们知道Transaction是与线程绑定的(ThreadLocal<DataSource>), 那么在线程池中的其他线程,我们可能存在一个情况就是,TransactionA还没提交或处于提交的过程中,那么此时我们是对于EntityA是不可见的。于是就需要将提交到线程的过程与TransactionA分开。在工程中,我们是使用了一种比较丑的方法,也就将待处理的EntityA id当做返回值返回给上层(事务外),然后通过上层来进行调用。但是通过这个流程过耦合了,并不是一种优美的实现方式。

2. 解决方案:

2.1 TransactionEventListener

这几天在浏览Spring Reference的时候,看到了一种方法能够很有效的方式。
在Spring4.2+,有一种较TransactionEventListener的方式,能够控制在事务的时候Event事件的处理方式。
我们知道,Spring的发布订阅模型实际上并不是异步的,而是同步的来将代码进行解耦。而TransactionEventListener仍是通过这种方式,只不过加入了回调的方式来解决,这样就能够在事务进行Commited,Rollback...等的时候才会去进行Event的处理。
代码如下:


@Service("fooService")
public class FooServiceImpl implements FooService {

    private static final Logger LOGGER = Logger.getLogger(FooServiceImpl.class);

    @Override
    public void insertFoo(Foo foo) throws MyTransactionException {
        LOGGER.info("[fooService] start insert foo");
        ApplicationEventPublisher eventPublisher = EventPublisher.getApplicationEventPublisher();
        if (null != eventPublisher) {
            eventPublisher.publishEvent(new MyTransactionEvent("test", this));
        }
        LOGGER.info("[fooServive] finish insert foo");
    }
}


public class MyTransactionEvent extends ApplicationEvent {

    private String name;

    public MyTransactionEvent(String name, Object source) {
        super(source);
        this.name = name;
    }

    public String getName() {
        return this.name;
    }
}

@Component
public class MyTransactionListener {

    private static final Logger LOGGER = Logger.getLogger(MyTransactionListener.class);

    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
    public void hanldeOrderCreatedEvent(MyTransactionEvent event) {
        LOGGER.info("transactionEventListener start");
//        do transaction event
        LOGGER.info("event : " + event.getName());
//        finish transaction event
        LOGGER.info("transactionEventListener finish");
    }
}

输出结果:

[DEBUG] 2018-06-01 11:23:50,165 [main]  jdbc.datasource.DataSourceTransactionManager    (DataSourceTransactionManager.java:248) -Acquired Connection [1794768050, URL=jdbc:mysql://127.0.0.1:3306/test, UserName=root@localhost, MySQL Connector Java] for JDBC transaction
[DEBUG] 2018-06-01 11:23:50,172 [main]  jdbc.datasource.DataSourceTransactionManager    (DataSourceTransactionManager.java:265) -Switching JDBC Connection [1794768050, URL=jdbc:mysql://127.0.0.1:3306/test, UserName=root@localhost, MySQL Connector Java] to manual commit
[INFO]  2018-06-01 11:23:50,173 [main]  transaction.declarative.FooServiceImpl  (FooServiceImpl.java:36)    -[fooService] start insert foo
[DEBUG] 2018-06-01 11:23:50,174 [main]  factory.support.DefaultListableBeanFactory  (AbstractBeanFactory.java:251)  -Returning cached instance of singleton bean 'fooService'
[DEBUG] 2018-06-01 11:23:50,175 [main]  jdbc.datasource.DataSourceTransactionManager    (AbstractPlatformTransactionManager.java:476)   -Participating in existing transaction
[INFO]  2018-06-01 11:23:50,175 [main]  transaction.declarative.FooServiceImpl  (FooServiceImpl.java:43)    -[fooServive] finish insert foo
[DEBUG] 2018-06-01 11:23:50,175 [main]  jdbc.datasource.DataSourceTransactionManager    (AbstractPlatformTransactionManager.java:759)   -Initiating transaction commit
[DEBUG] 2018-06-01 11:23:50,178 [main]  jdbc.datasource.DataSourceTransactionManager    (DataSourceTransactionManager.java:310) -Committing JDBC transaction on Connection [1794768050, URL=jdbc:mysql://127.0.0.1:3306/test, UserName=root@localhost, MySQL Connector Java]
[DEBUG] 2018-06-01 11:23:50,184 [main]  factory.support.DefaultListableBeanFactory  (AbstractBeanFactory.java:251)  -Returning cached instance of singleton bean 'myTransactionListener'
[INFO]  2018-06-01 11:23:50,185 [main]  transaction.event.MyTransactionListener (MyTransactionListener.java:21) -transactionEventListener start
[INFO]  2018-06-01 11:23:50,185 [main]  transaction.event.MyTransactionListener (MyTransactionListener.java:23) -event : test
[INFO]  2018-06-01 11:23:50,185 [main]  transaction.event.MyTransactionListener (MyTransactionListener.java:25) -transactionEventListener finish
[DEBUG] 2018-06-01 11:23:50,192 [main]  jdbc.datasource.DataSourceTransactionManager    (DataSourceTransactionManager.java:368) -Releasing JDBC Connection [1794768050, URL=jdbc:mysql://127.0.0.1:3306/test, UserName=root@localhost, MySQL Connector Java] after transaction
[DEBUG] 2018-06-01 11:23:50,193 [main]  jdbc.datasource.DataSourceUtils (DataSourceUtils.java:329)  -Returning JDBC Connection to DataSource

需要注意的是,如果想使用这个注解,需要在配置文件中添加:

 <tx:annotation-driven/>

由于只有在AnnotationDrivenBeanDefinitionParser的parse方法中,我们才会将
TransactionalEventListenerFactory加入到容器中。

    /**
     * Parses the {@code <tx:annotation-driven/>} tag. Will
     * {@link AopNamespaceUtils#registerAutoProxyCreatorIfNecessary register an AutoProxyCreator}
     * with the container as necessary.
     */
    @Override
    public BeanDefinition parse(Element element, ParserContext parserContext) {
        registerTransactionalEventListenerFactory(parserContext);
        String mode = element.getAttribute("mode");
        if ("aspectj".equals(mode)) {
            // mode="aspectj"
            registerTransactionAspect(element, parserContext);
        }
        else {
            // mode="proxy"
            AopAutoProxyConfigurer.configureAutoProxyCreator(element, parserContext);
        }
        return null;
    }

对于注解@TransactionEventListener来讲,有一个属性fallbackExecutor,其默认值为false。如果将其设为true,则无论当前的场景是否处在事务上下文中,均能够执行。

2.2 TransactionSynchronizationManager.registerSynchronization

第二种解决方法便是通过手动的来注册回调来实现的。
我们可与利用博客Spring Event 事件中的事务控制的方式来进行。
比如:

@EventListener
public void afterRegisterSendMail(MessageEvent event) {
    // Spring 4.2 之前
 
    TransactionSynchronizationManager.registerSynchronization(
            new TransactionSynchronizationAdapter() {
                @Override
                public void afterCommit() {
                    internalSendMailNotification(event);
                }
            });
}

上面的代码将在事务提交后执行.如果在非事务context中将抛出java.lang.IllegalStateException: Transaction synchronization is not active,

    @EventListener
        public void afterRegisterSendMail(MessageEvent event) {
            // Spring 4.2 之前
         
            if (TransactionSynchronizationManager.isActualTransactionActive()) {
         
                TransactionSynchronizationManager.registerSynchronization(
                        new TransactionSynchronizationAdapter() {
                            @Override
                            public void afterCommit() {
                                mailService.send(event);
                            }
                        });
            } else {
                mailService.send(event);
            }
        }

通过上面这种进行人为的判断后,我们便可以兼容是否在事务上下文而不用抛出异常。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,907评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,546评论 1 289
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,705评论 0 238
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,624评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,940评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,371评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,672评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,396评论 0 195
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,069评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,350评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,876评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,243评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,847评论 3 231
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,004评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,755评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,378评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,266评论 2 259

推荐阅读更多精彩内容