RuoVea.ExFilter 8.0.1.5

RuoVea.ExFilter

介绍

注入 进行全局的异常日志收集、执行操作日志、参数验证、对资源型信息进行过滤、对结果进行统一、接口安全校验、签名验证 MD5 ( appKey + signKey + timeStamp + data );支持简体中文、繁体中文、粤语、日语、法语、英语.

1.快速入门

通过Nuget安装组件

Install-Package RuoVea.ExFilter

2、使用示例

注入 进行全局的异常日志收集、执行操作日志、参数验证

builder.Services.ExceptionSetup();// 注入 全局错误日志

builder.Services.ExceptionSetup(ExceptionLog actionOptions);// 注入 全局错误日志

builder.Services.ExceptionSetup(builder.Configuration.GetSection("AopOption:ExceptionLog"));// 注入 全局错误日志

builder.Services.RequestActionSetup();// 注入 请求日志拦截 [执行操作日志、参数验证 ]

builder.Services.RequestActionSetup(RequestLog actionOptions);// 注入 请求日志拦截 [执行操作日志、参数验证 ]

builder.Services.RequestActionSetup(builder.Configuration.GetSection("AopOption:RequestLog"));// 注入 请求日志拦截 [执行操作日志、参数验证 ]

builder.Services.ResourceSetup();//对资源型信息进行过滤

builder.Services.ResultSetup();//对结果进行统一

builder.Services.ApISafeSetup(AppSign actionOptions);//接口安全校验

builder.Services.ApISafeSetup(builder.Configuration.GetSection("AopOption:AppSign"));//接口安全校验

builder.Services.ApISignSetup(AppSign actionOptions);//签名验证 ( appKey + signKey + timeStamp + data );

builder.Services.ApISignSetup(builder.Configuration.GetSection("AopOption:AppSign"));//签名验证 ( appKey + signKey + timeStamp + data );

builder.Services.AddUiFilesZipSetup();//将前端UI压缩文件进行解压

app.UseVirtualPathMiddle();//虚拟路径

前端
"appKey": appKey,
"timeStamp": (Math.floor(Date.now() / 1000) + 1000),

3、继承重写

3.1、IRestfulFilterLog 方法

    /// <summary>
    /// 成功返回值
    /// </summary>
    /// <param name="context"></param>
    /// <param name="data"></param>
    /// <returns>ActionExecutionDelegate</returns>
    IActionResult OnSucceeded(ActionExecutedContext context, object data);
    /// <summary>
    /// 验证失败返回值
    /// </summary>
    /// <param name="context"></param>
    /// <param name="metadata"></param>
    /// <returns></returns>
    IActionResult OnValidateFailed(ActionExecutingContext context, ValidationMetadata metadata);
 
    /// <summary>
    /// 异常日志
    /// </summary>
    /// <param name="exception"></param>
    void ExceptionLog( ExceptionVo exception);
    /// <summary>
    /// 操作日志
    /// </summary>
    /// <param name="operation"></param>
    void OperationLog(OperationVo operation);

3.2、预实现 RestfulFilterLog

    /// <summary>
    /// 操作日志
    /// </summary>
    /// <param name="operation"></param>
    virtual void OperationLog(OperationVo operation)
    
    /// <summary>
    /// 异常日志
    /// </summary>
    /// <param name="exception"></param>
    virtual void ExceptionLog(ExceptionVo exception)

4、Non**特性相关

不进行接口安全校验 → NonAplSafeAttribute

不签名验证 → NonAplSignAttribute

不进行全局的异常日志收集 → NonExceptionAttribute

不对资源型信息进行过滤 → NonResourceAttribute

不对结果进行统一 → NonRestfulResultAttribute

5、相关配置文件

  /* 全局的异常日志配置 */
  "ExceptionLog": {
    "Enabled": true,
    "LogToFile": false,
    "LogMore": false
  },

   /* 请求日志拦截配置 */
  "RequestLog": {
    "Enabled": true,
    "LogToFile": false, //记录到文件
    "LogMore": false, //记录更多内容 如写入数据库 需继承重写 IRestfulFilterLog
    "IgnoreApis": ""
  },

  /*接口安全校验*/
  "ApISafe": {
    "AppKeys": "",//多个appKey用逗号分开
    "AppKeyName": "appKey",
    "TimeStampName": "timeStamp",
    "ExpiresMinute": 2, //单位(分钟) 
  }

  /*签名验证*/
  "AppSign": {
    "AppKeys": "",//多个appKey用逗号分开
    "AppKeyName": "appKey",
    "TimeStampName": "timeStamp",
    "ExpiresMinute": 2, //单位(分钟) 

    "SignKey": "", //签名key 
    "SignatureName": "signature", //签名
    "IgnoreApi": "" //签名验证忽略api列表
  }


 /* 整合配置 */
  "AopOption": {
    "RequestLog": {
      "Enabled": true,
      "LogToFile": false, //记录到文件
      "LogMore": false, //记录更多内容 如写入数据库 需继承重写 IRestfulFilterLog
      "IgnoreApis": ""
    },
    "ExceptionLog": {
      "Enabled": true,
      "LogToFile": false,
      "LogMore": false
    },
    "AppSign": {
      "AppKeys": "",//多个appKey用逗号分开
      "AppKeyName": "appKey",
      "TimeStampName": "timeStamp",
      "ExpiresMinute": 2, //单位(分钟)  

      "SignKey": "", //签名key 
      "SignatureName": "signature", //签名
      "IgnoreApi": "" //签名验证忽略api列表
    }
  },

  "VirtualPath":""//虚拟路径

6、Http 拓展类

/// <summary>
/// 设置规范化文档自动登录
/// </summary>
/// <param name="httpContext">HttpContext</param>
/// <param name="accessToken">accessToken</param>
static void SigninToSwagger(this HttpContext httpContext, string accessToken)

/// <summary>
/// 设置规范化文档退出登录
/// </summary>
/// <param name="httpContext">HttpContext</param>
static void SignoutToSwagger(this HttpContext httpContext)

/// <summary>
/// 获取完整请求地址
/// </summary>
/// <param name="request">HttpRequest</param>
/// <returns>完整请求地址</returns>
static string GetRequestUrlAddress(this HttpRequest request)

/// <summary>
/// 获取站点 (http|s)://Host
/// </summary>
/// <param name="request">HttpRequest</param>
/// <returns>完整请求地址</returns>
static string GetRequestHost(this HttpRequest request)

/// <summary>
/// 获取站点 (http|s)://Host:端口
/// </summary>
/// <param name="request">HttpRequest</param>
/// <returns>完整请求地址</returns>
static string GetRequestHostPort(this HttpRequest request)

/// <summary>
/// 获取来源地址
/// </summary>
/// <param name="request">HttpRequest</param>
/// <param name="refererHeaderKey">刷新的key值</param>
/// <returns>来源地址</returns>
static string GetRefererUrl(this HttpRequest request, string refererHeaderKey = "Referer")

/// <summary>
/// 获得浏览器 Chrome、Safari、Firefox、Edg、Opera、IE
/// </summary>
/// <returns>字符串数组</returns>
static string GetBrowser(this HttpContext httpContext)

/// <summary>
/// 请求UserAgent信息
/// </summary>
static string UserAgent(this HttpContext httpContext)

/// <summary>
/// 获取 User-Agent 所有信息
/// </summary>
static ClientInfo GetDefault(this HttpContext httpContext)

/// <summary>
/// 得到操作系统版本
/// </summary>
/// <returns></returns>
static string GetOSVersion(this HttpContext httpContext)

/// <summary>
/// UserAgent信息
/// </summary>
/// <param name="httpContext"></param>
/// <returns>手机型号,操作系统(版本),浏览器(版本)</returns>
static (string PhoneModel, string OS,string Browser) UserAgentInfo(this HttpContext httpContext)

/// <summary>
/// 远程路径Encode处理,会保证开头是/，结尾也是/
/// </summary>
/// <param name="remotePath"></param>
/// <returns></returns>
static string EncodeRemotePath(this string remotePath)

/// <summary>
/// 获取本机 IPv4地址
/// </summary>
/// <param name="context">HttpContext</param>
/// <returns>IPv4地址</returns>
static string GetLocalIpAddressToIPv4(this HttpContext context) 

/// <summary>
/// 获取本机 IPv6地址
/// </summary>
/// <param name="context">HttpContext</param>
/// <returns>IPv6地址</returns>
static string GetLocalIpAddressToIPv6(this HttpContext context) 

/// <summary>
/// 获取远程 IPv6地址
/// </summary>
/// <param name="context">HttpContext</param>
/// <returns>远程 IPv6地址</returns>
static string GetRemoteIpAddressToIPv6(this HttpContext context) 

/// <summary>
/// 获得IP地址 业务使用
/// </summary>
/// <returns>字符串数组</returns>
static string GetIp(this HttpContext context) 

/// <summary>
/// 得到局域网IP地址
/// </summary>
/// <returns></returns>
static string GetLanIp(this HttpContext context) 

7、提供注入的服务

    /// <summary>
    /// 注入 全局异常处理 [进行全局的异常日志收集]
    /// </summary>
    /// <param name="services"></param>
    static IServiceCollection ExceptionSetup(this IServiceCollection services)

    /// <summary>
    /// 注入 全局异常处理 [进行全局的异常日志收集]
    /// </summary>
    /// <param name="services"></param>
    /// <param name="actionOptions"></param>
    /// <returns></returns>
    static IServiceCollection ExceptionSetup(this IServiceCollection services, Action<ExceptionLog> actionOptions)

    /// <summary>
    /// 注入 全局异常处理 [进行全局的异常日志收集]
    /// </summary>
    /// <param name="services"></param>
    /// <param name="config"></param>
    static IServiceCollection ExceptionSetup(this IServiceCollection services, IConfiguration config)

    /// <summary>
    /// 注入 请求日志拦截 [执行操作日志、参数验证，权限控制 ]
    /// </summary>
    static IServiceCollection RequestActionSetup(this IServiceCollection services)

    /// <summary>
    /// 注入 请求日志拦截 [执行操作日志、参数验证，权限控制 ]
    /// </summary>
    /// <param name="services"></param>
    /// <param name="actionOptions"></param>
    static IServiceCollection RequestActionSetup(this IServiceCollection services, Action<RequestLog> actionOptions)

    /// <summary>
    /// 注入 请求日志拦截 [执行操作日志、参数验证，权限控制 ]
    /// </summary>
    /// <param name="services"></param>
    /// <param name="config"></param>
    static IServiceCollection RequestActionSetup(this IServiceCollection services, IConfiguration config)

    /// <summary>
    /// 注入 对资源型信息进行过滤。常用于防盗链/资源缓存
    /// </summary>
    static IServiceCollection ResourceSetup(this IServiceCollection services)

    /// <summary>
    /// 结果格式化处理
    /// </summary>
    /// <param name="services"></param>
    static IServiceCollection ResultSetup(this IServiceCollection services)

    /// <summary>
    /// 接口appkey和时间戳校验
    /// </summary>
    /// <param name="services"></param>
    /// <param name="actionOptions"></param>
    /// <returns></returns>
    static IServiceCollection ApISafeSetup(this IServiceCollection services, Action<ApISafe> actionOptions)

    /// <summary>
    /// 接口appkey和时间戳校验
    /// </summary>
    /// <param name="services"></param>
    /// <param name="config"></param>
    /// <returns></returns>
    static IServiceCollection ApISafeSetup(this IServiceCollection services, IConfiguration config)
    
    /// <summary>
    /// 签名验证 ( appKey + signKey + timeStamp + data );
    /// </summary>
    /// <param name="services"></param>
    /// <param name="actionOptions"></param>
    /// <returns></returns>
    static IServiceCollection ApISignSetup(this IServiceCollection services, Action<AppSign> actionOptions)
   
    /// <summary>
    /// 签名验证 ( appKey + signKey + timeStamp + data );
    /// </summary>
    /// <param name="services"></param>
    /// <param name="config"></param>
    /// <returns></returns>
    static IServiceCollection ApISignSetup(this IServiceCollection services, IConfiguration config)
    
    /// <summary>
    /// 
    /// </summary>
    /// <typeparam name="TFilterType"></typeparam>
    /// <param name="services"></param>
    /// <returns></returns>
    static IServiceCollection AddRestfulSetup<TFilterType>(this IServiceCollection services) where TFilterType : IRestfulFilterLog
    
    /// <summary>
    /// 弃用原始模型验证
    /// </summary>
    /// <param name="services"></param>
    /// <param name="configure">options.SuppressImplicitRequiredAttributeForNonNullableReferenceTypes = true;</param>
    /// <returns></returns>
    static IMvcBuilder AddValidateSetup(this IServiceCollection services, Action<MvcOptions> configure=null)
    
    /// <summary>
    /// 规范化模型校验
    /// </summary>
    /// <param name="services"></param>
    /// <param name="configureOptions">弃用原始模型验证:options.SuppressModelStateInvalidFilter=true;</param>
    /// <returns></returns>
    static IServiceCollection AddRestfulModelsSetup(this IServiceCollection services, Action<ApiBehaviorOptions> configureOptions = null)
    
    /// <summary>
    /// 将前端UI压缩文件进行解压
    /// </summary>
    /// <param name="services"></param>
    /// <param name="_env"></param>
    /// <exception cref="ArgumentNullException"></exception>
    static void AddUiFilesZipSetup(this IServiceCollection services, IWebHostEnvironment _env)
    
    /// <summary>
    /// 使用虚拟路径
    /// </summary>
    /// <param name="app"></param>
    /// <returns></returns>
    static WebApplication UseVirtualPathMiddle(this WebApplication app)
    
    /// <summary>
    /// 使用虚拟路径
    /// </summary>
    /// <param name="app"></param>
    /// <param name="virtualPath"></param>
    /// <returns></returns>
    static WebApplication UseVirtualPathMiddle(this WebApplication app, string virtualPath)