Historique de la page

Sommaire :

...

Exemple

L'écriture des formulaires JSF ne déroutera pas l'habitué des formulaires JSP. On utilisera par exemple :

...

Les balises <h:messages> et <h:message> sont traitées dans un paragraphe à suivre.

 <%@include file="_include.jsp"%>

 <%@include file="_navigation.jsp"%>

<%@include file="_include.jsp"%>
<%@include file="_navigation.jsp"%>
  <h:form>
    <h:commandButton value="Move"
	action="gotoWelcome"/>
  </h:form>

<navigation-rule>
  <from-view-id>/stylesheets/test1.jsp</from-view-id>
  <navigation-case>
    <from-outcome>gotoWelcome</from-outcome>
    <to-view-id>/stylesheets/welcome.jsp</to-view-id>
    <redirect />
   </navigation-case>
</navigation-rule>

avec une méthode callback :
/**
 * JSF callback.
 * @return A String.
 */
public String callback() {
  return "gotoWelcome";
}

<bean id="test1Controller"
      class="org.esupportail.formation.web.controllers.Test1Controller"
      parent="abstractContextAwareController"
      scope="session">
  <description>A bean to manage the test1 page.</description>
</bean>

<%@include file="_include.jsp"%>
<%@include file="_navigation.jsp"%>
  <h:form>
    <h:commandButton value="Move"
	action="#{test1Controller.callback}"/>
  </h:form>

Messages d'erreur

Dans une page JSP les balises <h:messages> et <h:message> permettent d'afficher des messages d'erreur à l'utilisateur.La balise <h:messages> permet d'afficher l'ensemble des messages d'erreurs. La balise <h:message> permet d'afficher les messages d'erreurs relatifs à une balise <h:inputText> particulière. Elle dispose, à cet effet, d'un attribut for qui lui permet de faire le lien avec un attribut id d'une balise <h:inputText> donnée. Ce mécanisme est notamment utilisé quand l'attribut required de la balise  <h:inputText> est positionné à true ou bien quand un validateur (cf. ci-dessous) lui est associé.Il est aussi possible, dans une callback d'un contrôleur, de remonter des messages d'erreurs vers la vue. Ces messages seront généralement rendus grâce à la balise <h:messages>. Typiquement, la callback renverra null, c'est-à-dire que la page affichée à l'utilisateur restera la même (celle où s'est produite l'erreur de saisie).  Dans l'exemple suivant, on affiche un message si l'utilisateur correspondant à l'identifiant donné est déjà administrateur :

...

addErrorMessage("form:myInput", "TEST1.MESSAGE.SHORT"))

private String myInput;

public String getMyInput() {
  return myInput;
}

public void setMyInput(String myInput) {
  this.myInput = myInput;
}

/* JSF callback.
 * @return A String.
 */
public String callback() {
  if (myInput.length() < 2) {
	addErrorMessage(null, "TEST1.MESSAGE.SHORT");
	return null;
  }
  return "gotoWelcome";
}

Exemple pour messages_fr.properties
TEST1.MESSAGE.SHORT = Le champ "myInput" doit contenir plus de 2 caractères.

<%@include file="_include.jsp"%>
  <%@include file="_navigation.jsp"%>
  <h:form>
	<h:messages/>
	<h:inputText value="#{test1Controller.myInput}" required="true"/>
	<h:commandButton value="Move"
	action="#{test1Controller.callback}"/>
  </h:form>

Validation des formulaires

Validation au niveau des JSP

Utilisation des validateurs prédéfinis

Il existe des validateurs par défaut dans JSF (validateLength, validateLongRange et validateDoubleRange), par exemple :

...

/**
 * JSF callback.
 * @return A String.
 */
public String callback() {
  return "gotoWelcome";
}

<%@include file="_include.jsp"%>
  <%@include file="_navigation.jsp"%>
  <h:form>
    <h:messages/>
    <h:inputText value="#{test1Controller.myInput}" required="true">
	<f:validateLength minimum="3"/>
    </h:inputText>
    <h:commandButton value="Move"
	action="#{test1Controller.callback}"/>
  </h:form>

Développement de validateurs personnalisés

Il est aussi possible d'écrire ses propres validateurs. Leur mise en œuvre est relativement simple, par exemple :

...

