4.7.2 Creando tus mensajes de error en diferentes idiomas

Vamos a crear un archivo de recursos para manejar todos los mensajes de error de forma general, de esta manera también podemos agregar mensajes de error en diferentes idiomas.

Un buen mensaje de error debe decir claramente porque, donde ocurrió el error y explicarle al usuario como debe corregir el error de forma amable.

1. Agrega una nueva carpeta llamada Resources aqui vamos a guardar todos los recursos

2. Da clic con el botón derecho del mouse sobre la carpeta Resources

3. Da clic en agregar > Nuevo Elemento..

4. Del lado izquierdo selecciona ASP .NET Core > General > Archivo de Recursos

5. En el nombre teclea mensajes.resx

6. Da clic en el botón Agregar

Los recursos se agrupan por un nombre el cual funciona como una variable, cuando quieras mostrar un mensaje de error de que no se encontró el registro en el nombre puedes guardarlo como NotFound y en el valor tecleas el mensaje de error que se mostrará cuando no se encuentre el registro en diferentes idiomas. Se recomienda utilizar los nombres en inglés si piensas traducir a más idiomas ya que es el más común para los programadores.

Puedes sustituir los valores de tus mensajes de error por variables en tu código si escribes un número entre llaves para indicar que en lugar de las llaves vas a proporcionar el valor en tu código. Puedes agregar un comentario a cada valor en mi caso no agregare comentarios ya que me parece que el nombre es claro para identificar de que se trata el mensaje de error.

Para empezar vamos a agregar estos valores:

Nombre	Valor
Required	Por favor registra el campo {0}.
NotFound	{0} que deseas borrar ya no existe u otro usuario la borró, por favor vuelve a consultar la información.
StringLength	El campo {0} debe tener como máximo {1} caracteres. Por favor abrevia el campo.
Range	El campo {0} solo admite valores de {1} a {2}. Por favor teclea un número dentro de este rango.
Repeteaded	Ya existe {0} con este {1}. Por favor teclea {1} diferente.

Cambiamos el modificador de acceso del archivo a Internal el cual indica que los mensajes solo están disponibles para nuestro proyecto

Primero vamos a cambiar los mensajes de error en el modelo, en la clase Categoria en ErrorMessage escribimos el nombre del archivo de recursos

Categoria.cs

[Required(ErrorMessage = "Required")]
[Range(1,999, ErrorMessage = "Range")]
public int Clave { get; set; }

[Required(ErrorMessage = "Required")]
[Column(TypeName = "VARCHAR(80)")]
public string Nombre { get; set; }

En la clase startup configuramos para que las clases del modelo tomen el archivo de recursos que creamos

startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc().SetCompatibilityVersion(
                        CompatibilityVersion.Version_2_1)
              .AddDataAnnotationsLocalization(options =>
                 {
                     options.DataAnnotationLocalizerProvider = 
                     (type, factory) =>
                         factory.Create(
                           typeof(CaducaRest.Resources.mensajes));
                 });

Listo, puedes probar tus servicios y probar los mensajes de error del archivo de recursos. Puedes ver la documentación oficial en el siguiente enlace

Globalización y localización en ASP.NET Coredocsmsft

Ahora vamos a preparar nuestra aplicación para que los mensajes estén en varios idiomas, para dejar el código del ejemplo con los mensajes de forma general, crearé un nuevo archivo de recursos en este caso será SharedResource.es-MX.resx donde es-MX indica que los mensajes de error estarán en Español - México. Aquí copiare los mismos mensajes de error creados previamente.

Luego agregare otro archivo SharedResource.en-US.resx aquí pondré los mensajes en inglés

Nombre	Valor
NotFound	{0} doesn't exists, maybe was delete for other user, please try again
Range	The field {0} should be from {1} to {2}. Please write a number between this range.
Repeteaded	{0} Exist with this {1}. Please write a different {1}
Required	Please register the field {0}
StringLength	The field {0} should be max {1} characters. Please abbreviate

Vamos a crear una clase llamada LocService la cual tomará los mensajes de error creados anteriormente para cambiarlos según el idioma

LocService.cs

public class LocService
{
    private readonly IStringLocalizer _localizer;

    public LocService(IStringLocalizerFactory factory)
    {
         var type = typeof(SharedResource);
         var assemblyName = new AssemblyName(type
                         .GetTypeInfo().Assembly.FullName);
         _localizer = factory.Create("SharedResource", 
                                                assemblyName.Name);
     }

     public LocalizedString GetLocalizedHtmlString(string key)
     {
         return _localizer[key];
     }
}

Vamos a crear una clase dumy llamada SharedResource.cs

La estructura queda de la siguiente forma

En el archivo startup.cs agregamos nuestra clase LocService como singleton y agregamos también la carpeta donde están nuestros recursos

