在ModelState.Errors中使用[JsonProperty("name")]

本文关键字：quot name JsonProperty Errors ModelState | 更新日期: 2023-09-27 18:18:28

我们有几个模型通过JsonProperty覆盖该名称，但是当我们通过ModelState获得验证错误时，这会导致一个问题。例如:

class MyModel
{
    [JsonProperty("id")]
    [Required]
    public string MyModelId {get;set;}
}
class MyModelController
{
    public IHttpActionResult Post([FromBody] MyModel model)
    {
        if (!ModelState.IsValid)
        {
            return HttpBadRequest(ModelState);
        }
        /* etc... */
    }
}

上面的Post将返回错误The MyModelId field is required.，这是不准确的。我们把它写成The id field is required.。我们已经尝试使用[DataMember(Name="id")]，但得到相同的结果。

问题1:除了在每个[Required]属性上提供我们自己的错误消息外，是否有一种方法可以让ModelState错误显示JSON属性名称而不是c#属性名称?

——更新——

我一直在玩这个，发现了一个"自己动手"的方法来重新创建使用自定义属性名称的错误消息。我真的希望有一个内置的方法来做到这一点，但这似乎做的工作…

https://gist.github.com/Blackbaud-JasonTremper/b64dc6ddb460afa1698daa6d075857e4

问题2:假定Key与<parameterName>.<reflectedProperty>语法匹配，或者在某些情况下这可能不正确?

问题3:是否有更简单的方法来确定JSON参数名称预期是什么，而不是通过反射[DataMember]或[JsonProperty]属性进行搜索?

在ModelState.Errors中使用[JsonProperty("name")]

您是否尝试使用DisplayName属性?

displayname attribute vs display attribute

也可以给[Required]属性指定一个错误消息。

[Required(ErrorMessage = "Name is required")]

我也面临这个问题，我修改了一些代码从你的链接，以适应我的WebAPI。modelState还将存储旧的键，它是模型的变量名，加上Json属性名。

    首先，创建过滤器ValidateModelStateFilter
  1. 在控制器方法上面添加[ValidateModelStateFilter]

过滤器源代码:

public class ValidateModelStateFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        var descriptor = actionContext.ActionDescriptor;
        var modelState = actionContext.ModelState;
        if (descriptor != null)
        {
            var parameters = descriptor.GetParameters();
            var subParameterIssues = modelState.Keys
                                               .Where(s => s.Contains("."))
                                               .Where(s => modelState[s].Errors.Any())
                                               .GroupBy(s => s.Substring(0, s.IndexOf('.')))
                                               .ToDictionary(g => g.Key, g => g.ToArray());
            foreach (var parameter in parameters)
            {
                var argument = actionContext.ActionArguments[parameter.ParameterName];
                if (subParameterIssues.ContainsKey(parameter.ParameterName))
                {
                    var subProperties = subParameterIssues[parameter.ParameterName];
                    foreach (var subProperty in subProperties)
                    {
                        var propName = subProperty.Substring(subProperty.IndexOf('.') + 1);
                        var property = parameter.ParameterType.GetProperty(propName);
                        var validationAttributes = property.GetCustomAttributes(typeof(ValidationAttribute), true);
                        var value = property.GetValue(argument);
                        modelState[subProperty].Errors.Clear();
                        foreach (var validationAttribute in validationAttributes)
                        {
                            var attr = (ValidationAttribute)validationAttribute;
                            if (!attr.IsValid(value))
                            {
                                var parameterName = GetParameterName(property);
                                // modelState.AddModelError(subProperty, attr.FormatErrorMessage(parameterName));
                                modelState.AddModelError(parameterName, attr.FormatErrorMessage(parameterName));
                            }
                        }
                    }
                }

            }
        }
    }
    private string GetParameterName(PropertyInfo property)
    {
        var dataMemberAttribute = property.GetCustomAttributes<DataMemberAttribute>().FirstOrDefault();
        if (dataMemberAttribute?.Name != null)
        {
            return dataMemberAttribute.Name;
        }
        var jsonProperty = property.GetCustomAttributes<JsonPropertyAttribute>().FirstOrDefault();
        if (jsonProperty?.PropertyName != null)
        {
            return jsonProperty.PropertyName;
        }
        return property.Name;
    }
}

您可以访问参数类型，获取json名称，然后将属性名称替换为json名称。像这样:

var invalidParameters = (from m in actionContext.ModelState
                         where m.Value.Errors.Count > 0
                         select new InvalidParameter
                         {
                              ParameterName = m.Key,
                              ConstraintViolations = (from msg in m.Value.Errors select msg.ErrorMessage).ToArray()
                         }).AsEnumerable().ToArray();
if (actionContext.ActionDescriptor.Parameters.Count == 1)
{
    var nameMapper = new Dictionary<string, string>();
    foreach (var property in actionContext.ActionDescriptor.Parameters[0].ParameterType.GetProperties())
    {
        object[] attributes = property.GetCustomAttributes(typeof(JsonPropertyNameAttribute), false);
        if (attributes.Length != 1) continue;
        nameMapper.Add(property.Name, ((JsonPropertyNameAttribute) attributes[0]).Name);
    }
    var modifiedInvalidParameters = new List<InvalidParameter>();

    foreach (var invalidParameter in invalidParameters)
    {
        if(invalidParameter.ParameterName != null && nameMapper.TryGetValue(invalidParameter.ParameterName, out var mappedName))
        {
            var modifiedConstraintViolations = new List<string>();
            foreach (var constraintViolation in invalidParameter.ConstraintViolations ?? Enumerable.Empty<string>())
            {
                modifiedConstraintViolations.Add(constraintViolation.Replace(invalidParameter.ParameterName, mappedName));
            }
            modifiedInvalidParameters.Add(new InvalidParameter
            {
                ParameterName = mappedName,
                ConstraintViolations = modifiedConstraintViolations.ToArray()
            });
        }
        else
        {
            modifiedInvalidParameters.Add(invalidParameter);
        }
    }
    invalidParameters = modifiedInvalidParameters.ToArray();
}

public struct InvalidParameter
{
    [JsonPropertyName("parameter_name")]
    public string? ParameterName { get; set; }
    [JsonPropertyName("constraint_violations")]
    public string[]? ConstraintViolations { get; set; }
}

对于任何在。net 6/7中遇到同样问题的人

这是最近在。net 7中修复的。

为了在System.Text.Json.Serialization中使用JsonPropertyName，在Program.cs

中的配置中添加以下内容
builder.Services.AddControllers(options => 
            options.ModelMetadataDetailsProviders.Add(new SystemTextJsonValidationMetadataProvider()));

为了在Newtonsoft.Json中使用JsonProperty.Name，在Program.cs

中的配置中添加以下内容
builder.Services.AddControllers(options => 
            options.ModelMetadataDetailsProviders.Add(new NewtonsoftJsonValidationMetadataProvider()));

。. NET 7文档

。NET 7发布

相关文章：