TOPCASED UML Génération de la couche d accès aux données via Acceleo. Atos Origin Communauté D2I. Version : 1.0.Révision (1) Date : 30/10/2007

Transcription

1 TOPCASED UML Génération de la couche d accès aux données via Acceleo Atos Origin Communauté D2I Version : 1.0.Révision (1) Date : 30/10/2007 Atos Origin Intégration Les Miroirs C Tél. : +33 (0) Siège social : S.A.S. au capital de euros 18, avenue d Alsace Fax : +33 (0) Les Miroirs C, 18 avenue d Alsace Siren : RCS Nanterre Paris La Défense Cedex France Courbevoie France TVA intracommunautaire : FR

2 TOPCASED UML Génération couche accès aux données Via un module Acceleo IDENTIFICATION DU PROJET Programme TOPCASED UML Client Préparé par : Vérifié par: Nom, Fonction Date Raphaël Faudou 3010/2007 raphael.faudou@atosorigin.com Responsable innovation Midi Pyrénnées Approuvé par : RESUME: MOTS CLE: Nombre de pages Système hôte 21 PC Référence Logiciels Word 2000 Ref : Erreur! Nom de propriété de Ce document est la propriété de Atos Origin. Il ne peut être document inconnu. Version : 1.0.Révision- 2 Date : utilisé, reproduit ou divulgué sans son autorisation écrite préalable. 2

3 TOPCASED UML Génération de la couche d accès aux données via Acceleo HISTORIQUE DES MODIFICATIONS N Date Paragraphes Modifications Version.Révision modifiés /10/2007 Tous Version initiale 1.1 7/11/2007 : Ajout pré-requis version packagée d installation TOPCASED Ref : Ce document est la propriété de Atos Origin. Il ne peut être Version : Revision 1 Date : 30/10/2007 utilisé, reproduit ou divulgué sans son autorisation écrite préalable. 3

4 TOPCASED UML Génération de la couche d accès aux données via Acceleo Sommaire 1 Introduction Objectif du document Périmètre du document Présentation des étapes de génération Acceleo Modélisation UML Installation du module Acceleo JEE hibernate/struts Pré-requis sur la version packagéetopcased Installation du module Vérification que l installation du module est effective Décoration du modèle Récupération des profils de persistance Acceleo Chargement du profil de persistance Application du profil au modèle Génération de code Acceleo Conclusion...21 Ref : Ce document est la propriété de Atos Origin. Il ne peut être Version : Revision 1 Date : 30/10/2007 utilisé, reproduit ou divulgué sans son autorisation écrite préalable. 3

5 TOPCASED UML Génération de la couche d accès aux données via Acceleo Table des illustrations Figure 1 : exemple de modélisation de domaine...7 Figure 2 : import des types primitifs dans le modèle...8 Figure 3 : ajout du type primitif "String"...8 Figure 4 : modèle avec attributs typés...9 Figure 5 : chargement d'un profil...16 Figure 6 : ajout du stéréotype "entity" à une classe du modèle...19 Figure 7: résultat de la génération Acceleo sur le modèle décoré...20 Ref : Ce document est la propriété de Atos Origin. Il ne peut être Version : Revision 1 Date : 30/10/2007 utilisé, reproduit ou divulgué sans son autorisation écrite préalable. 3

6 1Introduction 1.1Objectif du document Ce document a pour objectif principal d expliquer comment générer les scripts de création de BD et la couche d accès aux données en java via une modélisation TOPCASED UML et le générateur de code Acceleo. 1.2Périmètre du document Ce document ne présente pas Acceleo en détail. Cet outil de génération est un framework open source de très bonne qualité initié par la société OBEO, partenaire du projet TOPCASED. Acceleo est utilisé dans plusieurs composants de génération de code de TOPCASED. Pour en savoir plus : Ce document explique comment décorer un modèle UML TOPCASED à l aide de stéréotypes (via des profils) fournis par Acceleo puis comment Acceleo pour générer du code à partir de ce modèle décoré. Page 6 10/01/2008

7 2Présentation des étapes de génération Acceleo Il y a principalement 3 étapes : 1. modélisation UML 2. installation du module Acceleo de génération de la couche d accès aux données 3. décoration «technique» d une partie du modèle en vue de génération Acceleo 4. génération via invocation Acceleo 2.1Modélisation UML Cette étape peut être réalisée avec n importe quel outil de modélisation UML2 capable d exporter au format Eclipse UML, à savoir «.uml». C est le cas notamment de TOPCASED UML.. Exemple : Figure 1 : exemple de modélisation de domaine En fait, la génération ne fonctionnera pas tant qu il n y aura pas au moins des types pour les attributs et des rôles publics sur chaque extrémité d une association. Concernant les associations, les rôles existent par défaut (certains sont masqués sur le diagramme ci-dessus pour simplifier la lecture). Par contre, il n y a pas de type par défaut. Il faut donc importer les types primitifs dans le modèle. Cela se fait au travers de la vue «outline» avec le menu contextuel : Page 7 10/01/2008

8 Figure 2 : import des types primitifs dans le modèle Pour notre exemple, nous avons seulement besoin de «String» (mais d autres types peuvent être ajoutés de la même manière) : Figure 3 : ajout du type primitif "String" Nous avons maintenant un modèle complètement défini. Page 8 10/01/2008

