Blame view

netcore/src/Infrastructure/NCC/UnifyResult/Providers/IUnifyResultProvider.cs 1.55 KB
de2bd2f9   “wangming”   项目初始化
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
  using NCC.DataValidation;
  using NCC.UnifyResult.Internal;
  using Microsoft.AspNetCore.Http;
  using Microsoft.AspNetCore.Mvc;
  using Microsoft.AspNetCore.Mvc.Filters;
  using System.Threading.Tasks;
  
  namespace NCC.UnifyResult
  {
      /// <summary>
      /// 规范化结果提供器
      /// </summary>
      public interface IUnifyResultProvider
      {
          /// <summary>
          /// 异常返回值
          /// </summary>
          /// <param name="context"></param>
          /// <param name="metadata"></param>
          /// <returns></returns>
          IActionResult OnException(ExceptionContext context, ExceptionMetadata metadata);
  
          /// <summary>
          /// 成功返回值
          /// </summary>
          /// <param name="context"></param>
          /// <param name="data"></param>
          /// <returns></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="context"></param>
          /// <param name="statusCode"></param>
          /// <param name="unifyResultSettings"></param>
          /// <returns></returns>
          Task OnResponseStatusCodes(HttpContext context, int statusCode, UnifyResultSettingsOptions unifyResultSettings = default);
      }
  }