DotNetCore.CAP 7.0.0

.NET 6.0
dotnet add package DotNetCore.CAP --version 7.0.0
NuGet\Install-Package DotNetCore.CAP -Version 7.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DotNetCore.CAP" Version="7.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DotNetCore.CAP --version 7.0.0
#r "nuget: DotNetCore.CAP, 7.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install DotNetCore.CAP as a Cake Addin
#addin nuget:?package=DotNetCore.CAP&version=7.0.0

// Install DotNetCore.CAP as a Cake Tool
#tool nuget:?package=DotNetCore.CAP&version=7.0.0

<p align="center"> <img height="140" src="https://cap.dotnetcore.xyz/img/logo.svg"> </p>

CAP                     中文

Travis branch AppVeyor NuGet NuGet Preview Member project of .NET Core Community GitHub license

CAP is a library based on .Net standard, which is a solution to deal with distributed transactions, has the function of EventBus, it is lightweight, easy to use, and efficient.

In the process of building an SOA or MicroService system, we usually need to use the event to integrate each service. In the process, simple use of message queue does not guarantee reliability. CAP adopts local message table program integrated with the current database to solve exceptions that may occur in the process of the distributed system calling each other. It can ensure that the event messages are not lost in any case.

You can also use CAP as an EventBus. CAP provides a simpler way to implement event publishing and subscriptions. You do not need to inherit or implement any interface during subscription and sending process.

Architecture overview

cap.png

CAP implements the Outbox Pattern described in the eShop ebook.

Getting Started

NuGet

CAP can be installed in your project with the following command.

PM> Install-Package DotNetCore.CAP

CAP supports most popular message queue as transport, following packages are available to install:

PM> Install-Package DotNetCore.CAP.Kafka
PM> Install-Package DotNetCore.CAP.RabbitMQ
PM> Install-Package DotNetCore.CAP.AzureServiceBus
PM> Install-Package DotNetCore.CAP.AmazonSQS
PM> Install-Package DotNetCore.CAP.NATS
PM> Install-Package DotNetCore.CAP.RedisStreams
PM> Install-Package DotNetCore.CAP.Pulsar

CAP supports most popular database as event storage, following packages are available to install:

// select a database provider you are using, event log table will integrate into.

PM> Install-Package DotNetCore.CAP.SqlServer
PM> Install-Package DotNetCore.CAP.MySql
PM> Install-Package DotNetCore.CAP.PostgreSql
PM> Install-Package DotNetCore.CAP.MongoDB     //need MongoDB 4.0+ cluster

Configuration

First, you need to configure CAP in your Startup.cs:

public void ConfigureServices(IServiceCollection services)
{
    //......

    services.AddDbContext<AppDbContext>(); //Options, If you are using EF as the ORM
    services.AddSingleton<IMongoClient>(new MongoClient("")); //Options, If you are using MongoDB

    services.AddCap(x =>
    {
        // If you are using EF, you need to add the configuration:
        x.UseEntityFramework<AppDbContext>(); //Options, Notice: You don't need to config x.UseSqlServer(""") again! CAP can autodiscovery.

        // If you are using ADO.NET, choose to add configuration you needed:
        x.UseSqlServer("Your ConnectionStrings");
        x.UseMySql("Your ConnectionStrings");
        x.UsePostgreSql("Your ConnectionStrings");

        // If you are using MongoDB, you need to add the configuration:
        x.UseMongoDB("Your ConnectionStrings");  //MongoDB 4.0+ cluster

        // CAP support RabbitMQ,Kafka,AzureService as the MQ, choose to add configuration you needed:
        x.UseRabbitMQ("ConnectionString");
        x.UseKafka("ConnectionString");
        x.UseAzureServiceBus("ConnectionString");
        x.UseAmazonSQS();
    });
}

Publish

Inject ICapPublisher in your Controller, then use the ICapPublisher to send messages

public class PublishController : Controller
{
    private readonly ICapPublisher _capBus;

    public PublishController(ICapPublisher capPublisher)
    {
        _capBus = capPublisher;
    }

    [Route("~/adonet/transaction")]
    public IActionResult AdonetWithTransaction()
    {
        using (var connection = new MySqlConnection(ConnectionString))
        {
            using (var transaction = connection.BeginTransaction(_capBus, autoCommit: true))
            {
                //your business logic code

                _capBus.Publish("xxx.services.show.time", DateTime.Now);
            }
        }

        return Ok();
    }

    [Route("~/ef/transaction")]
    public IActionResult EntityFrameworkWithTransaction([FromServices]AppDbContext dbContext)
    {
        using (var trans = dbContext.Database.BeginTransaction(_capBus, autoCommit: true))
        {
            //your business logic code

            _capBus.Publish("xxx.services.show.time", DateTime.Now);
        }

        return Ok();
    }
}

