如何从BaseController派生类返回自定义错误信息至客户端error变量

问题描述 #

请问是否可以从BaseController派生类向客户端返回自定义错误信息？例如使用如下代码：

NotFound("Function :" + scheduleReq.UserFunction + " for date: " + scheduleReq.Date + " already taken");

遗憾的是，NotFound的返回值无法将我的自定义消息传递给客户端。我希望客户端的error变量能够获取到该消息，客户端代码如下：

客户端：

this.accountService.GetScheduleFromPool(this.account.id, schedule)
      .pipe(first())
      .subscribe({
        next: (account) => {
          this.addingSchedule = false;

          console.log(account);
          this.schedules = account.schedules;
          

          if (this.poolElements.length != 0) {
            this.form.get('availableScheduledDate').setValue(this.poolElements[0].date);
            this.form.get('availableFunction').setValue(this.poolElements[0].userFunction);
          }
          this.updateSchedulesAndPoolFromServer();
        },
        error: error => {
          this.addingSchedule = false;

          this.alertService.error(error);
        }
      });

解决方案 #

方法1：返回自定义ObjectResult #

替代默认的NotFound方法，直接返回包含状态码和自定义消息的响应体：

return new ObjectResult(new { 
    Message = $"Function :{scheduleReq.UserFunction} for date: {scheduleReq.Date} already taken" 
})
{
    StatusCode = StatusCodes.Status404NotFound
};

客户端可通过error.error.Message（具体路径取决于框架序列化逻辑）获取自定义消息。

方法2：使用标准化ProblemDetails #

ASP.NET Core提供ProblemDetails类型用于标准化错误响应，确保客户端能统一解析：

var problemDetails = new ProblemDetails
{
    Status = StatusCodes.Status404NotFound,
    Title = "Schedule already taken",
    Detail = $"Function :{scheduleReq.UserFunction} for date: {scheduleReq.Date} already taken"
};
return new ObjectResult(problemDetails)
{
    StatusCode = problemDetails.Status
};

客户端通过error.error.Detail即可拿到详细错误消息。

方法3：重写BaseController的NotFound方法 #

如果需要在多个派生类中复用该逻辑，可在BaseController里重写NotFound方法：

protected new IActionResult NotFound(string message)
{
    return new ObjectResult(new { Message = message })
    {
        StatusCode = StatusCodes.Status404NotFound
    };
}

之后直接调用NotFound("你的自定义消息")即可返回带自定义内容的404响应。

客户端适配 #

客户端需根据后端返回的JSON结构调整错误取值逻辑，示例如下：

error: error => {
    this.addingSchedule = false;
    const errorMessage = error.error?.Message || error.error?.Detail || '请求失败';
    this.alertService.error(errorMessage);
}

内容的提问来源于stack exchange，提问作者Janciu