001/*
002 *  Copyright (c) 2022-2025, Mybatis-Flex (fuhai999@gmail.com).
003 *  <p>
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *  <p>
008 *  http://www.apache.org/licenses/LICENSE-2.0
009 *  <p>
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package com.mybatisflex.spring;
017
018import com.mybatisflex.core.transaction.TransactionContext;
019import com.mybatisflex.core.transaction.TransactionalManager;
020import com.mybatisflex.core.util.StringUtil;
021import org.springframework.jdbc.datasource.JdbcTransactionObjectSupport;
022import org.springframework.transaction.TransactionDefinition;
023import org.springframework.transaction.TransactionException;
024import org.springframework.transaction.support.AbstractPlatformTransactionManager;
025import org.springframework.transaction.support.DefaultTransactionStatus;
026
027/**
028 * MyBatis-Flex 事务支持。
029 *
030 * @author michael
031 */
032public class FlexTransactionManager extends AbstractPlatformTransactionManager {
033
034    @Override
035    protected Object doGetTransaction() throws TransactionException {
036        return new TransactionObject(TransactionContext.getXID());
037    }
038
039    @Override
040    protected boolean isExistingTransaction(Object transaction) throws TransactionException {
041        TransactionObject transactionObject = (TransactionObject) transaction;
042        return StringUtil.hasText(transactionObject.prevXid);
043    }
044
045    @Override
046    protected Object doSuspend(Object transaction) throws TransactionException {
047        TransactionContext.release();
048        TransactionObject transactionObject = (TransactionObject) transaction;
049        return transactionObject.prevXid;
050    }
051
052    @Override
053    protected void doResume(Object transaction, Object suspendedResources) throws TransactionException {
054        String xid = (String) suspendedResources;
055        TransactionContext.holdXID(xid);
056    }
057
058    @Override
059    protected void doBegin(Object transaction, TransactionDefinition definition) throws TransactionException {
060        TransactionObject transactionObject = (TransactionObject) transaction;
061        transactionObject.currentXid = TransactionalManager.startTransactional();
062
063        TimeoutHolder.hold(definition);
064    }
065
066    @Override
067    protected void doCommit(DefaultTransactionStatus status) throws TransactionException {
068        TransactionObject transactionObject = (TransactionObject) status.getTransaction();
069        TransactionalManager.commit(transactionObject.currentXid);
070        transactionObject.clear();
071    }
072
073    @Override
074    protected void doRollback(DefaultTransactionStatus status) throws TransactionException {
075        TransactionObject transactionObject = (TransactionObject) status.getTransaction();
076        TransactionalManager.rollback(transactionObject.currentXid);
077        transactionObject.clear();
078    }
079
080    @Override
081    protected void doSetRollbackOnly(DefaultTransactionStatus status) throws TransactionException {
082        // 在多个事务嵌套时，子事务的传递方式为 REQUIRED（加入当前事务）
083        // 那么，当子事务抛出异常时，会调当前方法，而不是直接调用 doRollback
084        // 此时，需要标识 prevXid 进行 Rollback
085        TransactionObject transactionObject = (TransactionObject) status.getTransaction();
086        transactionObject.setRollbackOnly();
087    }
088
089    @Override
090    protected void doCleanupAfterCompletion(Object transaction) {
091        TimeoutHolder.clear();
092    }
093
094    static class TransactionObject extends JdbcTransactionObjectSupport {
095
096        private static final ThreadLocal<String> ROLLBACK_ONLY_XIDS = new ThreadLocal<>();
097
098        private final String prevXid;
099        private String currentXid;
100
101        public TransactionObject(String prevXid) {
102            this.prevXid = prevXid;
103        }
104
105        public void setRollbackOnly() {
106            ROLLBACK_ONLY_XIDS.set(prevXid);
107        }
108
109        public void clear() {
110            ROLLBACK_ONLY_XIDS.remove();
111        }
112
113        @Override
114        public boolean isRollbackOnly() {
115            return currentXid != null && currentXid.equals(ROLLBACK_ONLY_XIDS.get());
116        }
117    }
118
119}