繁体   English   中英

如何在 ASP.NET Core 中本地化验证属性的标准错误消息

[英]How to localize standard error messages of validation attributes in ASP.NET Core

如何在 ASP.NET Core (v2.2) 中本地化验证属性的标准错误消息? 例如, [Required]属性有这个错误信息“ The xxx field is required. ”; [EmailAddress]有“ xxx 字段不是有效的电子邮件地址。 ”; 【比较】有“ 'xxx'和'yyy'不匹配。 ”等。 在我们的项目中,我们不使用英语,我想找到一种方法来翻译标准错误消息,而无需将它们直接写入每个数据模型类的每个属性中

这在docs 中有详细说明。 您可以执行以下任一操作:

  1. 在属性上使用ResourcePath选项。

     [Required(ResourcePath = "Resources")]

    然后,您将本地化的消息添加到Resources/Namespace.To.MyClass.[lang].resx

  2. 对所有类使用一个资源文件:

     public void ConfigureServices(IServiceCollection services) { services.AddMvc() .AddDataAnnotationsLocalization(options => { options.DataAnnotationLocalizerProvider = (type, factory) => factory.Create(typeof(SharedResource)); }); }

如果您只想本地化错误消息而不是构建多语言站点,您可以试试这个:(消息字符串可能是您的语言。)

  1. 添加自定义IValidationMetadataProvider
    public class MyModelMetadataProvider : IValidationMetadataProvider
    {
        public void CreateValidationMetadata(ValidationMetadataProviderContext context)
        {
            if (context == null)
            {
                throw new ArgumentNullException();
            }
            var validators = context.ValidationMetadata.ValidatorMetadata;

            // add [Required] for value-types (int/DateTime etc)
            // to set ErrorMessage before asp.net does it
            var theType = context.Key.ModelType;
            var underlyingType = Nullable.GetUnderlyingType(theType);

            if (theType.IsValueType &&
                underlyingType == null && // not nullable type
                validators.Where(m => m.GetType() == typeof(RequiredAttribute)).Count() == 0)
            {
                validators.Add(new RequiredAttribute());
            }
            foreach (var obj in validators)
            {
                if (!(obj is ValidationAttribute attribute))
                {
                    continue;
                }
                fillErrorMessage<RequiredAttribute>(attribute, 
                    "You must fill in '{0}'.");
                fillErrorMessage<MinLengthAttribute>(attribute, 
                    "Min length of '{0}' is {1}.");
                fillErrorMessage<MaxLengthAttribute>(attribute, 
                    "Max length of '{0}' is {1}.");
                fillErrorMessage<EmailAddressAttribute>(attribute, 
                    "Invalid email address.", true);
                // other attributes like RangeAttribute, CompareAttribute, etc
            }
        }
        private void fillErrorMessage<T>(object attribute, string errorMessage, 
            bool forceOverriding = false) 
            where T : ValidationAttribute
        {
            if (attribute is T validationAttribute)
            {
                if (forceOverriding ||
                    (validationAttribute.ErrorMessage == null 
                    && validationAttribute.ErrorMessageResourceName == null))
                {
                    validationAttribute.ErrorMessage = errorMessage;
                }
            }
        }
    }
  1. Startup.cs添加一些行:
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllersWithViews()
                .AddMvcOptions(m => {
                    m.ModelMetadataDetailsProviders.Add(new MyModelMetadataProvider());

                    m.ModelBindingMessageProvider.SetValueMustBeANumberAccessor(
                        fieldName => string.Format("'{0}' must be a valid number.", fieldName));
                    // you may check the document of `DefaultModelBindingMessageProvider`
                    // and add more if needed

                })
                ;
        }

参见DefaultModelBindingMessageProvider 的文档

如果您能用日语阅读,请参阅这篇文章了解更多详情。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM