Instalación y uso del framework Taylor para el modelaje de entidades JPA

Transcripción

1 Instalación y uso del framework Taylor para el modelaje de entidades JPA por: María Consuelo Franky Dpto. Ingeniería de Sistemas Pontificia Universidad Javeriana lfranky@javeriana.edu.co Junio de 2011 pg. 1

2 Tabla de Contenido 1 Propósito de este documento Lista de instalaciones que deben realizarse para trabajar con Taylor Instalar el framework Taylor Crear un proyecto de modelaje de entidades con el framework Taylor Crear un proyecto con un modelo Taylor Modelar entidades y sus relaciones... 5 pg. 2

3 1 Propósito de este documento En este documento se describe la instalación y uso del framework Taylor para el modelaje de entidades persistente JPA. El framework Taylor permite hacer modelos UML de entidades persistentes y generar las clases Java correspondientes (incluyendo anotaciones). Las clases Java de entidades podrán posteriormente agregarse a un proyecto Java EE 5. Sobre este proyecto podrá aplicarse el framework Seam para generar otros elementos de las distintas capas. NOTA: el framework Taylor también ofrece generadores de elementos de las distintas capas de una aplicación Java EE 5. Sin embargo, la estructuración de archivos fuentes es muy diferente a la que se obtiene utilizando Seam. Entre los 2 frameworks se prefiere Seam que es soportado por RedHat y una comunidad más amplia que la de Taylor. Es por eso que se recomienda utilizar el framework Taylor solo para el modelaje de entidades (este modelaje todavía no es ofrecido por el framework Seam). Taylor se instala como plugin de Eclipse IDE for Java EE Developers. Se describirá la instalacion para Eclipse IDE for Java EE Developers (Ganymede) por ser la misma versión que soporta los plugins de Seam para Java EE 5 (ver 1-guia-configuracionjavaee5.pdf). 2 Lista de instalaciones que deben realizarse para trabajar con Taylor NOTA IMPORTANTE: las siguientes herramientas libres están disponibles en el CD del curso: CD-curso-jee5, por lo cual no es necesario bajarlas. JDK 1.6: obtener jdk-6uxx-windows-i586.exe del sitio de Oracle (donde XX es la última versión encontrada): Para su instalación ejecutar (con doble-click) el instalador de JDK 1.6 en la versión que se disponga. Eclipse IDE for Java EE Developers : obtener eclipse-jee-ganymede-sr2-win32.zip del sitio: Para su instalación descomprimir el archivo en el directorio de instalación escogido, por ejemplo c:\eclipsejee (no debe haber espacios en la ruta de ese directorio) Framework Taylor: pg. 3

4 la versión Taylor MDA requiere: Maven (administrador de librerías): obtener apache-maven bin.zip en software Taylor MDA 1.2.0: obtenerlo en el sitio o taylor-mda-core zip : contiene los editores UML o taylor-mda-jee zip : contiene plantillas y generadores de código 3 Instalar el framework Taylor Para la instalación del framework Taylor deben seguirse las instrucciones del sitio Esta instalación se resume en los siguientes pasos: Previamente tener instalado Eclipse 3.4.x (siguiendo las secciones anteriores se supone que en este punto ya se tiene instalado) Instalación de Maven: descomprimir el archivo apache-maven bin.zip conformando el subdirectorio apache-maven y luego añadir las siguientes variables de ambiente: M2_HOME con el valor <ruta del directorio apache-maven-2.0.9> M2 con el valor %M2_HOME%\bin MAVEN_OPTS con el valor -Xms256m -Xmx512m actualizar variable PATH añadiendo al principio %M2%; verificar la instalación de Maven con el siguiente comando en DOS: $ mvn --version debe indicar la versión del JDK, de Maven y del sistema operacional Instalación de los plugins de Taylor MDA 1.2.0: cerrar Eclipse y descomprimir en el directorio de instalación de Eclipse los archivos taylor-mda-core zip y taylor-mda-jee zip Lanzar Eclipse y abrir la perspectiva Taylor: aparecerá en esta perspectiva la vista Model Navigator que posteriormente se utilizará para modelar entidades. pg. 4

