Guide pas à pas de l'utilisation de JBoss tools pour le développement JSF

Date de publication : 30/10/08 , Date de mise à jour : 12/11/08

Par Lotfi Mellouk
 

I. Introduction

I-A. Présentation de JBoss Tools

• Exadel Studio Product : passé sous le giron de JBoss pour le développement JSF,
• Hibernate tools : permet de générer les fichier de mapping hibernate ainsi que les classes DAO en se connectant à la source de données,
• JBoss jBPM tools : fournit les outils pour modéliser , exécuter, et monitorer les processus métier. De plus, il permet de faciliter le développement de services web WSDL et des processus métier avec jPDL(jBPM Process Definition Language) et BPEL (Business Process Execution Language)
• Drools IDE : pour le développement des règles métier pour le moteur de règles métier Drools
• JBoss Application Server tools : pour la gestion du serveur d'application JBoss
• JBoss Seam tools : pour l'utilisation du framework JBoss Seam

I-A-1. Installation de JBoss tools

I-A-1-a. Compatibilités système

• Java: Java 5.0 ou plus
• Système d'exploitation: Window, Linux.
• Plug-ins: JBoss tools contient tous les plugins nécessaires à son utilisation, l'installation vient avec les plugings suivants:
  
  
  
  
  1. WTP runtime
  2. GEF runtime
  3. JEM runtime
  4. EMF & SDO runtime
  5. XSD runtime

I-A-1-b. Installation

Il est important de vérifier la compatibilité de la version de JBoss tools avec la version d'Eclipse.

II. Présentation des outils JBoss tools pour JSF

II-A. La perspective Web development

II-B. La palette JBoss tools

II-C. Editeur Graphique

II-D. Vue du fichier de configuration de JSF

JBoss toos fournit un puissant éditeur du fichier de configuration faces-config.xml, il contient trois modes:

• Diagram Visialise le workflow de navigation
  
  
• Tree Contient tous les éléments du faces-config avec la possibilité de réaliser les opérations d'ajout/suppression/modification de chaque élément
  
  
• Source Le code source du faces-config.

II-E. Assistant du contenu du code source

II-F. Vérificateur et reporteur d'erreur

II-G. Autres éditeurs

• Editeur XML
• Editeur Graphique de Properties
• Editeur Graphique de TLD
• Editeur Graphique de fichier de description de l'application Web (web.xml)
• Editeur CSS
• Editeur JavaScript
• Visualiseur d'Image
• Editeur XSD
• Editeur WSDL

II-H. Présentation des nouveautés de la version 3.0 de JBoss tools

• Amélioration de la rapidité de l'éditeur visuel. Il est maintenant possible d'écrire directement et aisément dans l'éditeur visuel.
• Editeur de classe CSS: un nouvel assistant de classe CSS est proposé, pour l'utiliser:
  1. Faire un clic droit sur le composant dans l'éditeur visuel et sélectionner ses attributs.
     
     
     
     
  2. Choisir l'attribut styleClass, ensuite, cliquer sur le bouton d'aide à la saisie qui s'affiche sur la droite.
     
     
     
     
  3. Choisir le fichier CSS, une classe de style à modifier, ou créer une nouvelle .
     
     
     
     
  L'assistant CSS peut être solliciter dans l'attribut styleClass d'un composant sélectionné dans la palette ou directement : File/New/CSS class ou File/New/Other.
  
  
  
  
  
  
• Amélioration de l'assistant de code JSF: Les problèmes rencontrés dans l'ancienne version sont en cours de correction, comme, la proposition de composants JSF à l'intérieur de l'attribut jsfc de Facelets
  
  
  
  
• Affichage des tags non visuel: L'éditeur propose l'affichage de composants non visuels :
  Lorsque cet affichage est choisi, les composants non visuels sont affichés ce qui permet au développeur de les localiser facilement et les sélectionner avec un simple clic.
