Skip to main content

Localization In .NetCore MVC Application

Localization:

The translation to a specific region or country or culture or local. The websites with localization can reach a wider range of audiences.

Create A DotNet Core MVC Sample Application:

Let's learn localization steps by implementing them in a sample MVC application.


Add Sample Language Collection To AppSettings File:

In our sample let's read the different languages that we support from the appSettings.json file.
appSettings.Development.json:
"LanguageCodes": [
{
  "Name": "Spain",
  "Code": "es"
},
{
  "Name": "Mexico",
  "Code": "es-Mx"
},
{
  "Name": "United States",
  "Code": "en-us"
}
]
Let's create a type for the "LanguageCodes".
Shared/LanguageCodes:
namespace Sample.Localization.Mvc.Shared
{
  public class LanguageCodes
  {
    public string Name { get; set; }
    public string Code { get; set; }
  }
}
Register the 'LangaugeCodes' Type in DI(Dependency Injection) services so that it can be accessed by injection.
Startup.cs:(ConfigureServices method)
services.Configure<List<LanguageCodes>>(Configuration.GetSection("LanguageCodes"));

UseRequestLocalization Middleware:

The current culture on request is set in the localization middleware(UseRequestLocalization Middleware). This middleware initializes the RequestLocalization object. On every request, middleware can read the current culture with the following type of providers.
  • QueryStringRequestCultureProvider.
  • CookieRequestCultureProvider.
  • AcceptLanguageHeaderRequestCultureProvider.
From the above providers, we need to understand that 'UseRequestLocalization' middleware tries to read the culture value from the 'query parameter' or 'cookie' or 'accept headers' as per the order we defined above.
Startup.cs:
private RequestLocalizationOptions RegisterSuportCulture()
{
  var langCodes = Configuration.GetSection("LanguageCodes").GetChildren().ToList().Select(_ => new LanguageCodes
  {
	Name = _.GetValue<string>("Name"),
	Code = _.GetValue<string>("Code")
  }).ToList();
  var localizationOptions = new RequestLocalizationOptions()
  .SetDefaultCulture(langCodes.Where(_ => _.Name == "United States")
  .Select(_ => _.Code).FirstOrDefault());
	
  return localizationOptions;
}
  • The 'UseRequestLocalization' middleware needs the 'Microsoft.AspNetCore.Builder.RequesLocalizationOption' object. The 'RequesLocalizationOption' object is used to configure all the cultures supported by our application.
  • (Line: 3-7) Reding the culture info from the 'appSettings.Development.json' file.
  • (Line: 9-11) Initialized RequestLocalizationOptions object by setting the default culture for the application.
Now register the 'UseRequestLocalization' middleware above the 'UseRouting' middleware.
Startup.cs:
app.UseRequestLocalization(RegisterSuportCulture());
app.UseRouting();

UI Dropdown To Change Culture:

In _Layout.cshtml we will configure a dropdown in the menu section to change the culture of the website.

Let's create a partial view to implement the dropdown functionality.
Views/Shared/_LanguageSelectionPartial.cshtml:
@using Microsoft.Extensions.Options
@using Sample.Localization.Mvc.Shared
@using Microsoft.AspNetCore.Localization;
@inject IOptions<List<LanguageCodes>> _languageCodes
@{
    var requestCulture = Context.Features.Get<IRequestCultureFeature>();
    var cultureName = requestCulture.RequestCulture.Culture.Name;
    var selectionItems = _languageCodes.Value.
        Select(_ => new SelectListItem {
            Text = _.Name,
            Value = _.Code,
            Selected = (_.Code.ToLower() == cultureName.ToLower()) }).ToList();
    var returnUrl = string.IsNullOrEmpty(Context.Request.Path) ? "~/" : $"~{Context.Request.Path.Value}";

}

<form id="selectLanguage" 
      asp-controller="Home" 
      asp-action="SetLanguage" 
      method="post" 
      class="form-horizontal" 
      role="form" 
      asp-route-returnUrl="@returnUrl"  >
    <select class="form-control" 
            name="culture" id="culture" 
            onchange="this.form.submit()" asp-items="selectionItems">
    </select>
