Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

README.zh-cn.md 5.4 KiB

il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
il y a 7 ans
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  1. # CAP                       [English](https://github.com/dotnetcore/CAP/blob/develop/README.md)
  2. [![Travis branch](https://img.shields.io/travis/dotnetcore/CAP/develop.svg?label=travis-ci)](https://travis-ci.org/dotnetcore/CAP)
  3. [![AppVeyor](https://ci.appveyor.com/api/projects/status/4mpe0tbu7n126vyw?svg=true)](https://ci.appveyor.com/project/yuleyule66/cap)
  4. [![NuGet](https://img.shields.io/nuget/v/DotNetCore.CAP.svg)](https://www.nuget.org/packages/DotNetCore.CAP/)
  5. [![NuGet Preview](https://img.shields.io/nuget/vpre/DotNetCore.CAP.svg?label=nuget-pre)](https://www.nuget.org/packages/DotNetCore.CAP/)
  6. [![Member project of .NET China Foundation](https://img.shields.io/badge/member_project_of-.NET_CHINA-red.svg?style=flat&colorB=9E20C8)](https://github.com/dotnetcore)
  7. [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/dotnetcore/CAP/master/LICENSE.txt)
  8. CAP 是一个在分布式系统(SOA、MicroService)中实现最终一致性的库,它具有轻量级、易使用、高性能等特点。
  9. ## 预览(OverView)
  10. CAP 是在一个 ASP.NET Core 项目中使用的库,当然他可以用于 ASP.NET Core On .NET Framework 中。
  11. 你可以把 CAP 看成是一个 EventBus,因为它具有 EventBus 的所有功能,并且 CAP 提供了更加简化的方式来处理 EventBus 中的发布和订阅。
  12. CAP 具有消息持久化的功能,当你的服务进行重启或者宕机时它可以保证消息的可靠性。CAP提供了基于Microsoft DI 的 Publisher Service 服务,它可以和你的业务服务进行无缝结合,并且支持强一致性的事务。
  13. 这是CAP集在ASP.NET Core 微服务架构中的一个示意图:
  14. ![](http://images2015.cnblogs.com/blog/250417/201707/250417-20170705175827128-1203291469.png)
  15. > 图中实线部分代表用户代码,虚线部分代表CAP内部实现。
  16. ## Getting Started
  17. ### NuGet
  18. 你可以运行以下下命令在你的项目中安装 CAP。
  19. ```
  20. PM> Install-Package DotNetCore.CAP
  21. ```
  22. 如果你的消息队列使用的是 Kafka 的话,你可以:
  23. ```
  24. PM> Install-Package DotNetCore.CAP.Kafka
  25. ```
  26. 如果你的消息队列使用的是 RabbitMQ 的话,你可以:
  27. ```
  28. PM> Install-Package DotNetCore.CAP.RabbitMQ
  29. ```
  30. CAP 默认提供了 Sql Server 的扩展作为数据库存储(MySql的正在开发中):
  31. ```
  32. PM> Install-Package DotNetCore.CAP.SqlServer
  33. ```
  34. ### Configuration
  35. 首先配置CAP到 Startup.cs 文件中,如下:
  36. ```cs
  37. public void ConfigureServices(IServiceCollection services)
  38. {
  39. ......
  40. services.AddDbContext<AppDbContext>();
  41. services.AddCap(x =>
  42. {
  43. // 如果你的 SqlServer 使用的 EF 进行数据操作,你需要添加如下配置:
  44. // 注意: 你不需要再次配置 x.UseSqlServer(""")
  45. x.UseEntityFramework<AppDbContext>();
  46. // 如果你使用的Dapper,你需要添加如下配置:
  47. x.UseSqlServer("数据库连接字符串");
  48. // 如果你使用的 RabbitMQ 作为MQ,你需要添加如下配置:
  49. x.UseRabbitMQ("localhost");
  50. //如果你使用的 Kafka 作为MQ,你需要添加如下配置:
  51. x.UseKafka("localhost");
  52. });
  53. }
  54. public void Configure(IApplicationBuilder app)
  55. {
  56. .....
  57. app.UseCap();
  58. }
  59. ```
  60. ### 发布
  61. 在 Controller 中注入 `ICapPublisher` 然后使用 `ICapPublisher` 进行消息发送
  62. ```cs
  63. public class PublishController : Controller
  64. {
  65. private readonly ICapPublisher _publisher;
  66. public PublishController(ICapPublisher publisher)
  67. {
  68. _publisher = publisher;
  69. }
  70. [Route("~/checkAccount")]
  71. public async Task<IActionResult> PublishMessage()
  72. {
  73. //指定发送的消息头和内容
  74. await _publisher.PublishAsync("xxx.services.account.check", new Person { Name = "Foo", Age = 11 });
  75. return Ok();
  76. }
  77. [Route("~/checkAccountWithTrans")]
  78. public async Task<IActionResult> PublishMessageWithTransaction([FromServices]AppDbContext dbContext)
  79. {
  80. using (var trans = dbContext.Database.BeginTransaction())
  81. {
  82. await _publisher.PublishAsync("xxx.services.account.check", new Person { Name = "Foo", Age = 11 });
  83. trans.Commit();
  84. }
  85. return Ok();
  86. }
  87. }
  88. ```
  89. ### 订阅
  90. **Action Method**
  91. 在 Action 上添加 CapSubscribeAttribute 来订阅相关消息。
  92. ```cs
  93. public class PublishController : Controller
  94. {
  95. private readonly ICapPublisher _publisher;
  96. public PublishController(ICapPublisher publisher)
  97. {
  98. _publisher = publisher;
  99. }
  100. [NoAction]
  101. [CapSubscribe("xxx.services.account.check")]
  102. public async Task CheckReceivedMessage(Person person)
  103. {
  104. Console.WriteLine(person.Name);
  105. Console.WriteLine(person.Age);
  106. return Task.CompletedTask;
  107. }
  108. }
  109. ```
  110. **Service Method**
  111. 如果你的订阅方法没有位于 Controller 中,则你订阅的类需要继承 `ICapSubscribe`:
  112. ```cs
  113. namespace xxx.Service
  114. {
  115. public interface ISubscriberService
  116. {
  117. public void CheckReceivedMessage(Person person);
  118. }
  119. public class SubscriberService: ISubscriberService, ICapSubscribe
  120. {
  121. [CapSubscribe("xxx.services.account.check")]
  122. public void CheckReceivedMessage(Person person)
  123. {
  124. }
  125. }
  126. }
  127. ```
  128. 然后在 Startup.cs 中的 `ConfigureServices()` 中注入你的 `ISubscriberService` 类
  129. ```cs
  130. public void ConfigureServices(IServiceCollection services)
  131. {
  132. services.AddTransient<ISubscriberService,SubscriberService>();
  133. }
  134. ```
  135. ## 贡献
  136. 贡献的最简单的方法之一就是是参与讨论和讨论问题(issue)。你也可以通过提交的 Pull Request 代码变更作出贡献。
  137. ### License
  138. MIT