使用JSON简化.NET多语言支持：Senlin.Mo.Localization

使用JSON简化.NET多语言支持：Senlin.Mo.Localization

介绍

本地化是现代应用开发中的关键方面，使软件能够面向全球用户。然而，像.NET的resx文件这样的传统方法可能会复杂且繁琐。Senlin.Mo.Localization就是一种JSON为导向的替代方案，它简化了这一过程，同时保持了功能性。

什么是Senlin.Mo.Localization？

Senlin.Mo.Localization是一个.NET库，旨在简化应用程序中的多语言支持。它使用源生成器和JSON配置文件来自动创建资源文件，使本地化过程更加轻松高效。

开始使用

要开始使用Senlin.Mo.Localization，请按照以下步骤操作：

添加NuGet包

首先，将NuGet包添加到您的.NET项目中：

dotnet add package Senlin.Mo.Localization

定义JSON文件

接下来，创建并定义包含本地化字符串的JSON文件。
基本JSON示例

在您的项目目录中创建一个l.json文件，内容如下

{
  "hello": "Hello",
  "sayHelloTo": "Hello {name}!"
}

项目配置

通过在您的.csproj文件中添加以下XML配置来包含JSON文件：

<ItemGroup>
    <AdditionalFiles Include="l.json">
        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </AdditionalFiles>
</ItemGroup>

生成的文件

配置项目后，您可以在代码中使用生成的资源文件。以下是一个全面的示例：
代码示例

var zh = new ZhResource();
var ja = new JaResource();
var resourceProvider = new LResourceProvider(zh, ja);

var currentCulture = "zh";
GetCulture getCulture = () => currentCulture;
GetCultureResource getCultureResource = resourceProvider.GetResource;

var resolver = new LStringResolver(getCulture, getCultureResource);
var zhHello = resolver[L.Hello];
Console.WriteLine(zhHello);

currentCulture = "ja";
var jaHello = resolver[L.Hello];
Console.WriteLine(jaHello);

Console.WriteLine(resolver[L.SayHelloTo("世界")]);
currentCulture = "unknown";
Console.WriteLine(resolver[L.SayHelloTo("World")]);

public class JaResource : LResource
{
    public override string Culture => "ja";

    protected override string Hello => "こんにちは";

    protected override string SayHelloTo => "こんにちは、{name}";
}

public class ZhResource : ILResource
{
    public string Culture => "zh";

    public Dictionary<string, string> GetResource()
    {
        var jsonPath = Path.Combine(
            Directory.GetCurrentDirectory(),
            "L",
            $"{Culture}.json");
        var json = File.ReadAllText(jsonPath);
        return JsonSerializer.Deserialize<Dictionary<string, string>>(json)!;
    }
}

添加其他语言

要添加对其他语言的支持，请按照以下步骤操作：

• 创建一个名为L的文件夹。
• 在L文件夹内添加一个zh.json文件，内容如下：

{
  "hello": "你好",
  "sayHelloTo": "你好，{name}！"
}

• 修改项目配置以包含新的JSON文件：

<ItemGroup>
    <None Update="L\*.json">
        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
</ItemGroup>

自定义配置

如果需要修改默认文件，您可以按如下方式自定义配置：

<Project>
    <PropertyGroup>
        <MoLocalizationFile>l-customize.config</MoLocalizationFile>
    </PropertyGroup>
    <ItemGroup>
        <CompilerVisibleProperty Include="MoLocalizationFile" />
    </ItemGroup>
</Project>

总结

Senlin.Mo.Localization提供了一种简化的、以JSON为导向的替代传统.NET resx文件的方法，使多语言支持变得简单高效。您可以试试它，亲身体验本地化的便利。如果您觉得这篇文章对您有帮助，请给Github仓库点个星！