Jbosstools

Guide pas pas de l'utilisation de JBoss tools pour le dveloppement JSF
par Lotfi Mellouk

Date de publication : 17/12/08 Dernire mise jour :
Cet article prsente l'utilisation de JBoss tools pour faciliter et industrialiser le dveloppement d'applications web avec JSF
Guide pas pas de l'utilisation de JBoss tools pour le dveloppement JSF par Lotfi Mellouk
I - Introduction..............................................................................................................................................................3 I-A - Prsentation de JBoss Tools......................................................................................................................... 3 I-A-1 - Installation de JBoss tools.................................................................................................................... 3 I-A-1-a - Compatibilits systme................................................................................................................. 3 I-A-1-b - Installation..................................................................................................................................... 3 II - Prsentation des outils JBoss tools pour JSF.......................................................................................................4 II-A - La perspective Web development................................................................................................................ 4 II-B - La palette JBoss tools.................................................................................................................................. 4 II-C - Editeur Graphique.........................................................................................................................................4 II-D - Vue du fichier de configuration de JSF........................................................................................................ 5 II-E - Assistant du contenu du code source.......................................................................................................... 6 II-F - Vrificateur et reporteur d'erreur................................................................................................................... 7 II-G - Autres diteurs..............................................................................................................................................9 II-H - Prsentation des nouveauts de la version 3.0 de JBoss tools...................................................................9 III - Guide de cration d'un nouveau projet JSF.......................................................................................................16 III-A - Cration d'un nouveau projet.....................................................................................................................16 III-B - Premire page JSF.................................................................................................................................... 19 III-C - Ajouter un managedBean.......................................................................................................................... 24 III-D - Ajouter une rgle de navigation................................................................................................................ 27 III-E - Importer un projet existant......................................................................................................................... 30 III-F - Utilisation avec un projet dj prsent dans le workspace........................................................................31 III-G - Crer un Converter....................................................................................................................................32 III-H - Crer un Validator......................................................................................................................................36 IV - Customiser l'utilisation de JBoss Tools.............................................................................................................. 38 IV-A - Crer son propre template de projet......................................................................................................... 38 IV-B - Ajouter une librairie de tags...................................................................................................................... 40 IV-C - Crer son propre template de page..........................................................................................................42 IV-D - Support de Facelets.................................................................................................................................. 45 V - Remerciements.................................................................................................................................................... 50
-2Copyright 2008 - Lotfi MELLOUK. Aucune reproduction, mme partielle, ne peut tre faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu' 3 ans de prison et jusqu' 300 000 E de dommages et intrts.
http://lmellouk.developpez.com/tutoriels/jsf/jbosstools/
I - Introduction I-A - Prsentation de JBoss Tools

JBoss tools est un ensemble de plugins Eclipse pour le dveloppement J2EE, il inclut les produits suivant : Exadel Studio Product : plug-in Eclipse pour le dveloppement web, pass sous le giron de JBoss pour enrichir JBoss tools. Hibernate tools : permet de gnrer les fichier de mapping hibernate ainsi que les classes DAO en se connectant la source de donnes, JBoss jBPM tools : fournit les outils pour modliser , excuter, et monitorer les processus mtier. De plus, il permet de faciliter le dveloppement de services web WSDL et des processus mtier avec jPDL(jBPM Process Definition Language) et BPEL (Business Process Execution Language) Drools IDE : pour le dveloppement des rgles mtier pour le moteur de rgles mtier Drools JBoss Application Server tools : pour la gestion du serveur d'application JBoss JBoss Seam tools : pour l'utilisation du framework JBoss Seam
JBoss tools supporte nativement les environnements : JSF-RI, MyFaces, Richfaces, JBoss Seam, Facelets, Shale. JBoss tools est donc un outil puissant qui fait partie des meilleurs outils open source pour le dveloppement JSF.
I-A-1 - Installation de JBoss tools I-A-1-a - Compatibilits systme

