.NET最佳實踐：避免同步讀取HttpRequest

為什么要避免同步讀取

ASP.NET Core 中的所有 I/O 操作都是異步的。服務器實現了 Stream 接口，該接口同時具備同步和異步的方法。

在進行 I/O 操作時，應優先使用異步方法，以避免阻塞線程池的線程。

如果阻塞了線程池線程，可能會導致服務器無法處理更多請求，造成急劇性性能下降。

尤其是當客戶端上傳速度緩慢時，同步讀取將阻塞線程直到整個請求體被全部讀取完成。

如何避免同步讀取

錯誤的做法

以下代碼示例使用了同步方法 ReadToEnd，導致線程被阻塞：

public class BadStreamReaderController : Controller
{
    [HttpGet("/contoso")]
    public ActionResult<ContosoData> Get()
    {
        var json = new StreamReader(Request.Body).ReadToEnd();

        return JsonSerializer.Deserialize<ContosoData>(json);
    }
}

在這段代碼中，Get方法將整個 HTTP 請求體同步讀入內存。如果客戶端上傳速度緩慢，應用程序將阻塞在這個讀取操作上，導致效率下降。

正確的做法

使用異步方法 ReadToEndAsync，可以避免阻塞線程：

public class GoodStreamReaderController : Controller
{
    [HttpGet("/contoso")]
    public async Task<ActionResult<ContosoData>> Get()
    {
        var json = await new StreamReader(Request.Body).ReadToEndAsync();

        return JsonSerializer.Deserialize<ContosoData>(json);
    }
}

這段代碼使用異步讀取方法，在讀取過程中不會阻塞線程，可以提升性能和響應速度。

讀取表單數據時的注意事項

錯誤的做法

使用 HttpContext.Request.Form，會在內部執行同步讀取，導致線程被阻塞：

public class BadReadController : Controller
{
    [HttpPost("/form-body")]
    public IActionResult Post()
    {
        var form = HttpContext.Request.Form;

        Process(form["id"], form["name"]);

        return Accepted();
    }
}

正確的做法

使用 ReadFormAsync，進行異步讀取：

public class GoodReadController : Controller
{
    [HttpPost("/form-body")]
    public async Task<IActionResult> Post()
    {
        var form = await HttpContext.Request.ReadFormAsync();

        Process(form["id"], form["name"]);

        return Accepted();
    }
}

這種做法使用異步方式讀取表單數據，能有效避免阻塞線程池資源。

結論

在 ASP.NET Core 開發中，應符合框架的異步操作模式，避免使用同步方法讀取 HTTP 請求文本。

這樣可以有效地提升應用程序的性能和響應速度，避免因阻塞導致的急劇性性能下降。