.NET Core 中多语言支持的实现方法

在全球化的今天，软件应用需要适应不同地区和语言的用户需求。在 .NET Core 中，实现多语言支持（本地化）变得相对简单。本文将详细介绍如何在 .NET Core 中实现多语言支持，并对每个步骤进行深入解析。😊

一、什么是多语言支持？

多语言支持（Localization）是指根据用户的区域和语言偏好，动态地呈现适当的内容，如文本、日期、货币等。

二、基本实现步骤

1. 创建资源文件

在项目中添加 资源文件（.resx），用于存储不同语言的文本。

• 默认资源文件：Resources.resx
• 中文资源文件：Resources.zh.resx
• 英文资源文件：Resources.en.resx

2. 配置服务

在 Startup.cs 中，添加多语言支持的相关服务。

public void ConfigureServices(IServiceCollection services)
{
    services.AddLocalization(options => options.ResourcesPath = "Resources");
    services.AddControllersWithViews()
        .AddViewLocalization()
        .AddDataAnnotationsLocalization();
}

解释：

• AddLocalization：添加本地化服务，指定资源文件的路径为 Resources。
• AddControllersWithViews：添加 MVC 控制器和视图支持。
• AddViewLocalization：启用视图本地化。
• AddDataAnnotationsLocalization：启用数据注解本地化。

3. 配置中间件

在 Configure 方法中，添加请求本地化中间件。

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    var supportedCultures = new[] { "en", "zh" };
    var localizationOptions = new RequestLocalizationOptions()
        .SetDefaultCulture(supportedCultures[0])
        .AddSupportedCultures(supportedCultures)
        .AddSupportedUICultures(supportedCultures);

    app.UseRequestLocalization(localizationOptions);

    // 其他中间件配置
    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

解释：

• supportedCultures：定义支持的语言文化。
• SetDefaultCulture：设置默认文化为 en。
• UseRequestLocalization：启用请求本地化中间件。

4. 在代码中使用本地化资源

在控制器或视图中，注入 IStringLocalizer，并使用本地化字符串。

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

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

    public IActionResult Index()
    {
        ViewData["Message"] = _localizer["WelcomeMessage"];
        return View();
    }
}

解释：

• IStringLocalizer<HomeController>：本地化字符串接口，泛型参数为当前类。
• _localizer["WelcomeMessage"]：获取键为 WelcomeMessage 的本地化字符串。

5. 创建资源文件内容

在 Resources 文件夹下的资源文件中，添加对应的键值对。

• Resources.resx：	Name	Value
  WelcomeMessage	Welcome to our website!

• Resources.zh.resx：	Name	Value
  WelcomeMessage	欢迎来到我们的网站！

三、工作流程图

flowchart TD
A[用户请求] --> B[请求中间件]
B --> C{检查语言偏好}
C -- 有 --> D[加载对应资源]
C -- 无 --> E[使用默认语言]
D & E --> F[返回本地化内容]

解释：

• 请求经过本地化中间件，检查用户的语言偏好，加载相应的资源文件，返回本地化后的内容。

四、如何设置用户语言偏好？

用户的语言偏好通常通过以下方式确定：

• Accept-Language 请求头
• 查询字符串 参数，如 ?culture=zh
• Cookie 中保存的语言设置

在请求中间件中添加语言提供程序

var localizationOptions = new RequestLocalizationOptions()
    .SetDefaultCulture(supportedCultures[0])
    .AddSupportedCultures(supportedCultures)
    .AddSupportedUICultures(supportedCultures);

localizationOptions.RequestCultureProviders.Insert(0, new QueryStringRequestCultureProvider());

解释：

• RequestCultureProviders：请求文化提供程序列表。
• QueryStringRequestCultureProvider：通过查询字符串获取文化信息。

五、重要概念对比

六、常见问题及解决方案

问题一：资源文件未被正确加载

解决方案：

• 确认资源文件的命名正确，格式为 Resources.[Culture].resx。
• 确保资源文件的 访问修饰符 设置为 Public。

问题二：无法获取本地化字符串

解决方案：

• 检查是否正确注入了 IStringLocalizer。
• 确认键名是否一致，注意大小写敏感。

七、实践建议

• 使用命名空间组织资源文件：根据功能模块，将资源文件放在对应的文件夹中，方便管理。
• 避免硬编码字符串：所有需要本地化的字符串，都应放入资源文件中。
• 定期更新资源文件：在添加新功能时，及时更新各语言的资源文件，保持一致性。

八、总结

通过以上步骤，我们成功地在 .NET Core 中实现了多语言支持。利用资源文件和本地化中间件，可以根据用户的语言偏好，动态地呈现对应的内容。👍

注意：在实际开发中，需要根据项目需求，支持更多的语言和更复杂的本地化逻辑。