Subscribe

In Controller Action

Add the Attribute [CapSubscribe()] on Action to subscribe to messages:

public class PublishController : Controller
{
    [CapSubscribe("xxx.services.show.time")]
    public void CheckReceivedMessage(DateTime datetime)
    {
        Console.WriteLine(datetime);
    }
}

In Business Logic Service

If your subscription method is not in the Controller, then your subscribe class needs to implement ICapSubscribe interface:


namespace BusinessCode.Service
{
    public interface ISubscriberService
    {
        void CheckReceivedMessage(DateTime datetime);
    }

    public class SubscriberService: ISubscriberService, ICapSubscribe
    {
        [CapSubscribe("xxx.services.show.time")]
        public void CheckReceivedMessage(DateTime datetime)
        {
        }
    }
}

Then register your class that implements ISubscriberService in Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services.AddTransient<ISubscriberService,SubscriberService>();

    services.AddCap(x=>
    {
        //...
    });
}
Async subscription

You are able to implement async subscription. Subscription's method should return Task and receive CancellationToken as parameter.

public class AsyncSubscriber : ICapSubscribe
{
    [CapSubscribe("name")]
    public async Task ProcessAsync(Message message, CancellationToken cancellationToken)
    {
        await SomeOperationAsync(message, cancellationToken);
    }
}
Use partials for topic subscriptions

To group topic subscriptions on class level you're able to define a subscription on a method as a partial. Subscriptions on the message queue will then be a combination of the topic defined on the class and the topic defined on the method. In the following example the Create(..) function will be invoked when receiving a message on customers.create

[CapSubscribe("customers")]
public class CustomersSubscriberService : ICapSubscribe
{
    [CapSubscribe("create", isPartial: true)]
    public void Create(Customer customer)
    {
    }
}
Subscribe Group

The concept of a subscription group is similar to that of a consumer group in Kafka. it is the same as the broadcast mode in the message queue, which is used to process the same message between multiple different microservice instances.

When CAP startups, it will use the current assembly name as the default group name, if multiple same group subscribers subscribe to the same topic name, there is only one subscriber that can receive the message. Conversely, if subscribers are in different groups, they will all receive messages.

In the same application, you can specify Group property to keep subscriptions in different subscribe groups:


[CapSubscribe("xxx.services.show.time", Group = "group1" )]
public void ShowTime1(DateTime datetime)
{
}

[CapSubscribe("xxx.services.show.time", Group = "group2")]
public void ShowTime2(DateTime datetime)
{
}

ShowTime1 and ShowTime2 will be called one after another because all received messages are processed linear. You can change that behaviour to set UseDispatchingPerGroup true.

BTW, You can specify the default group name in the configuration:

services.AddCap(x =>
{
    x.DefaultGroup = "default-group-name";  
});

Dashboard

CAP also provides dashboard pages, you can easily view messages that were sent and received. In addition, you can also view the message status in real time in the dashboard. Use the following command to install the Dashboard in your project.

PM> Install-Package DotNetCore.CAP.Dashboard

In the distributed environment, the dashboard built-in integrates Consul as a node discovery, while the realization of the gateway agent function, you can also easily view the node or other node data, It's like you are visiting local resources.

services.AddCap(x =>
{
    //...

    // Register Dashboard
    x.UseDashboard();

    // Register to Consul
    x.UseDiscovery(d =>
    {
        d.DiscoveryServerHostName = "localhost";
        d.DiscoveryServerPort = 8500;
        d.CurrentNodeHostName = "localhost";
        d.CurrentNodePort = 5800;
        d.NodeId = 1;
        d.NodeName = "CAP No.1 Node";
    });
});

The default dashboard address is :http://localhost:xxx/cap, you can configure relative path /cap with x.UseDashboard(opt =>{ opt.MatchPath="/mycap"; }).

Contribute

One of the easiest ways to contribute is to participate in discussions and discuss issues. You can also contribute by submitting pull requests with code changes.

License

MIT

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (150)

Showing the top 5 NuGet packages that depend on DotNetCore.CAP:

Package Downloads
DotNetCore.CAP.RabbitMQ

Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern.

DotNetCore.CAP.SqlServer

Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern.

DotNetCore.CAP.Dashboard

Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern.

DotNetCore.CAP.MySql

Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern.

DotNetCore.CAP.InMemoryStorage

Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern.

GitHub repositories (15)

Showing the top 5 popular GitHub repositories that depend on DotNetCore.CAP:

