Cómo usar las cláusulas de guardia en C#

Las cláusulas de guardia son una excelente forma de mejorar la legibilidad y el mantenimiento del código en C#, eliminando la necesidad de estructuras anidadas y condicionales innecesarias en tu aplicación.

¿Qué es una cláusula de guardia?

Una cláusula de guardia es una comprobación condicional que valida las condiciones o parámetros de entrada especificados en un método.

Si las condiciones no se cumplen, la ejecución del método se detiene prematuramente, generalmente lanzando una excepción o utilizando una sentencia return.

Las cláusulas de guardia siguen el principio de “fallar rápido”, deteniendo el flujo de control del programa si los parámetros de entrada son inválidos o si no se cumplen otras condiciones.

Puedes aprovechar las cláusulas de guardia para interrumpir los métodos antes de que ocurran errores en tiempo de ejecución.

Beneficios de las cláusulas de guardia en C#

1. Evitar excepciones de referencia nula: Las cláusulas de guardia te ayudan a prevenir excepciones de referencia nula al validar que un objeto no sea nulo antes de su uso.

2. Validación de entradas: Aseguran que solo los datos válidos sean procesados, manteniendo la integridad de los datos.

3. Mejora la legibilidad y mantenimiento: Al centralizar las reglas de validación, las cláusulas de guardia hacen que tu código sea más limpio y fácil de mantener.

Crear un proyecto de consola en Visual Studio 2022

1. Lanza Visual Studio 2022.
2. Haz clic en Crear nuevo proyecto.
3. Selecciona Aplicación de consola (.NET Core).
4. En la ventana de configuración, elige el nombre y la ubicación para tu proyecto.
5. Selecciona .NET 9.0 (Soporte estándar) como la versión del marco.
6. Haz clic en Crear.

Ejemplos de uso de cláusulas de guardia

Evitar excepciones de referencia nula

public void CheckIfNull(object obj)
{
    if (obj is null)
    {
        throw new ArgumentNullException(nameof(obj), "El parámetro del método no puede ser nulo.");
    }
    // Otro código
}

Validación de entradas

public void CheckIfNullOrEmpty(string str)
{
    if (string.IsNullOrEmpty(str))
    {
        throw new ArgumentException("Dato inválido: La cadena no puede ser vacía ni nula.");
    }
    // Otro código
}

Mejora de legibilidad y mantenimiento

En lugar de tener múltiples condicionales en el constructor de una clase, puedes utilizar las cláusulas de guardia de manera más eficiente:

Sin cláusulas de guardia:

public Author(string firstName, string lastName, string address, string email)
{
    if (string.IsNullOrEmpty(firstName))
    {
        throw new ArgumentException("El primer nombre no puede ser nulo o vacío", nameof(firstName));
    }
    if (string.IsNullOrEmpty(lastName))
    {
        throw new ArgumentException("El apellido no puede ser nulo o vacío", nameof(lastName));
    }
    if (string.IsNullOrEmpty(address))
    {
        throw new ArgumentException("La dirección no puede ser nula o vacía", nameof(address));
    }
    if (string.IsNullOrEmpty(email))
    {
        throw new ArgumentException("El correo electrónico no puede ser nulo o vacío", nameof(email));
    }
}

Con cláusulas de guardia:

Guard.NotNullOrEmpty(firstName, nameof(firstName), "El primer nombre no puede ser nulo o vacío");
Guard.NotNullOrEmpty(lastName, nameof(lastName), "El apellido no puede ser nulo o vacío");
Guard.NotNullOrEmpty(address, nameof(address), "La dirección no puede ser nula o vacía");
Guard.NotNullOrEmpty(email, nameof(email), "El correo electrónico no puede ser nulo o vacío");

¿Usar cláusulas de guardia o frameworks de validación? ⚖️

Aunque las cláusulas de guardia son útiles para validar entradas, no son la mejor opción para la validación de datos de usuario.

Las excepciones no deben usarse para manejar entradas inválidas de usuario. En su lugar, deberías emplear frameworks de validación como FluentValidation para manejar estos casos.

Recuerda que un fallo de validación no debe considerarse una excepción, sino un comportamiento esperado.

Conclusión

Las cláusulas de guardia te permiten adherir al principio de responsabilidad única, aislando la lógica de validación de la lógica de negocio de tu aplicación.

Esto te permitirá escribir código limpio, conciso y mantenible, mientras aseguras la integridad de los datos y previenes comportamientos inesperados en tu código.