ASP NET Core 本地化模型验证消息完全指南

在实现系统本地化的过程中，模型验证消息的本地化是一个绕不开的环节。毕竟，这些直接呈现给用户的错误信息，其友好性和准确性至关重要。

免费影视、动漫、音乐、游戏、小说资源长期稳定更新！ 👉 点此立即查看 👈

疑问产生

在标准的MVC架构下，我们通常会利用数据注解（Data Annotations）来装饰模型类，以实现请求参数的绑定和验证。一个典型的例子是这样的：

public class UserDto
{
    [Required(ErrorMessage = "姓名不能为空")]
    public string Name{get; set;}

    [Required(ErrorMessage = "年龄不能为空")]
    [Range(1, 120, ErrorMessage = "年龄必须在1到120之间")]
    public int? Age {get; set;}
}

单从功能上看，这没有任何问题。然而，一旦面临大批量模型需要本地化改造的场景，问题就浮现了——这几乎是一项重复性的体力劳动。

这就引出了一个核心疑问：我们真的必须为每个属性手工指定ErrorMessage吗？那些框架提供的默认错误消息难道不能用？仔细想想，除了字段名不同，我们手动编写的提示信息在结构上几乎一模一样，这种重复劳动似乎并无必要。

默认消息

抱着这个疑问，我们尝试删掉所有自定义的ErrorMessage：

public class UserDto
{
    [Required]
    public string Name{get; set;}

    [Required]
    [Range(1, 120)]
    public int? Age {get; set;}
}

运行验证，当参数缺失时，得到的消息是这样的：

"The Name field is required."

"The Age field is required."

没错，默认消息是英文的。这对中文用户显然不够友好，也解释了为什么之前我们不得不逐一进行手动设置。

查找默认消息

那么，有没有更彻底的办法？能否直接对框架的默认验证消息进行本地化？如果可以，岂不是一劳永逸，彻底告别手工设置ErrorMessage的烦恼？

顺着这个思路去翻阅官方源码，答案逐渐清晰。以RequiredAttribute为例，其默认错误消息来源于一个内部类SR：

public RequiredAttribute()
      : base(() => SR.RequiredAttribute_ValidationError)
{
}

进一步查看SR类的简化结构：

internal static partial class SR
{
    internal static global::System.Resources.ResourceManager ResourceManager => s_resourceManager ?? (s_resourceManager = new global::System.Resources.ResourceManager(typeof(FxResources.System.ComponentModel.Annotations.SR)));

    internal static string @RequiredAttribute_ValidationError => GetResourceString("RequiredAttribute_ValidationError", @"The {0} field is required.");
}

这里的逻辑很明确：GetResourceString方法最终会调用内部声明的ResourceManager。而这个资源管理器，会根据运行时文化和传入的类型参数，去定位对应的本地化资源文件。

本地化默认消息

分析到这里，路径就非常清楚了。要实现中文默认消息，我们只需要将翻译好的文本，放入正确命名的资源文件FxResources.System.ComponentModel.Annotations.SR.zh-CN.resources中即可。

动手之前，最好再确认一下。使用ILSpy等工具打开System.ComponentModel.Annotations.dll，确实可以看到名为FxResources.System.ComponentModel.Annotations.SR.resources的默认（中立语言）资源，这印证了我们的分析是完全正确的。

默认资源文件中包含了所有验证属性（如Required、Range、StringLength等）的错误消息模板，也包括一些内部的异常消息。我们可以根据自己的需要，对其进行全部或选择性的本地化。

建立语言扩展包

理论可行，接下来就是实践。我们新建一个类库项目，命名为 FxResources.System.ComponentModel.Annotations。根据.NET的资源命名规则，项目中创建的资源文件会自动加上项目默认命名空间作为前缀。

因此，我们只需在项目中添加一个名为SR的资源文件（.resx）即可。

如图所示，我们分别创建了针对简体中文（zh-Hans）和繁体中文（zh-Hant）的资源文件，并填入对应的翻译内容。这样一来，核心工作就完成了。

这里有个细节需要说明：语言标记zh-Hans（简体中文）兼容zh-CN、zh-SG等地区变体；zh-Hant（繁体中文）则兼容zh-TW、zh-MO、zh-HK。严格来说，港澳台地区的用词习惯略有差异，但在大多数通用场景下，使用统一的繁体中文资源已足够。

最终效果

现在，回到最初那个例子，我们不再需要指定任何ErrorMessage：

public class UserDto
{
    [Required]
    public string Name{get; set;}

    [Required]
    [Range(1, 120)]
    public int? Age {get; set;}
}

当验证触发时，用户看到的将是地道的中文提示，效果立竿见影：

"Name 字段为必填项。"

"Age 字段为必填项。"

需要注意的是：如果你的项目尚未启用或配置完整的国际化（I18N）中间件，你可能需要在应用启动时显式设置默认的UI文化，例如：CultureInfo.DefaultThreadUICulture = CultureInfo.GetCultureInfo(“zh-Hans”)，以确保资源查找机制能正确生效。

Nuget包

为了方便广大开发者直接使用，已经将制作好的中文简体语言资源打包并发布到了NuGet。只需在项目中执行以下命令即可安装：

Install-Package FxResources.System.ComponentModel.Annotations.zh-Hans -Version 9.0.0

由于不同版本的.NET框架中，验证消息的文本可能存在细微调整，因此语言包也对应不同的主版本。请大家根据自己项目使用的.NET版本，选择对应版本的语言包进行安装，以达到最佳兼容效果。