使用Func<T, TResult> 委托实现API日志的记录

问题

平常我们开发web api的时候，一般是需要记录api的输入输出信息，方便后续排查问题；那么我们一般怎么做的，一般是我们在一个公共地方的写个公共方法控制输入输出。这时候Func<T, TResult> 委托就派上用场。

什么是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、查看日志。