.NetCore 請求WebAPI響應信息記錄到數據庫

環境：.NetCore3.1、VS2019、Web API模板、SqlSugar、MSSqlServer

思路：我們要把每次HTTP請求響應的信息都保存到數據庫，因為每次HTTP都會走一遍中間件，我們可以把寫入數據庫的操作寫在自定義中間件上。但是它做的事情比較多，后續也可能變更需求，所有我決定把這個事情寫在自定義服務上，讓中間件使用該服務進行寫入數據庫操作。

1.新建服務對應的接口。

public interface IApiLogService
    {
        void DataSave(HttpContext context, long responseTime);
    }

 

2.新建服務。

2.1.需要安裝Nuget包sqlSugarCore，當然也可以使用其他ORM，本例只支持單例模式連接數據庫的ORM。

 

2.2.添加數據庫連接。需要在此數據庫連接字符串上的服務器地址新建數據庫，本人使用本地的SqlServer。

services.AddSingleton(new SqlSugarClient(new ConnectionConfig
            {
                ConnectionString = "server=.;uid=sa;pwd=sasa;database=apilogdemo;MultipleActiveResultSets=true",//必填, 數據庫連接字符串
                DbType = DbType.SqlServer,         //必填, 數據庫類型
                IsAutoCloseConnection = true,       //默認false, 時候知道關閉數據庫連接, 設置為true無需使用using或者Close操作
                InitKeyType = InitKeyType.SystemTable    //默認SystemTable, 字段信息讀取, 如：該屬性是不是主鍵，是不是標識列等等信息
            }));

public class ApiLogService : IApiLogService
    {
        private readonly IConfiguration _configuration;
        private readonly SqlSugarClient _dbContext;

        public ApiLogService(IConfiguration configuration, SqlSugarClient dbContext)
        {
            _configuration = configuration;
            _dbContext = dbContext;
        }

        public void DataSave(HttpContext context, long responseTime)
        {
            var isLog = _configuration.GetValue<bool>("ApiLog:IsEnable");
            if (isLog)
            {
                var requestMethod = context.Request.Method;
                var requestURL = $"{context.Request.Scheme}://{context.Request.Host}{context.Request.Path}";
                //var accessToken = context.GetTokenAsync("access_token").Result;//添加身份驗證的項目可以使用此方法獲取到access_toekn
                var accessToken = string.Empty;
                var requestBody = string.Empty;
                if (requestMethod == "POST")
                {
                    context.Request.Body.Seek(0, SeekOrigin.Begin);
                    var _reader = new StreamReader(context.Request.Body);
                    requestBody = _reader.ReadToEnd();
                }
                _dbContext.Insertable(new ApiLog
                {
                    AccessToken = accessToken,
                    AccessTime = DateTime.Now,
                    AccessAction = requestMethod,
                    AccessApiUrl = requestURL,
                    QueryString = context.Request.QueryString.ToString(),
                    Body = requestBody,
                    HttpStatus = context.Response.StatusCode,
                    ClientIP = context.Connection.RemoteIpAddress.ToString(),
                    ResponseTime = responseTime
                }).ExecuteCommand();
            }
        }
    }

 

2.3.需要在appsettion.json/appsetting.Development.json文件添加配置信息，用於控制是否啟用響應日志，當然也可以不控制。

"ApiLog": {
    "IsEnable": true
  }

 

2.4.添加響應日志實體，需要在數據庫上添加該表。

    /// <summary>
    /// 接口請求日志
    /// </summary>
    public class ApiLog
    {
        /// <summary>
        /// Desc:
        /// Default:
        /// Nullable:False
        /// </summary>           
        public int ALgID { get; set; }

        /// <summary>
        /// Desc:
        /// Default:
        /// Nullable:True
        /// </summary>           
        public string ClientIP { get; set; }

        /// <summary>
        /// Desc:
        /// Default:
        /// Nullable:False
        /// </summary>           
        public long ResponseTime { get; set; }

        /// <summary>
        /// Desc:
        /// Default:
        /// Nullable:True
        /// </summary>           
        public string AccessToken { get; set; }

        /// <summary>
        /// Desc:
        /// Default:
        /// Nullable:False
        /// </summary>           
        public DateTime AccessTime { get; set; }

        /// <summary>
        /// Desc:
        /// Default:
        /// Nullable:True
        /// </summary>           
        public string AccessApiUrl { get; set; }

        /// <summary>
        /// Desc:
        /// Default:
        /// Nullable:True
        /// </summary>           
        public string AccessAction { get; set; }

        /// <summary>
        /// Desc:
        /// Default:
        /// Nullable:True
        /// </summary>           
        public string QueryString { get; set; }

        /// <summary>
        /// Desc:
        /// Default:
        /// Nullable:True
        /// </summary>           
        public string Body { get; set; }

        /// <summary>
        /// Desc:
        /// Default:
        /// Nullable:False
        /// </summary>           
        public int HttpStatus { get; set; }
    }

 

3.此時，我們的服務已經定義好了。接下來是自定義一個中間件。

3.1.新建中間件，注入並使用剛才定義好的服務。

public class LogMiddleware
    {
        private readonly RequestDelegate _next;
        private readonly IApiLogService _apiLogService;
        private readonly IConfiguration _configration;

        public LogMiddleware(RequestDelegate next, IApiLogService apiLogService, IConfiguration configration)
        {
            _next = next;
            _apiLogService = apiLogService;
            _configration = configration;
        }

        public Task Invoke(HttpContext context)
        {
            var watch = new Stopwatch();
            watch.Start();
            context.Response.OnStarting(() =>
            {
                var isLog = _configration.GetValue<bool>("ApiLog:IsEnable");
                if (isLog)
                {
                    watch.Stop();
                    _apiLogService.DataSave(context, watch.ElapsedMilliseconds);
                }
                return Task.CompletedTask;
            });
            
            return this._next(context);
        }
    }

 

 3.2.新建暴露中間件擴展類。

public static class LogMiddlewareExtension
    {
        public static IApplicationBuilder UseLogMiddleware(this IApplicationBuilder builder)
        {
            return builder.UseMiddleware<LogMiddleware>();
        }
    }

 

4.我們的工作已經做好了，接下來使用自定義的中間件就可以了。

4.1.添加自定義服務

services.AddSingleton<IApiLogService, ApiLogService>();

 

 4.2.使用自定義中間件。

app.UseLogMiddleware();

 

 5.運行項目，查看效果。

 源碼地址：https://github.com/Jcanc/WebApiResponseLog