Movatterモバイル変換

No results found!

• Microservice Solution

• Exception Handling

• Localization

• Logging

• Object Extensions

• Options

• Microsoft.Extensions.Localization package and compatible with theMicrosoft's localization documentation. It adds some useful features and enhancements to make it easier to use in real life application scenarios.

  Installation

  This package is already installed by default with the startup template. So, most of the time, you don't need to install it manually.

  You can use theABP CLI to install the Volo.Abp.Localization package to your project. Execute the following command in the folder of the .csproj file that you want to install the package on:

  abp add-package Volo.Abp.Localization

  If you haven't done it yet, you first need to install theABP CLI. For other installation options, seethe package description page.

  Then you can addAbpLocalizationModule dependency to your module:

  using Volo.Abp.Modularity;using Volo.Abp.Localization;namespace MyCompany.MyProject{    [DependsOn(typeof(AbpLocalizationModule))]    public class MyModule : AbpModule    {        //...    }}

  Creating A Localization Resource

  A localization resource is used to group related localization strings together and separate them from other localization strings of the application. Amodule generally defines its own localization resource. Localization resource is just a plain class. Example:

  public class TestResource{}

  Then it should be added usingAbpLocalizationOptions as shown below:

  [DependsOn(typeof(AbpLocalizationModule))]public class MyModule : AbpModule{    public override void ConfigureServices(ServiceConfigurationContext context)    {        Configure<AbpVirtualFileSystemOptions>(options =>        {            // "YourRootNameSpace" is the root namespace of your project. It can be empty if your root namespace is empty.            options.FileSets.AddEmbedded<MyModule>("YourRootNameSpace");        });        Configure<AbpLocalizationOptions>(options =>        {            //Define a new localization resource (TestResource)            options.Resources                .Add<TestResource>("en")                .AddVirtualJson("/Localization/Resources/Test");        });    }}

  In this example;

  • Added a new localization resource with "en" (English) as the default culture.
  • Used JSON files to store the localization strings.
  • JSON files are embedded into the assembly usingAbpVirtualFileSystemOptions (seevirtual file system).

  JSON files are located under "/Localization/Resources/Test" project folder as shown below:

  

  A JSON localization file content is shown below:

  {  "culture": "en",  "texts": {    "HelloWorld": "Hello World!"  }}

  • Every localization file should define theculture code for the file (like "en" or "en-US").
  • texts section just contains key-value collection of the localization strings (keys may have spaces too).

  ABP will ignore (skip) the JSON file if theculture section is missing.

  Default Resource

  AbpLocalizationOptions.DefaultResourceType can be set to a resource type, so it is used when the localization resource was not specified:

  Configure<AbpLocalizationOptions>(options =>{    options.DefaultResourceType = typeof(TestResource);});

  Theapplication startup template setsDefaultResourceType to the localization resource of the application.

  Short Localization Resource Name

  Localization resources are also available in the client (JavaScript) side. So, setting a short name for the localization resource makes it easy to use localization texts. Example:

  [LocalizationResourceName("Test")]public class TestResource{}

  See the Getting Localized Test / Client Side section below.

  Inherit From Other Resources

  A resource can inherit from other resources which makes possible to re-use existing localization strings without referring the existing resource. Example:

  [InheritResource(typeof(AbpValidationResource))]public class TestResource{}

  Alternative inheritance by configuring theAbpLocalizationOptions:

  services.Configure<AbpLocalizationOptions>(options =>{    options.Resources        .Add<TestResource>("en") //Define the resource by "en" default culture        .AddVirtualJson("/Localization/Resources/Test") //Add strings from virtual json files        .AddBaseTypes(typeof(AbpValidationResource)); //Inherit from an existing resource});

  • A resource may inherit from multiple resources.
  • If the new resource defines the same localized string, it overrides the string.

  Extending Existing Resource

  Inheriting from a resource creates a new resource without modifying the existing one. In some cases, you may want to not create a new resource but directly extend an existing resource. Example:

  services.Configure<AbpLocalizationOptions>(options =>{    options.Resources        .Get<TestResource>()        .AddVirtualJson("/Localization/Resources/Test/Extensions");});

  • If an extension file defines the same localized string, it overrides the string.

  Getting the Localized Texts

  Getting the localized text is pretty standard.

  Simplest Usage In A Class

  Just inject theIStringLocalizer<TResource> service and use it like shown below:

  public class MyService : ITransientDependency{    private readonly IStringLocalizer<TestResource> _localizer;    public MyService(IStringLocalizer<TestResource> localizer)    {        _localizer = localizer;    }    public void Foo()    {        var str = _localizer["HelloWorld"];    }}

  Format Arguments

  Format arguments can be passed after the localization key. If your message isHello {0}, welcome!, then you can pass the{0} argument to the localizer like_localizer["HelloMessage", "John"].

  Refer to theMicrosoft's localization documentation for details about using the localization.

  Using In A Razor View/Page

  UseIHtmlLocalizer<T> in razor views/pages;

  @inject IHtmlLocalizer<TestResource> Localizer<h1>@Localizer["HelloWorld"]</h1>

  Special Base Classes

  Some ABP base classes provide aL property to use the localizer even easier.

  Example: Localize a text in an application service method

  using System.Threading.Tasks;using MyProject.Localization;using Volo.Abp.Application.Services;namespace MyProject{    public class TestAppService : ApplicationService    {        public TestAppService()        {            LocalizationResource = typeof(MyProjectResource);        }        public async Task DoIt()        {            var str = L["HelloWorld"];        }    }}

  When you set theLocalizationResource in the constructor, theApplicationService class uses that resource type when you use theL property, just like in theDoIt() method.

  SettingLocalizationResource in every application service can be tedious. You can create an abstract base application service class, set it there and derive your application services from that base class. This is already implemented when you create a new project with thestartup templates. So, you can simply inherit from the base class directly use theL property:

  using System.Threading.Tasks;namespace MyProject{    public class TestAppService : MyProjectAppService    {        public async Task DoIt()        {            var str = L["HelloWorld"];        }    }}

  TheL property is also available for some other base classes likeAbpController andAbpPageModel.

  Supported Languages

  You can configure theAbpLocalizationOptions'sLanguages property to add the languages supported by the application. The template already sets common languages, but you can add new languages as shown below:

  Configure<AbpLocalizationOptions>(options =>{    options.Languages.Add(new LanguageInfo("uz", "uz", "Uzbek"));});

  The Client Side

  See the following documents to learn how to reuse the same localization texts in the JavaScript side;

  • Localization for the MVC / Razor Pages UI
  • Localization for the Blazor UI
  • Localization for the Angular UI
  • Video tutorial

Thank you for your valuable feedback!

Please note that although we cannot respond to feedback, our team will use your comments to improve the experience.