5 4 Crear un proyecto de modelaje de entidades con el framework Taylor A continuación se resumen los pasos para empezar a modelar entidades con Taylor, tomando como referencia el tutorial de CREAR UN PROYECTO CON UN MODELO TAYLOR Crear un nuevo proyecto en Eclipse (de tipo General, no Java), llamado por ejemplo proyecto-taylor Bajo el nuevo proyecto crear un Folder llamado Model Abrir la perspectiva Taylor y el window Model Navigator Bajo el folder Model, crear un objeto Taylor UML Model dándole el mismo nombre que el proyecto (con sufijo.uml): este tipo de objeto es ofrecido por el plugin de Taylor; dejar las opciones de creación con los valores por defecto. Bajo el window Model Navigator ubicar el elemento <Model> y mediante el window Properties o darle el mismo nombre del proyecto o en la pestaña Documentation poner una descripción del modelo que se pretende hacer Salvar el modelo ubicando el elemento <Model> y mediante click-derecho invocar la opción save. De nuevo ubicar el elemento <Model> y con click-derecho crear un package, mediante el window Properties darle el nombre co.edu.javeriana.myproject.model suponiendo que co.edu.javeriana.myproject es el paquete raíz del proyecto que se va a generar con Seam (ver 4-guia.generadores.seam.pdf). Probar ahora el generador de entidades Java: en el elemento <Model> con clickderecho invocar la opción Generate >> By Project Suffrix >> jpa :como efecto se crea un nuevo proyecto Eclipse llamado proyecto-taylor-jpa que por ahora no contiene fuentes. 4.2 MODELAR ENTIDADES Y SUS RELACIONES Se recomienda tener previamente definido el modelo UML de las entidades, para pasarlo a Taylor y añadir estereotipos que generarán anotaciones. Taylor es frágil cuando se eliminan elementos del modelo: el diagrama de entidades puede quedar inconsistente en cuyo caso hay que eliminarlo y volver a empezar. A continuación se indica como modelar en Taylor varias entidades y sus relaciones; referencia: : pg. 5

6 Bajo el elemento package creado previamente con click-derecho invocar la opción New Class Diagram : darle como nombre el nombre del paquete seguido de.uml_diagram y guardarlo bajo el folder Model. Abrir el diagrama creado con doble-click: o mediante la paleta crear un Entity llamada Empresa con 2 propiedades (atributos): nombre y id o por defecto el tipo de cada atributo es String; ubicar el atributo id en el árbol del window Model Navigator, y mediante el window Properties cambiar su tipo a Long (puede requerir cerrar y volver a abrir el diagrama para ver el tipo actualizado); además utilizando la pestaña Stereotypes, aplicar al atributo id los estereotipos Id y GenerateValue que posteriormente generarán las anotaciones correspondientes o ubicar el atributo nombre en el árbol del window Model navigator, y mediante el window Properties aplicar el estereotipo Length que posteriormente generará la anotación de validación de longitud; mediante la sub-pestaña Stereotype Attributes establecer el mínimo, máximo y mensaje de validación. Salvar el modelo y volver a generar las entidades Java como se indicó en la sección anterior: observar la clase Empresa.java generada en el proyecto proyecto-taylorjpa : tiene las anotaciones correspondiente a la entidad y a cada uno de sus atributos. NOTA: el método tostring() generado en las entidades presenta problemas en ejecución y es recomendable cambiarlo por el tostring() tradicional que retorna como String la concatenación de atributos de estado. Añadir al diagrama una segunda entidad: Telefono; ubicar esta entidad en el árbol del window Model Navigator y con click-derecho invocar la opción Add Primary key que añade un atributo id de tipo Long y con los estereotipos Id y GenerateValue. Añadir a la entidad Telefono los atributos tipo y numero. Establecer en el diagramauna relación One To Many entre Empresa y Telefono y luego: o en Empresa renombrar el atributo de relación a telefonos (mediante el window Properties) y mediante Stereotypes Attributes establecer cascada de tipo ALL, evaluación perezosa (Fecth LAZY) y mappedby empresa o En Telefono (que queda con una relación Many To One hacia Empresa) renombrar el atributo de relación a empresa (mediante el window Properties) y mediante Stereotypes Attributes establecer evaluación temprana (Fecth EAGER) y optional = true Seguir modelando entidades con sus relaciones y generar las clases Java correspondientes. Tener cuidado de eliminar la cascada en las clases generadas que tengan un atributo de relación Many to One y además reemplazar el método tostring() como se indicó anteriormente. Cuando se termine el modelaje las clases generadas se pueden copiar al proyecto Seam, en donde se podrán generar los casos de uso CRUDs asociados a las entidades. pg. 6