Application web JSF – mtitek.com

Samples | Application web JSF

Application web JSF
Créer un projet web avec Maven : mtitek-modulez-jsf
Structure de l'application web : mtitek-modulez-jsf
Fichier de configuration JSF : faces-config.xml
Fichier de configuration spécifique à JBoss : jboss-web.xml
Déployer l'application web dans JBoss en utilisant Maven
Structure finale de l'application web : mtitek-modulez-jsf

Application web JSF
Cette page présente la création d'un exemple JSF (2.1) avec Eclipse (4.2.0), Maven (3.0.4), JBoss AS (7.1.1.Final).

La structure de base d'une application web utilisant JSF est :

WEB-INF/classes/[packages]/[mbeans].class WEB-INF/web.xml [files].xhtml
Ces composants seront discutés en détails dans le reste de ce tutoriel, mais il faut signaler à ce stade que la compilation des beans nécessite la librairie JSF qui peut être acquise de plusieurs façons.
Dans cet exemple, on utilise Maven qui contient dans son repository toutes les librairies nécessaires au développement des applications web JSF.
Créer un projet web avec Maven : mtitek-modulez-jsf
Créer un projet web avec Maven :

$ mvn archetype:generate \ -DarchetypeGroupId=org.apache.maven.archetypes \ -DarchetypeArtifactId=maven-archetype-webapp \ -DarchetypeVersion=1.4 \ -DgroupId=mtitek.modulez \ -DartifactId=mtitek-modulez-jsf \ -Dversion=1.0.0-SNAPSHOT \ -DinteractiveMode=false
Importer le projet dans Eclipse (Eclipse –> Import –> Maven –> Existing Maven Projects).

Notes :
Sur Linux, le caractère "\" permet d'écrire une commande sur plusieurs lignes.
Sur Windows, il faut utiliser le caractère "^".

Modifier le fichier POM et ajouter une dépendance sur la librairie JSF :

<dependency> <groupId>javax.faces</groupId> <artifactId>jsf-api</artifactId> <version>2.1</version> <scope>provided</scope> </dependency>
Structure de l'application web : mtitek-modulez-jsf
Voici la structure de l'application web présentée dans cet exemple :

|+ src |+ main |+ java |+ mtitek |+ mbeans |+ HelloManagedBean.java |+ webapp |+ WEB-INF |+ web.xml |+ hello.xhtml |+ welcome.xhtml
Cette application contient deux fichiers web ("hello.xhtml", "welcome.xhtml") qui utilisent des tags JSF et un bean managé (Managed Bean) ("HelloManagedBean.java").
Le fichier "web.xml" contient le mapping des URLs, se terminant par l'extension ".xhtml", avec la Servlet JSF ("FacesServlet").

Voici le contenu du fichier "web.xml" :

<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0"> <display-name>JSF tutorial</display-name>  <servlet> <servlet-name>FacesServletMappingName</servlet-name> <servlet-class>javax.faces.webapp.FacesServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet>  <servlet-mapping> <servlet-name>FacesServletMappingName</servlet-name> <url-pattern>*.xhtml</url-pattern> </servlet-mapping> </web-app>
Voici le code de la classe "HelloManagedBean" :

package mtitek.mbeans; import javax.faces.bean.ManagedBean; import javax.faces.bean.RequestScoped; @ManagedBean @RequestScoped public class HelloManagedBean { private String helloMsg; public String getHelloMsg() { return helloMsg; } public void setHelloMsg(String helloMsg) { this.helloMsg = helloMsg; } }
Voici le code du fichier "hello.xhtml" :

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html"> <h:head> <title>JSF 2.1: Hello</title> </h:head> <h:body> <h1>Hello, world! ...</h1> <hr /> <h:form> <h:inputText value="#{helloManagedBean.helloMsg}"></h:inputText> <h:commandButton value="Submit" action="welcome"></h:commandButton> </h:form> </h:body> </html>
Voici le code du fichier "welcome.xhtml" :

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html"> <h:head> <title>JSF 2.1: Welcome</title> </h:head> <h:body bgcolor="white"> <h1>Welcome World ...</h1> <hr /> <b>#{helloManagedBean.helloMsg}</b> </h:body> </html>
Pour installer l'application avec Maven et générer le fichier war "mtitek-modulez-jsf.war" :

mvn install
Copier le fichier "mtitek-modulez-jsf.war" dans le répertoire "$JBOSS_HOME/standalone/deployments/"

Voici l'URL pour lancer la page "hello.xhtml" :

http://localhost:8080/mtitek-modulez-jsf/hello.xhtml
Fichier de configuration JSF : faces-config.xml
Il est possible de déployer le fichier de configuration "faces-config.xml" avec l'application web.
Il contient des configurations spécifiques à l'application web JSF : navigation entre les pages, beans managés, fichiers de ressources, …
Son utilisation va être vue plus en détails dans les chapitres qui suivront.

Ce fichier n'est plus obligatoire, d'autant plus qu'il est possible de spécifier un autre nom à ce fichier, et même, si nécessaire, spécifier plusieurs fichiers de configuration pour l'application web JSF.

Voici un exemple vide du fichier "faces-config.xml" :

<?xml version='1.0' encoding='UTF-8'?> <faces-config xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facesconfig_2_1.xsd" version="2.1"> </faces-config>
Ce fichier doit être placé directement dans le répertoire "WEB-INF".
Il est possible de placer ce fichier dans le répertoire "META-INF".
Il est aussi possible de renommer le fichier avec un nom qui a l'extension ".faces-config.xml" et le placer dans le répertoire "META-INF".
L'autre alternative consiste à spécifier les noms des fichiers de configuration dans le fichier "web.xml" (les noms doivent être séparés par une virgule).

<web-app> <context-param> <param-name>javax.faces.CONFIG_FILES</param-name> <param-value>WEB-INF/faces-config1.xml,WEB-INF/faces-config2.xml</param-value> </context-param> </web-app>
Fichier de configuration spécifique à JBoss : jboss-web.xml
Le fichier de configuration "jboss-web.xml" permet de définir plusieurs paramètres spécifiques à JBoss.
Voici un exemple du fichier "jboss-web.xml" où on utilise le paramètre "context-root" pour spécifier un alias explicite à l'application web.

<jboss-web> <context-root>/modulez-jsf</context-root> </jboss-web>
L'URL pour lancer la page "hello.xhtml" devient :

http://localhost:8080/modulez-jsf/hello.xhtml
Déployer l'application web dans JBoss en utilisant Maven
Pour pouvoir déployer l'application web dans JBoss en utilisant Maven, il faut ajouter le plugin JBoss dans le fichier POM :

<plugin> <groupId>org.jboss.as.plugins</groupId> <artifactId>jboss-as-maven-plugin</artifactId> <executions> <execution> <phase>package</phase> <goals> <goal>deploy</goal> </goals> </execution> </executions> </plugin>
La ligne de commande pour déployer l'application dans JBoss (il faut que JBoss soit déjà démarré) :

mvn jboss-as:deploy -Dhostname=localhost -Dport=8080
Pour connaitre les différents paramètres du but deploy :

mvn help:describe -Dplugin=jboss-as -Dmojo=deploy -Ddetail -Dfull
Structure finale de l'application web : mtitek-modulez-jsf
|+ src |+ main |+ java |+ mtitek |+ mbeans |+ HelloManagedBean.java |+ webapp |+ WEB-INF |+ faces-config.xml |+ jboss-web.xml |+ web.xml |+ hello.xhtml |+ welcome.xhtml