DDD 架構分層，MQ消息要放到那一層處理？

作者：小傅哥

博客：https://bugstack.cn

沉澱、分享、成長，讓自己和他人都能有所收穫！😄

本文的宗旨在於通過簡單幹淨實踐的方式教會讀者，使用 Docker 配置 RocketMQ 並在基於 DDD 分層結構的 SpringBoot 工程中使用 RocketMQ 技術。因爲大部分 MQ 的發送都是基於特定業務場景的，所以本章節也是基於《MyBatis 使用教程和插件開發》章節的擴展。

本章也會包括關於 MQ 消息的發送和接收應該處於 DDD 的哪一層的實踐講解和使用。

本文涉及的工程：

xfg-dev-tech-rocketmq：https://gitcode.net/KnowledgePlanet/road-map/xfg-dev-tech-rocketmq
RocketMQ Docker 安裝：rocketmq-docker-compose-mac-amd-arm.yml
導入測試庫表 road-map.sql

一、案例背景

首先我們要知道，MQ 消息的作用是用於；解耦過長的業務流程和應對流量衝擊的消峯。如；用戶下單支付完成後，拿到支付消息推動後續的發貨流程。也可以是我們基於《MyBatis 使用教程和插件開發》中的案例場景，給僱員提升級別和薪資的時候，也發送一條MQ消息，用於發送郵件通知給用戶。

從薪資調整到郵件發送，這裏是2個業務流程，通過 MQ 消息的方式進行連接。
其實MQ消息的使用場景特別多，原來你可能使用多線程的一些操作，現在就擴展爲多實例的操作了。發送 MQ 消息出來，讓應用的各個實例接收並進行消費。

二、領域事件

因爲我們本章所講解的內容是把 RocketMQ 放入 DDD 架構中進行使用，那麼也就引申出領域事件定義。所以我們先來了解下，什麼是領域事件。

領域事件，可以說是解耦微服務設計的關鍵。領域事件也是領域模型中非常重要的一部分內容，用於標示當前領域模型中發生的事件行爲。一個領域事件會推進業務流程的進一步操作，在實現業務解耦的同時，也推動了整個業務的閉環。

首先，我們需要在領域模型層，添加一塊 event 區域。它的存在是爲了定義出於當前領域下所需的事件消息信息。信息的類型可以是model 下的實體對象、聚合對象。
之後，消息的發送是放在基礎設置層。本身基礎設置層就是依賴倒置於模型層，所以在模型層所定義的 event 對象，可以很方便的在基礎設置層使用。而且大部分開發的時候，MQ消息的發送與數據庫操作都是關聯的，採用的方式是，做完數據落庫後，推送MQ消息。所以定義在倉儲中實現，會更加得心應手、水到渠成。
最後，就是 MQ 的消息，MQ 的消費可以是自身服務所發出的消息，也可以是外部其他微服務的消息。就在小傅哥所整體講述的這套簡明教程中 DDD 部分的觸發器層。

三、環境安裝

本案例涉及了數據庫和RocketMQ的使用，都已經在工程中提供了安裝腳本，可以按需執行。

這裏主要介紹 RocketMQ 的安裝；

1. 執行 compose yml

文件：docs/rocketmq/rocketmq-docker-compose-mac-amd-arm.yml - 關於安裝小傅哥提供了不同的鏡像，包括Mac、Mac M1、Windows 可以按需選擇使用。

version: '3'
services:
  # https://hub.docker.com/r/xuchengen/rocketmq
  # 注意修改項；
  # 01：data/rocketmq/conf/broker.conf 添加 brokerIP1=127.0.0.1
  # 02：data/console/config/application.properties server.port=9009 - 如果8080端口被佔用，可以修改或者添加映射端口
  rocketmq:
    image: livinphp/rocketmq:5.1.0
    container_name: rocketmq
    ports:
      - 9009:9009
      - 9876:9876
      - 10909:10909
      - 10911:10911
      - 10912:10912
    volumes:
      - ./data:/home/app/data
    environment:
      TZ: "Asia/Shanghai"
      NAMESRV_ADDR: "rocketmq:9876"

