.net core 實作基于 JSON 的多語言

Intro

上次我們提到了，微軟默認提供基于資源檔案的多語言本地化，個人感覺使用起來不是太方便，沒有 json 看起來直觀，于是動手造了一個輪子， dotnet core 基于 json 的本地化組件

GetStarted

需要參考 nuget 包 WeihanLi.Extensions.Localization.Json

注冊服務：

services.AddJsonLocalization(options =>
    {
        options.ResourcesPath = Configuration.GetAppSetting("ResourcesPath");
        options.ResourcesPathType = ResourcesPathType.TypeBased; // 默認方式和微軟找資源的方式類似
        // options.ResourcesPathType = ResourcesPathType.CultureBased; // 在對應的 culture 子目錄下尋找資源檔案，可以參考后面的示例
    });

中間件配置(如果是asp.net core，和之前一樣):

app.UseRequestLocalization();

That's it~

添加你的資源檔案

TypeBased 資源檔案的路徑

For Types:

Home/Index => Controllers/HomeController

資源路徑：

[ResourcesPath]/Controllers/HomeController.[cultureName].json

示例:

Resources/Controllers/HomeController.en.json
Resources/Controllers/HomeController.zh.json

For Razor 視圖:

示例:

Resources/Views/Home/Index.en.json
Resources/Views/Home/Index.zh.json

CultureBased 資源檔案路徑

For Types:

Home/Index => Controllers/HomeController

資源路徑:

[ResourcesPath]/[cultureName]/Controllers/HomeController.json

示例：

Resources/en/Controllers/HomeController.json
Resources/zh/Controllers/HomeController.json

For Razor 視圖:

示例：

Resources/en/Views/Home/Index.json
Resources/zh/Views/Home/Index.json

Copy your resource files to output:

需要設定將資源檔案拷貝到輸出目錄，否則會找不到資源檔案，可以在啟動專案專案檔案中加入以下示例代碼：

<ItemGroup>
<Content Update="Resources\**\*.json">
    <CopyToOutputDirectory>Always</CopyToOutputDirectory>
</Content>
</ItemGroup>

上面的配置會將 Resources 目錄下的所有 json 檔案拷貝到輸出目錄下，可以根據自己的需要進行修改

Use

用法和之前是一樣的

Controller 示例：

public class ValuesController : Controller
{
    private readonly IStringLocalizer<ValuesController> _localizer;

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

    // GET: api/<controller>
    [HttpGet]
    public string Get()
    {
        return _localizer["Culture"];
    }
}

Razor 視圖示例：

@using Microsoft.AspNetCore.Mvc.Localization
@using Microsoft.Extensions.Localization
@using WeihanLi.Extensions.Localization.Json.Sample.Controllers
@inject IHtmlLocalizer<HomeController> HtmlLocalizer
@inject IStringLocalizer<HomeController> StringLocalizer
@inject IViewLocalizer ViewLocalizer
@{
    ViewData["Title"] = "Index";
}

<h2>Index</h2>

<div>string: @StringLocalizer["Hello"]</div>

<div>html: @HtmlLocalizer["Hello"]</div>

<div>view: @ViewLocalizer["Hello"]</div>

資源檔案示例：