在ServiceStack REST服务中自定义异常处理

本文关键字:自定义 异常处理 服务 ServiceStack REST | 更新日期: 2023-09-27 18:05:40

我有一个ServiceStack REST服务,我需要实现自定义错误处理。我已经能够通过设置AppHostBase自定义服务错误。ServiceExceptionHandler转换为自定义函数。

然而,对于其他类型的错误,例如验证错误,这不起作用。我怎样才能涵盖所有的情况?

换句话说,我正在努力实现两件事:

  1. 为可能弹出的每种异常设置自己的HTTP状态码,包括非服务错误(验证)
  2. 为每个错误类型返回我自己的自定义错误对象(不是默认的ResponseStatus)

我该怎么做呢?

在ServiceStack REST服务中自定义异常处理

AppHostBase.ServiceExceptionHandler全局处理程序只处理服务异常。要处理服务之外发生的异常,您可以设置全局AppHostBase.ExceptionHandler处理程序,例如:

public override void Configure(Container container)
{
    //Handle Exceptions occurring in Services:
    this.ServiceExceptionHandler = (request, exception) => {
        //log your exceptions here
        ...
        //call default exception handler or prepare your own custom response
        return DtoUtils.HandleException(this, request, exception);
    };
    //Handle Unhandled Exceptions occurring outside of Services, 
    //E.g. in Request binding or filters:
    this.ExceptionHandler = (req, res, operationName, ex) => {
         res.Write("Error: {0}: {1}".Fmt(ex.GetType().Name, ex.Message));
         res.EndServiceStackRequest(skipHeaders: true);
    };
}

要在非服务 ExceptionHandler中创建和序列化DTO到响应流,您需要访问并使用正确的序列化器来处理来自IAppHost.ContentTypeFilters的请求。

更多详细信息请参见错误处理wiki页面

我对@mythz的答案做了改进。

public override void Configure(Container container) {
    //Handle Exceptions occurring in Services:
    this.ServiceExceptionHandlers.Add((httpReq, request, exception) = > {
        //log your exceptions here
        ...
        //call default exception handler or prepare your own custom response
        return DtoUtils.CreateErrorResponse(request, exception);
    });
    //Handle Unhandled Exceptions occurring outside of Services
    //E.g. Exceptions during Request binding or in filters:
    this.UncaughtExceptionHandlers.Add((req, res, operationName, ex) = > {
        res.Write("Error: {0}: {1}".Fmt(ex.GetType().Name, ex.Message));
#if !DEBUG
        var message = "An unexpected error occurred."; // Because we don't want to expose our internal information to the outside world.
#else
        var message = ex.Message;
#endif
        res.WriteErrorToResponse(req, req.ContentType, operationName, message, ex, ex.ToStatusCode()); // Because we don't want to return a 200 status code on an unhandled exception.
    });
}