Java : Java 5.0 ou plus Systme d'exploitation : Window, Linux. Plug-ins : JBoss tools contient tous les plugins ncessaires son utilisation, l'installation vient avec les plugins suivants : a b c d e WTP runtime GEF runtime JEM runtime EMF & SDO runtime XSD runtime
I-A-1-b - Installation
JBoss tools est propos en tlchargement sur le site suivant , il est possible d'installer seulement le module de dveloppement web et JSF, ou de prendre tout le package JBoss tools. Pour installer le plugin, il suffit de tlcharger l'archive et de la dzipper dans le dossier d'installation d'Eclipse. Il est important de vrifier la compatibilit de la version de JBoss tools avec la version d'Eclipse. Pour l'installation l'aide du site de mise jour d'Eclipse : slectionnez Help/Software updates/Add Site Ajouter le lien suivant pour la version stable : http://download.jboss.org/jbosstools/updates/stable Pour la version de dveloppement, utile pour la dernire version d'Eclipse : http://download.jboss.org/jbosstools/ updates/development Pour vrifier l'installation slectionnez Window/Open Perspective/Other/Web development
II - Prsentation des outils JBoss tools pour JSF II-A - La perspective Web development
La perspective web development contient le plan de travail pour un projet web. Pour ouvrir cette perspective : Window/Open perspective/Web development
II-B - La palette JBoss tools

La palette JBoss tools rassemble les librairies de tags JSF, Richfaces, Facelets et JBoss seam, il est possible d'ajouter d'autres librairies la palette.
II-C - Editeur Graphique

Un diteur pour pages JSF de type WYSIWYG est disponible pour aider au dveloppement.
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 lments du faces-config avec la possibilit de raliser les oprations d'ajout/ suppression/modification de chaque lment
Source Le code source du faces-config.
II-E - Assistant du contenu du code source

Dans tous les diteurs du code source, un assistant est disponible. Il est lanc lorsqu'on commence crire, sinon, on peut le solliciter en utilisant CTRL-ESPACE. Voici un exemple dans le code source du web.xml, comme ce qui est propos en natif dans WTP.
II-F - Vrificateur et reporteur d'erreur

JBoss tools permet de dtecter les erreurs dans le faces-config, le web.xml ou les pages JSP. Il permet galement de dtecter les classes mal dfinies, une property d'un bean qui n'a pas de getter, ou une erreur de parsing des fichiers XML. Il est possible de dfinir les niveaux de vrification de JBoss tools, dans Window/Preferences/JBoss Tools/Web, Verification.
Il est possible galement de faire une vrification explicite en faisant un clic-droit sur un projet JBoss Tools JSF et en slctionnant ensuite verify :
II-G - Autres diteurs

D'autres diteurs trs intressants sont fournis avec JBoss Tools comme : 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 - Prsentation des nouveauts de la version 3.0 de JBoss tools

JBoss Tools 3 est disponible depuis le 31 octobre 2008 en version Beta, cette version est la premire compatible avec Eclipse 3.4/Ganymede. Pour l'installer, il suffit d'ajouter le site des versions en cours de dveloppement au gestionnaire de mise jour d'Eclipse, ou la tlcharger manuellement l'adresse suivante. En ce qui concerne le dveloppement JSF, les nouveauts concernent essentiellement l'diteur visuel. Les problmes rencontrs avec la version 2 sont pour la plupart corrigs. Parmi les nouvelles caractristiques de la version 3.0, on peut citer : Amlioration de la rapidit de l'diteur visuel. Il est maintenant possible d'crire directement et aisment 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 slectionner ses attributs.
Choisir l'attribut styleClass, ensuite, cliquer sur le bouton d'aide la saisie qui s'affiche sur la droite.
- 10 Copyright 2008 - Lotfi MELLOUK. Aucune reproduction, mme partielle, ne peut tre faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu' 3 ans de prison et jusqu' 300 000 E de dommages et intrts.
Choisir le fichier CSS, une classe de style modifier, ou crer une nouvelle .
L'assistant CSS peut tre sollicit dans l'attribut styleClass d'un composant slectionn dans la palette ou directement : File/New/CSS class ou File/New/Other.
Amlioration de l'assistant de code JSF : les problmes rencontrs dans l'ancienne version sont en cours de correction, comme, la proposition de composants JSF l'intrieur de l'attribut jsfc de Facelets.
Affichage des tags non visuels :
L'diteur propose l'affichage de composants non visuels : Lorsque cet affichage est choisi, les composants non visuels sont affichs ce qui permet au dveloppeur de les localiser facilement et les slectionner avec un simple clic. Affichage des messages issus du fichier de ressources :
les dernires versions de JBoss tools ne permettaient pas de visualiser la valeur des cls de fichiers de ressources, alors que cette possibilit existait dans l'ancienne version du produit tenu par Exadel. Ce problme 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'accder directement au fichier inclus l'aide de l'attribut src par l'utilisation de la touche F3 ou de CTRL+ clic. Support de la compltion pour davantage 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.
On peut regretter nanmoins une rgression de l'diteur de code JSF lors du passage de la version d'Exadel compatible avec Eclipse 3.2 au nouvelles versions JBoss tools, certains bugs ne sont toujours pas corrigs dans la version 3.0. Par exemple, dans la saisie des tags JSF ou Richfaces, l'diteur ne filtre pas les valeurs disponibles dans l'expression EL.
III - Guide de cration d'un nouveau projet JSF III-A - Cration d'un nouveau projet
Nous allons utiliser l'assistant de cration d'un nouveau projet JSF: Clic droit sur la vue Web project, puis, slctionner Create New JSF project :
Ajouter le nom du projet, l'environnement JSF et le template. Nous allons choisir l'implmentation JSF 1.1 avec les librairies.
L'assistant nous propose le choix de la version de l'implmentation JSF : JSF 1.1 ou 1.2 ainsi que myfaces 1.1.4. Le template est le type de gabarit du projet cr, les templates proposs sont : JSFBlank : Cration d'un projet web standard avec les capacits JSF JSFKickStart : Cration d'un projet JSF standard avec un exemple prt l'emploi. With/Without Libs : Les deux templates sont disponibles avec une version qui inclut les librairies JSF dans le dossier WEB-INF/libs WithLibs et une autre sans les librairies JSF withoutLibs. Il est nanmoins possible d'ajouter son propre template. Dclarer la version de l'api des servlet et le serveur de dploiement :
Le projet JSF est cr avec les librairies ncessaires, nous allons maintenant crer une nouvelle page JSF.
III-B - Premire page JSF

Cration d'un nouveau fichier JSP : on fait un clic droit sur le dossier WebContent, New, File, et on choisit JSP file.
Choix de template :
L'assistant nous propose de dfinir le template de page, les templates proposs sont : Blank : une page JSP vide JSFBasePage : page JSF avec la saisie des librairies de tags utiliser : JSPRedirect : une page de redirection. Il est possible de crer sa propre page de template. Nous allons choisir JSFBasePage, et nous slectionnerons ensuite les tags utiliss dans la page, JSF core et JSF HTML. Notre page contient donc : JSFBasePage
<%@ 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>
Nous souhaitons maintenant afficher un message sur la page, nous pouvons procder de deux manires : En utilisant la palette : utiliser la palette Jbos Tools, on slectionne JSF HTML dans la palette, et on fait un clic sur outputText.
En utilisant l'diteur : il suffit de commencer crire 'h:out' et l'diteur propose la liste des composants qui correspondent aux premires lettres tapes.
Dployer l'application : pour dployer 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 dmarrage et l'arrt du serveur peuvent se faire l'aide de :
Le rsultat :
III-C - Ajouter un managedBean

Nous allons utiliser l'diteur du fichier de configuration de JSF pour ajouter un nouveau 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 paramtres du managedBean : l'assistant de cration du managedBean nous propose de saisir le scope, la classe et le nom du managedBean, on coche generate Source Code, la classe sera gnre dans le package dfini.
Ajouter des properties : nous allons maintenant ajouter les properties du bean, en cliquant sur le bouton Add dans l'diteur du managedBean.
Si on ne connait pas le package exact de la classe, utiliser l'assistant en cliquant sur CTRL-ESPACE .
III-D - Ajouter une rgle de navigation

Nous allons crer la navigation entre la page login.jsp et index.jsp. Passons maintenant sur l'onglet Diagram de l'diteur du faces-config.
Clic droit dans l'diteur, New View.
On ajoute une page JSFBasedPage login.jsp.
Dans le diagramme, on ralise un clic sur l'icne create New connection On lie index.jsp login.jsp.
Il est possible de modifier le cas de navigation en double cliquant sur la connection.
Ajouter une action dans la page 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>
Nous pouvons accder directement la proprit du bean en cliquant sur CTRL + lien sur la property. Ajouter la fonction de contrle,dans la classe Compte en ajoutant la fonction connect :
public String connect(){ return "index"; }
Tester la navigation : nous avons cr un seul cas de navigation, en cliquant sur le bouton Login, nous passons page index.jsp. 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 crer une rgle de navigation ou d'ajouter un cas de navigation une rgle existante.
III-E - Importer un projet existant

Si l'on souhaite utiliser JBoss tools avec un projet existant, un assistant d'import de projets est disponible dans la vue WebProject. Cliquer droit dans la vue Web Project, ou utiliser le bouton import :
L'assistant nous demande l'endroit ou se situe le web.xml du projet importer, ensuite, on saisit le nom du projet, les dossiers sources et le serveur de dploiement.
III-F - Utilisation avec un projet dj prsent dans le workspace

Pour utiliser JBoss Tools avec un projet JSF qui existe dj dans le workspace, il faut lui ajouter des capacits JSF : JSF capabilities. Pour cela, il faut faire un clic droit sur le projet en question puis slctionner JBoss tools/add JSF capabilities :
Ensuite nous donnons l'adresse du web.xml et les dossiers web/sources ainsi que le serveur de dploiement comme pour l'import de projet.
III-G - Crer un Converter

1 Editer le faces config, puis, passer dans l'onglet Tree.
Slectionner Converters et cliquer sur Add ou par un clic droit sur Converters et ensuite New/Converter with Id.
Cliquer sur le lien Converter-Class pour crer la classe. Si on clique sur Finish avant de crer la classe, une croix rouge apparait dans la dclaration du converter, on peut cliquer sur Converter-Class pour le crer.
On Cre la classe qui implmente l'interface javax.faces.convert.Converter.
Ajouter le code de conversion. On peut maintenant dfinir la logique mtier de notre Converter.
III-H - Crer un Validator

De la mme manire on peut crer un validator personnalis en utilisant l'assistant.
IV - Customiser l'utilisation de JBoss Tools IV-A - Crer son propre template de projet
JBoss tools dispose d'un systme de templates pour crer les nouveaux projets web. Il est parfois utile de dfinir son propre template, comme celui de Maven par exemple. Pour cela : 1 Cration du Template Dans l'explorateur de projet, clic droit sur le projet et slectionner JBoss Tools JSF et Save As Template.
Ajouter l'implmentation.
Ajouter les prfrences.
On choisit les dossiers et/ou librairies ajouter dans le template. 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 en cliquant sur Finish. Pour en savoir plus sur Velocity, consultez le site Apache Velocity Maintenant, le template de projet est enregistr, nous pouvons l'utiliser dans la cration ou l'import de nouveaux projets
IV-B - Ajouter une librairie de tags

Il est possible d'ajouter d'autres librairies de tags que JSF et Richfaces, nous allons voir comment ajouter les librairies de Rcfaces . 1 2 Ajouter les tags Rcfaces ou le jar qui les contient dans le projet. Utiliser le bouton import dans la palette.
Slection du fichier TLD : l'assistant de cration de tags nous propose de slectionner le fichier TLD.
Choix des Tags : l'assistant propose la liste des tags disponibles. Si la librairie n'est pas dans la liste, il faut vrifier que le projet contient bien le fichier TLD. Parfois, il sera ncessaire de redmarrer Eclipse.
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.
On peut galement ajouter une nouvelle librairie de Tag, l'aide d'un glisser-dposer du fichier TLD de la vue WebProjects dans la palette JBoss Tools, l'assistant apparaissant comme avec le bouton import.
IV-C - Crer son propre template de page

Lorsque on ajoute une nouvelle page JSP, nous pouvons utiliser un template de page existant au lieu de crer une page vide. Nous allons voir comment dfinir notre une page template xhtml qui utilise Facelets. 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 slctionne Save as Template.
Dfinir le nom du template.
Nous pouvons crer une page de Template dans les prfrences Eclipse.
1 2
Ouvrir les prfrences Eclipse Windows/Preferences. Slectionner JSF Page dans la rubrique JBoss tools.
Slctionner le fichier JSP : slectionner le fichier en faisant un clic sur Browse...
Pour crer un nouveau fichier avec notre template de page, on choisit le template MyFaceletsPage lors de la cration d'un nouveau fichier xhtml.
IV-D - Support de Facelets

JBoss tools propose nativement l'utilisation de Facelets, plusieurs outils sont la disposition du dveloppeur : 1 Capacits 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.
Assistant de cration d'un projet web. L'assistant de cration de projet dispose nativement d'un template pour un projet Facelets avec l'implmentation JSF.
Assistant de cration d'une page xhtml : l'assistant de cration d'une page xhtml dispose nativement d'un template de page Facelets.
Outils de la Palette : la palette JBoss Tools dispose de tous les composants Facelets.
Assistant de code : l'assistant de code propose aussi de l'aide pour l'utilisation de l'attribut jsfc ainsi que les tags de Facelets, l'assistant 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.
Editeur visuel : l'editeur visuel prend en charge les Facelets et affiche la page en tenant compte des templates utiliss.
V - Remerciements
Mes remerciements les plus sincres pour : djo.mos pour ses encouragements et sa relecture. romaintaz pour sa relecture. RomainVALERI pour sa relecture.

Jbosstools

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Jbosstools

Uploaded by

Copyright:

Available Formats

Guide pas pas de l'utilisation de JBoss tools pour le dveloppement JSF

par Lotfi Mellouk

I - Introduction I-A - Prsentation de JBoss Tools

I-A-1 - Installation de JBoss tools I-A-1-a - Compatibilits systme

II-B - La palette JBoss tools

II-C - Editeur Graphique

II-D - Vue du fichier de configuration de JSF

Diagram Visialise le workflow de navigation

Source Le code source du faces-config.

II-E - Assistant du contenu du code source

II-F - Vrificateur et reporteur d'erreur

II-G - Autres diteurs

II-H - Prsentation des nouveauts de la version 3.0 de JBoss tools

Affichage des tags non visuels :

III-B - Premire page JSF

III-C - Ajouter un managedBean

III-D - Ajouter une rgle de navigation

Clic droit dans l'diteur, New View.

On ajoute une page JSFBasedPage login.jsp.

Il est possible de modifier le cas de navigation en double cliquant sur la connection.

Ajouter une action dans la page login.jsp.

III-E - Importer un projet existant

III-F - Utilisation avec un projet dj prsent dans le workspace

III-G - Crer un Converter

On Cre la classe qui implmente l'interface javax.faces.convert.Converter.

III-H - Crer un Validator

Ajouter les prfrences.

IV-B - Ajouter une librairie de tags

IV-C - Crer son propre template de page

Dfinir le nom du template.

Slctionner le fichier JSP : slectionner le fichier en faisant un clic sur Browse...

IV-D - Support de Facelets

Ensuite on choisit Facelets.

You might also like