[Article] Asp.Net Core | Globalización y Localización

En estos últimos días estuve analizando una aplicación para convertirla a soporte en múltiples lenguajes. Asp.Net Core nos brinda una gran cantidad servicios en su middleware. Entre ellos tenemos disponibles para manejar la globalización y la localización de una manera muy simple.

Objetivo

El objetivo de esta publicación es tocar las posibles utilizaciones y alcance del manejo de globalización y localización como también que son y para qué pueden sernos útiles.

Audiencia

Este document o está dirigido a desarrolladores que quieren conocer Asp.Net Core o personas que desarrollan tareas de consultoría de desarrollo o que simplemente están interesados en leer e investigar sobre la tecnología alcanzada por esta publicación.

Desarrollo

Comencemos aclarando algunos conceptos:

  • Globalización (Globalization) es el proceso por el cual se debe diseñar una aplicación para que pueda responder a diferentes culturas. Esta agrega soporte para entrada de información, también su salida o visualizaciones definida para cierto lenguaje o para un área geográfica específica.
  • La localización (Localization) es la adaptación de una aplicación globalizada para una cultura particular cultura.

Para tener disponibles estas caracteristicas deberemos hacer uso de 2 interfaces IStringLocalizar y IStringLocalizar<T>. Estas 2 últimas hacen uso de las clases ResourceManager and ResourceReader que proveerán la información específica que será recuperada de los archivos de recursos.

Algo para destacar es que no es necesario tener los archivos de recursos disponibles. Si invocamos un valor y no existe un archivo de recurso o valor devolverá el nombre del parámetro. Esto puede utilizarse como idioma por default.

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Localization;

namespace AspNetCoreGloLoc.Controllers
{
[Route("api/[controller]")]
public class StringTextController : Controller
{
private readonly IStringLocalizer&lt;StringTextController&gt; _localizer;

public StringTextController(IStringLocalizer&lt;StringTextController&gt; localizer)
{
_localizer = localizer;
}
[HttpGet]
public string Get()
{
return _localizer["Title"];
}
}
}

Si necesitamos implementar globalización y localización dentro de código con html una buena opción es usar las interfaces IHtmlLocalizar y IHtmlLocalizar<T>. Debemos hacer uso de los siguientes namespaces Microsoft.AspNetCore.Localization y Microsoft.AspNetCore.Mvc.Localization. Usualmente usamos siempre texto simple antes que html específico.


using System;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Localization;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Localization;&lt;/pre&gt;
namespace Localization.StarterWeb.Controllers
{
public class BookController : Controller
{
private readonly IHtmlLocalizer&lt;BookController&gt; _localizer;

public BookController(IHtmlLocalizer&lt;BookController&gt; localizer)
{
_localizer = localizer;
}

public IActionResult Hello(string name)
{
ViewData["Message"] = _localizer["&lt;b&gt;Hello&lt;/b&gt;&lt;i&gt; {0}&lt;/i&gt;", name];

return View();
}
Una opción interesante es la posibilidad de particionar la localización por controlador, área o algún tipo de contenedor. Veamos cómo podemos usar ShareResource para esto.
namespace Localization.StarterWeb
{
public class SharedResource
{
}
}

Podemos usar Startup del proyecto y agregarlo al contenedor global veamos el siguiente controlador de ejemplo:

&lt;/pre&gt;
public class InfoController : Controller
{
private readonly IStringLocalizer&lt;InfoController&gt; _localizer;
private readonly IStringLocalizer&lt;SharedResource&gt; _sharedLocalizer;

public InfoController(IStringLocalizer&lt;InfoController&gt; localizer,
IStringLocalizer&lt;SharedResource&gt; sharedLocalizer)
{
_localizer = localizer;
_sharedLocalizer = sharedLocalizer;
}

public string TestLoc()
{
string msg = "Shared resx: " + _sharedLocalizer["Hello!"] +
" Info resx " + _localizer["Hello!"];
return msg;
}

Para una vista podemos usar IViewLocalizer. ViewLocalizer implementa la interface anterior y busca en los archivos de recursos dependiendo el path de la vista.

@using Microsoft.AspNetCore.Mvc.Localization

@inject IViewLocalizer Localizer

@{
ViewData["Title"] = Localizer["About"];
}
&lt;h2&gt;@ViewData["Title"].&lt;/h2&gt;
&lt;h3&gt;@ViewData["Message"]&lt;/h3&gt;

&lt;p&gt;@Localizer["Use this area to provide additional information."]&lt;/p&gt;
&lt;pre&gt;

Importane!:

  • Es necesario usar el paquete nuget “Localization.AspNetCore.TagHelpers”.
  • Generalmente usamos una sola localizacion para texto y no HTML.

Otra opción que utilizamos mucho puede ser por medio de DataAnnotations.

public class RegisterViewModel
{
[Required(ErrorMessage = "The Email field is required.")]
[EmailAddress(ErrorMessage = "The Email field is not a valid e-mail address.")]
[Display(Name = "Email")]
public string Email { get; set; }

[Required(ErrorMessage = "The Password field is required.")]
[StringLength(8, ErrorMessage = "The {0} must be at least {2} characters long.", MinimumLength = 6)]
[DataType(DataType.Password)]
[Display(Name = "Password")]
public string Password { get; set; }

[DataType(DataType.Password)]
[Display(Name = "Confirm password")]
[Compare("Password", ErrorMessage = "The password and confirmation password do not match.")]
public string ConfirmPassword { get; set; }
}

Conclusión

Asp.Net Core posee un de características las cuales nosotros como desarrolladores podemos sacarle un muy buen provecho a la localización y globalización. En próximo post hablaremos de la utilización de archivos de recursos para lograr el mismo objetivo.

[Article] Asp.Net Core | Múltiples entornos de trabajo

Una de las nuevas características de Asp.Net Core es la capacidad de trabajar con múltiples entornos de trabajo. Podemos utilizar un entorno de desarrollo, prueba y producción. Esta configuración nos permitirá modificar el comportamiento según el entorno en el cual está ejecutando la aplicación.

Objetivo

El objetivo de esta publicación es tratar los posibles usos de esta nueva característica junto a las buenas prácticas en el desarrollo de aplicaciones.

Audiencia

Este documento está dirigido a desarrolladores que quieren conocer Asp.Net Core o personas que desarrollan tareas de Consultoría de desarrollo o que simplemente están interesados en leer e investigar sobre la tecnología alcanzada por esta publicación.

Desarrollo

Supongamos que tenemos 3 entornos donde debemos ejecutar o cargar diferentes configuraciones: Development, Staging y Production. Asp.Net Core nos permite distinguir estos entornos por medio de variables denominadas “Enviroment Variable”. la variable a la cual nos referimos se llama ASPNETCORE_ENVIROMENT.  Esta es la que nos permitirá configurar nuestro entorno de trabajo. Los valores más comunes son Development, Staging y Production.

Una vez configurada esta variable podemos detectar en tiempo de ejecución cuál es el valor de esta variable y en qué entorno nos encontramos corriendo la aplicación.

Debemos tener en cuenta que en Linux el nombre es case sensitive, por esta razón, los archivos y las configuraciones serán tomadas como case sensitive como buena práctica.

Development

Este entorno es que usaremos mientras estamos desarrollando nuestra aplicación. ¿Cómo hacemos para configurarlo? debemos hacer botón derecho sobre nuestro proyecto, seleccionar configuración, se abrirá una ventana y seleccionamos de la solapa izquierda “Debug” como podemos ver en la siguiente ventana.

Recordemos que cuando modifico esta pantalla la configuración es modificada en el archivo launchSessting.json dentro de la carpeta properties . En este archivo podemos incluir cualquier entorno que deseemos, por ejemplo, podemos agregar varios perfiles de configuración como podemos ver en el código siguiente:


{

"iisSettings": {

"windowsAuthentication": false,

"anonymousAuthentication": true,

"iisExpress": {

"applicationUrl": "http://localhost:40088/",

"sslPort": 0

}

},

"profiles": {

"IIS Express": {

"commandName": "IISExpress",

"launchBrowser": true,

"environmentVariables": {

"ASPNETCORE_ENVIRONMENT": "Development"

}

},

"IIS Express (Staging)": {

"commandName": "IISExpress",

"launchBrowser": true,

"environmentVariables": {

"ASPNETCORE_ENVIRONMENT": "Staging"

}

}

}

}

Si cambiamos alguna de estas configuraciones en el archivo no se tomarán los efectos automáticamente. Deberemos reiniciar los servidores, sobre todo Kestrel necesitará reiniciar, una vez que se haya modificado para poder detectar correctamente el cambio.

Staging

Este es el entorno que utilizaremos para un entorno de test o preproducción. Casi siempre para un testing final antes de hacer un pasaje a producción. Casi siempre este entorno debería ser un espejo de producción para reducir el impacto de implementación.

Production

Este es el entorno al que muchas veces denominados Vivo. Es un entorno donde configuramos características de seguridad, rendimiento y la fiabilidad de la aplicación. algunas de las características que puede tener el entorno de producción es:

  • Activar funciones de cache
  • Ajustes de archivos del lado del cliente como paquetes, reduccion de archivos js y css o configuraciones de CDN (Content Delivery Network)
  • Desactivar funciones de diagnóstico
  • Activar configuraciones de registro y monitoreo.

La lista puede ser más extensa dependiendo de las necesidades de cada aplicación.

Configurando los entornos

En Windows podemos hacer uso de la configuración por medio de una vez que se está ejecutando nuestra aplicación:

línea de comandos

set ASPNETCORE_ENVIRONMENT=”Development”

PowerShell

$Env:ASPNETCORE_ENVIRONMENT = “Development”

Estos comandos solamente serán validados mientras la ventana donde se está ejecutando este abierta. Si la cerramos perderemos esta configuración. En caso de querer que el valor sea global deberemos configurarlo desde Panel de Control > Sistema > Configuración Avanzada de Sistema, en la solapa Opciones Avanzadas deberemos agregar la variable ASPNETCORE_ENVIRONMENT como vemos en la captura siguiente:

En macOS debemos usar desde el bash el siguiente comando

ASPNETCORE_ENVIRONMENT=Development dotnet run

Ha nivel sistema operativo o maquina debemos configurar las variables en los archivos .bashrc o .bash.profile. debemos editar el archivo y agregar los siguiente:

export ASPNETCORE_ENVIRONMENT=Development

En Linux debemos usar el comando export  desde la consola para la sesión abierta o modificar el archivo bash_profile para todo el sistema operativo o máquina .

Cómo verificar en tiempo de ejecución el entorno

Asp.Net provee un servicio basado en la interface IHostingEnviroment que es disponible por medio de Inyección de Dependencia en el contenedor principal. En el archivo startup.cs podemos ver como es inyectada la variable env  la cual nos permitirá acceder al entorno.


public void Configure(IApplicationBuilder app, IHostingEnvironment env)

{

if (env.IsDevelopment())

{

app.UseDeveloperExceptionPage();

app.UseDatabaseErrorPage();

app.UseBrowserLink();

}

else

{

app.UseExceptionHandler("/Home/Error");

}

Para chequear un entorno específico mientras estamos ejecutando la aplicación, IHostingEnvironment provee el método IsEnviroment( “Nombre del entorno”).

En el código podemos ver que se está preguntando si el entorno es Development por medio del método IsDevelopment() cual cual configurara algunas opciones para este entorno. Por ejemplo, vemos que se configura app.UseBrowserLink(); que es característica propia de visual studio que en producción no usaremos.

También tenemos la posibilidad de usar estas configuraciones por medio de Tag Helper dentro de las Vistas de MVC. Por ejemplo, podemos decirle que utilice archivos css o js no comprimidos en Develoment y que en Staging y Production los use comprimidos.


&lt;environment names="Development"&gt;
&lt;link rel="stylesheet" href="~/lib/bootstrap/dist/css/bootstrap.css" /&gt;
&lt;link rel="stylesheet" href="~/css/site.css" /&gt;
&lt;/environment&gt;
&lt;environment names="Staging,Production"&gt;
&lt;link rel="stylesheet" href="https://ajax.aspnetcdn.com/ajax/bootstrap/3.3.6/css/bootstrap.min.css"
asp-fallback-href="~/lib/bootstrap/dist/css/bootstrap.min.css"
asp-fallback-test-class="sr-only" asp-fallback-test-property="position" asp-fallback-test-value="absolute" /&gt;
&lt;link rel="stylesheet" href="~/css/site.min.css" asp-append-version="true" /&gt;
&lt;/environment&gt;

Conclusión

Asp.Net Core posee un de características las cuales nosotros como desarrolladores podemos sacarle un muy buen provecho como también un gran control sobre los entornos en los cuales trabajamos habitualmente. Esta configuración nos permite cambiar el comportamiento de nuestra aplicación con un simple cambio de valor en la variable de entorno.

[Article] Asp.Net Core | Manejo errores

Algo muy importante que deberíamos tener en cuenta en el desarrollo de nuestras aplicaciones es un correcto manejo de excepción. En varios de nuestros clientes notamos que no hacen uso de una forma correcta o directamente no es tenido en cuenta. Al ocurrir algún error dentro de una aplicación Asp.Net nos permite manejalo de varias formas de una manera simple y rápida.

Objetivo

El objetivo de esta publicación es tocar las posibles utilizaciones y alcance del manejo de errores propuesto por Asp.Net Core.

Audiencia

Este documento está dirigido a desarrolloradores que deseen conocer Asp.Net core o personas que desarrollan tareas de consultoría de desarrollo o que simplemente están interesados en leer e investigar sobre la tecnología alcanzada por esta publicación.

Desarrollo

Comencemos enumerando las diferentes tipos de excepciones, configuraciones y opciones que podemos utilizar:

  • Página de excepción para desarrollo.
  • Configurar excepciones personalizadas.
  • Configurando código de estado para las páginas.
  • Manejando código de excepciones.
  • Manejando código de excepciones en el servidor.
  • Manejo de excepción en el inicio de aplicación.
  • Manejo de excepciones en Asp.Net MVC.

Página de excepciones para desarrollo

La configuración por defaults de la página de errores tal vez es poca. Por este motivos, para obtener una mayor cantidad de información podemos instalar el paquete Nuget Microsoft.AspNetCore.Diagnostics. Luego de instalar el paquete debemos hacer la inyección correspondiente en el método Configure que se encuentra en el archivo startup.cs de la siguiente manera.


public void Configure(IApplicationBuilder app, IHostingEnvironment env,
ILoggerFactory loggerFactory){
loggerFactory.AddConsole();
env.EnvironmentName = EnvironmentName.Production;

if (env.IsDevelopment()){
app.UseDeveloperExceptionPage();
}else{
app.UseExceptionHandler("/error");
}
}

  • Recordemos que esto solo debe estar activo cuando la aplicación esté corriendo en un entorno de desarrollo.

Para ver la página  de excepción debemos correr la aplicación seteado en entorno de desarrollo y debemos agregar ?throw=true en la url. Podemos que la página incluye algunos tabs muy interesantes que contienen la información de la excepción y el request que hicimos. La primera solapa es Stack:

La solapa Query muestra los parámetros pasados por Query String si los hay.

La siguiente solapa es Cookies. Si hay cookies en el request van a aparecer en esta solapa.

Por último, tenemos la solapa de Headers donde podemos ver todos los encabezados enviados en el Request.

Configurar excepciones personalizadas

Cuando no estamos trabajando en un entorno de desarrollo es conveniente configurar un manejador especial.


public void Configure(IApplicationBuilder app, IHostingEnvironment env,
ILoggerFactory loggerFactory){
loggerFactory.AddConsole();
env.EnvironmentName = EnvironmentName.Production;
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/error");
}
}

En Asp.Net MVC no tenemos un decorador de errores para que ejecute una acción dependiendo de un método http. Para solucionar esto debemos tener un Action que sea ruteado a el como podemos ver en el siguiente código:

[Route("/Error")]
public IActionResult Index()
{
// Handle error here
}

Configurando código de estado para las páginas

Nuestra aplicación, por default, no muestra ningun codigo de estado para un código de estado de HTTP como podría ser el error 500(Internal Server Error) o el 404 (Not Found). Podemos configurar StatusCodePagesMiddleware en el método Configure en el archivo startup.cs

app.UseStatusCodePages();

Este middleware agregara un texto simple como podemos ver en la captura

app.UseStatusCodePages() puede soportar varios tipos de métodos. Alguno pueden ser expresiones del tipo lambda o tipos de contenido o formato de textos como podemos ver en los siguientes codigos:


app.UseStatusCodePages(async context =&gt;
{
context.HttpContext.Response.ContentType = "text/plain";
await context.HttpContext.Response.WriteAsync(
"Status code page, status code: " +
context.HttpContext.Response.StatusCode);
});

app.UseStatusCodePages("text/plain", "Status code page, status code: {0}");

En otros casos podemos redireccionar directamente a algún método que deseamos. por ejemplo, podemos devolver el error 302 al cliente pero también podemos redireccionarlo a un dirección url.

app.UseStatusCodePagesWithRedirects("/error/{0}");
app.UseStatusCodePagesWithReExecute("/error/{0}");

Si necesitamos desactivarlo por algún motivo simplemente debemos usar el siguiente código:

var statusCodePagesFeature = context.Features.Get&lt;IStatusCodePagesFeature&gt;();

if (statusCodePagesFeature != null)
{
statusCodePagesFeature.Enabled = false;
}

Manejando código de excepciones.

A menudo es una buena idea para las páginas de error en producción para constan de contenido puramente estática. Hay que tener en cuenta que una vez enviado los encabezados en el response es posible cambiar el estado de la respuesta como tampoco ejecutar otra página de excepción. El response debe ser completado o la conexión abortada.

Manejando código de excepciones en el servidor.

Recordemos que además de manejar las excepciones, en el servidor donde se encuentra alojada la aplicación, realizara alguna gestión sobre esa excepción. Algunos puntos para tener en cuenta son: Si el servidor detecta un error 500 antes de que se envíe al cliente se enviará un error sin contenido. Si se detecta una excepción después de que los cabeceros se han enviado, se cerrara la conexión, por último, las solicitudes que no son manejadas por la aplicación serán manejadas por los servidores. Cualquier configuración que hagamos en el manejo de excepciones no modificarán el comportamiento del servidor.

Manejo de excepción en el inicio de aplicación

Todas las configuraciones y situaciones anteriores ocurren durante el ciclo de vida de la aplicación. En caso de ocurrir un error durante el inicio de la aplicación se disparará una excepción a nivel servidor.

Manejo de excepciones en Asp.Net MVC.

Asp.Ne MVC  tiene algunas opciones mas para poder capturar errores como configurar excepción en los llamados filtros (filter) y validaciones en los modelos.

Exception Filters

Un filtro puede ser configurado de forma global o sobre un controller o  action basado en MVC. Los filtros pueden capturar una excepción que no haya sido configurada con anterior mientras ocurre la ejecución de un controlado o acción. Inclusive en un filtro.

Handling Model  State Errors

El Model Validation se ejecuta cuando el controlador y el action son invocados. Es posible invocarlo con el método ModelState.IsValid para verificar si el modelo está correct.

Conclusión

un buen manejo de errores puede evitarnos un dolor de cabeza muy grande cuando nuestra aplicación está fallando y no sabemos cuál es la causa.