Repository Stars
SkyAPM/SkyAPM-dotnet
The .NET/.NET Core instrument agent for Apache SkyWalking
AlphaYu/Adnc
.NET6微服务/分布式开发框架,同时也适用于单体架构系统的开发。
bing-framework/Bing.NetCore
Bing是基于 .net core 3.1 的框架,旨在提升团队的开发输出能力,由常用公共操作类(工具类、帮助类)、分层架构基类,第三方组件封装,第三方业务接口封装等组成。
colinin/abp-next-admin
这是基于vue-vben-admin 模板适用于abp Vnext的前端管理项目
91270/Meiam.System
.NET 5 / .NET Core 3.1 WebAPI + Vue 2.0 + RBAC 企业级前后端分离权限框架
Version Downloads Last updated
7.0.0 719 11/27/2022
7.0.0-preview-186133345 40 11/25/2022
7.0.0-preview-185881699 40 11/22/2022
7.0.0-preview-185533510 46 11/18/2022
7.0.0-preview-185469232 36 11/18/2022
7.0.0-preview-185451687 40 11/17/2022
6.2.1 25,999 10/15/2022
6.2.1-preview-180716003 364 9/23/2022
6.2.0 18,725 9/19/2022
6.1.1 1,391 9/19/2022
6.1.1-preview-176300030 322 8/3/2022
6.1.1-preview-175769056 98 7/28/2022
6.1.0 173,980 6/10/2022
6.1.0-preview-165373954 667 3/30/2022
6.1.0-preview-163077268 678 3/3/2022
6.1.0-preview-162971117 83 3/2/2022
6.0.1 236,443 2/15/2022
6.0.0 118,337 1/6/2022
6.0.0-preview-153999281 2,402 11/18/2021
5.2.0 164,083 11/12/2021
5.2.0-preview-152861792 867 11/5/2021
5.2.0-preview-150458135 1,408 10/8/2021
5.1.4 138,486 9/29/2021
5.1.4-preview-147174683 12,723 8/31/2021
5.1.3 94,016 8/18/2021
5.1.3-preview-144669387 6,058 8/2/2021
5.1.3-preview-144222698 831 7/28/2021
5.1.2 118,056 7/26/2021
5.1.2-preview-143176668 952 7/16/2021
5.1.1 99,692 7/9/2021
5.1.1-preview-141622241 861 6/29/2021
5.1.1-preview-140603701 755 6/16/2021
5.1.0 63,447 6/7/2021
5.1.0-preview-138879827 773 5/27/2021
5.0.3 65,644 5/14/2021
5.0.2 52,852 4/28/2021
5.0.2-preview-136262472 622 4/27/2021
5.0.2-preview-136113481 677 4/25/2021
5.0.2-preview-135224594 708 4/15/2021
5.0.2-preview-134636747 647 4/8/2021
5.0.1 86,110 4/7/2021
5.0.1-preview-133783177 626 3/29/2021
5.0.0 22,565 3/23/2021
5.0.0-preview-132888327 766 3/19/2021
5.0.0-preview-132124922 1,683 3/10/2021
5.0.0-preview-131679580 1,814 3/5/2021
5.0.0-preview-126609691 7,156 1/5/2021
3.1.2 331,399 12/3/2020
3.1.2-preview-121943182 1,198 11/12/2020
3.1.2-preview-120665033 1,119 10/29/2020
3.1.2-preview-120490779 946 10/26/2020
3.1.2-preview-119453473 1,124 10/14/2020
3.1.1 302,960 9/23/2020
3.1.1-preview-115802637 1,082 9/2/2020
3.1.0 274,738 8/15/2020
3.1.0-preview-114160390 1,047 8/14/2020
3.1.0-preview-112969177 4,441 7/31/2020
3.1.0-preview-112250362 1,216 7/23/2020
3.1.0-preview-111117527 1,979 7/10/2020
3.1.0-preview-108719052 1,617 6/12/2020
3.0.4 153,922 5/27/2020
3.0.4-preview-106413158 1,049 5/16/2020
3.0.4-preview-103991021 1,826 4/18/2020
3.0.4-preview-102596937 5,160 4/2/2020
3.0.4-preview-102593320 1,001 4/2/2020
3.0.3 70,379 4/1/2020
3.0.3-preview-98619331 11,977 2/16/2020
3.0.2 50,569 2/5/2020
3.0.2-preview-97503759 1,173 2/3/2020
3.0.1 17,584 1/19/2020
3.0.1-preview-95233114 1,192 1/8/2020
3.0.1-preview-94915444 1,399 1/4/2020
3.0.0 64,161 12/30/2019
3.0.0-preview-93361469 1,869 12/17/2019
3.0.0-preview-92995853 1,264 12/13/2019
3.0.0-preview-92907246 1,049 12/12/2019
2.6.0 154,269 8/29/2019
2.6.0-preview-82454970 3,179 8/14/2019
2.6.0-preview-82001197 2,715 8/8/2019
2.6.0-preview-80821564 1,722 7/25/2019
2.6.0-preview-79432176 2,631 7/9/2019
2.5.1 103,241 6/21/2019
2.5.1-preview-75824665 8,746 5/28/2019
2.5.1-preview-73792921 1,810 5/5/2019
2.5.1-preview-73031417 1,332 4/26/2019
2.5.0 168,580 3/30/2019
2.5.0-preview-69219007 2,994 3/14/2019
2.5.0-preview-69210974 1,342 3/13/2019
2.5.0-preview-68640186 13,046 3/6/2019
2.5.0-preview-67093158 1,423 2/16/2019
2.4.2 37,521 1/8/2019
2.4.2-preview-62147279 1,519 12/21/2018
2.4.1 2,591 12/19/2018
2.4.0 3,182 12/8/2018
2.4.0-preview-58415569 1,582 11/8/2018
2.4.0-preview-58238865 1,365 11/6/2018
2.3.1 24,900 10/29/2018
2.3.1-preview-57307518 1,433 10/26/2018
2.3.1-preview-53660607 1,418 9/25/2018
2.3.1-preview-53320926 1,405 9/10/2018
2.3.0 27,558 8/30/2018
2.2.6-preview-50057154 1,603 8/3/2018
2.2.6-preview-50053657 1,478 8/3/2018
2.2.6-preview-49112414 1,505 7/23/2018
2.2.5 5,531 7/19/2018
2.2.5-preview-45566217 1,494 6/12/2018
2.2.5-preview-45139132 1,466 6/7/2018
2.2.4 10,262 6/5/2018
2.2.3-preview-43309801 1,661 5/17/2018
2.2.2 17,728 4/28/2018
2.2.2-preview-40816597 1,605 4/18/2018
2.2.1 4,310 4/18/2018
2.2.0 2,957 4/17/2018
2.2.0-preview-40294348 1,392 4/12/2018
2.2.0-preview-38490295 1,508 3/23/2018
2.2.0-preview-37969809 2,214 3/16/2018
2.2.0-preview-37943663 1,301 3/16/2018
2.1.4 2,760 3/16/2018
2.1.4-preview-34848409 2,814 2/8/2018
2.1.4-preview-34825232 1,329 2/8/2018
2.1.4-preview-33704197 1,289 1/26/2018
2.1.3 6,901 1/24/2018
2.1.3-preview-33358922 1,278 1/22/2018
2.1.3-preview-33191223 1,253 1/20/2018
2.1.3-preview-31198104 2,395 12/28/2017
2.1.2 3,456 12/18/2017
2.1.2-preview-30288174 1,349 12/17/2017
2.1.2-preview-30286136 1,363 12/17/2017
2.1.2-preview-29226626 1,480 12/5/2017
2.1.2-preview-28879945 1,316 12/1/2017
2.1.2-preview-28782089 1,236 12/1/2017
2.1.1 2,170 11/28/2017
2.1.1-preview-28628301 1,228 11/28/2017
2.1.1-preview-28414190 1,278 11/26/2017
2.1.0 2,295 11/17/2017
2.1.0-preview-26231671 1,575 10/31/2017
2.1.0-preview-25885614 1,220 10/30/2017
2.0.2 2,091 9/29/2017
2.0.1 2,067 9/16/2017
2.0.1-preview-21560113 1,309 9/7/2017
2.0.1-preview-21392243 1,246 9/5/2017
2.0.0 2,241 9/1/2017
2.0.0-preview-20091963 1,289 8/21/2017
2.0.0-preview-19793485 1,296 8/18/2017
1.2.0-preview-00019208119 1,256 8/11/2017
1.1.1-preview-00018720262 1,117 8/5/2017
1.1.0 2,149 8/4/2017
1.1.0-preview-00018359725 1,131 8/1/2017
1.1.0-preview-00018287510 1,175 8/1/2017
1.1.0-preview-00018199934 1,185 7/30/2017
1.1.0-preview-00017833331 1,151 7/27/2017
1.1.0-preview-00017748473 1,197 7/25/2017
1.0.1 1,697 7/24/2017
1.0.1-preview-00017636063 1,045 7/24/2017
1.0.1-preview-00017490435 1,043 7/22/2017
1.0.1-preview-00017285652 1,017 7/20/2017
1.0.0 2,080 7/19/2017
0.1.0-ci-00016390477 969 7/9/2017
0.1.0-ci-00016261636 947 7/8/2017
0.1.0-ci-00016020116 980 7/5/2017
0.1.0-ci-00016011622 1,032 7/5/2017
0.1.0-ci-00015583876 1,064 6/30/2017