9 Figure 4 : modèle avec attributs typés 2.2Installation du module Acceleo JEE hibernate/struts 2.2.1Pré-requis sur la version packagéetopcased Cette installation a été testée avec succès sur la version TOPCASED 1.1 RCP téléchargeable directement sous l URL livelink suivante : func=ll&objid= &objaction=browse&sort=name&viewtype=1 A ce jour, l installation du module JEE Acceleo au dessus du pack Eclipse D2I 1.3 ne fonctionne pas Installation du module Ce module Acceleo permet de générer la couche d accès aux données : c est le module «JEE hibernate/struts». L installation d un module Acceleo est décrite ici (site d Acceleo) : Remarque : attention, l installation du module telle que décrite sur le site est correcte mais ne fonctionnera pas en raison d un conflit avec un autre plug-in TOPCASED. : Page 9 10/01/2008

10 Quand vous êtes arrivés à cette étape, il faut fermer la fenêtre courante et relancer l assistant en sélectionnant cette fois aussi «Europa Discovery Site», site contenant les plug-ins manquants. Page 10 10/01/2008

11 Suivez l assistant en sélectionnant un miroir de votre choix pour le téléchargement. Ensuite, il faut demander le téléchargement du projet WST comme indiqué ci-dessous et le conflit disparaît : Page 11 10/01/2008

12 Suivez l assistant jusqu à la fin : le module JEE Hibernate/Struts d Acceleo est installé. A la fin, l assistant vous demande si vous souhaitez redémarrer l espace de travail pour prendre en compte les nouveaux plugins : dites oui. TOPCASED se relance 2.2.3Vérification que l installation du module est effective Placez vous dans le projet TOPCASED contenant le modèle à décorer, dans le répertoire «models». Demander l assistant de création d un nouveau lanceur de module Acceleo : choisissez «Hibernate» Page 12 10/01/2008

13 Donnez un nom à la chaîne Acceleo (Hibernate.chain) puis sélectionnez le modèle d entrée : Page 13 10/01/2008

14 L assistant se finit en créant la chaîne de génération Hibernate pour votre modèle UML. Vous pouvez lancer la génération mais sachant que le modèle n a pas été décoré : la génération sera donc très limitée, seulement l infrastructure sera générée Page 14 10/01/2008

15 2.3Décoration du modèle La décoration du modèle consiste à rajouter des informations sur certains éléments du modèle en vue de générer du code à partir des informations du modèle ainsi complété. Cette décoration se fait en appliquant un profil UML au modèle courant et en utilisant certains stéréotypes de ce profil sur des éléments du modèle Récupération des profils de persistance Acceleo Ces profils sont contenus dans le plug-in suivant : «org.acceleo.module.pim.uml21.gen.java.common_ jar» installé dans le répertoire «plugins» de TOPCASED et ne sont pas accessibles directement. Il faut donc décompresser ce plug-in afin de pouvoir les référencer. Ils se trouvent dans le sous-répertoire «models» du plug-in. Page 15 10/01/2008

16 2.3.2Chargement du profil de persistance Le chargement se fait depuis la vue outline du modèle TOPCASED et via le menu contextuel «load Resource». Figure 5 : chargement d'un profil Page 16 10/01/2008

17 Il faut ensuite choisir les fichiers suivants dans le répertoire suivant : plugins/org.acceleo.module.pim.uml21.gen.java.common_ \models : AcceleoJEE.business.profile.uml AcceleoJEE.main.profile.uml.uml Remarque : attention à bien prendre les fichiers d extention «.uml» et non pas «.umldi». Pour la génération de la couche DAO, ces profiles suffisent. Pour la génération d IHM vous pouvez sélectionner aussi Acceleo.ui.profile.uml. 2.4Application du profil au modèle Toujours via la vue outline, il est maintenant possible d appliquer le profil de persistance. Page 17 10/01/2008

18 Une fois les profils appliqués au modèle, il devient possible d ajouter les stéréotypes correspondants sur un élément du modèle. Avec ces profils, le stéréotype «entity» est maintenant disponible et applicable sur chaque entité de notre diagramme de classes. Page 18 10/01/2008

19 Figure 6 : ajout du stéréotype "entity" à une classe du modèle Il suffit de compléter cette étape pour toutes les entités du domaine pour lesquelles on souhaite générer de la persistance. Notre modèle est maintenant décoré et nous pouvons passer à la génération. Remarque : L approche étant itérative et centrée sur le modèle, il est toujours possible de compléter la décoration du modèle plus tard et relancer la génération(acceleo sait conserver des modifications effectuées dans le code) 2.5Génération de code Acceleo Il suffit maintenant de relancer la génération via le menu contextuel «launch» sur la chaîne de génération hibernate.chain créée précédemment. La génération crée : Les scripts de création des tables Les entités java, les opérations «create», «modifier», «update», «delete» d accès hibernate, les fichiers de mapping Hibernate des tests unitaires sur les classes java Page 19 10/01/2008

20 Figure 7: résultat de la génération Acceleo sur le modèle décoré Page 20 10/01/2008

21 3Conclusion La génération Acceleo via le module JEE Hibernate/Struts depuis un modèle TOPCASED UML est possible et c est une très bonne nouvelle car cela permet de laisser de côté MagicDraw ou d autres outils commerciaux. Il reste encore une ou deux manipulations un peu compliquées pour récupérer les profils (la première fois) mais cela permet d exploiter désormais un modèle du domaine de façon assez rapide ; et comme le générateur est open-source, il est possible d améliorer ou personnaliser la génération assez facilement Page 21 10/01/2008