/**
 * @param context
 * @param componentToValidate
 * @param value
 * @throws ValidatorException
 */
public void validateMyInput(FacesContext context,
  UIComponent componentToValidate,
  Object value) throws ValidatorException {
  String strValue = (String) value;
  if (strValue.length() < 2) {
	throw new ValidatorException(getFacesErrorMessage("TEST1.MESSAGE.SHORT"));
  }
}

<%@include file="_include.jsp"%>
<%@include file="_navigation.jsp"%>

 <h:form>
   <h:messages/>
   <h:inputText value="#{test1Controller.myInput}" required="true"
      validator="#{test1Controller.validateMyInput}"/>
   <h:commandButton value="Move"
	action="#{test1Controller.callback}"/>
 </h:form>

Validation au niveau des beans (JSR 303)

http://www.jmdoudoux.fr/java/dej/chap-validation_donnees.htm
http://musingsofaprogrammingaddict.blogspot.com/2009/01/getting-started-with-jsr-303-beans.html

Mise à jour de propriétés par les formulaires (updateActionlistener)

http://www.touilleur-express.fr/2008/06/06/jsr-303-vous-avez-valide-votre-bean/
http://www.openscope.net/2010/02/08/spring-mvc-3-0-and-jsr-303-aka-javax-validation

Au cours du développement d'une application web on constate la nécessité de valider les objets manipulés à différents niveau :