• Affichage des messages issus du fichier de ressources: les dernières versions de JBoss tools ne permettaient pas de visualiser la valeur des clés de fichiers de ressources, alors que cette possibilité existait dans l'ancienne version du produit tenu par Exadel. Ce problème est corrigé dans la version 3.
• Support de l'ouverture de fichiers inclus à l'aide des tags a4j:include et rich:insert, comme pour le tag Facelets ui:include, l'assistant permet d'accéder directement au fichiers inclus à l'aide de l'attribut src par l'utilisation de la touche F3 ou de CTRL+ clic.
• Support de la complétion pour d'avantage de tags JSF notamment les tags JSF core.
• La palette change de look et contient de nouvelles icones pour la librairie ajax4jsf et Richfaces.
  
  
  
  
• Support des nouveaux tags Richfaces par l'editeur visuel: rich:hotKey, rich:ajaxValidator, rich:graphValidator, rich:beanValidator, rich:extendedDataTable.
• Support des nouveaux tags JSF 2: h:body, h:head, h:outputscript, h:outputstyle

III. Guide de création d'un nouveau projet JSF

III-A. Création d'un nouveau projet

Clic droit sur la vue Web project, puis, séléctionner Create New JSF project :

Ajouter le nom du projet, l'environnement JSF et le template. Nous allons choisir l'implémentation JSF 1.1 avec les librairies.


L'assistant nous propose le choix de la version de l'implémentation JSF : JSF 1.1 ou 1.2 ainsi que myfaces 1.1.4.

Déclarer la version de l'api des servlet et le serveur de déploiement:

III-B. Première page JSF

Création d'un nouveau fichier JSP:
On fait un clic droit sur le dossier WebContent, New, File, et on choisi JSP file.

Choix de template:


L'assistant nous propose de définir le template de page, les templates proposés sont:
Blank: Une page JSP vide
JSFBasePage: Page JSF avec la saisie des librairies de tags à utiliser:
JSPRedirect: Une page de redirection.

<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
<html>
	<head>
		<title></title>
	</head>
	<body>
		<f:view>
			
			
		</f:view>
	</body>	
</html>  

En utilisant la palette: utiliser la palette Jbos Tools, on sélectionne JSF HTML dans la palette, et on fait un clic sur outputText

En utilisant l'éditeur: Il suffit de commencer d'écrire 'h:out' et l'éditeur propose la liste des composants qui correspondent aux premières lettres tapées.

Deployer l'application:

Pour déployer notre application,on l'ajoute dans les modules web dans la perspective J2EE/Server, ou on clique droit sur le projet et on fait Run on Server. Le démarrage et l'arrêt du serveur peut se faire à l'aide de:

Le résultat:

III-C. Ajouter un managedBean

Ouvrir le fichier faces-config.xml qui se trouve dans : le dossier configuration

Aller dans l'onglet Tree, et clic droit sur ManagedBeans et faire New ManagedBean

Saisir les paramètres du managedBean : l'assistant de création du managedBean nous propose de saisir le scope, la classe et le nom du managedBean, on coche generate Source Code, la classe sera générée dans le package défini.

Ajouter des properties: Nous allons maintenant ajouter les properties du bean, en cliquant sur le bouton Add dans l'éditeur du mangedBean

Si on ne connait pas le package exact de la classe, utiliser l'assistant en cliquant sur CTRL-ESPACE

III-D. Ajouter une règle de navigation

On ajoute une page JSFBasedPage login.jsp

Dans le diagramme, on réalise un clic sur l'icône create New connection

On lie index.jsp à login.jsp

<h:form>
	<h:panelGrid columns="2" cellspacing="5" cellpadding="5">
		<h:outputText value="Login" />
		<h:inputText value="#{compte.login}" />
		<h:outputText value="Mot de passe" />
		<h:inputSecret value="#{compte.password}" />
	</h:panelGrid>
	<h:commandLink value="#{compte.connect}"></h:commandLink>
</h:form>
</f:view>

public String connect(){ 
 return "index"; 
 }

Ajouter un cas de navigation : pour ajouter un autre cas de navigation, on ouvre l'éditeur de faces config et l'onglet Tree. Il est alors possible de créer une règle de navigation ou d'ajouter un cas de navigation à une règle existante.

III-E. Importer un projet existant

III-F. Utilisation avec un projet déjà présent dans le workspace

Pour utiliser JBoss Tools avec un projet JSF qui existe déjà dans le workspace, il faut lui ajouter des capacités JSF: JSF capabilities. Pour cela, il faut faire un clic droit sur le projet en question puis séléctionner JBoss tools/add JSF capabilities :
Ensuite nous donnons l'adresse du web.xml et les dossiers web/sources ainsi que le serveur de déploiement comme pour l'import de projet.

III-G. Créer un Converter

1. Editer le faces config, puis, passer dans l'onglet Tree
   
   
2. Sélectionner Converters et cliquer sur Add ou par un clic droit sur Converters et ensuite New/Converter with Id
   
   
3. Cliquer sur le lien Converter-Class pour créer la classe Si on clique sur Finish avant de créer la classe, une croix rouge apparait dans la déclaration du converter, on peut cliquer sur Converter-Class pour le créer
   On Crée la classe qui implémente l'interface javax.faces.convert.Converter
   
4. Ajouter le code de conversion On peut maintenant définir la logique métier de notre Converter
   

III-H. Créer un Validator

De la même manière on peut créer un validator personnalisé en utilisant l'assistant

IV. Customiser l'utilisation de JBoss Tools

IV-A. Créer son propre template de projet

1. Création du Template Dans l'explorateur de projet, clic droit sur le projet et sélectionner JBoss Tools JSF et Save As Template
2. Ajouter l'implémentation
   
3. Ajouter les préférences
   On choisit les dossiers et/ou librairies à ajouter dans le template.
4. Choix des Templates Velocity
   JBoss tools prend en charge les template Velocity, il n'est pas obligatoire d'ajouter un fichier pour velocity, le template sera crée en cliquant sur Finish.
   Pour en savoir plus sur Velocity, consultez le site Apache Velocity

IV-B. Ajouter une librairie de tag

1. Ajouter les tags Rcfaces ou le jar qui les contient dans le projet
2. Utiliser le bouton import dans la palette
   
   
3. Sélection du fichier TLD L'assistant de création de tag nous propose de sélectionner le fichier TLD
4. Choix des Tags L'assistant propose la liste des tags disponibles. Si la librairie n'est pas dans la liste, il faut vérifier que le projet contient bien le fichier TLD. Parfois, il sera nécessaire de redémarrer Eclipse.
5. Ajouter un nouveau groupe de librairies On ajoute la librairie à un nouveau Groupe créé en cochant create New Group, en cliquant sur ok. On termine ainsi l'ajout de la nouvelle librairie.
   

IV-C. Créer son propre template de page

1. Sauvegarder la page en tant que Template Pour le faire, on doit se positionner dans la vue Web Project, on clic droit sur la page en question et on séléctionne Save as Template
   
2. Définir le nom du template

1. Ouvrir les préférences Eclipse Windows/Preferences
2. Sélectionner JSF Page dans la rubrique JBoss tools
   
3. Séléctionner le fichier JSP Sélectionner le fichier en faisant un clic sur Browse...

IV-D. Support de Facelets

1. Capacités Facelets Nous pouvons ajouter Facelets à un projet JSF en ajoutant Facelets Capabilities, pour cela:
   Clic droit sur le projet, JBoss Tools/add custom Capabilities...
   
   Ensuite on choisit Facelets
   
2. Assistant de création d'un projet web. L'assistant de création de projet dispose nativement d'un template pour un projet Facelets avec l'implémentation JSF
   
3. Assistant de création d'une page xhtml L'assistant de création d'une page xhtml dispose nativement d'un template de page Facelets
   
4. Outils de la Palette La palette JBoss Tools dispose de tous les composants Facelets
   
5. Assistant de code L'assistant de code propose aussi l'aide pour l'utilisation de l'attribut jsfc ainsi que les tags de Facelets, l'assitant devrait proposer tous les tags JSF à l'interieur de jsfc comme le proposait l'ancienne version avec Exadel Studio. Ce bug est en cours de correction il sera corrigé dans les prochaines versions.
   
6. Editeur visuel L'editeur visuel prend en charge les Facelets et affiche la page en tenant compte des templates utilisés.