Jakarta Validation

Ouvrir dans ChatGPT

Java Bean Validation est largement reconnu comme la norme pour intégrer la logique de validation dans les applications Java. Il utilise une approche uniforme pour la validation en permettant aux développeurs d'annoter les propriétés du modèle de domaine avec des contraintes de validation déclaratives. Ces contraintes sont appliquées à l'exécution, avec des options pour des règles intégrées ainsi que personnalisées.

webforJ s'intègre avec Bean Validation via l'adaptateur JakartaValidator, offrant un support complet dès le départ.

Installation

Il est nécessaire d'inclure une implémentation compatible, telle que Hibernate Validator, dans votre classpath. Si votre environnement ne comprend pas cette implémentation par défaut, vous pouvez l'ajouter manuellement en utilisant les dépendances Maven suivantes :

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>8.0.1.Final</version>
</dependency>
<dependency>
    <groupId>org.glassfish.expressly</groupId>
    <artifactId>expressly</artifactId>
    <version>5.0.0</version>
</dependency>

Le JakartaValidator

La classe JakartaValidator sert d'adaptateur, reliant le contexte de liaison webforJ avec Jakarta Validation. Cette intégration permet d'utiliser des règles de validation complexes directement via des annotations dans la classe bean.

Activation de JakartaValidator

Pour activer le JakartaValidator dans l'ensemble du contexte, vous utilisez généralement le paramètre useJakartaValidator lors de la création du BindingContext.

BindingContext<User> context = new BindingContext<>(User.class, true);

Définition des contraintes pour les propriétés bean

Les contraintes basées sur des annotations sont directement appliquées dans la classe bean pour spécifier les conditions de validation, comme illustré dans l'exemple ci-dessous :

public class Hero {
  @NotEmpty(message = "Le nom ne peut pas être vide")
  @Length(min = 3, max = 20)
  private String name;

  @NotEmpty(message = "Pouvoir non spécifié")
  @Pattern(regexp = "Fly|Invisible|LaserVision|Speed|Teleportation", message = "Pouvoir invalide")
  private String power;

  // getters and setters
}

De telles contraintes sont aussi efficaces que celles définies par programme lors de l'initialisation de la liaison et produisent des résultats de validation cohérents.

avertissement

Actuellement, le JakartaValidator ne reconnaît que les contraintes qui sont directement assignées aux propriétés et ignore toute validation non directement associée aux propriétés.

Messages de validation sensibles à la locale 25.12

Jakarta Validation prend en charge les messages de contrainte localisés via une interpolation de message standard. Lorsque vous changez la locale de l'application, le JakartaValidator doit connaître la nouvelle locale afin de pouvoir résoudre les messages dans la langue correcte.

JakartaValidator implémente l'interface LocaleAware, ce qui signifie que BindingContext.setLocale() propage automatiquement la locale à tous les validateurs Jakarta dans le contexte. Vous n'avez pas besoin de mettre à jour chaque validateur manuellement.

BindingContext<Hero> context = new BindingContext<>(Hero.class, true);

// Lorsque la locale change, les validateurs Jakarta produisent automatiquement
// des messages dans la nouvelle locale
context.setLocale(Locale.GERMAN);

Dans un composant qui implémente LocaleObserver, appelez context.setLocale() à l'intérieur de onLocaleChange() pour garder les messages de validation synchronisés avec la langue de l'interface utilisateur :

@Override
public void onLocaleChange(LocaleEvent event) {
  context.setLocale(event.getLocale());
}

Voir dynamic validation messages pour plus d'informations sur les validateurs sensibles à la locale.