DotNetCore CAP 分布式事件总线快速入门指南

DotNetCore CAP 分布式事件总线快速入门指南

【免费下载链接】CAP Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern 项目地址: https://gitcode.com/gh_mirrors/ca/CAP

什么是 CAP

CAP 是一个基于 .NET Core 的分布式事件总线系统，它提供了事件发布/订阅的抽象层，能够帮助开发者轻松构建松耦合的微服务架构。与直接集成消息队列相比，CAP 提供了更高级别的抽象和可靠性保证。

核心优势

1. 可靠性：消息持久化存储，确保消息不会丢失
2. 最终一致性：通过重试机制保证跨服务数据最终一致
3. 简化开发：提供简洁的 API 处理分布式事务
4. 多消息队列支持：可适配多种消息中间件
5. 监控支持：内置消息监控界面

快速安装

使用 NuGet 包管理器安装核心库：

Install-Package DotNetCore.CAP

基础配置

对于快速入门，我们可以使用内存存储和内存消息队列（仅适用于开发和测试环境）：

Install-Package DotNetCore.CAP.InMemoryStorage
Install-Package Savorboard.CAP.InMemoryMessageQueue

在 Startup.cs 中进行配置：

public void ConfigureServices(IServiceCollection services)
{
    services.AddCap(x =>
    {
        x.UseInMemoryStorage();    // 使用内存存储
        x.UseInMemoryMessageQueue(); // 使用内存消息队列
    });
}

消息发布实战

基本消息发布

创建一个控制器来发布消息：

public class PublishController : Controller
{
    [Route("~/send")]
    public IActionResult SendMessage([FromServices]ICapPublisher capBus)
    {
        // 发布一个名为"test.show.time"的事件，携带当前时间
        capBus.Publish("test.show.time", DateTime.Now);
        return Ok();
    }
}

延迟消息发布

CAP 支持延迟消息发布，这在需要定时触发或延迟处理的场景非常有用：

[Route("~/send/delay")]
public IActionResult SendDelayMessage([FromServices]ICapPublisher capBus)
{
    // 100秒后发布消息
    capBus.PublishDelay(TimeSpan.FromSeconds(100), "test.show.time", DateTime.Now);
    return Ok();
}

带自定义头信息的消息

在分布式系统中，有时需要在消息中附加一些元数据：

var header = new Dictionary<string, string>()
{
    ["trace-id"] = Guid.NewGuid().ToString(), // 跟踪ID
    ["user-id"] = "12345" // 用户ID
};

capBus.Publish("test.show.time", DateTime.Now, header);

消息消费处理

基本消息消费

创建一个消费者控制器来处理消息：

public class ConsumerController : Controller
{
    [NonAction]
    [CapSubscribe("test.show.time")]
    public void ReceiveMessage(DateTime time)
    {
        Console.WriteLine($"收到消息，时间: {time}");
        // 这里可以添加业务处理逻辑
    }
}

处理带头信息的消息

如果需要访问消息的元数据：

[CapSubscribe("test.show.time")]
public void ReceiveMessage(DateTime time, [FromCap]CapHeader header)
{
    Console.WriteLine($"消息时间: {time}");
    Console.WriteLine($"跟踪ID: {header["trace-id"]}");
    Console.WriteLine($"用户ID: {header["user-id"]}");
    
    // 根据头信息进行业务处理
}

生产环境建议

在快速入门中我们使用了内存存储和内存队列，但在生产环境中需要：

1. 使用持久化存储（如 SQL Server、MySQL、PostgreSQL 等）
2. 使用真正的消息队列（如 RabbitMQ、Kafka 等）
3. 配置重试策略和失败处理
4. 启用监控仪表板

总结

CAP 为 .NET Core 微服务架构提供了一套完整的分布式事件解决方案。通过本快速入门，你已经学会了：

1. 如何安装和配置 CAP
2. 如何发布基本消息、延迟消息和带头信息的消息
3. 如何订阅和处理消息
4. CAP 的核心价值和应用场景

CAP 的强大之处在于它将复杂的分布式事务简化为简单的发布/订阅模式，同时保证了消息的可靠传递。对于构建高可用、松耦合的微服务系统，CAP 是一个非常值得考虑的选择。

【免费下载链接】CAP Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern 项目地址: https://gitcode.com/gh_mirrors/ca/CAP