ASP.NET Core Web API批量并行请求的返回类型最佳实践

你当前的问题核心是嵌套ActionResult导致序列化/返回格式异常，因为ActionResult是ASP.NET Core用来描述HTTP响应的框架类型，不应该作为业务结果的容器放在返回集合中。正确的做法是定义一个统一的业务结果DTO，用来包装每个子请求的成功/失败状态，整体返回这个DTO的集合。

解决方案步骤 #

1. 定义统一的业务结果DTO #

创建一个泛型类，明确区分成功数据和错误信息，让前端能清晰识别每个请求的处理状态：

// 统一结果包装类
public class OperationResult<T>
{
    public bool IsSuccess { get; set; }
    public T? Data { get; set; }
    public CustomError? Error { get; set; }

    // 静态工厂方法，简化实例创建
    public static OperationResult<T> Success(T data)
    {
        return new OperationResult<T> { IsSuccess = true, Data = data };
    }

    public static OperationResult<T> Failure(CustomError error)
    {
        return new OperationResult<T> { IsSuccess = false, Error = error };
    }
}

// 自定义错误类（根据业务需求扩展字段）
public class CustomError
{
    public string ErrorMessage { get; set; }
    public string? ErrorCode { get; set; }

    public CustomError(Exception ex)
    {
        // 注意：生产环境不要直接返回异常堆栈，返回友好提示或业务错误码
        ErrorMessage = $"处理请求失败：{ex.Message}";
        ErrorCode = "REQUEST_PROCESS_FAILED";
    }
}

2. 重构API方法 #

放弃使用ConcurrentBag和嵌套ActionResult，直接通过Task.WhenAll收集每个子任务的结果，代码更简洁且避免线程安全问题：

// 正确的返回类型：ActionResult包裹统一结果集合
public async Task<ActionResult<IEnumerable<OperationResult<MyClass>>>> MyOperation1(IEnumerable<Request1> requests)
{
    // 将每个请求映射为独立的处理任务
    var taskList = requests.Select(request => ProcessSingleRequest(request));
    
    // 等待所有任务完成，批量获取结果
    var results = await Task.WhenAll(taskList);
    
    // 整体返回200 OK，响应体包含所有子请求的处理结果
    return Ok(results);
}

// 单个请求的处理逻辑，返回统一结果
private async Task<OperationResult<MyClass>> ProcessSingleRequest(Request1 request)
{
    try
    {
        var resultData = await SomeOperation(request);
        return OperationResult<MyClass>.Success(resultData);
    }
    catch (Exception ex)
    {
        var errorInfo = new CustomError(ex);
        return OperationResult<MyClass>.Failure(errorInfo);
    }
}

为什么这样做是最佳实践 #

• 格式清晰：前端可以通过IsSuccess快速判断每个请求的状态，分别处理成功数据或错误信息，无需解析嵌套的框架类型。
• 避免框架类型滥用：ActionResult是用来定义HTTP响应状态（如404、500）的，不应该作为业务数据的载体放入返回集合。
• 代码更简洁：通过Task.WhenAll + Select的组合，替代手动管理任务列表和线程安全集合，可读性和可维护性更高。
• 状态语义正确：批量请求整体是成功接收并处理的，所以返回200 OK，在响应体中区分子请求的失败，比返回500更符合HTTP语义。

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