在 IDEA 中打開 rocketmq-docker-compose-mac-amd-arm.yml 你會看到一個綠色的按鈕在左側側邊欄，點擊即可安裝。或者你也可以使用命令安裝：# /usr/local/bin/docker-compose -f /docs/dev-ops/environment/environment-docker-compose.yml up -d - 比較適合在雲服務器上執行。
首次安裝可能使用不了，一個原因是 brokerIP1 未配置IP，另外一個是默認的 8080 端口占用。可以按照如下小傅哥說的方式修改。

2. 修改默認配合

打開 data/rocketmq/conf/broker.conf 添加一條 brokerIP1=127.0.0.1 在結尾

# 集羣名稱
brokerClusterName = DefaultCluster
# BROKER 名稱
brokerName = broker-a
# 0 表示 Master, > 0 表示 Slave
brokerId = 0
# 刪除文件時間點，默認凌晨 4 點
deleteWhen = 04
# 文件保留時間，默認 48 小時
fileReservedTime = 48
# BROKER 角色 ASYNC_MASTER爲異步主節點，SYNC_MASTER爲同步主節點，SLAVE爲從節點
brokerRole = ASYNC_MASTER
# 刷新數據到磁盤的方式，ASYNC_FLUSH 刷新
flushDiskType = ASYNC_FLUSH
# 存儲路徑
storePathRootDir = /home/app/data/rocketmq/store
# IP地址
brokerIP1 = 127.0.0.1

