ABP框架教程：模块化CRM系统开发(7) - 基于消息的事件通信

田桥桑Industrious

于 2025-06-03 09:02:55 发布

阅读量381

点赞数 5

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00213/article/details/148392256

ABP框架教程：模块化CRM系统开发(7) - 基于消息的事件通信

abp Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation. 项目地址: https://gitcode.com/gh_mirrors/abp1/abp

前言

在模块化系统设计中，模块间的通信是一个关键问题。ABP框架提供了强大的事件总线系统，支持模块间通过发布/订阅事件进行松耦合通信。本文将深入讲解如何在ABP框架的模块化CRM系统中实现基于消息的事件通信。

事件总线概述

ABP框架提供了两种事件总线实现：

本地事件总线(Local Event Bus)
- 适用于进程内通信
- 在模块化单体应用中，发布者和订阅者位于同一进程
- 无需外部消息代理
分布式事件总线(Distributed Event Bus)
- 设计用于跨进程通信(如微服务架构)
- 默认情况下仍以进程内方式工作(底层使用本地事件总线)
- 可配置为使用外部消息代理(RabbitMQ、Kafka等)

对于模块化单体应用，建议使用分布式事件总线，原因如下：

未来可无缝迁移到微服务架构
默认情况下没有性能损耗
支持数据库级别的事务性事件处理

业务场景实现

我们将实现一个订单-库存联动场景：

订单模块在订单创建时发布事件
产品模块订阅该事件
事件处理程序自动减少相关产品的库存数量

1. 定义事件类

在订单模块的ModularCrm.Ordering.Contracts项目中创建事件类：

public class OrderPlacedEto
{
    public string CustomerName { get; set; }
    public Guid ProductId { get; set; }
}

注意：

事件类放在Contracts项目中，便于其他模块引用
ETO(Event Transfer Object)是事件数据传输对象的命名约定
只包含必要的最小数据量

2. 发布事件

在订单服务中注入IDistributedEventBus并发布事件：

public async Task CreateAsync(OrderCreationDto input)
{
    var order = new Order
    {
        CustomerName = input.CustomerName,
        ProductId = input.ProductId,
        State = OrderState.Placed
    };

    await _orderRepository.InsertAsync(order);

    await _distributedEventBus.PublishAsync(
        new OrderPlacedEto
        {
            ProductId = order.ProductId,
            CustomerName = order.CustomerName
        });
}

关键点：

先完成数据库操作
再发布事件
事件发布是异步操作

3. 订阅事件

在产品模块中处理订单事件：

模块依赖配置

需要将订单模块的Contracts项目引用添加到产品模块的Domain层。可以使用ABP Studio的"Import Module"功能完成此操作。

事件处理器实现

public class OrderEventHandler :
    IDistributedEventHandler<OrderPlacedEto>,
    ITransientDependency
{
    private readonly IRepository<Product, Guid> _productRepository;

    public OrderEventHandler(IRepository<Product, Guid> productRepository)
    {
        _productRepository = productRepository;
    }

    public async Task HandleEventAsync(OrderPlacedEto eventData)
    {
        var product = await _productRepository.FindAsync(eventData.ProductId);
        if (product == null) return;

        product.StockCount--;
        await _productRepository.UpdateAsync(product);
    }
}

要点说明：