CAP-分布式事务的解决方案

CAP 是一个基于 .NET Standard 的 C# 库，它是一种处理分布式事务的解决方案，同样具有 EventBus 的功能，它具有轻量级、易使用、高性能等特点。

https://github.com/dotnetcore/CAP

在我们构建 SOA 或者微服务系统的过程中，我们通常需要使用事件来对各个服务进行集成，在这过程中简单的使用消息队列并不能保证数据的最终一致性， CAP 采用的是和当前数据库集成的本地消息表的方案来解决在分布式系统互相调用的各个环节可能出现的异常，它能够保证任何情况下事件消息都是不会丢失的。

你同样可以把 CAP 当做 EventBus 来使用，CAP提供了一种更加简单的方式来实现事件消息的发布和订阅，在订阅以及发布的过程中，你不需要继承或实现任何接口。

这是CAP集在ASP.NET Core 微服务架构中的一个示意图：

架构预览

CAP 实现了 eShop 电子书中描述的发件箱模式

Getting Started

NuGet

你可以运行以下下命令在你的项目中安装 CAP。

PM> Install-Package DotNetCore.CAP

CAP 支持 Kafka、RabbitMQ、AzureServiceBus 等消息队列，你可以按需选择下面的包进行安装：

PM> Install-Package DotNetCore.CAP.Kafka
PM> Install-Package DotNetCore.CAP.RabbitMQ
PM> Install-Package DotNetCore.CAP.AzureServiceBus

CAP 提供了 Sql Server, MySql, PostgreSQL，MongoDB 的扩展作为数据库存储：

// 按需选择安装你正在使用的数据库
PM> Install-Package DotNetCore.CAP.SqlServer
PM> Install-Package DotNetCore.CAP.MySql
PM> Install-Package DotNetCore.CAP.PostgreSql
PM> Install-Package DotNetCore.CAP.MongoDB

Configuration

首先配置CAP到 Startup.cs 文件中，如下：

public void ConfigureServices(IServiceCollection services)
{......services.AddDbContext<AppDbContext>();services.AddCap(x =>{//如果你使用的 EF 进行数据操作，你需要添加如下配置：x.UseEntityFramework<AppDbContext>();  //可选项，你不需要再次配置 x.UseSqlServer 了//如果你使用的ADO.NET，根据数据库选择进行配置：x.UseSqlServer("数据库连接字符串");x.UseMySql("数据库连接字符串");x.UsePostgreSql("数据库连接字符串");//如果你使用的 MongoDB，你可以添加如下配置：x.UseMongoDB("ConnectionStrings");  //注意，仅支持MongoDB 4.0+集群//CAP支持 RabbitMQ、Kafka、AzureServiceBus 等作为MQ，根据使用选择配置：x.UseRabbitMQ("ConnectionStrings");x.UseKafka("ConnectionStrings");x.UseAzureServiceBus("ConnectionStrings");});
}

发布

在 Controller 中注入 ICapPublisher 然后使用 ICapPublisher 进行消息发送

public class PublishController : Controller
{private readonly ICapPublisher _capBus;public PublishController(ICapPublisher capPublisher){_capBus = capPublisher;}//不使用事务[Route("~/without/transaction")]public IActionResult WithoutTransaction(){_capBus.Publish("xxx.services.show.time", DateTime.Now);return Ok();}//Ado.Net 中使用事务，自动提交[Route("~/adonet/transaction")]public IActionResult AdonetWithTransaction(){using (var connection = new MySqlConnection(ConnectionString)){using (var transaction = connection.BeginTransaction(_capBus, autoCommit: true)){//业务代码_capBus.Publish("xxx.services.show.time", DateTime.Now);}}return Ok();}//EntityFramework 中使用事务，自动提交[Route("~/ef/transaction")]public IActionResult EntityFrameworkWithTransaction([FromServices]AppDbContext dbContext){using (var trans = dbContext.Database.BeginTransaction(_capBus, autoCommit: true)){//业务代码_capBus.Publish("xxx.services.show.time", DateTime.Now);}return Ok();}
}

Dashboard

CAP 2.1+ 以上版本中提供了仪表盘（Dashboard）功能，你可以很方便的查看发出和接收到的消息。除此之外，你还可以在仪表盘中实时查看发送或者接收到的消息。

使用一下命令安装 Dashboard：

PM> Install-Package DotNetCore.CAP.Dashboard

在分布式环境中，仪表盘内置集成了 Consul 作为节点的注册发现，同时实现了网关代理功能，你同样可以方便的查看本节点或者其他节点的数据，它就像你访问本地资源一样。

services.AddCap(x =>
{//...// 注册 Dashboardx.UseDashboard();// 注册节点到 Consulx.UseDiscovery(d =>{d.DiscoveryServerHostName = "localhost";d.DiscoveryServerPort = 8500;d.CurrentNodeHostName = "localhost";d.CurrentNodePort = 5800;d.NodeId = 1;d.NodeName = "CAP No.1 Node";});
});

仪表盘默认的访问地址是：http://localhost:xxx/cap，你可以在d.MatchPath配置项中修改cap路径后缀为其他的名字。