startup.cs

  public void ConfigureServices(IServiceCollection services)
  {
      services.AddSingleton<LocService>();
       services.AddLocalization(options => options.ResourcesPath = "Resources");

Modificamos para que nuestro modelo tome los mensajes de error de acuerdo a la clase SharedResource

Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<LocService>();
    services.AddLocalization(options => options.ResourcesPath
                                                   = "Resources");

     services.AddMvc().SetCompatibilityVersion(
               CompatibilityVersion.Version_2_1)
           .AddDataAnnotationsLocalization(options =>
            {
               options.DataAnnotationLocalizerProvider = 
               (type, factory) =>
               {
                   var assemblyName = new AssemblyName(
                          typeof(SharedResource)
                          .GetTypeInfo().Assembly.FullName);
                    return factory.Create("SharedResource", 
                           assemblyName.Name);
                };
              });

Agregamos los idiomas disponibles e indicamos que el idioma de default sera español en México

Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<LocService>();
    services.AddLocalization(options => options.ResourcesPath 
                                                  = "Resources");

    services.AddMvc().SetCompatibilityVersion(
        CompatibilityVersion.Version_2_1)
        .AddDataAnnotationsLocalization(options =>
        {
            options.DataAnnotationLocalizerProvider 
            = (type, factory) =>
            {
                var assemblyName = new AssemblyName(
                          typeof(SharedResource)
                          .GetTypeInfo().Assembly.FullName);
                return factory.Create("SharedResource",
                                          assemblyName.Name);
                };
             });
    services.Configure<RequestLocalizationOptions>(
          options =>
          {
               var supportedCultures = new List<CultureInfo>
               {
                   new CultureInfo("es-MX"),
                   new CultureInfo("en-US"),
               };

               options.DefaultRequestCulture = 
                  new RequestCulture(culture: "es-MX", 
                                             uiCulture: "es-MX");
               options.SupportedCultures = supportedCultures;
               options.SupportedUICultures = supportedCultures;

               options.RequestCultureProviders
                  .Insert(0, new QueryStringRequestCultureProvider());
           });

Por último en el método Configure agregamos la opción para que los servicios rest reciban como parámetro el idioma

Startup.cs

 public void Configure(IApplicationBuilder app, 
                      IHostingEnvironment env)
 {     
     var locOptions = app.ApplicationServices
                         .GetService
                           <IOptions<RequestLocalizationOptions>>();
     app.UseRequestLocalization(locOptions.Value);

Listo tus mensajes aparecen en español y si desde postman agregamos como parámetro de cultura en-US ves los mensajes de error en inglés

http://localhost:50685/api/Categorias?culture=en-US

Si lo pruebas sin el parámetro esta en español

Puedes ver el tutorial de microsoft en inglés aquí

https://damienbod.com/2017/11/01/shared-localization-in-asp-net-core-mvc/

Mensajes de error en código

Ahora vamos a cambiar nuestro código para que tome los mensajes de error de nuestra clase SharedResource

En nuestra clase CategoriaDAO en el construrtor vamos a agregar un parámetro para recibir la clase que se encarga de traducir. Agregamos una variable privada localizacion.

CategoriaDAO.cs

public class CategoriaDAO
{
    private readonly LocService localizacion;

    public CategoriaDAO(CaducaContext context, LocService locService)
    {
         this.contexto = context;
         this.localizacion = locService;
    }

En nuestro método AgregarAsync vamos a cambiar el mensaje de error para trae el mensaje de acuerdo al idioma, la función es localizacion.GetLocalizedHtmlString(nombre) recibiendo como parámetro el nombre del mensaje que deseamos regresar. Utilizare la función String.Format para remplazar las variables en el mensaje

CategoriaDAO.cs

public class CategoriaDAO
{
     public async Task<bool> AgregarAsync(Categoria categoria)
     {
         Categoria registroRepetido;
         try
         {
             registroRepetido = contexto.Categoria
                     .FirstOrDefault(c => c.Nombre == categoria.Nombre);
             if (registroRepetido != null)
             {
                 customError = new CustomError(400, 
                    String.Format(
                    this.localizacion.GetLocalizedHtmlString
                    ("Repeteaded"), "categoría", "nombre"), "Nombre");
                 return false;
             }
             registroRepetido = contexto.Categoria
                     .FirstOrDefault(c => c.Clave == categoria.Clave);
             if (registroRepetido != null)
             {
                  customError = new CustomError(400, 
                     String.Format(
                     this.localizacion.GetLocalizedHtmlString
                     ("Repeteaded"), "categoría", "clave"), "Clave");
                  return false;
             }

De esta forma el mensaje de error cuando agregamos una categoría con un nombre que ya existe es:

Ya existe categoría con este nombre. Por favor teclea nombre diferente

Como ejercicio puedes modificar los mensajes de error de los métodos modificar y borrar. Puedes comprobar mi solución en github.