5.5.1 Agregando una excepción a todos nuestros servicios

.Net Core cuenta con diferentes tipos de filtro, algunos de los mas comunes son los siguientes:

• Autorización: Te permite crear filtros para validar tus servicios con tus propias reglas.

• Acción: Para definir código que se ejecutará antes y después de cada método.

• Excepción: Para manejar excepciones no controladas

Vamos a crear un filtro para controlar los mensajes de error de MySql, tanto MySql como SQL Server manejan un código de error, el cual nos dice si es un error de llave primaria, registros duplicados. Vamos a obtener el número del error y personalizar el mensaje para que sea mas entendible para los usuarios.

Puedes consultar la lista de errores de Mysql aquí

1. Dentro de la carpeta Core creamos una nueva clase CustomMySQLException la cual contiene los mensajes de error mas comunes para devolver un mensaje mas entendible para los usuarios.

CustomMySQLException.cs

public class CustomMySQLException
{
    public string MuestraErrorMYSQL(MySqlException mysqlError, 
                                    string tablaActual, 
                                    string claseOrigen)
    {
        try
        {
            string mensajeInicial = "Error interno en la base de datos";
            string mensajeDetalle = "Intente nuevamente si continua el error " +
                    " por favor comuníquese con el personal del sistema " +
                    " he infórmele sobre el error ocurrido" + 
                    System.Environment.NewLine + System.Environment.NewLine 
                    + "(" + mysqlError.Message.ToString() + ") en " 
                    + mysqlError.Source.ToString();
            string tablaUno;
            string tablaDos;
            switch (mysqlError.Number)
            {
                case 1370:
                    mensajeInicial = "El usuario no tiene permiso para realizar" +
                                     " esta acción ";
                    break;
                case 1451:
                    string[] cadena = mysqlError.Message.ToString().Split(Convert.ToChar("`"));
                    tablaUno = cadena[3];
                    tablaDos = cadena[9];
                    mensajeInicial = "No es posible borrar o actualizar (el/la) "                     
                        +tablaDos+" seleccionado(a) debido a que ya encuentran " + 
                        tablaUno+"(s) asociados a este(a) " + tablaDos;
                    mensajeDetalle = "Para borrar o actualizar (el/la)"+tablaDos+
                        " debe eliminar los registros en (el/la) "+tablaDos+
                        " y después intentar nuevamente.";
                break;
                case 1452:
                    string[] cadenas = mysqlError.Message
                                                   .Split(Convert.ToChar("`"));
                    tablaUno = cadenas[3];
                    //se obtiene el nombre/descripción de la tabla
                    tablaDos = cadenas[9];
                    //se obtiene el nombre/descripción de la tabla
                    mensajeInicial = "No es posible agregar o actualizar (el/la) "
                       +tablaDos+" seleccionado(a) debido a que ya encuentran " 
                       +tablaUno+"(s) asociados a este(a) " +tablaDos;
                    mensajeDetalle = "Para agregar o actualizar (el/la)" 
                       +tablaDos+" debe ingresar (un/una) " + tablaUno 
                       +" existente.";
                break;
                case 1062:
                    tablaUno = tablaActual;
                    string[] erroers = mysqlError.Message
                                                    .Split(Convert.ToChar("'"));
                    mensajeInicial = "No es posible agregar " + tablaUno + 
                                     " ya existe";
                    break;
                case 1014:
                case 1015:
                case 1016:
                case 1017:
                case 1018:
                case 1019:
                    mensajeInicial = "No se puede abrir/leer el archivo o "
                        + "directorio de la base de datos";
                break;
                case 1020:
                    mensajeInicial = "El registro ha cambiado desde la última"
                        + " lectura ( " + tablaActual + ")";
                break;
                case 1021:
                    mensajeInicial = "Disco lleno, esperando para que se "
                        + "libere algo de espacio";
                    break;
                case 1042:
                    mensajeInicial = "No fue posible conectarse al servidor. "
                           + " Es posible que el servidor este apagado o existan "
                           + "problemas con la red";
                break;
                case 1207:
                case 1401:
                case 1412:
                case 1480:
                    mensajeInicial = "Operación en proceso. El proceso no "
                           + " puede continuar porque la base de datos tiene "
                           + "tablas bloqueadas o una transacción activa";
                break;
                case 1406:
                    mensajeInicial = "La longitud de los datos es muy larga";
                    break;
                case 1431:
                    mensajeInicial = "Ha ocurrido un error interno. El "
                             + "Identificador referencial no existe";
                break;
                case 1088:
                    mensajeInicial = "No es posible agregar o actualizar, "
                         + "intente nuevamamente";
                break;
                case 1091:
                    tablaUno = tablaActual;
                    //se obtiene el nombre/descripción de la tabla
                    mensajeInicial = "No es posible borrar (el/la) " + 
                         tablaUno + " porque ya no existe";
                    mensajeDetalle = "Salga de esta opción y verifique que no "
                         +" exista (el/la) " + tablaUno + " de lo contrario "
                         +"intente nuevamente por favor.";
                    break;
                case 1132:
                    mensajeInicial = "Debes de tener permiso para actualizar"
                         +"tablas en la base de datos y para cambiar las claves";
                        break;
                case 1044:
                case 1045:
                    mensajeInicial = "Por el momento el sistema no se encuentra "
                      +"disponible, debido a una restricción de accesos. El "
                      +" sistema no registrará la transacción que usted está "
                      +" procesando, el error ha sido resgistrado y será "
                      +"solucionado.";
                    mensajeDetalle = "Comuníquese con el perosnal de sistemas e "
                      +"infórmele sobre el error ocurrido";
                break;
                case 1049:
                case 1102:
                    mensajeInicial = "Base de datos desconocida/Nombre de"
                    +" base de datos incorrecto";
                break;
                case 1053:
                    mensajeInicial = "Desconexión de servidor en proceso";
                    break;
                case 1130:
                    mensajeInicial = "El equipo no permite conectarse al servidor"
                    +" de la base de datos. Probablemente el servidor se esta "
                    +"actualizando.";
                break;
                case 1152:
                    mensajeInicial = "Conexión abortada para este usuario";
                break;
                case 2003:
                case 2002:
                    mensajeInicial = "El servicio de MYSQL Server no se inicio,"
                         +" debe iniciar el servicio de MYSQL para que el "
                         +" sistema funcione.";
                break;
                case 1146:
                    mensajeInicial = "La Tabla de la base de datos no existe";
                break;
                case 1149:
                    mensajeInicial = "Error de sintaxis al momento de ejecutar "
                          +"una consulta a la base de datos";
                break;
                case 1166:
                    mensajeInicial = "Error de sintaxis al momento de ejecutar "
                       +" una consulta a la base de datos, nombre de columna "
                       +" incorrecto";
                break;
                case 1179:
                    mensajeInicial = "No tiene el permiso para ejecutar este "
                        +" comando en una transacción";
                break;
                case 1012:
                    mensajeInicial = "No puedo leer el registro en la tabla "
                        +"del sistema";
                break;
                case 1104:
                    mensajeInicial = "La consulta que se esta realizando puede"
                        + " obtener muchos registros y probablemente tarde "
                        + "mucho tiempo";
                break;
                case 1105:
                    mensajeInicial = "Error desconocido";
                break;
                case 1107:
                case 1108:
                    mensajeInicial = "Parámetros incorrectos para procedimiento "
                       + " almacenado";
                break;
                case 1114:
                    mensajeInicial = "La tabla " + tablaActual + " esta llena";
                    break;
                case 1205:
                    mensajeInicial = "Expiró el tiempo de espera para realizar "
                        +"un bloqueo. La transacción se canceló";
                break;
                case 1213:
                    mensajeInicial = "Ocurrió un deadlock durante una transacción";
                break;
                case 1181:
                    mensajeInicial = "Ocurrío un error al momento de regresar a "+
                            " un punto en la transacción";
                break;
                case 1216:
                   mensajeInicial = "Se está intentando agregar una fila, pero no hay "
                        +"una fila padre, lo que hace que una restricción de clave "
                        +"foránea falle. Se debe insertar antes la fila padre";
                break;
                case 1217:
                    mensajeInicial = "Se está intentando eliminar una fila "
                        +"padre que tiene filas hijas, lo que hace que una "
                        +"restricción de clave foránea falle. Se deben eliminar"
                        +" primero las filas hijas";
                break;
                case 2013:
                    mensajeInicial = "La consulta a la base de datos a tardado"
                        +" mucho tiempo";
                break;
                default:
                    mensajeInicial = "Error interno en la base de datos";
                break;
            }
            return mensajeInicial;
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
            return "";
        }
    }
}

