我希望下面的示例控制器返回没有内容的状态代码 418。设置状态码很容易,但似乎需要做一些事情来表示请求的结束。在 ASP.NET Core 之前的 MVC 或 WebForms 中可能调用 Response.End()
但它如何在不存在 Response.End
的 ASP.NET Core 中工作?
public class ExampleController : Controller
{
[HttpGet][Route("/example/main")]
public IActionResult Main()
{
this.HttpContext.Response.StatusCode = 418; // I'm a teapot
// How to end the request?
// I don't actually want to return a view but perhaps the next
// line is required anyway?
return View();
}
}
this.HttpContext.Response.StatusCode = 418; // 我是茶壶怎么结束请求?
尝试其他解决方案,只需:
return StatusCode(418);
您可以使用 StatusCode(???)
返回任何 HTTP 状态代码。
此外,您可以使用专用结果:
成功:
返回 Ok() ← Http 状态码 200
返回 Created() ← Http 状态码 201
返回无内容(); ← Http 状态码 204
客户端错误:
返回 BadRequest(); ← Http 状态码 400
返回未授权(); ← Http 状态码 401
返回未找到(); ← Http 状态码 404
更多细节:
ControllerBase 类(感谢@Technetium)
StatusCodes.cs(在 ASP.NET Core 中可用的常量)
Wiki 上的 HTTP 状态码
HTTP 状态代码 IANA
最好的方法是:
return this.StatusCode(StatusCodes.Status418ImATeapot, "Error message");
StatusCodes
具有各种返回状态,您可以看到所有这些状态here。
选择 StatusCode
后,将其与消息一起返回。
查看当前对象结果是如何创建的。这是 BadRequestObjectResult。只是带有值和 StatusCode 的 ObjectResult 的扩展。
我以与 408 相同的方式创建了一个 TimeoutExceptionObjectResult。
/// <summary>
/// An <see cref="ObjectResult"/> that when executed will produce a Request Timeout (408) response.
/// </summary>
[DefaultStatusCode(DefaultStatusCode)]
public class TimeoutExceptionObjectResult : ObjectResult
{
private const int DefaultStatusCode = StatusCodes.Status408RequestTimeout;
/// <summary>
/// Creates a new <see cref="TimeoutExceptionObjectResult"/> instance.
/// </summary>
/// <param name="error">Contains the errors to be returned to the client.</param>
public TimeoutExceptionObjectResult(object error)
: base(error)
{
StatusCode = DefaultStatusCode;
}
}
客户:
if (ex is TimeoutException)
{
return new TimeoutExceptionObjectResult("The request timed out.");
}
此代码可能适用于非 .NET Core MVC 控制器:
this.HttpContext.Response.StatusCode = 418; // I'm a teapot
return Json(new { status = "mer" }, JsonRequestBehavior.AllowGet);
如果有人想使用 IHttpActionResult
执行此操作,可能在 Web API 项目中,下面可能会有所帮助。
// GET: api/Default/
public IHttpActionResult Get()
{
//return Ok();//200
//return StatusCode(HttpStatusCode.Accepted);//202
//return BadRequest();//400
//return InternalServerError();//500
//return Unauthorized();//401
return Ok();
}
对于基于 .Net 5 或 .Net 6 的 API(也可以在 .Net Core 3x 中工作,未检查)
public async Task<ActionResult<List<DocumentsResponseDto>>> SaveDocumentDetails([FromBody] List<DocumentDetailsRequestDto> documentDetailsRequestDto)
{
var response = await _documentService.SaveDocumentDetails(documentDetailsRequestDto);
return StatusCode(Microsoft.AspNetCore.Http.StatusCodes.Status207MultiStatus, response);
}
不定期副业成功案例分享
StatusCode(418)
确实 返回内容。它返回一个包含状态代码和一些其他属性的 JSON 对象,所以我看不出这甚至是对问题的有效答案。