打開 ``data/console/config/application.properties修改server.port=9009` 端口。

server.address=0.0.0.0
server.port=9009

修改配置後，重啓服務。

3. RockMQ登錄與配置

3.1 登錄

RocketMQ 此鏡像，會在安裝後在控制檯打印登錄賬號信息，你可以查看使用。

登錄：http://localhost:9009/

3.2 創建Topic

也可以使用命令創建：docker exec -it rocketmq sh /home/app/rocketmq/bin/mqadmin updateTopic -n localhost:9876 -c DefaultCluster -t xfg-mq

3.3 創建消費者組

也可以使用命令創建：docker exec -it rocketmq sh /home/app/rocketmq/bin/mqadmin updateSubGroup -n localhost:9876 -c DefaultCluster -g xfg-group

四、工程實現

1. 工程結構

MQ 的使用無論是 RocketMQ 還是 Kafka 等，都很簡單。但在使用之前，要考慮好怎麼在架構中合理的使用。如果最初沒有定義好這些，那麼胡亂的任何地方都能發送和接收MQ，最後的工程將非常難以維護。
所以這裏整個MQ的生產和消費，是按照整個 DDD 領域事件結構進行設計。分爲在 domain 使用基礎層生產消息，再有 trigger 層接收消息。

2. 配置文件

引入POM

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

添加配置

# RocketMQ 配置
rocketmq:
  name-server: 127.0.0.1:9876
  consumer:
    group: xfg-group
    # 一次拉取消息最大值，注意是拉取消息的最大值而非消費最大值
    pull-batch-size: 10
  producer:
    # 發送同一類消息的設置爲同一個group，保證唯一
    group: xfg-group
    # 發送消息超時時間，默認3000
    sendMessageTimeout: 10000
    # 發送消息失敗重試次數，默認2
    retryTimesWhenSendFailed: 2
    # 異步消息重試此處，默認2
    retryTimesWhenSendAsyncFailed: 2
    # 消息最大長度，默認1024 * 1024 * 4(默認4M)
    maxMessageSize: 4096
    # 壓縮消息閾值，默認4k(1024 * 4)
    compressMessageBodyThreshold: 4096
    # 是否在內部發送失敗時重試另一個broker，默認false
    retryNextServer: false

3. 定義領域事件

源碼：cn.bugstack.xfg.dev.tech.domain.salary.event.SalaryAdjustEvent

@EqualsAndHashCode(callSuper = true)
@Data
public class SalaryAdjustEvent extends BaseEvent<AdjustSalaryApplyOrderAggregate> {

    public static String TOPIC = "xfg-mq";

    public static SalaryAdjustEvent create(AdjustSalaryApplyOrderAggregate adjustSalaryApplyOrderAggregate) {
        SalaryAdjustEvent event = new SalaryAdjustEvent();
        event.setId(RandomStringUtils.randomNumeric(11));
        event.setTimestamp(new Date());
        event.setData(adjustSalaryApplyOrderAggregate);
        return event;
    }

}

每個領域的消息，都有領域自己定義。發送的時候再交給基礎設施層來發送。

4. 消息發送

源碼：cn.bugstack.xfg.dev.tech.infrastructure.event.EventPublisher

@Component
@Slf4j
public class EventPublisher {

    @Setter(onMethod_ = @Autowired)
    private RocketMQTemplate rocketmqTemplate;

    /**
     * 普通消息
     *
     * @param topic   主題
     * @param message 消息
     */
    public void publish(String topic, BaseEvent<?> message) {
        try {
            String mqMessage = JSON.toJSONString(message);
            log.info("發送MQ消息 topic:{} message:{}", topic, mqMessage);
            rocketmqTemplate.convertAndSend(topic, mqMessage);
        } catch (Exception e) {
            log.error("發送MQ消息失敗 topic:{} message:{}", topic, JSON.toJSONString(message), e);
            // 大部分MQ發送失敗後，會需要任務補償
        }
    }

    /**
     * 延遲消息
     *
     * @param topic          主題
     * @param message        消息
     * @param delayTimeLevel 延遲時長
     */
    public void publishDelivery(String topic, BaseEvent<?> message, int delayTimeLevel) {
        try {
            String mqMessage = JSON.toJSONString(message);
            log.info("發送MQ延遲消息 topic:{} message:{}", topic, mqMessage);
            rocketmqTemplate.syncSend(topic, MessageBuilder.withPayload(message).build(), 1000, delayTimeLevel);
        } catch (Exception e) {
            log.error("發送MQ延遲消息失敗 topic:{} message:{}", topic, JSON.toJSONString(message), e);
            // 大部分MQ發送失敗後，會需要任務補償
        }
    }

}

在基礎設施層提供 event 事件的處理，也就是 MQ 消息的發送。

源碼：cn.bugstack.xfg.dev.tech.infrastructure.repository.SalaryAdjustRepository

@Resource
private EventPublisher eventPublisher;
    
@Override
@Transactional(rollbackFor = Exception.class, timeout = 350, propagation = Propagation.REQUIRED, isolation = Isolation.DEFAULT)
public String adjustSalary(AdjustSalaryApplyOrderAggregate adjustSalaryApplyOrderAggregate) {
		 
		// ... 省略部分代碼 

    eventPublisher.publish(SalaryAdjustEvent.TOPIC, SalaryAdjustEvent.create(adjustSalaryApplyOrderAggregate));
    return orderId;
}

在 SalaryAdjustRepository 倉儲的實現中，做完業務流程開始發送 MQ 消息。這裏有2點要注意；

消息發送，不要寫在數據庫事務中。因爲事務一直佔用數據庫連接，需要快速釋放。
對於一些強MQ要求的場景，需要在發送MQ前，寫入一條數據庫 Task 記錄，發送消息後更新 Task 狀態爲成功。如果長時間未更新數據庫狀態或者爲失敗的，則需要由任務補償進行處理。

5. 消費消息

源碼：cn.bugstack.xfg.dev.tech.trigger.mq.SalaryAdjustMQListener

@Component
@Slf4j
@RocketMQMessageListener(topic = "xfg-mq", consumerGroup = "xfg-group")
public class SalaryAdjustMQListener implements RocketMQListener<String> {

    @Override
    public void onMessage(String s) {
        log.info("接收到MQ消息 {}", s);
    }

}

消費消息，配置消費者組合消費的主題，之後就可以接收到消息了。接收以後你可以做自己的業務，如果拋出異常，消息會進行重新接收處理。

六、測試驗證

1. 單獨發送消息測試

@Slf4j
@RunWith(SpringRunner.class)
@SpringBootTest
public class RocketMQTest {

    @Setter(onMethod_ = @Autowired)
    private RocketMQTemplate rocketmqTemplate;

    @Test
    public void test() throws InterruptedException {
        while (true) {
            rocketmqTemplate.convertAndSend("xfg-mq", "我是測試消息");
            Thread.sleep(3000);
        }
    }

}

這裏方便你來發送消息，驗證流程。

2. 業務流程消息驗證

@Test
public void test_execSalaryAdjust() throws InterruptedException {
    AdjustSalaryApplyOrderAggregate adjustSalaryApplyOrderAggregate = AdjustSalaryApplyOrderAggregate.builder()
            .employeeNumber("10000001")
            .orderId("100908977676003")
            .employeeEntity(EmployeeEntity.builder().employeeLevel(EmployeePostVO.T3).employeeTitle(EmployeePostVO.T3).build())
            .employeeSalaryAdjustEntity(EmployeeSalaryAdjustEntity.builder()
                    .adjustTotalAmount(new BigDecimal(100))
                    .adjustBaseAmount(new BigDecimal(80))
                    .adjustMeritAmount(new BigDecimal(20)).build())
            .build();
    String orderId = salaryAdjustApplyService.execSalaryAdjust(adjustSalaryApplyOrderAggregate);
    log.info("調薪測試 req: {} res: {}", JSON.toJSONString(adjustSalaryApplyOrderAggregate), orderId);
    Thread.sleep(Integer.MAX_VALUE);
}

23-07-29.15:40:52.307 [main            ] INFO  HikariDataSource       - HikariPool-1 - Start completed.
23-07-29.15:40:52.445 [main            ] INFO  EventPublisher         - 發送MQ消息 topic:xfg-mq message:{"data":{"employeeEntity":{"employeeLevel":"T3","employeeTitle":"T3"},"employeeNumber":"10000001","employeeSalaryAdjustEntity":{"adjustBaseAmount":80,"adjustMeritAmount":20,"adjustTotalAmount":100},"orderId":"100908977676004"},"id":"98117654515","timestamp":"2023-07-29 15:40:52.425"}
23-07-29.15:40:52.517 [main            ] INFO  ISalaryAdjustApplyServiceTest - 調薪測試 req: {"employeeEntity":{"employeeLevel":"T3","employeeTitle":"T3"},"employeeNumber":"10000001","employeeSalaryAdjustEntity":{"adjustBaseAmount":80,"adjustMeritAmount":20,"adjustTotalAmount":100},"orderId":"100908977676004"} res: 100908977676004
23-07-29.15:40:52.520 [ConsumeMessageThread_1] INFO  SalaryAdjustMQListener - 接收到MQ消息 {"data":{"employeeEntity":{"employeeLevel":"T3","employeeTitle":"T3"},"employeeNumber":"10000001","employeeSalaryAdjustEntity":{"adjustBaseAmount":80,"adjustMeritAmount":20,"adjustTotalAmount":100},"orderId":"100908977676004"},"id":"98117654515","timestamp":"2023-07-29 15:40:52.425"}

當執行一次加薪調整後，就會接收到MQ消息了。

DDD 架構分層，MQ消息要放到那一層處理？

一、案例背景

二、領域事件

三、環境安裝

1. 執行 compose yml

2. 修改默認配合

3. RockMQ登錄與配置

3.1 登錄

3.2 創建Topic

3.3 創建消費者組

四、工程實現

1. 工程結構

2. 配置文件

3. 定義領域事件

4. 消息發送

5. 消費消息

六、測試驗證

1. 單獨發送消息測試

2. 業務流程消息驗證

如何使用 JS 判斷用戶是否處於活躍狀態

Mono 支持LoongArch架構

lightdb秒級增加列和刪除列（not null帶默認值）

lightdb數據庫超時相關控制參數

通過HPA+CronHPA組合應對業務複雜彈性伸縮場景

❤️‍🔥 Solon Cloud Event 新的事務特性與應用

網絡爬蟲的祕密：如何高效地抓取JD.com視頻鏈接

lightdb mysql 8.0兼容之不可見主鍵

使用 JS 實現在瀏覽器控制檯打印圖片 console.image()

基於Ubuntu-22.04安裝K8s-v1.28.2實驗（四）使用域名訪問網站應用

大營銷抽獎系統，DDD開發要如何建模？

花了19周，終於把這套源碼解析圖，全部畫完了！

爽了！免費的SSL，還能自動續期！

體驗下，大廠在使用功能的API網關！

發佈DDD腳手架到Maven倉庫，IntelliJ IDEA 配置一下即可使用

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結