使用 CQRS 模式在 API 中返回有意义的错误

Question

使用 Mediatr 模式时，我发现向 API 控制器返回有意义的错误非常具有挑战性。我们以

OrdersController.CancelOrder

方法为例 (src)。

在此示例中，它们“仅”返回

Ok()

和

BadRequest()

。在这种情况下，他们将如何返回“此订单 ID 不存在”(404) 或“此订单已发货”(400) (...) 等错误。

我们可以引入一个名为

Result

的新类，它包含返回值（如果有）和潜在的错误消息。在这种情况下，您的所有命令、查询都应返回

Result<YourModel>

。我们还可以直接在控制器内添加代码。我无法下定决心，这两种解决方案各有利弊。

你对此有何看法？

谢谢 塞布

Answer 1

这正是我使用 Mediatr 的方式。
返回一个包装类。

如果我们以 eShopOnContainers 为例

CancelOrder

示例，我将得到命令，返回一个

CancelOrderCommandResult

public class CancelOrderCommand : IRequest<CancelOrderCommandResult>
{ }

CancelOrderCommandResult

可能是这样的：

public class CancelOrderCommandResult
{
    public CancelOrderCommandResult(IEnumerable<Error> errors)
    {
        Success = false;
        Errors = errors;
    }

    public CancelOrderCommandResult(bool success)
    {
        Success = success;
    }

    public bool Success {get; set;}

    public IEnumerable<Error> Errors {get; set;}
}

我省略了

Error

类，但它可能只是包含错误信息、错误代码等的 POCO...

我们的处理程序就变成了

public class CancelOrderCommandHandler : IRequestHandler<CancelOrderCommand, CancelOrderCommandResult>
{
    private readonly IOrderRepository _orderRepository;

    public CancelOrderCommandHandler(IOrderRepository orderRepository)
    {
        _orderRepository = orderRepository;
    }

    public async Task<CancelOrderCommandResult> Handle(CancelOrderCommand command, CancellationToken cancellationToken)
    {
        var orderToUpdate = await _orderRepository.GetAsync(command.OrderNumber);

        if(orderToUpdate == null)
        {
            return new CancelOrderCommandResult(false);
        }

        try 
        {
            orderToUpdate.SetCancelledStatus();
            await _orderRepository.UnitOfWork.SaveEntitiesAsync();

            //iff success, return true
            return new CancelOrderCommandResult(true);
        }
        catch (Exception ex)
        {
            var errors = MapErrorsFromException(ex);
            return new CancelOrderCommandResult(errors)
        }
    }
}

再次，为了简洁起见，省略了

MapErrorsFromException

，但您甚至可以将其作为依赖项注入。

在控制器中，当您调用

_mediator.Send

时，您现在会返回

CancelOrderCommandResult

- 如果

.Success

为 true，则像以前一样返回 200。

否则，您将收到一系列错误 - 您可以使用这些错误来决定返回什么 - 400、500 等...