eShopOnContainers 知多少[7]：Basket microservice
阿新 • • 發佈：2019-01-04
引言
Basket microservice（購物車微服務）主要用於處理購物車的業務邏輯，包括：
- 購物車商品的CRUD
- 訂閱商品價格更新事件，進行購物車商品同步處理
- 購物車結算事件釋出
- 訂閱訂單成功建立事件，進行購物車的清空操作
架構模式
如上圖所示，本微服務採用資料驅動的CRUD微服務架構，來執行購物車商品的維護操作。並使用Redis資料庫進行持久化。
這種型別的服務在單個 ASP.NET Core Web API 專案中即可實現所有功能，該專案包括資料模型類、業務邏輯類及其資料訪問類。其專案結構如下：
核心技術選型：
- ASP.NET Core Web API
- Entity Framework Core
- Redis
- Swashbuckle（可選）
- Autofac
- Eventbus
Newtonsoft.Json
實體建模和持久化
該微服務的核心領域實體是購物車，其類圖如下：
其中CustomerBasket與BasketItem為一對多關係，使用倉儲模式進行持久化。
- 通過對
CustomerBasket物件進行json格式的序列化和反序列化來完成在redis中的持久化和讀取。 - 以單例模式注入redis連線
ConnectionMultiplexer，該物件最終通過建構函式注入到RedisBasketRepository中。
services.AddSingleton<ConnectionMultiplexer>(sp => { var settings = sp.GetRequiredService<IOptions<BasketSettings>>().Value; var configuration = ConfigurationOptions.Parse(settings.ConnectionString, true); configuration.ResolveDns = true; return ConnectionMultiplexer.Connect(configuration); });
事件的註冊和消費
在本服務中主要需要處理以下事件的釋出和消費：
- 事件釋出：當用戶點選購物車結算時，釋出使用者結算事件。
- 事件消費：訂單建立成功後，進行購物車的清空
- 事件消費：商品價格更新後，進行購物車相關商品的價格同步
private void ConfigureEventBus(IApplicationBuilder app)
{
var eventBus = app.ApplicationServices.GetRequiredService<IEventBus>();
eventBus.Subscribe<ProductPriceChangedIntegrationEvent, ProductPriceChangedIntegrationEventHandler>();
eventBus.Subscribe<OrderStartedIntegrationEvent, OrderStartedIntegrationEventHandler>();
}以上都是基於事件匯流排來達成。
認證和授權
購物車管理介面是需要認證和授權。那自然需要與上游的Identity Microservice進行銜接。在啟動類進行認證中介軟體的配置。
private void ConfigureAuthService(IServiceCollection services)
{
// prevent from mapping "sub" claim to nameidentifier.
JwtSecurityTokenHandler.DefaultInboundClaimTypeMap.Clear();
var identityUrl = Configuration.GetValue<string>("IdentityUrl");
services.AddAuthentication(options =>
{
options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
}).AddJwtBearer(options =>
{
options.Authority = identityUrl;
options.RequireHttpsMetadata = false;
options.Audience = "basket";
});
}
protected virtual void ConfigureAuth(IApplicationBuilder app)
{
if (Configuration.GetValue<bool>("UseLoadTest"))
{
app.UseMiddleware<ByPassAuthMiddleware>();
}
app.UseAuthentication();
}手動啟用斷路器
在該微服務中，定義了一個中斷中介軟體：FailingMiddleware，通過訪問http://localhost:5103/failing獲取該中介軟體的啟用狀態，通過請求引數指定：即通過http://localhost:5103/failing?enable和http://localhost:5103/failing?disable來手動中斷和恢復服務，來模擬斷路，以便用於測試斷路器模式。
開啟斷路後，當訪問購物車頁面時，Polly在重試指定次數依然無法訪問服務時，就會丟擲BrokenCircuitException異常，通過捕捉該異常告知使用者稍後再試。
public class CartController : Controller
{
//…
public async Task<IActionResult> Index()
{
try
{
var user = _appUserParser.Parse(HttpContext.User);
//Http requests using the Typed Client (Service Agent)
var vm = await _basketSvc.GetBasket(user);
return View(vm);
}
catch (BrokenCircuitException)
{
// Catches error when Basket.api is in circuit-opened mode
HandleBrokenCircuitException();
}
return View();
}
private void HandleBrokenCircuitException()
{
TempData["BasketInoperativeMsg"] = "Basket Service is inoperative, please try later on. (Business message due to Circuit-Breaker)";
}
}
注入過濾器
在配置MVC服務時指定了兩個過濾器：全域性異常過濾器和模型驗證過濾器。
// Add framework services.
services.AddMvc(options =>
{
options.Filters.Add(typeof(HttpGlobalExceptionFilter));
options.Filters.Add(typeof(ValidateModelStateFilter));
}).AddControllersAsServices();- 全域性異常過濾器是通過定義
BasketDomainException異常和HttpGlobalExceptionFilter過濾器來實現的。 - 模型驗證過濾器是通過繼承
ActionFilterAttribute特性實現的ValidateModelStateFilter來獲取模型狀態中的錯誤。
public class ValidateModelStateFilter : ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext context)
{
if (context.ModelState.IsValid)
{
return;
}
var validationErrors = context.ModelState
.Keys
.SelectMany(k => context.ModelState[k].Errors)
.Select(e => e.ErrorMessage)
.ToArray();
var json = new JsonErrorResponse
{
Messages = validationErrors
};
context.Result = new BadRequestObjectResult(json);
}
}SwaggerUI認證授權整合
因為預設啟用了安全認證，所以為了方便在SwaggerUI介面進行測試，那麼我們就必須為其整合認證授權。程式碼如下：
services.AddSwaggerGen(options =>
{
options.DescribeAllEnumsAsStrings();
options.SwaggerDoc("v1", new Info
{
Title = "Basket HTTP API",
Version = "v1",
Description = "The Basket Service HTTP API",
TermsOfService = "Terms Of Service"
});
options.AddSecurityDefinition("oauth2", new OAuth2Scheme
{
Type = "oauth2",
Flow = "implicit",
AuthorizationUrl = $"{Configuration.GetValue<string>("IdentityUrlExternal")}/connect/authorize",
TokenUrl = $"{Configuration.GetValue<string>("IdentityUrlExternal")}/connect/token",
Scopes = new Dictionary<string, string>()
{
{ "basket", "Basket API" }
}
});
options.OperationFilter<AuthorizeCheckOperationFilter>();
});其中有主要做了三件事：
- 配置授權Url
- 配置TokenUrl
- 指定授權範圍
- 注入授權檢查過濾器
AuthorizeCheckOperationFilter用於攔截需要授權的請求
public class AuthorizeCheckOperationFilter : IOperationFilter
{
public void Apply(Operation operation, OperationFilterContext context)
{
// Check for authorize attribute
var hasAuthorize = context.ApiDescription.ControllerAttributes().OfType<AuthorizeAttribute>().Any() ||
context.ApiDescription.ActionAttributes().OfType<AuthorizeAttribute>().Any();
if (hasAuthorize)
{
operation.Responses.Add("401", new Response { Description = "Unauthorized" });
operation.Responses.Add("403", new Response { Description = "Forbidden" });
operation.Security = new List<IDictionary<string, IEnumerable<string>>>();
operation.Security.Add(new Dictionary<string, IEnumerable<string>>
{
{ "oauth2", new [] { "basketapi" } }
});
}
}
}最後
本服務較之前講的Catalog microservice 而言，主要是多了一個認證和redis儲存。