Validaciones en .NET con Data Annotations
En el desarrollo de aplicaciones con .NET, una de las formas más eficientes de validar y describir las propiedades de un modelo es mediante Data Annotations. En este artículo exploraremos qué son, cómo utilizarlas y en qué proyectos son aplicables.
¿Qué son las Data Annotations?
Las Data Annotations son atributos que se agregan a las propiedades de un modelo para validar datos, proporcionar metadatos o describir su comportamiento. Estas anotaciones permiten que .NET valide automáticamente la entrada de datos sin necesidad de escribir código adicional.
Por ejemplo, si en el modelo existe un campo obligatorio o un formato específico, con solo agregar una anotación se puede verificar su validez automáticamente.
Biblioteca Necesaria
using System.ComponentModel.DataAnnotations;Esta biblioteca incluye las anotaciones más comunes como Required, StringLength, RegularExpression, Range y otras que veremos más adelante. Si se trabaja con ASP.NET MVC o Entity Framework, esta biblioteca ya viene incluida por defecto en el proyecto.
Ejemplo Práctico
Veamos un ejemplo sencillo. Se está desarrollando un sistema de gestión de Artículos y se necesita validar que el código del artículo sea obligatorio, tenga un formato específico y que su nombre tenga una longitud máxima entonces se podría manejar de la siguiente manera:
using System.ComponentModel.DataAnnotations;
namespace Entidades
{
public class Articulo
{
// Propiedades
[Required(ErrorMessage = "El código del artículo es obligatorio.")]
[RegularExpression(@"^[a-zA-Z0-9]{10}$", ErrorMessage = "Código inválido.")]
[Display(Name = "Código")]
public string CodArt { get; set; }
// Constructor
public Articulo() { }
}
}
Explicación:
- [Required]: Indica que el campo es obligatorio y no puede quedar vacío.
- [RegularExpression]: Valida un formato específico usando expresiones regulares. (Expresiones regulares en .NET)
- [Display]: Cambia el nombre visible en la interfaz de usuario.
Además de las comentadas, existen otras anotaciones comunes en .NET, especialmente dentro del espacio de nombres System.ComponentModel.DataAnnotations.
Algunos ejemplos podrían ser:
1. [StringLength]: Especifica la longitud máxima y mínima permitida de una cadena.
[StringLength(50, MinimumLength = 5, ErrorMessage = "El nombre debe tener entre 5 y 50 caracteres.")]
2. [Range]: Restringe el valor de un campo a un rango numérico o de fechas.
[Range(18, 99, ErrorMessage = "La edad debe estar entre 18 y 99 años.")]
3. [MaxLength] | [MinLength]: Es similar a StringLength, especifica la longitud máxima o mínima de una cadena o colección.
[MaxLength(100, ErrorMessage = "El nombre no puede tener más de 100 caracteres.")]
[MinLength(3, ErrorMessage = "El nombre debe tener al menos 3 caracteres.")]
4. [EmailAddress]: Valida que el valor sea un formato de correo electrónico válido.
[EmailAddress(ErrorMessage = "Debe ser una dirección de correo válida.")]
5. [Phone]: Valida que el valor sea un número de teléfono válido.
[Phone(ErrorMessage = "Número de teléfono inválido.")]
6. [Url]: Valida que el valor sea una URL válida.
[Url(ErrorMessage = "Debe ser una URL válida.")]
7. [Key]: Define una clave primaria en un modelo (útil en Entity Framework).
[Key]
public int Id { get; set; }
Entre otras.
¿En qué tipo de proyectos puedo usar Data Annotations?
Las Data Annotations son extremadamente versátiles y es posible utilizarlas en varios tipos de proyectos:
- ASP.NET MVC: Ideal para validar datos en formularios web y mostrar mensajes de error al usuario.
- ASP.NET Core: Permite validar modelos en APIs REST o aplicaciones web modernas.
- Entity Framework (EF y EF Core): Las anotaciones ayudan a definir restricciones y metadatos en la base de datos.
- Aplicaciones de escritorio: Puedes usar las anotaciones con WPF o WinForms junto con validaciones manuales.
Dicho esto..
Debemos tener presente que las validaciones mediante Data Annotations no se ejecutan automáticamente al crear un objeto manualmente con un constructor en .NET. Estas validaciones forman parte del modelo de validación de .NET y otras herramientas como Entity Framework y se aplican explícitamente en casos como los siguientes (a nivel de ejemplo):
.NET FW MVC o .NET Core: Cuando se envían datos desde una vista (formulario) hacia un controlador, el framework de MVC valida automáticamente el modelo utilizando las Data Annotations.
Esto se activa mediante ModelState.IsValid en tu controlador. ModelState.IsValid verifica las propiedades del modelo decoradas con Data Annotations y muestra mensajes de error cuando la validación falla.
Validaciones Manuales con Validator.TryValidateObject: Si se crea un objeto manualmente (por ejemplo, con un constructor), las validaciones no se ejecutarán automáticamente.
Para validar manualmente las Data Annotations, se debe utilizar la clase Validator del namespace System.ComponentModel.DataAnnotations.
Entity Framework: En Entity Framework y EF Core, las validaciones se aplican automáticamente cuando guardas los cambios en la base de datos mediante SaveChanges().
Entity Framework valida los atributos decorados con Data Annotations antes de persistir los datos en la base de datos.