在Web API中返回自定义错误对象

3 回答

• 40

  这些答案比他们需要的更复杂 .

  public static class WebApiConfig
  {
      public static void Register(HttpConfiguration config)
      {
          config.Filters.Add(new HandleApiExceptionAttribute());
          // ...
      }
  }
  
  public class HandleApiExceptionAttribute : ExceptionFilterAttribute
  {
      public override void OnException(HttpActionExecutedContext context)
      {
          var request = context.ActionContext.Request;
  
          var response = new
          {
               //Properties go here...
          };
  
          context.Response = request.CreateResponse(HttpStatusCode.BadRequest, response);
      }
  }
  

  这就是你所需要的 . 单元测试也很好很容易：

  [Test]
  public async void OnException_ShouldBuildProperErrorResponse()
  {
      var expected = new 
      {
           //Properties go here...
      };
  
      //Setup
      var target = new HandleApiExceptionAttribute()
  
      var contextMock = BuildContextMock();
  
      //Act
      target.OnException(contextMock);
  
      dynamic actual = await contextMock.Response.Content.ReadAsAsync<ExpandoObject>();
  
      Assert.AreEqual(expected.Aproperty, actual.Aproperty);
  }
  
  private HttpActionExecutedContext BuildContextMock()
  {
      var requestMock = new HttpRequestMessage();
      requestMock.Properties.Add(HttpPropertyKeys.HttpConfigurationKey, new HttpConfiguration());
  
      return new HttpActionExecutedContext()
      {
          ActionContext = new HttpActionContext
          {
              ControllerContext = new HttpControllerContext
              {
                  Request = requestMock
              }
  
          },
          Exception = new Exception()
      };
  }
  

  回复于 2024-04-29T08:53:15+08:00
• 2

  我认为这样可以解决问题：

  为业务层创建自定义异常类：

  public class MyException: Exception
   {
      public ResponseStatus Status { get; private set; }
      public ResponseSubStatus SubStatus { get; private set; }
      public new string Message { get; private set; }
  
      public MyException()
      {}
  
      public MyException(ResponseStatus status, ResponseSubStatus subStatus, string message)
      {
          Status = status;
          SubStatus = subStatus;
          Message = message;
      }
   }
  

  创建一个静态方法以从 MyException 的实例生成 HttpError . 我在这里使用反射，所以我可以添加属性 MyException 并且总是让它们返回w / o更新 Create ：

  public static HttpError Create<T>(MyException exception) where T:Exception
      {
          var properties = exception.GetType().GetProperties(BindingFlags.Instance 
                                                           | BindingFlags.Public 
                                                           | BindingFlags.DeclaredOnly);
          var error = new HttpError();
          foreach (var propertyInfo in properties)
          {
              error.Add(propertyInfo.Name, propertyInfo.GetValue(exception, null));
          }
          return error;
      }
  

  我目前有一个常规异常处理程序的自定义属性 . 所有类型为 MyException 的异常都将在此处理：

  public class ExceptionHandlingAttribute : ExceptionFilterAttribute
  {
      public override void OnException(HttpActionExecutedContext context)
      {
          var statusCode = HttpStatusCode.InternalServerError;
  
          if (context.Exception is MyException)
          {
              statusCode = HttpStatusCode.BadRequest;
              throw new HttpResponseException(context.Request.CreateErrorResponse(statusCode, HttpErrorHelper.Create(context.Exception)));
          }
  
          if (context.Exception is AuthenticationException)
              statusCode = HttpStatusCode.Forbidden;
  
          throw new HttpResponseException(context.Request.CreateErrorResponse(statusCode, context.Exception.Message));
      }
  }
  

  当我在这个计划中找到漏洞时，我会更多地玩这个并更新 .

  回复于 2024-04-29T08:53:15+08:00
• 9

  看看下面的文章 . 它将帮助您控制Web api异常和错误消息：Web Api, HttpError, and the Behavior of Exceptions

  回复于 2024-04-29T08:53:15+08:00