Asp.NetコアコントローラーからIAsyncEnumerable <T>およびNotFoundを返す

IAsyncEnumerable<T>and を返すが、NotFoundResultまだ非同期で処理されるコントローラーアクションの正しいシグネチャは何ですか？

私はこのシグネチャを使用しましたが、それがIAsyncEnumerable<T>待てないためコンパイルできません：

[HttpGet]
public async Task<IActionResult> GetAll(Guid id)
{
    try
    {
        return Ok(await repository.GetAll(id)); // GetAll() returns an IAsyncEnumerable
    }
    catch (NotFoundException e)
    {
        return NotFound(e.Message);
    }
}

これは正常にコンパイルされますが、その署名は非同期ではありません。だから私はそれがスレッドプールのスレッドをブロックするかどうか心配しています：

[HttpGet]
public IActionResult GetAll(Guid id)
{
    try
    {
        return Ok(repository.GetAll(id)); // GetAll() returns an IAsyncEnumerable
    }
    catch (NotFoundException e)
    {
        return NotFound(e.Message);
    }
}

私はawait foreachこのようにループを使用しようとしましたが、それも明らかにコンパイルされません：

[HttpGet]
public async IAsyncEnumerable<MyObject> GetAll(Guid id)
{
    IAsyncEnumerable<MyObject> objects;
    try
    {
        objects = contentDeliveryManagementService.GetAll(id); // GetAll() returns an IAsyncEnumerable
    }
    catch (DeviceNotFoundException e)
    {
        return NotFound(e.Message);
    }

    await foreach (var obj in objects)
    {
        yield return obj;
    }
}

実装を通過オプション2、IAsyncEnumerable<>へのOkコールは、結構です。ASP.NET CoreのIAsyncEnumerable<>プラミングは列挙を処理し、3.0以降は認識されます。

これは質問からの呼び出しであり、コンテキストについて繰り返されます：

return Ok(repository.GetAll(id)); // GetAll() returns an IAsyncEnumerable

の呼び出しOkによりOkObjectResult、を継承するのインスタンスが作成されますObjectResult。に渡される値Okはのタイプでobject、ObjectResultのValueプロパティに保持されます。ASP.NET Core MVCはコマンドパターンを使用します。これにより、コマンドはの実装でIActionResultあり、の実装を使用して実行されIActionResultExecutor<T>ます。

の場合ObjectResult、をHTTP応答に変換するためにObjectResultExecutor使用されObjectResultます。それは-awareの実装です：ObjectResultExecutor.ExecuteAsyncIAsyncEnumerable<>

public virtual Task ExecuteAsync(ActionContext context, ObjectResult result)
{
    // ...

    var value = result.Value;

    if (value != null && _asyncEnumerableReaderFactory.TryGetReader(value.GetType(), out var reader))
    {
        return ExecuteAsyncEnumerable(context, result, value, reader);
    }

    return ExecuteAsyncCore(context, result, objectType, value);
}

コードが示すように、Valueプロパティが実装されているかどうかがチェックされますIAsyncEnumerable<>（詳細はへの呼び出しで非表示になっていますTryGetReader）。含まれている場合は、ExecuteAsyncEnumerable呼び出され、列挙が実行され、列挙された結果がに渡されExecuteAsyncCoreます。

private async Task ExecuteAsyncEnumerable(ActionContext context, ObjectResult result, object asyncEnumerable, Func<object, Task<ICollection>> reader)
{
    Log.BufferingAsyncEnumerable(Logger, asyncEnumerable);

    var enumerated = await reader(asyncEnumerable);
    await ExecuteAsyncCore(context, result, enumerated.GetType(), enumerated);
}

reader上記のスニペットでは、列挙が行われます。少し埋め込まれていますが、ソースはここに表示されます。

private async Task<ICollection> ReadInternal<T>(object value)
{
    var asyncEnumerable = (IAsyncEnumerable<T>)value;
    var result = new List<T>();
    var count = 0;

    await foreach (var item in asyncEnumerable)
    {
        if (count++ >= _mvcOptions.MaxIAsyncEnumerableBufferLimit)
        {
            throw new InvalidOperationException(Resources.FormatObjectResultExecutor_MaxEnumerationExceeded(
                nameof(AsyncEnumerableReader),
                value.GetType()));
        }

        result.Add(item);
    }

    return result;
}

IAsyncEnumerable<>列挙されているList<>使用してawait foreachほぼ定義することによって、要求スレッドをブロックしません、、。Panagiotis KanavosがOPのコメントで呼びかけたように、この列挙は応答がクライアントに返される前に完全に実行されます。