.NET 8.0 開源計畫偽微服務框架

2024-03-08碼農

1、前言

為什麽說是偽微服務框架，常見微服務框架可能還包括服務容錯、服務間的通訊、服務追蹤和監控、服務註冊和發現等等，而我這裏為了在使用中的更簡單，將很多東西進行了簡化或者省略了。

年前到現在在開發一個新的小計畫，剛好計畫最初的很多功能是比較通用的，所以就想著將這些功能抽離出來，然後做成一個通用的基礎服務，然後其他計畫可以直接參照這個基礎服務，這樣就可以減少很多重復的工作了。

我在做的過程中也是參考了公司原有的一個計畫，目標是盡量的簡單，但是計畫搞著搞著就越來越大了，所以我也是在不斷的進行簡化和最佳化。

當然我的思考和架構能力還存在很大的問題，另外還由於時間比較倉促，很多東西還沒有經過我的深思熟慮，而且現在計畫還在初期的開發階段，問題肯定是有很多的，這裏也是希望自己透過整理出來，加深對計畫的理解，也希望如果大家能夠給我一點指導和建議那就更好了。

總之，後期會慢慢最佳化和完善這個計畫，也會在這裏記錄下來。後端如果差不多了，就會進行前端計畫的開發，然後再進行整合。

直接上github連結：https://github.com/aehyok/NET8.0

現階段部署的一個單節點的服務：http://101.200.243.192:8080/docs/index.html

2、全文思維導航圖

其中列舉了我覺得比較重點的一些知識點吧，當然其實還有很多知識點，可能我忽略掉了，後期有時間看到了還會加進來。

3、簡單整體框架

首先我將sun.Core作為了中轉，其他外部或者自己封裝的類別庫，在參照的時候都是在sun.Core中進行的參照，算是間接參照，來簡化計畫中的依賴關系。同時在sun.Core也封裝了一些核心元件和服務。

sun.Infrastructure 其中主要封裝一些通用的方法，以及基礎設施元件，供外部使用。

4、已實作業務功能

這裏通常建議使用建構函式註入的方式，而且在.NET8.0中新增加了主建構函式的語法糖，使聲明建構函式的參數更加簡潔

沒有使用主建構函式的方式

