前言
上一篇【.Net Core微服務入門全紀錄（五）——Ocelot-API閘道器（下）】中已經完成了Ocelot + Consul的搭建，這一篇簡單說一下EventBus。
EventBus-事件匯流排
- 首先，什麼是事件匯流排呢？
貼一段引用：
事件匯流排是對觀察者（釋出-訂閱）模式的一種實現。它是一種集中式事件處理機制，允許不同的元件之間進行彼此通訊而又不需要相互依賴，達到一種解耦的目的。
如果沒有接觸過EventBus，可能不太好理解。其實EventBus在客戶端開發中應用非常廣泛（android，ios，web前端等），用於多個元件（或者介面）之間的相互通訊，懂的人都懂。。。
- 那麼，我們為什麼要用EventBus呢？
就拿當前的專案舉例，我們有一個訂單服務，一個產品服務。客戶端有一個下單功能，當使用者下單時，呼叫訂單服務的下單介面，那麼下單介面需要呼叫產品服務的減庫存介面，這涉及到服務與服務之間的呼叫。那麼服務之間又怎麼呼叫呢？直接RESTAPI？或者效率更高的gRPC？可能這兩者各有各的使用場景，但是他們都存在一個服務之間的耦合問題，或者難以做到非同步呼叫。
試想一下：假設我們下單時呼叫訂單服務，訂單服務需要呼叫產品服務，產品服務又要呼叫物流服務，物流服務再去呼叫xx服務 等等。。。如果每個服務處理時間需要2s，不使用非同步的話，那這種體驗可想而知。
如果使用EventBus的話，那麼訂單服務只需要向EventBus發一個“下單事件”就可以了。產品服務會訂閱“下單事件”，當產品服務收到下單事件時，自己去減庫存就好了。這樣就避免了兩個服務之間直接呼叫的耦合性，並且真正做到了非同步呼叫。
既然涉及到多個服務之間的非同步呼叫，那麼就不得不提分散式事務。分散式事務並不是微服務獨有的問題，而是所有的分散式系統都會存在的問題。
關於分散式事務，可以查一下“CAP原則”和“BASE理論”瞭解更多。當今的分散式系統更多的會追求事務的最終一致性。
下面使用國人開發的優秀專案“CAP”，來演示一下EventBus的基本使用。之所以使用“CAP”是因為它既能解決分散式系統的最終一致性，同時又是一個EventBus，它具備EventBus的所有功能！
作者介紹：https://www.cnblogs.com/savorboard/p/cap.html
CAP使用
- 環境準備
在Docker中準備一下需要的環境，首先是資料庫，資料庫我使用PostgreSQL，用別的也行。CAP支援：SqlServer，MySql，PostgreSql，MongoDB。
關於在Docker中執行PostgreSQL可以看我的另一篇部落格：https://www.cnblogs.com/xhznl/p/13155054.html
然後是MQ，這裡我使用RabbitMQ，Kafka也可以。
Docker執行RabbitMQ：
docker pull rabbitmq:management
docker run -d -p 15672:15672 -p 5672:5672 --name rabbitmq rabbitmq:management
預設使用者：guest，密碼：guest
環境準備就完成了，Docker就是這麼方便。。。
- 程式碼修改：
為了模擬以上業務，需要修改大量程式碼，下面程式碼如有遺漏的直接去github找。
NuGet安裝：
Microsoft.EntityFrameworkCore
Microsoft.EntityFrameworkCore.Tools
Npgsql.EntityFrameworkCore.PostgreSQL
CAP相關：
DotNetCore.CAP
DotNetCore.CAP.RabbitMQ
DotNetCore.CAP.PostgreSql
Order.API/Controllers/OrdersController.cs增加下單介面：
[Route("[controller]")]
[ApiController]
public class OrdersController : ControllerBase
{
private readonly ILogger<OrdersController> _logger;
private readonly IConfiguration _configuration;
private readonly ICapPublisher _capBus;
private readonly OrderContext _context;
public OrdersController(ILogger<OrdersController> logger, IConfiguration configuration, ICapPublisher capPublisher, OrderContext context)
{
_logger = logger;
_configuration = configuration;
_capBus = capPublisher;
_context = context;
}
[HttpGet]
public IActionResult Get()
{
string result = $"【訂單服務】{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")}——" +
$"{Request.HttpContext.Connection.LocalIpAddress}:{_configuration["ConsulSetting:ServicePort"]}";
return Ok(result);
}
/// <summary>
/// 下單 釋出下單事件
/// </summary>
/// <param name="order"></param>
/// <returns></returns>
[Route("Create")]
[HttpPost]
public async Task<IActionResult> CreateOrder(Models.Order order)
{
using (var trans = _context.Database.BeginTransaction(_capBus, autoCommit: true))
{
//業務程式碼
order.CreateTime = DateTime.Now;
_context.Orders.Add(order);
var r = await _context.SaveChangesAsync() > 0;
if (r)
{
//釋出下單事件
await _capBus.PublishAsync("order.services.createorder", new CreateOrderMessageDto() { Count = order.Count, ProductID = order.ProductID });
return Ok();
}
return BadRequest();
}
}
}
Order.API/MessageDto/CreateOrderMessageDto.cs：
/// <summary>
/// 下單事件訊息
/// </summary>
public class CreateOrderMessageDto
{
/// <summary>
/// 產品ID
/// </summary>
public int ProductID { get; set; }
/// <summary>
/// 購買數量
/// </summary>
public int Count { get; set; }
}
Order.API/Models/Order.cs訂單實體類：
public class Order
{
[Key]
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
public int ID { get; set; }
/// <summary>
/// 下單時間
/// </summary>
[Required]
public DateTime CreateTime { get; set; }
/// <summary>
/// 產品ID
/// </summary>
[Required]
public int ProductID { get; set; }
/// <summary>
/// 購買數量
/// </summary>
[Required]
public int Count { get; set; }
}
Order.API/Models/OrderContext.cs資料庫Context：
public class OrderContext : DbContext
{
public OrderContext(DbContextOptions<OrderContext> options)
: base(options)
{
}
public DbSet<Order> Orders { get; set; }
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
}
}
Order.API/appsettings.json增加資料庫連線字串：
"ConnectionStrings": {
"OrderContext": "User ID=postgres;Password=pg123456;Host=host.docker.internal;Port=5432;Database=Order;Pooling=true;"
}
Order.API/Startup.cs修改ConfigureServices方法，新增Cap配置：
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
services.AddDbContext<OrderContext>(opt => opt.UseNpgsql(Configuration.GetConnectionString("OrderContext")));
//CAP
services.AddCap(x =>
{
x.UseEntityFramework<OrderContext>();
x.UseRabbitMQ("host.docker.internal");
});
}
以上是訂單服務的修改。
Product.API/Controllers/ProductsController.cs增加減庫存介面：
[Route("[controller]")]
[ApiController]
public class ProductsController : ControllerBase
{
private readonly ILogger<ProductsController> _logger;
private readonly IConfiguration _configuration;
private readonly ICapPublisher _capBus;
private readonly ProductContext _context;
public ProductsController(ILogger<ProductsController> logger, IConfiguration configuration, ICapPublisher capPublisher, ProductContext context)
{
_logger = logger;
_configuration = configuration;
_capBus = capPublisher;
_context = context;
}
[HttpGet]
public IActionResult Get()
{
string result = $"【產品服務】{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")}——" +
$"{Request.HttpContext.Connection.LocalIpAddress}:{_configuration["ConsulSetting:ServicePort"]}";
return Ok(result);
}
/// <summary>
/// 減庫存 訂閱下單事件
/// </summary>
/// <param name="message"></param>
/// <returns></returns>
[NonAction]
[CapSubscribe("order.services.createorder")]
public async Task ReduceStock(CreateOrderMessageDto message)
{
//業務程式碼
var product = await _context.Products.FirstOrDefaultAsync(p => p.ID == message.ProductID);
product.Stock -= message.Count;
await _context.SaveChangesAsync();
}
}
Product.API/MessageDto/CreateOrderMessageDto.cs：
/// <summary>
/// 下單事件訊息
/// </summary>
public class CreateOrderMessageDto
{
/// <summary>
/// 產品ID
/// </summary>
public int ProductID { get; set; }
/// <summary>
/// 購買數量
/// </summary>
public int Count { get; set; }
}
Product.API/Models/Product.cs產品實體類：
public class Product
{
[Key]
[DatabaseGenerated(DatabaseGeneratedOption.Identity)]
public int ID { get; set; }
/// <summary>
/// 產品名稱
/// </summary>
[Required]
[Column(TypeName = "VARCHAR(16)")]
public string Name { get; set; }
/// <summary>
/// 庫存
/// </summary>
[Required]
public int Stock { get; set; }
}
Product.API/Models/ProductContext.cs資料庫Context：
public class ProductContext : DbContext
{
public ProductContext(DbContextOptions<ProductContext> options)
: base(options)
{
}
public DbSet<Product> Products { get; set; }
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
base.OnModelCreating(modelBuilder);
//初始化種子資料
modelBuilder.Entity<Product>().HasData(new Product
{
ID = 1,
Name = "產品1",
Stock = 100
},
new Product
{
ID = 2,
Name = "產品2",
Stock = 100
});
}
}
Product.API/appsettings.json增加資料庫連線字串：
"ConnectionStrings": {
"ProductContext": "User ID=postgres;Password=pg123456;Host=host.docker.internal;Port=5432;Database=Product;Pooling=true;"
}
Product.API/Startup.cs修改ConfigureServices方法，新增Cap配置：
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
services.AddDbContext<ProductContext>(opt => opt.UseNpgsql(Configuration.GetConnectionString("ProductContext")));
//CAP
services.AddCap(x =>
{
x.UseEntityFramework<ProductContext>();
x.UseRabbitMQ("host.docker.internal");
});
}
以上是產品服務的修改。
訂單服務和產品服務的修改到此就完成了，看著修改很多，其實功能很簡單。就是各自增加了自己的資料庫表，然後訂單服務增加了下單介面，下單介面會發出“下單事件”。產品服務增加了減庫存介面，減庫存介面會訂閱“下單事件”。然後客戶端呼叫下單介面下單時，產品服務會減去相應的庫存，功能就這麼簡單。
關於EF資料庫遷移之類的基本使用就不介紹了。使用Docker重新構建映象，執行訂單服務，產品服務：
docker build -t orderapi:1.1 -f ./Order.API/Dockerfile .
docker run -d -p 9060:80 --name orderservice orderapi:1.1 --ConsulSetting:ServicePort="9060"
docker run -d -p 9061:80 --name orderservice1 orderapi:1.1 --ConsulSetting:ServicePort="9061"
docker run -d -p 9062:80 --name orderservice2 orderapi:1.1 --ConsulSetting:ServicePort="9062"
docker build -t productapi:1.1 -f ./Product.API/Dockerfile .
docker run -d -p 9050:80 --name productservice productapi:1.1 --ConsulSetting:ServicePort="9050"
docker run -d -p 9051:80 --name productservice1 productapi:1.1 --ConsulSetting:ServicePort="9051"
docker run -d -p 9052:80 --name productservice2 productapi:1.1 --ConsulSetting:ServicePort="9052"
最後 Ocelot.APIGateway/ocelot.json 增加一條路由配置：
好了，進行到這裡，整個環境就有點複雜了。確保我們的PostgreSQL，RabbitMQ，Consul，Gateway，服務例項都正常執行。
服務例項執行成功後，資料庫應該是這樣的：
產品表種子資料：
cap.published表和cap.received表是由CAP自動生成的，它內部是使用本地訊息表+MQ來實現非同步確保。
執行測試
這次使用Postman作為客戶端呼叫下單介面（9070是之前的Ocelot閘道器埠）：
訂單庫published表：
訂單庫order表：
產品庫received表：
產品庫product表：
再試一下：
OK，完成。雖然功能很簡單，但是我們實現了服務的解耦，非同步呼叫，和最終一致性。
總結
注意，上面的例子純粹是為了說明EventBus的使用，實際中的下單流程絕對不會這麼做的！希望大家不要較真。。。
可能有人會說如果下單成功，但是庫存不足導致減庫存失敗了怎麼辦，是不是要回滾訂單表的資料？如果產生這種想法，說明還沒有真正理解最終一致性的思想。首先下單前肯定會檢查一下庫存數量，既然允許下單那麼必然是庫存充足的。這裡的事務是指：訂單儲存到資料庫，和下單事件儲存到cap.published表（儲存到cap.published表理論上就能夠傳送到MQ）這兩件事情，要麼一同成功，要麼一同失敗。如果這個事務成功，那麼就可以認為這個業務流程是成功的，至於產品服務的減庫存是否成功那就是產品服務的事情了（理論上也應該是成功的，因為訊息已經確保發到了MQ，產品服務必然會收到訊息），CAP也提供了失敗重試，和失敗回撥機制。
如果非要資料回滾也是能實現的，CAP的ICapPublisher.Publish方法提供一個callbackName引數，當減庫存時，可以觸發這個回撥。其本質也是通過釋出訂閱完成，這是不推薦的做法，就不詳細說了，有興趣自己研究一下。
另外，CAP無法保證訊息不重複，實際使用中需要自己考慮一下訊息的重複過濾和冪等性。
這一篇內容有點多，不知道有沒有表達清楚，有問題歡迎評論交流，如有不對之處還望大家指出。
下一篇計劃寫一下授權認證相關的內容。
程式碼放在：https://github.com/xiajingren/NetCoreMicroserviceDemo
未完待續...