• Couche métier (au moment de la validation d'un formulaire)
• Dans la couche domaine
• Au niveau du mapping objet-base
• Dans la base (Contrainte sur les colonnes)

On en vient souvent à dupliquer les contraintes à chaque niveau et de façon pas toujours cohérentes (ex: on limite un champs à 50 caractères dans un formulaire alors que la colonne correspondante en base est un varchar(100)

Pour répondre à cela la JSR 303 propose une spécification standard pour la validation des beans.
On utilisera alors les annotations introduites en Java 5 pour exprimer les contraintes sur le bean.

Exemple :

package org.esupportail.example.web.beans;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class UserBean{
	/**
	 * Id of the user.
	 */
	@NotNull
	private String id;

        /**
	 * Display Name of the user.
	 */
	@Size(max = 10, min = 1)
        private String displayName;


[...]
}

Pour utiliser javax.validation il faudra alors ajouter dans le pom.xml la dépendance suivante :

<dependency>
 <groupId>org.hibernate</groupId>
 <artifactId>hibernate-validator</artifactId>
 <version>4.0.2.GA</version>
</dependency>

Exemple de contraintes :

• @AssertFalse : doit être faux
• @AssertTrue : doit être vrai
• @DecimalMax : doit être un nombre inférieur ou égal à la valeur indiquée (représentation String d'un BigDecimal)
• @DecimalMin : doit être un nombre supérieur ou égal à la valeur indiquée (représentation String d'un BigDecimal)
• @Digits(integer=, fraction=) : doit être un chiffre (pour BigDecimal, BigInteger, String, byte, short, int, long)
• @Future : doit être une date dans le future
• @Max : doit être un nombre inférieur ou égal à la valeur indiquée
• @Min : doit être un nombre supérieur ou égal à la valeur indiquée
• @NotNull : ne doit pas être null
• @Null : doit être null
• @Past : doit être une date dans le passé
• @Size(min=, max=) : doit avoir une taille comprise entre min et max (pour String et tableaux)
• @Pattern(regex=, flag=) : doit respecter la regex indiquée
• @Valid : doit être valide (pour un objet propriété d'un autre)

On peut également imaginer un bean qui cumulerait les annotations nécéssaires à la validation et les annotations nécessaires à la persistance.

Intégration Hibernate

http://www.hibernate.org/subprojects/validator.html
Implémentation hibernate validator intègre la validation du bean au niveau de la persistance.
elle propose quelques contraintes supplémentaires à celles de la spécifictation JSR 303 comme :

• @CreditCardNumber : doit être un numéro de carte bleue
• @Email : doit être un e-mail
• @Length(min=, max=) : doit avoir un taille comprise entre min et max (taille de la colonne en base sera max)
• @NotBlank : ne doit pas être null ou vide ou composée d'espace (pour une chaîne)
• @NotEmpty : ne doit pas être null ou vide
• @URL(protocol=, host=, port=) : doit être une URL
• @Range(min=, max=) : doit avoir une valeur comprise entre Min et Max

Intégration JSF

JSF 2 intègre par défaut la validation des beans (JSR 303)
http://www.mastertheboss.com/web-interfaces/293-jsf-validation-tutorial.html?start=2
Dès lors, les pages JSF n'ont plus besoin de contenir les information de validation du bean. Lorsque une validation de contrainte échoue, les messages d'erreur associés sont automatiquement traduits en FacesMessage par l'implementation JSF.

On pourra toutefois les désactiver :

<h:inputText value="#{sampleBean.userName}">
    <f:validateBean disabled="true" />
</h:inputText>

Gestion des messages

On peut définir le message qui sera affiché en cas d'erreur de validation en précisant un attribut message dans l'annotation

@Size(max = 10, min = 1, message="{toto}")

Ici on utilise une clé (chaîne entre accolades) afin d'aller chercher le message dans un fichier de propriétés. Ce fichier doit se trouver dans le classpath et porter le nom ValidationMessages.properties

On peut le décliner ne fonction des langues ValidationMessages_en.properties, ValidationMessages_fr.properties

Mise à jour de propriétés par les formulaires (updateActionlistener)

updateActionListener est une balise de la librairie JSF Tomahawk qui est particulièrement utile. C'est un listener qui est updateActionListener est une balise de la librairie JSF Tomahawk qui est particulièrement utile. C'est un listener qui est associé à une balise permettant une action (bouton, lien) qui, au moment où ce dernier est activé, va lire le contenu de son attribut value pour l'assigner à la référence contenue dans son attribut property.On utilisera par exemple :

...

private String value;
public String getValue() {
  return value;
}
public void setValue(String value) {
  this.value = value;
}

<bean id="test2Controller"
      class="org.esupportail.formation.web.controllers.Test2Controller"
      parent="abstractContextAwareController"
      scope="session">
  <description>A bean to manage the test2 page.</description>
</bean>

<%@include file="_include.jsp"%>
<%@include file="_navigation.jsp"%>
 <h:form>
   <h:outputText value="#{test2Controller.value}"/>
 </h:form>

<navigation-rule>
  <from-view-id>/stylesheets/test1.jsp</from-view-id>
  <navigation-case>
    <from-outcome>gotoWelcome</from-outcome>
    <to-view-id>/stylesheets/welcome.jsp</to-view-id>
    <redirect />
  </navigation-case>
  <navigation-case>
    <from-outcome>gotoTest2</from-outcome>
    <to-view-id>/stylesheets/test2.jsp</to-view-id>
    <redirect />
  </navigation-case>
</navigation-rule>

<%@include file="_include.jsp"%>
<%@include file="_navigation.jsp"%>
  <h:form>
    <h:messages/>
    <h:inputText value="#{test1Controller.myInput}" validator="#{test1Controller.validateMyInput}"/>
    <h:commandButton value="Move" action="#{test1Controller.callback}"/>
    <h:commandButton value="SetTest2Value" action="gotoTest2">
       <t:updateActionListener value="#{test1Controller.myInput}"
	                       property="#{test2Controller.value}"/>
    </h:commandButton>
  </h:form>

Conversion des types complexes

Il existe des convertisseurs par défaut dans JSF (DateTimeConverter et NumberConverter). Ils permettent de transformer une date ou un nombre suivant différentes règles, par exemple :

...

La classe LocaleConverter implémente l'interface Converter de JSF.

JSF et accessibilité

Un des objectifs de l'utilisation de JSF est, via un standard de haut niveau, de tendre vers plus d'accessibilité (WAI : Web Accessibility Initiative). L'accessibilité des applications doit être une préoccupation constante des programmeurs, qui ne doivent pas hésiter à tester leurs applications en utilisant des navigateurs pauvres tels que Lynx. En règle générale, on évitera absolument d'utiliser les balises h:commandLink qui, à cause de l'utilisation de Javascript, brisent toutes les règles de l'accessibilité. On préfèrera dans tous les cas des boutons (h:commandButton). Javascript peut néanmoins être utilisé pour améliorer l'IHM des applications, en faisant attention à ce que les navigateurs ne parlant pas Javascript puissent quand même utiliser l'application. Nous montrons ici à titre d'exemple comment on peut soumettre un formulaire par simple changement de la valeur d'une boite déroulante :

...