目录
1. 需要更新的教程
有许多关于如何在ASP.NET Core 8 MVC构建多语言应用程序的教程,但许多教程对于旧版本的.NET来说已经过时,或者对于如何解决将所有语言资源string放在单个文件中的问题含糊不清。因此,该计划是提供有关如何做到这一点的实用说明,并附有代码示例和概念验证示例应用程序。
1.1 本系列文章
本系列中的文章包括:
- ASP.NET 8——使用单个Resx文件的多语言应用程序
- ASP.NET 8——使用单个Resx文件的多语言应用程序——第2部分——替代方法
- ASP.NET 8——使用单个Resx文件的多语言应用程序——第3部分——表单验证字符串
- ASP.NET 8——具有单个Resx文件的多语言应用程序——第4部分——资源管理器
2. 多语言网站、全球化和本地化
我不打算在这里解释拥有多种语言的网站有什么好处,以及什么是本地化和全球化。您可以在互联网上的许多地方阅读它(参见[4])。我将重点介绍如何在ASP.NET Core 8 MVC中实际构建这样一个站点。如果您不确定什么是.resx文件,这可能不适合您。
3. 共享资源方法
默认情况下,ASP.NET Core 8 MVC技术为每个控制器和视图设想单独的资源文件.resx。但是大多数人不喜欢它,因为大多数多语言string在应用程序的不同位置是相同的,我们希望它都在同一个地方。文献[1]将这种方法称为“共享资源”方法。为了实现它,我们将创建一个标记类SharedResoureces.cs来对所有资源进行分组。然后,在我们的应用程序中,我们将为该特定类/类型调用依赖注入(DI),而不是特定的控制器/视图。这是Microsoft文档[1]中提到的一个小技巧,在StackOverflow文章[6]中一直是混淆的根源。我们计划在这里揭开它的神秘面纱。虽然一切都在[1]中进行了解释,但需要的是一些实际示例,例如我们在这里提供的示例。
4. 多语种申请步骤
4.1 配置本地化服务和中间件
本地化服务配置Program.cs:
private static void AddingMultiLanguageSupportServices(WebApplicationBuilder? builder)
{
if (builder == null) { throw new Exception("builder==null"); };
builder.Services.AddLocalization(options => options.ResourcesPath = "Resources");
builder.Services.AddMvc()
.AddViewLocalization(LanguageViewLocationExpanderFormat.Suffix);
builder.Services.Configure<RequestLocalizationOptions>(options =>
{
var supportedCultures = new[] { "en", "fr", "de", "it" };
options.SetDefaultCulture(supportedCultures[0])
.AddSupportedCultures(supportedCultures)
.AddSupportedUICultures(supportedCultures);
});
}
private static void AddingMultiLanguageSupport(WebApplication? app)
{
app?.UseRequestLocalization();
}
4.2 创建标记类SharedResources.cs
这只是一个用于对共享资源进行分组的虚拟标记类。我们需要它的名称和类型。
似乎命名空间需要与应用根命名空间相同,而应用根命名空间需要与程序集名称相同。我在更改命名空间时遇到了一些问题,它不起作用。如果它不适合您,您可以尝试在DI指令中使用完整的类名,如下所示:
IStringLocalizer<SharedResources01.SharedResource> StringLocalizer
名称“SharedResource”没有魔力,您可以将其命名为“MyResources”并将代码中的所有引用更改为“MyResources”,所有引用仍然有效。
位置似乎可以是任何文件夹,尽管有些文章([6]声称它需要是根项目文件夹,但我在此示例中没有看到此类问题。对我来说,看起来它可以是任何文件夹,只需保持命名空间整洁即可。
//SharedResource.cs===================================================
namespace SharedResources01
{
/*
* This is just a dummy marker class to group shared resources
* We need it for its name and type
*
* It seems the namespace needs to be the same as app root namespace
* which needs to be the same as the assembly name.
* I had some problems when changing the namespace, it would not work.
* If it doesn't work for you, you can try to use full class name
* in your DI instruction, like this one:
* IStringLocalizer<SharedResources01.SharedResource> StringLocalizer
*
* There is no magic in the name "SharedResource", you can
* name it "MyResources" and change all references in the code
* to "MyResources" and all will still work
*
* Location seems can be any folder, although some
* articles claim it needs to be the root project folder
* I do not see such problems in this example.
* To me looks it can be any folder, just keep your
* namespace tidy.
*/
public class SharedResource
{
}
}
4.3 创建语言资源文件
在“资源”文件夹中,创建语言资源文件,并确保将其命名为 SharedResources.xx.resx。
4.4 选择语言/文化
基于[5],本地化服务有三个默认提供程序:
- QueryStringRequestCultureProvider
- CookieRequestCultureProvider
- AcceptLanguageHeaderRequestCultureProvider
由于大多数应用通常会提供一种机制来设置区域性,用于使用ASP.NET Core区域性Cookie设置区域性,因此在示例中,我们将仅关注该方法。
这是设置.AspNetCore.Culture cookie的代码:
private void ChangeLanguage_SetCookie(HttpContext myContext, string? culture)
{
if(culture == null) { throw new Exception("culture == null"); };
//this code sets .AspNetCore.Culture cookie
myContext.Response.Cookies.Append(
CookieRequestCultureProvider.DefaultCookieName,
CookieRequestCultureProvider.MakeCookieValue(new RequestCulture(culture)),
new CookieOptions { Expires = DateTimeOffset.UtcNow.AddMonths(1) }
);
}
使用Chrome DevTools可以很容易地看到Cookie:
我构建了一个小型应用程序来演示它,这是我更改语言的屏幕:
请注意,我在页脚中添加了一些调试信息,以显示请求语言cookie 的值,以查看应用程序是否按预期工作。
4.5 在控制器中使用本地化服务
当然,在控制器中,依赖注入(DI)进入并填充所有依赖项。关键是我们要求一个特定的type=SharedResource。
如果它不适合您,您可以尝试在DI指令中使用完整的类名,如下所示:IStringLocalizer<SharedResources01.SharedResource> stringLocalizer。
下面是代码片段:
public class HomeController : Controller
{
private readonly ILogger<HomeController> _logger;
private readonly IStringLocalizer<SharedResource> _stringLocalizer;
private readonly IHtmlLocalizer<SharedResource> _htmlLocalizer;
/* Here is, of course, the Dependency Injection (DI) coming in and filling
* all the dependencies. The key thing is we are asking for a specific
* type=SharedResource.
* If it doesn't work for you, you can try to use full class name
* in your DI instruction, like this one:
* IStringLocalizer<SharedResources01.SharedResource> stringLocalizer
*/
public HomeController(ILogger<HomeController> logger,
IStringLocalizer<SharedResource> stringLocalizer,
IHtmlLocalizer<SharedResource> htmlLocalizer)
{
_logger = logger;
_stringLocalizer = stringLocalizer;
_htmlLocalizer = htmlLocalizer;
}
//================================
public IActionResult LocalizationExample(LocalizationExampleViewModel model)
{
//so, here we use IStringLocalizer
model.IStringLocalizerInController = _stringLocalizer["Wellcome"];
//so, here we use IHtmlLocalizer
model.IHtmlLocalizerInController = _htmlLocalizer["Wellcome"];
return View(model);
}
4.6 在视图中使用本地化服务
当然,在视图中,依赖注入(DI)进入并填充所有依赖项。关键是我们要求一个特定的type=SharedResource。
如果它不适合您,您可以尝试在DI指令中使用完整的类名,如下所示:
IStringLocalizer<SharedResources01.SharedResource> stringLocalizer
下面是代码片段:
@* LocalizationExample.cshtml ====================================================*@
@using Microsoft.AspNetCore.Mvc.Localization
@using Microsoft.Extensions.Localization
@model LocalizationExampleViewModel
@* Here is of course the Dependency Injection (DI) coming in and filling
all the dependencies. The key thing is we are asking for a specific
type=SharedResource.
If it doesn't work for you, you can try to use full class name
in your DI instruction, like this one:
@inject IStringLocalizer<SharedResources01.SharedResource> StringLocalizer
*@
@inject IStringLocalizer<SharedResource> StringLocalizer
@inject IHtmlLocalizer<SharedResource> HtmlLocalizer
@{
<div style="width:600px">
<p class="bg-info">
IStringLocalizer Localized in Controller:
@Model.IStringLocalizerInController
</p>
<p class="bg-info">
@{
string? text1 = StringLocalizer["Wellcome"];
}
IStringLocalizer Localized in View: @text1
</p>
<p class="bg-info">
IHtmlLocalizer Localized in Controller:
@Model.IHtmlLocalizerInController
</p>
<p class="bg-info">
@{
string? text2 = "Wellcome";
}
IHtmlLocalizer Localized in View: @HtmlLocalizer[@text2]
</p>
</div>
}
4.7 执行结果
执行结果如下所示:
请注意,我在页脚中添加了一些调试信息,以显示请求语言cookie 的值,以查看应用程序是否按预期工作。
4.8 IHtmlLocalizer<SharedResource>的问题
我在IHtmlLocalizer<SharedResource>上遇到了一些问题。 它解析string并转换它们,这表明设置是正确的。但是,正如宣传的那样,它不适用于HTML。我尝试翻译像“<b>Wellcome</b>”这样的简单HTML,但它不起作用。但它适用于像“Wellcome”这样的简单字符串。
5. 完整代码
由于大多数人都喜欢可以复制粘贴的代码,因此这是应用程序的完整代码。
//Program.cs===========================================================================
namespace SharedResources01
{
public class Program
{
public static void Main(string[] args)
{
//=====Middleware and Services=============================================
var builder = WebApplication.CreateBuilder(args);
//adding multi-language support
AddingMultiLanguageSupportServices(builder);
// Add services to the container.
builder.Services.AddControllersWithViews();
//====App===================================================================
var app = builder.Build();
//adding multi-language support
AddingMultiLanguageSupport(app);
// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
app.UseExceptionHandler("/Home/Error");
}
app.UseStaticFiles();
app.UseRouting();
app.UseAuthorization();
app.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=ChangeLanguage}/{id?}");
app.Run();
}
private static void AddingMultiLanguageSupportServices
(WebApplicationBuilder? builder)
{
if (builder == null) { throw new Exception("builder==null"); };
builder.Services.AddLocalization
(options => options.ResourcesPath = "Resources");
builder.Services.AddMvc()
.AddViewLocalization(LanguageViewLocationExpanderFormat.Suffix);
builder.Services.Configure<RequestLocalizationOptions>(options =>
{
var supportedCultures = new[] { "en", "fr", "de", "it" };
options.SetDefaultCulture(supportedCultures[0])
.AddSupportedCultures(supportedCultures)
.AddSupportedUICultures(supportedCultures);
});
}
private static void AddingMultiLanguageSupport(WebApplication? app)
{
app?.UseRequestLocalization();
}
}
}
//SharedResource.cs===================================================
namespace SharedResources01
{
/*
* This is just a dummy marker class to group shared resources
* We need it for its name and type
*
* It seems the namespace needs to be the same as app root namespace
* which needs to be the same as the assembly name.
* I had some problems when changing the namespace, it would not work.
* If it doesn't work for you, you can try to use full class name
* in your DI instruction, like this one:
* IStringLocalizer<SharedResources01.SharedResource> StringLocalizer
*
* There is no magic in the name "SharedResource", you can
* name it "MyResources" and change all references in the code
* to "MyResources" and all will still work
*
* Location seems can be any folder, although some
* articles claim it needs to be the root project folder
* I do not see such problems in this example.
* To me looks it can be any folder, just keep your
* namespace tidy.
*/
public class SharedResource
{
}
}
//HomeController.cs================================================================
namespace SharedResources01.Controllers
{
public class HomeController : Controller
{
private readonly ILogger<HomeController> _logger;
private readonly IStringLocalizer<SharedResource> _stringLocalizer;
private readonly IHtmlLocalizer<SharedResource> _htmlLocalizer;
/* Here is, of course, the Dependency Injection (DI) coming in and filling
* all the dependencies. The key thing is we are asking for a specific
* type=SharedResource.
* If it doesn't work for you, you can try to use full class name
* in your DI instruction, like this one:
* IStringLocalizer<SharedResources01.SharedResource> stringLocalizer
*/
public HomeController(ILogger<HomeController> logger,
IStringLocalizer<SharedResource> stringLocalizer,
IHtmlLocalizer<SharedResource> htmlLocalizer)
{
_logger = logger;
_stringLocalizer = stringLocalizer;
_htmlLocalizer = htmlLocalizer;
}
public IActionResult ChangeLanguage(ChangeLanguageViewModel model)
{
if (model.IsSubmit)
{
HttpContext myContext = this.HttpContext;
ChangeLanguage_SetCookie(myContext, model.SelectedLanguage);
//doing funny redirect to get new Request Cookie
//for presentation
return LocalRedirect("/Home/ChangeLanguage");
}
//prepare presentation
ChangeLanguage_PreparePresentation(model);
return View(model);
}
private void ChangeLanguage_PreparePresentation(ChangeLanguageViewModel model)
{
model.ListOfLanguages = new List<SelectListItem>
{
new SelectListItem
{
Text = "English",
Value = "en"
},
new SelectListItem
{
Text = "German",
Value = "de",
},
new SelectListItem
{
Text = "French",
Value = "fr"
},
new SelectListItem
{
Text = "Italian",
Value = "it"
}
};
}
private void ChangeLanguage_SetCookie(HttpContext myContext, string? culture)
{
if(culture == null) { throw new Exception("culture == null"); };
//this code sets .AspNetCore.Culture cookie
myContext.Response.Cookies.Append(
CookieRequestCultureProvider.DefaultCookieName,
CookieRequestCultureProvider.MakeCookieValue(new RequestCulture(culture)),
new CookieOptions { Expires = DateTimeOffset.UtcNow.AddMonths(1) }
);
}
public IActionResult LocalizationExample(LocalizationExampleViewModel model)
{
//so, here we use IStringLocalizer
model.IStringLocalizerInController = _stringLocalizer["Wellcome"];
//so, here we use IHtmlLocalizer
model.IHtmlLocalizerInController = _htmlLocalizer["Wellcome"];
return View(model);
}
public IActionResult Error()
{
return View(new ErrorViewModel
{ RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier });
}
}
}
//ChangeLanguageViewModel.cs=====================================================
namespace SharedResources01.Models.Home
{
public class ChangeLanguageViewModel
{
//model
public string? SelectedLanguage { get; set; } = "en";
public bool IsSubmit { get; set; } = false;
//view model
public List<SelectListItem>? ListOfLanguages { get; set; }
}
}
//LocalizationExampleViewModel.cs===============================================
namespace SharedResources01.Models.Home
{
public class LocalizationExampleViewModel
{
public string? IStringLocalizerInController { get; set; }
public LocalizedHtmlString? IHtmlLocalizerInController { get; set; }
}
}
@* ChangeLanguage.cshtml ===================================================*@
@model ChangeLanguageViewModel
@{
<div style="width:500px">
<p class="bg-info">
<partial name="_Debug.AspNetCore.CultureCookie" /><br />
</p>
<form id="form1">
<fieldset class="border rounded-3 p-3">
<legend class="float-none w-auto px-3">Change Language</legend>
<div class="form-group">
<label asp-for="SelectedLanguage">Select Language</label>
<select class="form-select" asp-for="SelectedLanguage"
asp-items="@Model.ListOfLanguages">
</select>
<input type="hidden" name="IsSubmit" value="true">
<button type="submit" form="form1"
class="btn btn-primary mt-3 float-end"
asp-area="" asp-controller="Home"
asp-action="ChangeLanguage">
Submit
</button>
</div>
</fieldset>
</form>
</div>
}
@* LocalizationExample.cshtml ====================================================*@
@using Microsoft.AspNetCore.Mvc.Localization
@using Microsoft.Extensions.Localization
@model LocalizationExampleViewModel
@* Here is of course the Dependency Injection (DI) coming in and filling
all the dependencies. The key thing is we are asking for a specific
type=SharedResource.
If it doesn't work for you, you can try to use full class name
in your DI instruction, like this one:
@inject IStringLocalizer<SharedResources01.SharedResource> StringLocalizer
*@
@inject IStringLocalizer<SharedResource> StringLocalizer
@inject IHtmlLocalizer<SharedResource> HtmlLocalizer
@{
<div style="width:600px">
<p class="bg-info">
IStringLocalizer Localized in Controller:
@Model.IStringLocalizerInController
</p>
<p class="bg-info">
@{
string? text1 = StringLocalizer["Wellcome"];
}
IStringLocalizer Localized in View: @text1
</p>
<p class="bg-info">
IHtmlLocalizer Localized in Controller:
@Model.IHtmlLocalizerInController
</p>
<p class="bg-info">
@{
string? text2 = "Wellcome";
}
IHtmlLocalizer Localized in View: @HtmlLocalizer[@text2]
</p>
</div>
}
6. 参考资料
- [1] 使ASP.NET Core应用的内容可本地化
- [2] 在ASP.NET Core应用中提供语言和文化的本地化资源
- [3] 实现策略,在本地化的ASP.NET Core应用中为每个请求选择语言/区域性
- [4] ASP.NET Core中的全球化和本地化
- [5] 排查ASP.NET Core本地化问题
- [6] 在SharedResources的帮助下ASP.NET Core本地化
https://www.codeproject.com/Articles/5378651/ASP-NET-8-Multilingual-Application-with-Single-Res