Ahora creamos y configuramos nuestro filtro de excepción

1. Creamos una carpeta llamada Filters

2. Dentro de esta carpeta creamos una clase llamada CustomExceptionFilter que hereda de la clase ExceptionFilterAttribute

3. Sobrescribimos el método OnException

CustomExceptionFilter

public class CustomExceptionFilter : ExceptionFilterAttribute
{
    private readonly IHostingEnvironment _hostingEnvironment;
    private readonly IModelMetadataProvider _modelMetadataProvider;
     
    public CustomExceptionFilter(IHostingEnvironment hostingEnvironment, IModelMetadataProvider modelMetadataProvider)
    {
        _hostingEnvironment = hostingEnvironment;
        _modelMetadataProvider = modelMetadataProvider;
    }

    public override void OnException(ExceptionContext context)
    {
        string mensajeError = string.Empty;
        //Revisamos si la excepción es una excepción de MySQL
        if (context.Exception.InnerException != null && context.Exception.InnerException.GetType() == typeof(MySqlException))
        {              
            //Obtenemos la acción del controlador
            string accion = context.RouteData.Values["action"].ToString();
            //Obtenemos el nombre de la tabla
            string tabla = " el/la " + context.RouteData.Values["controller"]
                                                            .ToString() + " ";
            //Obtenemos la excepción de MySQL
            MySqlException exMySql = (MySqlException)context.Exception
                                                            .InnerException;
            //Personalizamos nuestro mensaje de error
            CustomMySQLException mySqlCustomError = new CustomMySQLException();
            mensajeError = mySqlCustomError.MuestraErrorMYSQL(exMySql, tabla,
                                                         this.GetType().Name);              
            //Regresamos como mensaje de error un badrequest
            BadRequestObjectResult badRequest = new BadRequestObjectResult(
                                            new CustomError(400, mensajeError));
            context.Result = badRequest;
         }    
         else
         {
            //Regresamos como mensaje de error un error del servidor
            context.Result = new StatusCodeResult(StatusCodes
                                                  .Status500InternalServerError);
         }
    }
}

4. En nuestra clase Startup.cs en el método ConfigureServices cuando configuramos el servicio de AddMvc agregamos nuestro filtro

Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(options=>
                           {
                               options.Filters.Add(typeof(CustomExceptionFilter));
                           }
                   ).SetCompatibilityVersion(CompatibilityVersion.Version_2_1)
}

Ahora podemos quitar el código try ... catch de nuestras clases DAO (CategoriaDAO y ProductoDAO) ya que ahora la excepción esta de forma general en nuestra clase CustomExceptionFilter.