public classDictController : BasicControllerBase { privatereadonly IDictionaryGroupService dictionaryGroupService; privatereadonly IDictionaryItemService dictionaryItemService; publicDictController(IDictionaryGroupService dictionaryGroupService, IDictionaryItemService dictionaryItemService) { this.dictionaryGroupService = dictionaryGroupService; this.dictionaryItemService = dictionaryItemService; }

使用主建構函式之後的方法，看上去程式碼就簡潔了很多

public class DictionaryController( IDictionaryGroupService dictionaryGroupService, IDictionaryItemService dictionaryItemService) : BasicControllerBase { }

var token = new UserToken() { ExpirationDate = DateTime.Now.AddHours(10), IpAddress = ipAddress.ToString(), PlatformType = platform, UserAgent = userAgent, UserId = user.Id, LoginType = LoginType.Login, RefreshTokenIsAvailable = true }; token.Token = StringExtensions.GenerateToken(user.Id.ToString(), token.ExpirationDate); token.TokenHash = StringExtensions.EncodeMD5(token.Token); token.RefreshToken = StringExtensions.GenerateToken(token.Token, token.ExpirationDate.AddMonths(1));

if (code === ResultEnum.NOT_LOGIN && !res.config.url?.includes("/basic/Token/Refresh")) { if (!isRefreshing) { isRefreshing = true; try { const { code, data } = await refreshTokenApi({ userId: storage.get(UserEnum.ACCESS_TOKEN_INFO).userId, refreshToken: storage.get(UserEnum.ACCESS_TOKEN_INFO).refreshToken }); if (code === ResultEnum.SUCCESS) { storage.set(UserEnum.ACCESS_TOKEN_INFO, data); res.config.headers.Authorization = `${data?.token}`; res.config.url = res.config.url?.replace("/api", ""); // token 重新整理後將陣列的方法重新執行 requests.forEach((cb) => cb(data?.token)); requests = []; // 重新請求完清空 // @ts-ignore return http.request(res.config, res.config.requestOptions); } } catch (err) { return Promise.reject(err); } finally { isRefreshing = false; } }

後端方法的實作則是透過RefreshToken進行確認身份，然後重新生成登入的token和refreshToken，以及重新設定token的過期時間，跟登入時的邏輯是一樣的。

7、實作Authentication安全授權

首先在初始化應用程式的時候註冊授權認證的中介軟體

builder.Services.AddAuthentication("Authorization-Token").AddScheme<RequestAuthenticationSchemeOptions, RequestAuthenticationHandler>("Authorization-Token", options => { });

然後來看一下我的RequestAuthenticationHandler具體實作如下

處理認證流程中的一個核心方法，這個方法返回 AuthenticateResult 來標記是否認證成功以及返回認證過後的票據（AuthenticationTicket）。

這樣後續便可以透過context.HttpContext.User.Identity.IsAuthenticated 來判斷是否已經認證

// 其他需要登入驗證的，則透過AuthenticationHandler進行使用者認證 if (!context.HttpContext.User.Identity.IsAuthenticated) { context.Result = new RequestJsonResult(new RequestResultModel(StatusCodes.Status401Unauthorized, "請先登入", null)); return; }

同時透過配置檔的方式，添加多個微服務計畫進行切換測試

直接透過以下程式碼

統一在Header中添加一個Menu-Code的參數

builder.ConfigureAppConfiguration((context, options) => { // 正式環境配置檔路徑 options.AddJsonFile(Path.Combine(AppContext.BaseDirectory, $"../etc/appsettings.json"), true, true); options.AddJsonFile(Path.Combine(AppContext.BaseDirectory, $"../etc/{moduleKey}-appsettings.json"), true, true); // 本地開發環境配置檔路徑 options.AddJsonFile(Path.Combine(AppContext.BaseDirectory, $"../../../../../../etc/appsettings.json"), true, true); options.AddJsonFile(Path.Combine(AppContext.BaseDirectory, $"../../../../../../etc/{moduleKey}-appsettings.json"), true, true); });

其中還可以對日誌封裝一些特殊欄位，方便檢視日誌，定位問題的欄位。例如下面我封裝了三個特殊欄位

IpAddressEnricher 在日誌中記錄請求的 IP 地址

TokenEnricher 將TokenId寫入日誌

WorkerEnricher 將配置檔中的WorkId寫入日誌

然後遍可以在seq視覺化平台進行檢視定位問題

實作IAsyncExceptionFilter介面，統一記錄錯誤日誌，以及統一返回前端錯誤

11、透過實作過濾器IAsyncActionFilter結合反射來記錄操作日誌，並透過請求頭中的Menu-Code來辨別具體介面

直接看一下對過濾器IAsyncActionFilter的實作

姑且有關RabbitMQ的內容我下面會繼續記錄，這裏暫時就點到為止。

12、透過實作IAsyncAuthorizationFilter來驗證使用者身份，並判斷介面存取的許可權

先看一下對IAsyncAuthorizationFilter介面的實作

///<summary> /// 請求介面許可權過濾器而AuthenticationHandler則是使用者認證，token認證 ///</summary> public class RequestAuthorizeFilter(IPermissionService permissionService) : IAsyncAuthorizationFilter { publicasync Task OnAuthorizationAsync(AuthorizationFilterContext context) { // 介面標記了[AllowAnonymous]，則不需要進行許可權驗證 if (context.ActionDescriptor.EndpointMetadata.Any(a => a.GetType() == typeof(AllowAnonymousAttribute))) { return; } // 其他需要登入驗證的，則透過AuthenticationHandler進行使用者認證 if (!context.HttpContext.User.Identity.IsAuthenticated) { context.Result = new RequestJsonResult(new RequestResultModel(StatusCodes.Status401Unauthorized, "請先登入", null)); return; } if (context.ActionDescriptor is not null && context.ActionDescriptor is ControllerActionDescriptor descriptor) { var namespaceStr = descriptor.ControllerTypeInfo.Namespace; var controllerName = descriptor.ControllerName; var actionName = descriptor.ActionName; var code = $"{namespaceStr}.{controllerName}.{actionName}"; var menuCode = string.Empty; if (context.HttpContext.Request.Headers.ContainsKey("Menu-Code") && !string.IsNullOrEmpty(context.HttpContext.Request.Headers["Menu-Code"])) { menuCode = context.HttpContext.Request.Headers["Menu-Code"].ToString(); } // 透過menuCode找到選單Id，透過code找到介面Id var hasPermission = false; //有些操作是不在選單下面的，則預設有存取介面的許可權 if (string.IsNullOrEmpty(menuCode)) { hasPermission = true; } hasPermission = await permissionService.JudgeHasPermissionAsync(code, menuCode); if (hasPermission) { return; } context.Result = new RequestJsonResult(new RequestResultModel(StatusCodes.Status403Forbidden, "暫無許可權", null)); await Task.CompletedTask; } } }

} // 比如直接return Ok(); elseif(context.Result is StatusCodeResult statusCodeResult) { var resultModel = new RequestResultModel { Code = statusCodeResult.StatusCode, Message = statusCodeResult.StatusCode == 200 ? "Success" : "請求發生錯誤", Data = statusCodeResult.StatusCode == 200 }; context.Result = new RequestJsonResult(resultModel); } elseif(context.Result is ObjectResult result) { if(result.Value isnull) { var resultModel = new RequestResultModel { Code = result.StatusCode ?? context.HttpContext.Response.StatusCode, Message = "未請求到數據" }; context.Result = new RequestJsonResult(resultModel); } elseif(result.Value is not RequestJsonResult) { if (result.Value is IPagedList pagedList) { var resultModel = new RequestPagedResultModel { Message = "Success", Data = result.Value, Total = pagedList.TotalItemCount, Page = pagedList.PageNumber, TotalPage = pagedList.PageCount, Limit = pagedList.PageSize, Code = result.StatusCode ?? context.HttpContext.Response.StatusCode }; context.Result = new RequestJsonResult(resultModel); } else { var resultModel = new RequestResultModel { Code = result.StatusCode ?? context.HttpContext.Response.StatusCode, Message = "Success", Data = result.Value }; context.Result = new RequestJsonResult(resultModel); } } } await next(); } }