Askmethat-Aspnet-JsonLocalizer

Json Localizer library for .NetStandard and .NetCore Asp.net projects

Nuget

Build

Project

This library allows users to use JSON files instead of RESX in an ASP.NET application. The code tries to be most compliant with Microsoft guidelines. The library is compatible with NetStandard & NetCore.

Configuration

An extension method is available for IServiceCollection. You can have a look at the method here

Options

A set of options is available. You can define them like this :

services.AddJsonLocalization(options => {
        options.CacheDuration = TimeSpan.FromMinutes(15);
        options.ResourcesPath = "mypath";
        options.FileEncoding = Encoding.GetEncoding("ISO-8859-1");
        options.SupportedCultureInfos = new HashSet<CultureInfo>()
        {
          new CultureInfo("en-US"),
          new CultureInfo("fr-FR")
        };
    });

Current Options

• SupportedCultureInfos : _Default value : List containing only default culture and CurrentUICulture. Optionnal array of cultures that you should provide to plugin. _(Like RequestLocalizationOptions)
• ResourcesPath : Default value : $"{_env.WebRootPath}/Resources/". Base path of your resources. The plugin will browse the folder and sub-folders and load all present JSON files.
• CacheDuration : Default value : 30 minutes. We cache all values to memory to avoid loading files for each request, this parameter defines the time after which the cache is refreshed.
• FileEncoding : default value : UTF8. Specify the file encoding.
• IsAbsolutePath : _default value : false. Look for an absolute path instead of project path.
• UseBaseName : _default value : false. Use base name location for Views and constructors like default Resx localization in ResourcePathFolder. Please have a look at the documentation below to see the different possiblities for structuring your translation files.
• Caching : _default value: MemoryCache. Internal caching can be overwritted by using custom class that extends IMemoryCache.
• PluralSeparator : _default value: |. Seperator used to get singular or pluralized version of localization. More information in Pluralization

Search patterns when UseBaseName = true

If UseBaseName is set to true, it will be searched for lingualization files by the following order - skipping the options below if any option before matches.

• If you use a non-typed IStringLocalizer all files in the Resources-directory, including all subdirectories, will be used to find a localization. This can cause unpredictable behavior if the same key is used in multiple files.

• If you use a typed localizer, the following applies - Namespace is the "short namespace" without the root namespace:

  • Nested classes will use the translation file of their parent class.
  • If there is a folder named "Your/Namespace/And/Classname", all contents of this folder will be used.
  • If there is a folder named "Your/Namespace" the folder will be searched for all json-files beginning with your classname.
  • Otherwise there will be searched for a json-file starting with "Your.Namespace.And.Classname" in your Resources-folder.
  • If there any .shared.json file at base path, all the keys that do not exist in other files will be added.

• If you need a base shared files, just add a file named localization.shared.json in your ResourcesPath

Pluralization

In version 2.0.0, Pluralization was introduced. You are now able to manage a singular (left) and plural (right) version for the same Key. PluralSeparator is used as separator between the two strings.

For example : User|Users for key Users

To use plural string, use paramters from IStringLocalizer, if last parameters is a boolean, pluralization will be activated.

Pluralization is available with IStringLocalizer, IViewLocalizer and HtmlStringLocalizer :

localizer.GetString("Users", true);

Clean Memory Cache

Version 2.2.0+ allows you to clean cache. It's usefull when you want's tu update in live some translations.

Example

public class HomeController{
  private readonly IJsonStringLocalizer _localizer;
  
  public HomeController(IJsonStringLocalizer<HomeController> localizer)
  {
      _localizer = localizer;
      _localizer.ClearMemCache(new List<CultureInfo>()
      {
          new CultureInfo("en-US")
      });
  }
}

Information

Platform Support

Platform	Version
NetStandard	2.0+
NetCore	2.0.0+

WithCulture method

WhithCulture method is not implemented and will not be implemented. ASP.NET Team, start to set this method Obsolete for version 3 and will be removed in version 4 of asp.net core.

For more information : AlexTeixeira#46

Performances

After talking with others Devs about my package, they asked my about performance.

BenchmarkDotNet=v0.11.5, OS=macOS Mojave 10.14.4 (18E226) [Darwin 18.5.0]
Intel Core i7-5557U CPU 3.10GHz (Broadwell), 1 CPU, 4 logical and 2 physical cores
.NET Core SDK=2.2.106
  [Host]     : .NET Core 2.2.4 (CoreCLR 4.6.27521.02, CoreFX 4.6.27521.01), 64bit RyuJIT
  DefaultJob : .NET Core 2.2.4 (CoreCLR 4.6.27521.02, CoreFX 4.6.27521.01), 64bit RyuJIT

Method	Mean	Error	StdDev	Min	Max	Ratio	RatioSD	Gen 0	Gen 1	Gen 2	Allocated
Localizer	115.89 ns	0.1277 ns	0.1132 ns	115.71 ns	116.03 ns	1.00	0.00	-	-	-	-
JsonLocalizer	80.46 ns	0.0964 ns	0.0805 ns	80.37 ns	80.61 ns	0.69	0.00	0.0228	-	-	48 B
JsonLocalizerWithCreation	533,754.90 ns	3,074.1865 ns	2,875.5960 ns	529,323.89 ns	539,354.61 ns	4,606.83	25.03	83.0078	28.3203	3.9063	175880 B
JsonLocalizerWithCreationAndExternalMemoryCache	4,734.27 ns	135.6678 ns	133.2439 ns	4,643.43 ns	5,162.57 ns	40.91	1.22	1.6174	0.8087	-	3408 B
JsonLocalizerDefaultCultureValue	331.54 ns	1.7528 ns	1.5539 ns	329.22 ns	334.37 ns	2.86	0.01	0.1793	-	-	376 B
LocalizerDefaultCultureValue	371.86 ns	3.8521 ns	3.6033 ns	368.69 ns	378.81 ns	3.20	0.03	0.1559	-	-	328 B

Contributors

Michael Monsour

Luka Gospodnetic

Christoph Sonntag

Nacho

Ashley Medway

Serhii Voitovych

A special thanks to @Compufreak345 for its hard work. He did a lot for this repo.

License

MIT Licence