ASP.NET Core WebAPI實現(xiàn)本地化(單資源文件)

更新時間：2020年06月04日 09:47:12 作者：HueiFeng

這篇文章主要介紹了ASP.NET Core WebAPI實現(xiàn)本地化(單資源文件),文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

在Startup ConfigureServices 注冊本地化所需要的服務AddLocalization和 Configure<RequestLocalizationOptions>

 public void ConfigureServices(IServiceCollection services)
  {
   services.AddLocalization();
   services.Configure<RequestLocalizationOptions>(options =>
   {
    var supportedCultures = new List<CultureInfo>
    {
     new CultureInfo("en-us"),
     new CultureInfo("zh-cn")
    };

    options.DefaultRequestCulture = new RequestCulture(culture: "en-us", uiCulture: "en-us");
    options.SupportedCultures = supportedCultures;
    options.SupportedUICultures = supportedCultures;
    options.RequestCultureProviders = new IRequestCultureProvider[] { new RouteDataRequestCultureProvider { IndexOfCulture = 1, IndexofUiCulture = 1 } };
   });
   services.Configure<RouteOptions>(options =>
   {
    options.ConstraintMap.Add("culture", typeof(LanguageRouteConstraint));
   });
   services.AddControllers();
  }

在Startup.cs類的Configure 方法中添加請求本地化中間件。

 var localizeOptions = app.ApplicationServices.GetService<IOptions<RequestLocalizationOptions>>();
   app.UseRequestLocalization(localizeOptions.Value);

RequestCultureProvider 它使用簡單的委托來確定當前的本地化區(qū)域性，當然我們還可以通過RequestCultureProvider自定義源的請求區(qū)域信息比如說配置文件或者數(shù)據(jù)庫都是可以的.或者說我們可以選用默認的一些方式讓我們?nèi)カ@取到當前區(qū)域.

ASP.NET Core 本地化默認向我們提供了四個方式，可用于確定正在執(zhí)行的請求的當前區(qū)域性：

QueryStringRequestCultureProvider
CookieRequestCultureProvider
AcceptLanguageHeaderRequestCultureProvider
CustomRequestCultureProvider

如下所示我將通過路由的方式,去確定當前區(qū)域

public class RouteDataRequestCultureProvider : RequestCultureProvider
 {
  public int IndexOfCulture;
  public int IndexofUiCulture;

  public override Task<ProviderCultureResult> DetermineProviderCultureResult(HttpContext httpContext)
  {
   if (httpContext == null)
    throw new ArgumentNullException(nameof(httpContext));
   string uiCulture;

   string culture = uiCulture = httpContext.Request.Path.Value.Split('/')[IndexOfCulture];

   var providerResultCulture = new ProviderCultureResult(culture, uiCulture);

   return Task.FromResult(providerResultCulture);
  }
 }

通過如下代碼片段實現(xiàn)IRouteConstraint對路由做相應的約束

 public class LanguageRouteConstraint : IRouteConstraint
 {
  public bool Match(HttpContext httpContext, IRouter route, string routeKey, RouteValueDictionary values, RouteDirection routeDirection)
  {

   if (!values.ContainsKey("culture"))
    return false;

   var culture = values["culture"].ToString();
   return culture == "en-us" || culture == "zh-cn";
  }
 }

添加區(qū)域資源文件

注入IStringLocalizer<T>，StringLocalizer將通過傳遞的共享資源(T)的值映射到資源文件,然后將本地化根據(jù)字符串的名稱從資源文件返回響應的值

 [Route("{culture:culture}/[controller]")]
 [ApiController]
 public class HomeController : ControllerBase
 {
  private readonly IStringLocalizer<Resource> localizer;
  public HomeController(IStringLocalizer<Resource> localizer)
  {
   this.localizer = localizer;
  }
  public string Get()
  {
   return localizer["Home"];
  }
 }

如下圖所示