</form>
  • (Line: 4) Injecting 'LanguageCodes' collection to display them in the dropdown.
  • (Line: 6) Creating an instance of the 'Microsoft.AspNetCore.Localization.IRequestCultureFeature'.
  • (Line: 7) Fetching the current culture of the application, by default it will 'United States' as we configured in the middleware.
  • (Line: 9-12) Creating dropdown item collection.
  • (Line: 13) The current application path will be passed as a post parameter on changing the dropdown value.
  • (Line: 17-28) The Html form that gets post values on changing the dropdown values. The 'asp-controller' and 'asp-action' attributes define endpoint(which we create in the next step) to post the form.
  • The 'asp-route-{your_parameter}' to pass the return URL as post value.

Culture And UI-Culture:

Dotnet supports two culture info objects like 'culture' and 'ui-culture'. The 'culture' is for translation of the text to display. The 'ui-culture' is for translation of date, time, numbers, and currency.

So we have to configure providers like 'SupportedCultures' and 'SupportedUICultures' to the RequesLocalizationOption object. So let's update our 'RegisterSuportCulture' method in the startup class.
Startup.cs:(Update RegisterSuportCulture method)
private RequestLocalizationOptions RegisterSuportCulture()
{
  var langCodes = Configuration.GetSection("LanguageCodes").GetChildren().ToList().Select(_ => new LanguageCodes
  {
	Name = _.GetValue<string>("Name"),
	Code = _.GetValue<string>("Code")
  }).ToList();
  var supportedCultures = langCodes.Select(_ => _.Code).ToArray();
  var localizationOptions = new RequestLocalizationOptions().SetDefaultCulture(langCodes.Where(_ => _.Name == "United States").Select(_ => _.Code).FirstOrDefault())
  .AddSupportedCultures(supportedCultures)
  .AddSupportedUICultures(supportedCultures);
  return localizationOptions;
}
  • (Line: 8) Creating an array of cultures.
  • (Line: 10-11) The 'AddSupportedCultures' and 'AddSupportedUICultures' configured.

MVC Endpoint Query Param Culture Redirection:

Create an MVC endpoint that get's invoked on dropdown change, this endpoint redirects us with a query parameter contains the value of the culture. Our query parameter should be like 'culture'(translation for text), 'ui-culture'(translation for the date, time, currency etc).
Controllers/HomeController.cs:
[HttpPost]
public IActionResult SetLanguage(string culture, string returnUrl)
{
  returnUrl = $"{returnUrl}?ui-culture={culture}&culture={culture}";
  return LocalRedirect(returnUrl);
}

Test UI-Culture Translation:

Let's test UI-Culture translation by adding test data on index.cshtml.
Views/Home/index.cshtml:
<h5>@DateTime.Now.ToShortDateString()</h5>
 <h5>@(Convert.ToDouble("1777.00").ToString("C2", System.Globalization.CultureInfo.CurrentCulture))</h5>

Resource File:

A resource file contains a translated string for our localization. An example of the resource file is like 'Example.resx'.

The resource file name should be fully qualified for its namespace by excluding the library name. For example, we have 'TestLocalization.dll' and we can create a resource file based on Stratup.cs file like Startup.resx,  Startup.es.resx(contains Spanish translated string). Another example of creating a resource file for HomeContorller can be done with dot notation or folder notation. Coming dot notation file names look like 'Controllers.HomeController.resx', 'Controllers.HomeController.es.resx'. Coming to folder notation file names like 'Resources/Controllers/HomeController.resx', 'Resources/Controllers/HomeController.es.resx'. Similarly, we can create resource files in views(*.cshtml) level also.

Configure Localization Service:

