首页 > 解决方案 > 抽象类和 IModelBinder,如何获得正确的 ValidationState?

问题描述

上下文

我有一个角度应用程序,它将复杂的数据发送到我的 .net Core API。发送的数据可以是一个图像 (ImageDto) 或几个图像 (StackImageDto),以及标题和标签。我们使用多部分 HTML 表单发送数据,这意味着数据不是 JSON 格式的。

错误

目前 .Net Core 2.2 中存在一个带有BindModelAsync的错误: https ://github.com/aspnet/AspNetCore/issues/6616

类似问题

我尝试遵循人们的建议,但我没有成功使其正常工作:

代码

由于我需要使 API 工作,我使用不同的方式来设置我在控制器中使用的抽象类 DTO。

这是 DTO 类MediaDto

[ModelBinder(BinderType = typeof(AbstractModelBinder))]
public abstract class MediaDto
{
    public Guid? Id { get; set; }
    [Required]
    public string Title { get; set; }
    public string Note { get; set; }
    public TagDto[] Tags { get; set; } = new TagDto[] { };
    public ChallengeDetailsDto[] Challenges { get; set; }
    [Required]
    public string Discriminator { get; set; }

    public DateTimeOffset? CreatedAt { get; set; }
    public string CreatedBy { get; set; }
    //public Guid CreatedByUserId { get; set; }
    public DateTimeOffset? EditedAt { get; set; }
    public string EditedBy { get; set; }
    public DateTimeOffset? DeletedAt { get; set; }
    public string DeletedBy { get; set; }
}

图像Dto

[Serializable]
public class ImageDto : MediaDto
{
    public IFormFile Image { get; set; }
    public string Url { get; set; }

    public ImageDto()
    {
        Discriminator = ImageDtoDiscriminator;
    }
}

StackImageDto

[Serializable]
public class StackImageDto : MediaDto
{
    [Required]
    [EnumDataType(typeof(StackImageType))]
    public StackImageType Type { get; set; }
    [Required]
    public IEnumerable<StackFileDto> StackFiles { get; set; }

    public StackImageDto()
    {
        Discriminator = StackImageDtoDiscriminator;
    }
}

堆栈文件Dto

[Serializable]
public class StackFileDto
{
    public Guid? Id { get; set; }
    public IFormFile Image { get; set; }
    public string Url { get; set; }
    public int Position { get; set; }
}

MediaLibraryConverter将 Json 转换为我的 MediaDto 实例:

public class MediaLibraryConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return typeof(MediaDto).IsAssignableFrom(objectType);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        MediaDto result = null;

        var jsonChallange = JObject.Load(reader);
        var discriminator = jsonChallange.Properties().First(p => p.Name == "discriminator").Value.ToString();

        if (discriminator.Equals(nameof(ImageDto), StringComparison.InvariantCultureIgnoreCase))
        {
            result = (ImageDto)JsonConvert.DeserializeObject(jsonChallange.ToString(), typeof(ImageDto));
        }
        else if (discriminator.Equals(nameof(StackImageDto), StringComparison.InvariantCultureIgnoreCase))
        {
            result = (StackImageDto)JsonConvert.DeserializeObject(jsonChallange.ToString(), typeof(StackImageDto));
        }
        else
        {
            throw new ApiException($"{nameof(MediaDto)} discriminator is not set properly.", HttpStatusCode.BadRequest);
        }

        return result;
    }

    public override bool CanWrite
    {
        get { return false; }
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

AbstractModelBinder执行上下文绑定,因为我在控制器的操作中使用 [FromForm] 属性获取数据:

public class AbstractModelBinder : IModelBinder
{
    public Task BindModelAsync(ModelBindingContext bindingContext)
    {
        if (bindingContext == null) throw new ArgumentNullException(nameof(bindingContext));

        // Fetch the value of the argument by name and set it to the model state
        string fieldName = bindingContext.FieldName;

        try
        {
            var data = ExtractDataFromContext(bindingContext)[0];
            var jsonData = JsonConvert.SerializeObject(data);
            bindingContext.ModelState.SetModelValue(fieldName, new ValueProviderResult(jsonData));

            var discriminator = JObject.Parse(jsonData)
                .Properties()
                .First(p => p.Name == "discriminator")
                .Value
                .ToString();

            // Deserialize the provided value and set the binding result
            if (discriminator.Equals(nameof(ImageDto), StringComparison.InvariantCultureIgnoreCase))
            {
                object o = JsonConvert.DeserializeObject<ImageDto>(jsonData, new MediaLibraryConverter());
                o = BindFormFiles(o, bindingContext);
                bindingContext.Result = ModelBindingResult.Success(o);
            }
            else if (discriminator.Equals(nameof(StackImageDto), StringComparison.InvariantCultureIgnoreCase))
            {
                object o = JsonConvert.DeserializeObject<StackImageDto>(jsonData, new MediaLibraryConverter());
                o = BindFormFiles(o, bindingContext);
                bindingContext.Result = ModelBindingResult.Success(o);
            }
        }
        catch (JsonException e)
        {
            bindingContext.Result = ModelBindingResult.Failed();
        }

        return Task.CompletedTask;
    }

BindFormFiles是一个递归函数,有助于将从 HttpContext 获取的 json 和 IFormFile 绑定到 MediaDto 的实例

    private object BindFormFiles(object tmp, ModelBindingContext bindingContext, string fieldName = null)
    {
        if (tmp == null)
        {
            return tmp;
        }

        var type = tmp.GetType();
        if (type.IsPrimitive || typeof(string).IsAssignableFrom(type))
        {
            return tmp;
        }

        if (typeof(IEnumerable).IsAssignableFrom(type) && !typeof(IEnumerable<IFormFile>).IsAssignableFrom(type))
        {
            var array = (IList)tmp;
            for (int i = 0; i < array.Count; i++)
            {
                array[i] = BindFormFiles(array[i], bindingContext, $"{fieldName}[{i}]");
            }
        }
        else
        {
            foreach (var property in tmp.GetType().GetProperties())
            {
                var name = property.Name;
                if (typeof(IFormFile).IsAssignableFrom(property.PropertyType))
                {
                    var file = bindingContext.HttpContext.Request.Form.Files
                        .FirstOrDefault(f => string.IsNullOrEmpty(fieldName)
                            ? f.Name.Equals($"{property.Name}", StringComparison.OrdinalIgnoreCase)
                            : f.Name.Equals($"{fieldName}.{property.Name}", StringComparison.OrdinalIgnoreCase)
                        );
                    if (file != null)
                    {
                        property.SetValue(tmp, file);
                    }
                }
                else if (typeof(IEnumerable).IsAssignableFrom(property.PropertyType))
                {
                    if (property.PropertyType == typeof(IEnumerable<IFormFile>))
                    {
                        var files = bindingContext.HttpContext.Request.Form.Files
                            .Where(f => string.IsNullOrEmpty(fieldName)
                                ? f.Name.Equals($"{property.Name}", StringComparison.OrdinalIgnoreCase)
                                : f.Name.Equals($"{fieldName}.{property.Name}", StringComparison.OrdinalIgnoreCase)
                            );
                        if (files?.Any() == true)
                        {
                            property.SetValue(tmp, files);
                        }
                    }
                    else
                    {
                        property.SetValue(
                            tmp,
                            BindFormFiles(
                                property.GetValue(tmp),
                                bindingContext,
                                string.IsNullOrEmpty(fieldName)
                                    ? property.Name
                                    : $"{fieldName}.{property.Name}"
                            )
                        );
                    }
                }
                else if (property.PropertyType.IsClass && !typeof(string).IsAssignableFrom(property.PropertyType))
                {
                    property.SetValue(
                        tmp,
                        BindFormFiles(
                            property.GetValue(tmp),
                            bindingContext,
                            property.Name
                        )
                    );
                }
            }
        }
        return tmp;
    }

ExtractDataFromContext是从 HttpContext 中提取数据的递归函数

    private List<Dictionary<string, object>> ExtractDataFromContext(ModelBindingContext bindingContext, string fieldName = null)
    {
        var i = 0;
        var propertyName = string.IsNullOrEmpty(fieldName)
            ? string.Empty
            : $"{fieldName}[{i}]";
        var result = new List<Dictionary<string, object>>();

        while (bindingContext.ActionContext.HttpContext.Request.Form
            .Where(kv => string.IsNullOrEmpty(propertyName)
                ? true
                : kv.Key.StartsWith(propertyName, StringComparison.OrdinalIgnoreCase)
            )
            .DistinctBy(kv => kv.Key.Substring(0, propertyName.Length))
            .Any()
        )
        {
            var values = bindingContext.ActionContext.HttpContext.Request.Form
                .Where(kv => string.IsNullOrEmpty(propertyName)
                    ? true
                    : kv.Key.StartsWith($"{fieldName}[{i}]", StringComparison.OrdinalIgnoreCase)
                )
                .ToDictionary(
                    kv => string.IsNullOrEmpty(propertyName)
                        ? kv.Key
                        : kv.Key.Replace($"{propertyName}.", string.Empty, StringComparison.OrdinalIgnoreCase),
                    kv => (object)kv.Value[0]
                );

            var subValues = values
                .Where(kv => kv.Key.Contains("]."))
                .GroupBy(kv => kv.Key.Substring(0, kv.Key.IndexOf("[")))
                .ToDictionary(
                    g => g.Key,
                    g => string.IsNullOrEmpty(propertyName)
                        ? (object)ExtractDataFromContext(bindingContext, $"{g.Key}")
                        : (object)ExtractDataFromContext(bindingContext, $"{propertyName}.{g.Key}")

                )
                .Concat(values
                    .Where(kv => kv.Key.Contains("]") && !kv.Key.Contains("]."))
                    .GroupBy(kv => kv.Key.Substring(0, kv.Key.IndexOf("[")))
                    .ToDictionary(
                        g => g.Key,
                        g => (object)g.Select(kv => kv.Value)
                    )
                );

            result.Add(values
                .Where(kv => !kv.Key.Contains("]"))
                .Concat(subValues)
                .ToList()
                .ToDictionary(
                    kv => kv.Key,
                    kv => kv.Value
                )
            );
            i++;
            propertyName = $"{fieldName}[{i}]";
        }
        return result;
    }

对于有兴趣了解 HttpContext.Request.Form 包含什么的人:

文件在此处输入图像描述

在此处输入图像描述

ValidateModelStateAttribute是一个 ActionFilterAttribute 验证所有控制器操作的当前 ModelState

[AttributeUsage(AttributeTargets.All, AllowMultiple = false)]
public class ValidateModelStateAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            context.Result = new BadRequestObjectResult(context.ModelState);
        }
    }
}

如您所见,ModelState 无效不是因为错误,而是因为 ValidationState 是“未验证”。

在此处输入图像描述

如果我绕过 ActionFilter 并进入我的控制器的操作,我可以看到 Dto 正确填充: 在此处输入图像描述

问题

我怎么能对context.ModelState说他的ValidationState是有效的?

标签: c#.net-core.net-core-2.2imodelbinder

解决方案


推荐阅读