使用Func<T, TResult> 委托實現API日志的記錄
本文轉載自微信公眾號「UP技術控」,作者 conan5566 。轉載本文請聯系UP技術控公眾號。
問題
平常我們開發web api的時候,一般是需要記錄api的輸入輸出信息,方便后續排查問題;那么我們一般怎么做的,一般是我們在一個公共地方的寫個公共方法控制輸入輸出。這時候Func
什么是Func
Func<T, TResult>封裝一個具有一個參數并返回 TResult 參數指定的類型值的方法。使用Func<T, TResult> 委托表示一種能以參數形式傳遞的方法,而不用顯式聲明自定義委托。 封裝的方法必須與此委托定義的方法簽名相對應。 也就是說,封裝的方法必須具有一個通過值傳遞給它的參數,并且必須返回值。在使用 Func<T, TResult> 委托時,不必顯式定義一個封裝只有一個參數的方法的委托。
主要代碼實現
1、定義委托。
- private ApiResult HandleWork(CreateBQoolSyncEventModel syncModel, Func<ApiResult> work)
- {
- //先記錄到 Db Event
- _innerBQoolSyncEventLogService.Create(syncModel);
- var result = new ApiResult();
- try
- {
- _logger.Info($"Call Web Api Start, data:{syncModel.ToJsonString()}");
- result = work();
- if (!result.Success && !string.IsNullOrEmpty(result.Code) && string.IsNullOrEmpty(result.ErrorMessage))
- {
- result.ErrorMessage = ApiResultCode.ErrorMessages[result.Code];
- }
- }
- catch (Exception ex)
- {
- _logger.Error(ex.ToString());
- result.Success = false;
- if (string.IsNullOrEmpty(result.ErrorMessage))
- {
- result.ErrorMessage = ex.Message;
- }
- else
- {
- result.ErrorMessage += "; " + ex.Message;
- }
- }
- finally
- {
- _logger.Info($"Call Web Api End , result:{result.ToJsonString()}");
- //更新 Db event
- syncModel.SetStatus(result.Success ? BQoolSyncEventStatus.Success : BQoolSyncEventStatus.Failure);
- _innerBQoolSyncEventLogService.ChangeStatus(syncModel.Id, syncModel.Status, result.ErrorMessage);
- }
- return result;
- }
2、把方法當做參數,傳入委托。
- [HttpPost]
- public ApiResult ModuleFeatureSetting(ReviewsApiRequestModel model)
- {
- string data = StringTools.AESDecrypt(model.Encrypt);
- var param = JObject.Parse(data).ToObject<ModuleFeatureSettingParam>();
- ApiResult result = HandleWork(
- new CreateBQoolSyncEventModel(param.Account, BQoolSyncEventType.ModuleFeatureSetting, param)
- , () => _ReviewsSettingSyncService.ModuleFeatureSetting(param));
- return result;
- }
3、查看日志。