In the Startup.cs file add the following service for accessing and identifying the resource files localization.
Startup.cs:(Inside ConfigureServices Methods)
services.AddLocalization(options => options.ResourcesPath = "Resources");
services.
AddControllersWithViews()
.AddViewLocalization(LanguageViewLocationExpanderFormat.Suffix);
  • (Line: 1) Giving instruction to check for the resource file inside the 'Resources' folder.
  • (Line: 2) This helps to check files with culture suffix example files like 'Example.es.resx'(es culture suffix).

Culture Change Using IStringLocalizer:

The IStringLocalizer<T> has the capability to load the translated string based on culture. It has the capability to choose the resource file name based on the culture.
Controllers/HelloWorldController.cs:
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Localization;

namespace Sample.Localization.Mvc.Controllers
{
  public class HelloWorldController : Controller
  {
	private readonly IStringLocalizer<HelloWorldController> _stringLocalizer;
	public HelloWorldController(IStringLocalizer<HelloWorldController> stringLocalizer)
	{
		_stringLocalizer = stringLocalizer;
	}
	public IActionResult Index()
	{
		ViewData["Message"] = _stringLocalizer["Hello World"];
		return View();
	}
  }
}
  • (Line: 15) The 'Hello World' will be the key value of the resource file.
Here implemented resource files using dot notation as below.
For default culture no need to prefix the resource file. Here in our sample default culture is English.
Views/HelloWorld.Index.cshtml:
<h5>@ViewData["Message"]</h5>

Culture Change Using IHtmlLocalizer:

The IHtmlLocalizer has the capability to load the translated string along with Html tags in it.
Controllers/GoodMorningController.cs:
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Localization;

namespace Sample.Localization.Mvc.Controllers
{
  public class GoodMorningController : Controller
  {
	private readonly IHtmlLocalizer<GoodMorningController> _htmlLocalizer;
	public GoodMorningController(IHtmlLocalizer<GoodMorningController> htmlLocalizer)
	{
		_htmlLocalizer = htmlLocalizer;
	}
	public IActionResult Index()
	{
		ViewData["Message"] = _htmlLocalizer["Good Morning"];
		return View();
	}
  }
}
Views/GoodMorning/Index.cshtml:
<div>
    @ViewData["Message"]
</div>
Here for this sample, we create resource files in the folder structure.


Culture Change Using IViewLocalizer:

The 'IViewLocalizer' is an interface injectable in views to load the translated string from the resource files.
Views/GoodMorning/Index.cshtml:
@using Microsoft.AspNetCore.Mvc.Localization
@inject IViewLocalizer _viewLocalizer;
 
<div>
    @_viewLocalizer["Good Morning"]
</div>
Here also we created resource file using folder notation as below.

Use Cookie For Culture Change:

Till now we have used query params to change the state of the culture, now we will update our sample to use cookie to save the culture info.
Controllers/HomeController.cs:(Update SetLanguage Action Method)
[HttpPost]
public IActionResult SetLanguage(string culture, string returnUrl)
{
  Response.Cookies.Append(
   CookieRequestCultureProvider.DefaultCookieName,
   CookieRequestCultureProvider.MakeCookieValue(new RequestCulture(culture)),
   new CookieOptions { Expires = DateTimeOffset.UtcNow.AddYears(1) }
  );
  return LocalRedirect(returnUrl);
}
That's all about the different approaches to make an application localizable.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on the localizing an AspNetCore Mvc application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo

Different HttpClient Techniques To Consume API Calls In Minimal API[.NET6]

In this article, we are going to implement different HttpClient techniques to consume API calls in minimal API. The different HttpClient techniques that we are going to explore are like: Register HttpClient Object Explicitly In DI(Dependency Injection Service) Named Client Type Client HttpRequestMessage Object Create A .NET6 Minimal API Project: Let's create a .Net6 Minimal API sample project to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. CLI command For Minimal API Project dotnet new webapi -minimal -o Your_Project_Name Create A Third Party API Response Model: Here I'm going to use a free third-party rest API that is "https://jsonplaceholder.typicode.com/posts". So to receive the response let's create a response model like 'Post.cs'. Program.cs:(Add Post.cs c

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl