Return BadRequest with null required property in model .net core web api

Question

所以，我的 controller 里面有一个 create 方法：

[Authorize]
[Route("[controller]")]
[ApiController]
public class ConversionsController : ControllerBase
{
    private readonly IGenericService<Conversion> _conversionService;
    public ConversionsController(IGenericService<Conversion> conversionService) => _conversionService = conversionService;

    /// <summary>
    /// Creates a new conversion
    /// </summary>
    /// <param name="conversion">The conversion</param>
    /// <returns></returns>
    [HttpPost]
    [ProducesResponseType(typeof(Conversion), StatusCodes.Status201Created)]
    [ProducesResponseType(StatusCodes.Status400BadRequest)]
    public async Task<IActionResult> CreateAsync(ConversionViewModel conversion)
    {
        if (conversion == null) return BadRequest();
        if (!ModelState.IsValid) return BadRequest(ModelState);

        var request = ModelFactory.Create(conversion);

        _conversionService.Create(request);
        await _conversionService.SaveChangesAsync();

        return Created(nameof(Get), new Sxp.Web.ActionResult<Conversion>(request, string.Format(Resources.EntityCreated, "conversion")));
    }
}

如您所见，如果没有 model 它将返回错误请求（有效）。

但是下一行说明if (.ModelState.IsValid)永远不会起作用。 即使在null处具有必需的属性，它也始终返回有效。

我写了一个测试，总是失败：

[Test]
public async Task ReturnBadRequestIfNullRequiredProperty()
{
    // Assemble
    var services = ConversionsControllerContext.GivenServices();
    var controller = services.WhenCreateController();

    // Act
    var actionResult = await controller.CreateAsync(new ConversionViewModel());
    var badRequestResult = actionResult as BadRequestResult;

    // Assert
    badRequestResult.Should().NotBeNull();
    badRequestResult?.StatusCode.Should().Be(StatusCodes.Status400BadRequest);
}

正如您在此处看到的，我只是传递了一个没有设置任何属性的CategoryViewModel ，但它失败了。

视图 model 如下所示：

public class ConversionViewModel
{
    public int Id { get; set; }
    [Range(1, int.MaxValue, ErrorMessageResourceName = "RangeErrorMessage", ErrorMessageResourceType = typeof(Resources))] public int FeedId { get; set; }
    [Required(ErrorMessageResourceName = "RequiredErrorMessage", ErrorMessageResourceType = typeof(Resources)), StringLength(100, ErrorMessageResourceName = "StringLengthErrorMessage", ErrorMessageResourceType = typeof(Resources))] public string Name { get; set; }
    [Required(ErrorMessageResourceName = "RequiredErrorMessage", ErrorMessageResourceType = typeof(Resources)), StringLength(100, ErrorMessageResourceName = "StringLengthErrorMessage", ErrorMessageResourceType = typeof(Resources))] public string FieldName { get; set; }
    [Required(ErrorMessageResourceName = "RequiredErrorMessage", ErrorMessageResourceType = typeof(Resources)), StringLength(100, ErrorMessageResourceName = "StringLengthErrorMessage", ErrorMessageResourceType = typeof(Resources))] public string Expression { get; set; }
    public double Value { get; set; }
    public MathOperator MathOperator { get; set; }
    public FilterOperator FilterOperator { get; set; }
}

我能想到的唯一另一件事是我禁用了自动 state 验证：

.ConfigureApiBehaviorOptions(options => { options.SuppressModelStateInvalidFilter = true; });

我认为这让我可以在 controller 内处理它。

有没有人遇到过这个？

Answer 1

您正在运行单元测试而不是端到端集成测试，因此在执行测试时某些框架问题未运行。

这些数据注释属性是元数据，仅在运行时由框架识别，而不是在隔离单元测试期间，因为它们在应用程序运行时由 model 绑定器实际读取。

如果打算让框架验证 model，则需要进行集成测试。

ASP.NET 内核中的参考集成测试

否则，在安排测试时，被测对象（控制器）必须手动更新其ModelState ，以便在执行时表现出预期的行为。

通过使用AddModelError添加错误来测试无效的 model state，如下面的测试所示：

[Test]
public async Task ReturnBadRequestIfNullRequiredProperty() {
    // Arrange / Assemble
    var services = ConversionsControllerContext.GivenServices();
    var controller = services.WhenCreateController();
    controller.ModelState.AddModelError("Name","Name required"); //<-- Invalidate model state
    //...other desired errors.

    // Act
    var actionResult = await controller.CreateAsync(new ConversionViewModel());
    var badRequestResult = actionResult as BadRequestResult;

    // Assert
    badRequestResult.Should().NotBeNull();
    badRequestResult?.StatusCode.Should().Be(StatusCodes.Status400BadRequest);
}

参考测试 ASP.NET 内核中的 controller 逻辑

Answer 2

如果您使用services.AddMvcCore而不是services.AddMvc然后添加

services.AddDataAnnotations();

到 Startup.ConfigureServices 方法