วิธีการคืน HTTP 500 จาก ASP.NET Core RC2 Web Api

ย้อนกลับไปใน RC1 ฉันจะทำสิ่งนี้:

[HttpPost]
public IActionResult Post([FromBody]string something)
{    
    try{
        // ...
    }
    catch(Exception e)
    {
         return new HttpStatusCodeResult((int)HttpStatusCode.InternalServerError);
    }
}

ใน RC2 ไม่มี HttpStatusCodeResult อีกต่อไปและไม่มีสิ่งใดที่ฉันสามารถค้นพบได้ซึ่งช่วยให้ฉันส่งคืน IActionResult ประเภท 500

ตอนนี้วิธีการนั้นแตกต่างกันอย่างสิ้นเชิงกับสิ่งที่ฉันถามหรือไม่? เราไม่ลองใช้Controllerโค้ดอีกต่อไปหรือไม่ เราเพียงแค่ปล่อยให้เฟรมเวิร์กส่งข้อยกเว้น 500 ทั่วไปกลับไปที่ผู้เรียก API หรือไม่ สำหรับการพัฒนาฉันจะดูสแต็กข้อยกเว้นที่แน่นอนได้อย่างไร

จากสิ่งที่ฉันเห็นมีวิธีช่วยเหลือภายในControllerBaseชั้นเรียน เพียงใช้StatusCodeวิธีการ:

[HttpPost]
public IActionResult Post([FromBody] string something)
{    
    //...
    try
    {
        DoSomething();
    }
    catch(Exception e)
    {
         LogException(e);
         return StatusCode(500);
    }
}

นอกจากนี้คุณยังสามารถใช้StatusCode(int statusCode, object value)โอเวอร์โหลดซึ่งยังเจรจาเนื้อหา

คุณสามารถใช้Microsoft.AspNetCore.Mvc.ControllerBase.StatusCodeและMicrosoft.AspNetCore.Http.StatusCodesสร้างการตอบกลับของคุณหากคุณไม่ต้องการ hardcode หมายเลขเฉพาะ

return  StatusCode(StatusCodes.Status500InternalServerError);

อัพเดท: ส.ค. 2562

อาจไม่เกี่ยวข้องโดยตรงกับคำถามต้นฉบับ แต่เมื่อพยายามบรรลุผลลัพธ์เดียวกันกับMicrosoft Azure Functionsฉันพบว่าฉันต้องสร้างStatusCodeResultวัตถุใหม่ที่พบในการMicrosoft.AspNetCore.Mvc.Coreชุมนุม รหัสของฉันตอนนี้มีลักษณะเช่นนี้;

return new StatusCodeResult(StatusCodes.Status500InternalServerError);

หากคุณต้องการร่างกายในการตอบสนองของคุณคุณสามารถโทร

return StatusCode(StatusCodes.Status500InternalServerError, responseObject);

สิ่งนี้จะคืนค่า 500 ด้วยวัตถุตอบกลับ ...

วิธีที่ดีกว่าในการจัดการนี้ ณ ขณะนี้ (1.1) คือการทำเช่นนี้ในStartup.cs's Configure():

app.UseExceptionHandler("/Error");

/Errorซึ่งจะดำเนินการเส้นทาง การทำเช่นนี้จะช่วยคุณไม่ให้เพิ่มบล็อก try-catch ลงในทุกการกระทำที่คุณเขียน

แน่นอนคุณจะต้องเพิ่ม ErrorController แบบนี้:

[Route("[controller]")]
public class ErrorController : Controller
{
    [Route("")]
    [AllowAnonymous]
    public IActionResult Get()
    {
        return StatusCode(StatusCodes.Status500InternalServerError);
    }
}

ข้อมูลเพิ่มเติมที่นี่

ในกรณีที่คุณต้องการได้รับข้อมูลข้อยกเว้นที่แท้จริงคุณสามารถเพิ่มสิ่งนี้ไปทางด้านGet()ขวาก่อนreturnคำสั่ง

// Get the details of the exception that occurred
var exceptionFeature = HttpContext.Features.Get<IExceptionHandlerPathFeature>();

if (exceptionFeature != null)
{
    // Get which route the exception occurred at
    string routeWhereExceptionOccurred = exceptionFeature.Path;

    // Get the exception that occurred
    Exception exceptionThatOccurred = exceptionFeature.Error;

    // TODO: Do something with the exception
    // Log it with Serilog?
    // Send an e-mail, text, fax, or carrier pidgeon?  Maybe all of the above?
    // Whatever you do, be careful to catch any exceptions, otherwise you'll end up with a blank page and throwing a 500
}

ด้านบนข้อมูลโค้ดนำมาจากบล็อกของสกอตต์ของ Sauber

return StatusCode((int)HttpStatusCode.InternalServerError, e);

ควรใช้ในบริบทที่ไม่ใช่ ASP.NET (ดูคำตอบอื่น ๆ สำหรับ ASP.NET Core)

HttpStatusCodeSystem.Netเป็นการแจงนับใน

วิธีการเกี่ยวกับการสร้างคลาส ObjectResult ที่กำหนดเองที่แสดงถึงข้อผิดพลาดเซิร์ฟเวอร์ภายในเช่นเดียวกับOkObjectResult? คุณสามารถใส่วิธีการที่ง่ายในระดับฐานของคุณเองเพื่อให้คุณสามารถสร้าง InternalServerError และส่งกลับมาเช่นเดียวกับคุณหรือOk()BadRequest()

[Route("api/[controller]")]
[ApiController]
public class MyController : MyControllerBase
{
    [HttpGet]
    [Route("{key}")]
    public IActionResult Get(int key)
    {
        try
        {
            //do something that fails
        }
        catch (Exception e)
        {
            LogException(e);
            return InternalServerError();
        }
    }
}

public class MyControllerBase : ControllerBase
{
    public InternalServerErrorObjectResult InternalServerError()
    {
        return new InternalServerErrorObjectResult();
    }

    public InternalServerErrorObjectResult InternalServerError(object value)
    {
        return new InternalServerErrorObjectResult(value);
    }
}

public class InternalServerErrorObjectResult : ObjectResult
{
    public InternalServerErrorObjectResult(object value) : base(value)
    {
        StatusCode = StatusCodes.Status500InternalServerError;
    }

    public InternalServerErrorObjectResult() : this(null)
    {
        StatusCode = StatusCodes.Status500InternalServerError;
    }
}

เมื่อคุณต้องการส่งคืนการตอบสนอง JSON ใน MVC .Net Core คุณยังสามารถใช้:

Response.StatusCode = (int)HttpStatusCode.InternalServerError;//Equals to HTTPResponse 500
return Json(new { responseText = "my error" });

สิ่งนี้จะส่งคืนทั้งผลลัพธ์ JSON และ HTTPStatus ฉันใช้เพื่อคืนผลลัพธ์ให้ jQuery.ajax ()

สำหรับ aspnetcore-3.1 คุณสามารถใช้Problem()ดังนี้

https://docs.microsoft.com/en-us/aspnet/core/web-api/handle-errors?view=aspnetcore-3.1

 [Route("/error-local-development")]
public IActionResult ErrorLocalDevelopment(
    [FromServices] IWebHostEnvironment webHostEnvironment)
{
    if (webHostEnvironment.EnvironmentName != "Development")
    {
        throw new InvalidOperationException(
            "This shouldn't be invoked in non-development environments.");
    }

    var context = HttpContext.Features.Get<IExceptionHandlerFeature>();

    return Problem(
        detail: context.Error.StackTrace,
        title: context.Error.Message);
}