.NET6 Web API本地化：实现点符号调用与资源键一致性校验

一、实现强类型资源的点符号调用 #

1. 配置资源文件生成强类型类 #

右键主资源文件（比如Resources/ApiResources.resx），打开属性面板：

• 设置自定义工具为 PublicResXFileCodeGenerator
• 设置自定义工具命名空间为项目根命名空间（如YourApi.Resources）

所有语言的资源文件（如ApiResources.zh-CN.resx、ApiResources.en-US.resx）需保持和主文件相同的前缀，并在属性面板中设置依赖项为主资源文件，编译时会自动生成统一的强类型类ApiResources。

2. 强类型方式调用资源 #

在控制器或服务中注入IStringLocalizer<ApiResources>，调用时用点符号或nameof避免硬编码：

using Microsoft.Extensions.Localization;
using YourApi.Resources;

[ApiController]
[Route("api/[controller]")]
public class DemoController : ControllerBase
{
    private readonly IStringLocalizer<ApiResources> _localizer;

    public DemoController(IStringLocalizer<ApiResources> localizer)
    {
        _localizer = localizer;
    }

    [HttpGet]
    public IActionResult Get()
    {
        // 方式1：直接点符号调用（生成的类自动支持）
        var langText = _localizer.Language;
        // 方式2：用nameof确保键修改时编译报错
        var langText2 = _localizer[nameof(ApiResources.Language)];
        
        return Ok(new { Language = langText });
    }
}

资源键修改时编译阶段就会报错，彻底避免硬编码带来的运行时问题。

3. 验证项目配置 #

检查项目文件（.csproj），确保资源文件配置正确：

<ItemGroup>
  <EmbeddedResource Update="Resources\ApiResources.resx">
    <Generator>PublicResXFileCodeGenerator</Generator>
    <LastGenOutput>ApiResources.Designer.cs</LastGenOutput>
  </EmbeddedResource>
  <EmbeddedResource Update="Resources\ApiResources.zh-CN.resx">
    <DependentUpon>ApiResources.resx</DependentUpon>
  </EmbeddedResource>
  <EmbeddedResource Update="Resources\ApiResources.en-US.resx">
    <DependentUpon>ApiResources.resx</DependentUpon>
  </EmbeddedResource>
</ItemGroup>

二、保障多语言资源文件键一致性 #

1. 利用Visual Studio自带同步功能 #

打开主资源文件，在资源编辑器顶部点击同步按钮，Visual Studio会自动将主文件的键同步到所有语言文件，新增/删除键时自动处理，避免手动遗漏。

2. 编译时键一致性检查 #

编写简单验证工具，在编译前检查所有语言文件的键是否和主文件一致：

using System.Xml.Linq;
using System.Linq;

var mainResx = @"Resources\ApiResources.resx";
var otherResxFiles = new[] { @"Resources\ApiResources.zh-CN.resx", @"Resources\ApiResources.en-US.resx" };

// 读取主文件的所有键
var mainKeys = XDocument.Load(mainResx)
    .Descendants("data")
    .Select(d => d.Attribute("name")?.Value)
    .Where(k => !string.IsNullOrEmpty(k))
    .ToHashSet();

foreach (var file in otherResxFiles)
{
    var currentKeys = XDocument.Load(file)
        .Descendants("data")
        .Select(d => d.Attribute("name")?.Value)
        .Where(k => !string.IsNullOrEmpty(k))
        .ToHashSet();

    var missingKeys = mainKeys.Except(currentKeys);
    var extraKeys = currentKeys.Except(mainKeys);

    if (missingKeys.Any())
    {
        Console.WriteLine($"[错误] {file} 缺少以下键：{string.Join(", ", missingKeys)}");
        Environment.Exit(1); // 终止编译
    }
    if (extraKeys.Any())
    {
        Console.WriteLine($"[错误] {file} 存在多余键：{string.Join(", ", extraKeys)}");
        Environment.Exit(1);
    }
}

将工具做成控制台项目，在主项目的.csproj中添加预编译事件：

<Target Name="ValidateResxKeys" BeforeTargets="Build">
  <Exec Command="dotnet run --project ResxKeyValidator/ResxKeyValidator.csproj" />
</Target>

键不一致时编译直接失败，提前发现问题。

3. 第三方工具辅助 #

使用ResXManager这类可视化工具管理多语言资源，它能自动同步键、检测缺失/多余键，支持团队协作，减少手动维护的出错概率。

内容的提问来源于stack exchange，提问作者Jolly