RocketMQ如何解决分布式事务

本文来说下RocketMQ如何解决分布式事务

---

基本实现思路

核心思想：事务消息总共分为3个阶段：发送Prepared消息、执行本地事务、发送确认消息。这三个阶段是前后关联的，只有发送Prepared消息成功，才会执行本地事务，本地事务返回的状态是提交，那么就会发送最终的确认消息。如果在结束消息事务时，本地事务状态失败，那么Broker回查线程定时（默认1分钟）扫描每个存储事务状态的表格文件，如果是已经提交或者回滚的消息直接跳过，如果是Prepared状态则会向生产者发起一个检查本地事务的请求。

基本流程

1. 生产者向我们的Broker（MQ服务器端）发送我们派单消息设置为半消息，该消息不可以被消费者消费。
2. 再执行我们的本地的事务，将本地执行事务结果提交或者回滚告诉Broker
3. Broker获取本地事务的结果，如果是已提交的话，将该半消息设置为允许被消费者消费，如果本地事务执行失败的情况下，将该半消息直接从Broker中移除
4. 如果我们的本地事务没有将结果及时通知给我们的Broker，这时候我们Broker会主动定时（默认60s）查询本地事务结果
5. 本地事务结果实际上就是一个回调方法，根据自己业务场景封装本地事务结果
6. 事务回查的时间次数等配置在broker里

---

RocketMQ的事务消息状态

RocketMQ的事务消息分为3种状态，分别是提交状态、回滚状态、中间状态：

• TransactionStatus.CommitTransaction: 提交事务，它允许消费者消费此消息。
• TransactionStatus.RollbackTransaction: 回滚事务，它代表该消息将被删除，不允许被消费。
• TransactionStatus.Unknown: 中间状态，它代表需要检查消息队列来确定状态。

---

代码实例

maven导入

maven导入

<!-- rocketmq -->
<!-- https://mvnrepository.com/artifact/org.apache.rocketmq/rocketmq-spring-boot-starter -->
<dependency>
	<groupId>org.apache.rocketmq</groupId>
	<artifactId>rocketmq-spring-boot-starter</artifactId>
	<version>2.1.1</version>
</dependency>

<!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
<dependency>
	<groupId>com.google.code.gson</groupId>
	<artifactId>gson</artifactId>
	<version>2.8.6</version>
</dependency>

---

yaml文件配置

yaml文件配置

#rocketmq配置信息
rocketmq:
  #nameservice服务器地址（多个以英文逗号隔开）
  name-server: 192.168.3.207:9876
  #生产者配置
  producer:
    #组名
    group: my-producer-group
    #超时时间设置长一点，要不然会报错sendDefaultImpl call timeout
    send-message-timeout: 50000

---

核心代码

实体

@Data
@AllArgsConstructor
@NoArgsConstructor
public class OrderEntity {

    private  Long  id;

    private  Integer age;

    private  String  name;
}

生产者消息发送，这里为了便于测试，写在了controller里面

@Slf4j
@RestController
@RequestMapping("/api")
@Api(tags = "RocketMq事务消息")
public class OrderController {

    @Autowired
    private RocketMQTemplate rocketMQTemplate;


    /***
     * 使用RocketMQTemplate发送事务消息和普通消息略有不同的是，
     * 需要指一个事务生产者组，当然如果传入null，则会使用默认值
     * rocketmq_transaction_default_global_name，
     * 发生消息的地址和普通消息一样都Topic:Tag，
     * 另外一点不同的是除了发生的Message之外，
     * 还可以发送其他的额外参数，不过这些参数
     * 只会在执行本地事务的时候会用到。
     *
     * @return
     */
    @GetMapping("/sendOrder")
    @ApiOperation(value = "发送消息")
    public String sendOrder() {

        //数据封装
        String orderId = (new Random().nextInt(1000)) +"";
        OrderEntity entity = new OrderEntity();
        entity.setId(Long.valueOf(orderId));
        entity.setAge(12);
        entity.setName("张三");

        //使用Gson将实体转化成字符串
        GsonBuilder gsonBuilder = new GsonBuilder();
        gsonBuilder.setPrettyPrinting();
        Gson gson = gsonBuilder.create();
        String mm = gson.toJson(entity);

        //消息封装
        MessageBuilder<String> stringMessageBuilder = MessageBuilder.withPayload(mm);
        stringMessageBuilder.setHeader("msg",mm);
        Message msg = stringMessageBuilder.build();

        log.info(">>>> send tx message start,tx_group={},destination={},payload={} <<<<","my-producer-group","order_topic",entity);

        // 发送半消息，sendMessageInTransaction方法，以前的版本是4个参数，最新的版本中只有3个参数了
        TransactionSendResult sendResult = rocketMQTemplate.sendMessageInTransaction("order_topic",msg,entity.getId().toString());
        // 发送半消息的返回结果
        String sendStatus = sendResult.getSendStatus().name();
        String localTXState = sendResult.getLocalTransactionState().name();
        log.info(">>>> send status={},localTransactionState={} <<<<",sendStatus,localTXState);
        return "success";


    }
}

生产者监听程序

/***
 * 除了消费者之外，我们还需要创建事务消息生产者端的消息监听器，注意是生产者，
 * 不是消费者，我们需要实现的是RocketMQLocalTransactionListener接口。
 * 重写执行本地事务的方法和检查本地事务方法
 *
 */
@Slf4j
@RocketMQTransactionListener
public class OrderTXMsgListener implements RocketMQLocalTransactionListener {


    private static final Gson GSON = new Gson();

    /***
     * executeLocalTransaction方法是用来执行本地事务的，
     * 将本地事务执行的状态告知Broker服务器的，并不能用来传消息，
     * 如果想传数据库的主键id，可以提前生成主键id，而不要数据库自动生成。
     * @param msg
     * @param arg
     * @return
     */
    @Override
    public RocketMQLocalTransactionState executeLocalTransaction(Message msg, Object arg) {

        log.info(">>>> TX message listener execute local transaction, message={},args={} <<<<",msg,arg);

        // 执行本地事务
        RocketMQLocalTransactionState result = RocketMQLocalTransactionState.COMMIT;
        try {
            String jsonString = new String((byte[]) msg.getPayload(), StandardCharsets.UTF_8);
            OrderEntity orderEntity = GSON.fromJson(jsonString, OrderEntity.class);
            log.info(orderEntity.toString());
            String id = (String) arg;
            log.info(id);
        } catch (Exception e) {
            log.error(">>>> exception message={} <<<<",e.getMessage());
            result = RocketMQLocalTransactionState.UNKNOWN;
        }
        return result;
    }

    /***
     * checkLocalTransaction方
     * 法是用来回查本地事务状态的
     * @param msg
     * @return
     */
    @Override
    public RocketMQLocalTransactionState checkLocalTransaction(Message msg) {

        log.info(">>>> TX message listener check local transaction, message={} <<<<",msg.getPayload());
        // 检查本地事务
        RocketMQLocalTransactionState result = RocketMQLocalTransactionState.COMMIT;
        try {
            String jsonString = new String((byte[]) msg.getPayload(), StandardCharsets.UTF_8);
            OrderEntity orderEntity = GSON.fromJson(jsonString, OrderEntity.class);
            log.info(orderEntity.toString());
        } catch (Exception e) {
            // 异常就回滚
            log.error(">>>> exception message={} <<<<",e.getMessage());
            result = RocketMQLocalTransactionState.ROLLBACK;
        }
        return result;
    }
}

消费者消费

/***
 * 和一般的消
 * 息消费类似
 */
@Slf4j
@Component
@RocketMQMessageListener(consumerGroup = "tx_consumer",topic = "order_topic")
public class OrderListener implements RocketMQListener<String> {

    @Override
    public void onMessage(String message) {

        log.info("===============消费者进行消息的消费==============");
        log.info(">>>> message={} <<<<",message);
    }
}

程序测试

在执行本地事务方法中正常情况下返回的值是COMMIT，即提交事务，这种情况下消费者会直接消费消息，而略过检查本地事务的方法。

---

本文小结

本文编写了一个实例来实现RocketMQ如何解决分布式事务，在解决分布式事务中还是比较常见的一种解决方案。