Browse Source

Update Readme.md

Update English version Readme.md
master
Ian Ye 7 years ago
committed by GitHub
parent
commit
f4e91b2a95
1 changed files with 10 additions and 13 deletions
  1. +10
    -13
      README.md

+ 10
- 13
README.md View File

@@ -1,7 +1,6 @@
# CAP # CAP
[![Travis branch](https://img.shields.io/travis/dotnetcore/CAP/master.svg?label=travis-ci)](https://travis-ci.org/dotnetcore/CAP) [![Travis branch](https://img.shields.io/travis/dotnetcore/CAP/master.svg?label=travis-ci)](https://travis-ci.org/dotnetcore/CAP)
[![AppVeyor](https://ci.appveyor.com/api/projects/status/4mpe0tbu7n126vyw?svg=true)](https://ci.appveyor.com/project/yuleyule66/cap) [![AppVeyor](https://ci.appveyor.com/api/projects/status/4mpe0tbu7n126vyw?svg=true)](https://ci.appveyor.com/project/yuleyule66/cap)
[![NuGet](https://img.shields.io/nuget/vpre/DotNetCore.CAP.svg)](https://www.nuget.org/packages/DotNetCore.CAP/)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/dotnetcore/CAP/master/LICENSE.txt) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/dotnetcore/CAP/master/LICENSE.txt)


CAP is a library to achieve eventually consistent in distributed architectures system like SOA,MicroService. It is lightweight,easy to use and efficiently. CAP is a library to achieve eventually consistent in distributed architectures system like SOA,MicroService. It is lightweight,easy to use and efficiently.
@@ -16,7 +15,7 @@ CAP has the function of Message Presistence, and it makes messages reliability w


This is a diagram of the CAP working in the ASP.NET Core MicroService architecture: This is a diagram of the CAP working in the ASP.NET Core MicroService architecture:


![](http://images2015.cnblogs.com/blog/250417/201706/250417-20170630143600289-1065294295.png)
![](http://images2015.cnblogs.com/blog/250417/201707/250417-20170705175827128-1203291469.png)


> The solid line in the figure represents the user code, and the dotted line represents the internal implementation of the CAP. > The solid line in the figure represents the user code, and the dotted line represents the internal implementation of the CAP.


@@ -29,19 +28,19 @@ You can run the following command to install the CAP in your project.
If your Message Queue is using Kafka, you can: If your Message Queue is using Kafka, you can:


``` ```
PM> Install-Package DotNetCore.CAP.Kafka
PM> Install-Package DotNetCore.CAP.Kafka -Pre
``` ```


or RabbitMQ: or RabbitMQ:


``` ```
PM> Install-Package DotNetCore.CAP.RabbitMQ
PM> Install-Package DotNetCore.CAP.RabbitMQ -Pre
``` ```


CAP provides EntityFramework as default database store extension : CAP provides EntityFramework as default database store extension :


``` ```
PM> Install-Package DotNetCore.CAP.EntityFrameworkCore
PM> Install-Package DotNetCore.CAP.EntityFrameworkCore -Pre
``` ```


### Configuration ### Configuration
@@ -57,7 +56,7 @@ public void ConfigureServices(IServiceCollection services)


services.AddCap() services.AddCap()
.AddEntityFrameworkStores<AppDbContext>() .AddEntityFrameworkStores<AppDbContext>()
.AddKafka(x => x.Servers = "localhost:9453");
.AddKafka(x => x.Servers = "localhost:9092");
} }


public void Configure(IApplicationBuilder app) public void Configure(IApplicationBuilder app)
@@ -100,9 +99,7 @@ public class PublishController : Controller


**Action Method** **Action Method**


Add Attribute on Action to subscribe message:

If you are using Kafka the Attribute is `[KafkaTopic()]`, and RabbitMQ is `[RabbitMQTopic()]`
Add the Attribute `[CapSubscribe()]` on Action to subscribe message:


```cs ```cs
public class PublishController : Controller public class PublishController : Controller
@@ -116,7 +113,7 @@ public class PublishController : Controller




[NoAction] [NoAction]
[KafkaTopic("xxx.services.account.check")]
[CapSubscribe("xxx.services.account.check")]
public async Task CheckReceivedMessage(Person person) public async Task CheckReceivedMessage(Person person)
{ {
Console.WriteLine(person.Name); Console.WriteLine(person.Name);
@@ -129,7 +126,7 @@ public class PublishController : Controller


**Service Method** **Service Method**


If your subscribe method is not in the Controller,then your subscribe class need to Inheritance `IConsumerService`:
If your subscribe method is not in the Controller,then your subscribe class need to Inheritance `ICapSubscribe`:


```cs ```cs


@@ -141,9 +138,9 @@ namespace xxx.Service
} }




public class SubscriberService: ISubscriberService, IConsumerService
public class SubscriberService: ISubscriberService, ICapSubscribe
{ {
[KafkaTopic("xxx.services.account.check")]
[CapSubscribe("xxx.services.account.check")]
public void CheckReceivedMessage(Person person) public void CheckReceivedMessage(Person person)
{ {


Loading…
Cancel
Save