Primeros pasos con JBoss Seam


Primeros pasos con JBoss Seam


Índice de contenidos.

1. Introducción

Este tutorial pretende ser una guía introductoria al Framework JBoss Seam utilizando el seam-gen. El seam-gen es una utilidad que trae JBoss Seam para crear el código fuente de la aplicación con el único requisito de tener una base de datos del que sacar la lógica de negocio en base al modelo de datos especificado. El proceso de creación no puede ser más sencillo, nos irá preguntando el nombre del proyecto, ubicación del servidor de aplicaciones, la base de datos que queremos utilizar, nombres de paquetes, empaquetamiento del proyecto (ear/war), etc. Con esto generará la aplicación que nos servirá de base para continuar desarrollando la lógica de negocio y demás funcionalidades del proyecto. Iremos viendo los pasos necesarios para crear una aplicación web de una sencilla biblioteca.

2. Entorno

El tutorial está escrito usando el siguiente entorno:

  • Hardware: Portátil Acer Aspire 5920G (Core Duo T8300 2.4GHz, 3GB RAM, 320 GB HD).
  • Sistema operativo: Windows Vista
  • JBoss Seam 2.2.0.GA
  • JBoss AS 5.1.0.GA
  • JDK 1.6
  • Apache Ant 1.7.1

3. Configuración del proyecto (seam setup)

Lo primero será descargarnos el framework JBoss Seam. Para ello vamos a la web oficial y bajamos el zip. Pinchar aquí

La instalación es sencilla, basta con descomprimir el zip en un directorio, por ejemplo en D:\Desarrollo\jboss-seam-2.2.0.GA

También debemos tener instalado el servidor de aplicaciones JBoss AS. Para ello lo descargamos de la web desde aquí. La instalación al igual que de Seam es tan sencilla como descomprimir el zip, por ejemplo D:\Servidores\jboss-5.1.0.GA

Sólo nos queda ejecutar el script de creación de las propiedades del proyecto localizado en la raíz del proyecto, llamado setup. Para ello abrimos una consola y escribimos seam setup. En este punto es necesario que esté instalado Apache Ant. A continuación Seam nos irá preguntando por una serie de propiedades que se necesitan para crear la estructura del proyecto y que debemos ir configurando.

  • Ubicación del proyecto: D:\Proyectos\tutoriales\
  • Ubicación del servidor JBoss: D:\Servidores\jboss-5.1.0.GA
  • Dominio utilizado del servidor JBoss: default
  • Ubicación del servidor Glassfish: D:\Servidores\Sun\AppServer\AppServer
  • Dominio utilizado del servidor Glassfish: domain1
  • Nombre del proyecto: biblioteca
  • ¿Usar ICEFaces en lugar de RichFaces?: n
  • Skin utilizado: ruby
  • Empaquetamiendo del proyecto (ear/war): ear
  • Nombre del paquete baes: com.autentia.tutoriales
  • Nombre del paquete de los beans de sesión: com.autentia.tutoriales.action
  • Nombre del paquete de los beans de entidad: com.autentia.tutoriales.entity
  • Nombre del paquete de las clases de test: com.autentia.tutoriales.test
  • Base de datos utilizada: mysql
  • Directorio al driver de mysql: D:\Drivers\mysql-connector-java-5.1.8-bin.jar
  • Dialecto de Hibernate: org.hibernate.dialect.MySQLDialect
  • Clase del Driver JDBC para MySQL: com.mysql.jdbc.Driver
  • Clase del Datasource JDBC para MySQL: com.mysql.jdbc.jdbc2.optional.MysqlDataSource
  • URL de conexión a la base de datos: jdbc:mysql://localhost:3306/biblioteca
  • Usuario de la base de datos: biblioteca
  • Password de la base de datos: *****
  • Nombre de la base de datos:
  • ¿Usar todas las tablas que están en la base de datos?: y
  • ¿Borrar la base de datos en cada despliegue?: n

Si todo ha ido bien saldrá la siguiente traza:

También se habrá generado un build.properties en D:\Desarrollo\jboss-seam-2.2.0.GA\seam-gen para que con una tarea de Ant se genere todo el proyecto

Antes de ejecutar el script de creación del proyecto necesitamos tener una base de datos de donde Seam pueda sacar la estructura necesaria. La base de datos de la biblioteca que vamos a crear es muy sencilla, tendrá tres tablas (libro, autor y reserva). El script de creación de la base de datos y las tablas es el siguiente:

4. Generando la estructura del proyecto (seam new-project)

Ya estamos en disposición de crear nuestro proyecto de biblioteca. Para ello desde la consola invocamos la tarea de ant seam new-project que crea el proyecto en base a las propiedades configuradas anteriormente.

Los fuentes generados estarán en el directorio que le indicamos en el paso anterior, D:\Proyectos\tutoriales\biblioteca

Como se puede ver nos ha creado los ficheros de configuración de Eclipse (.classpath y .project) y también de Netbeans (carpeta nbproject) para que podamos abrir el proyecto en nuestro IDE favorito.

Si navegamos por la estructura de directorios que nos ha creado vemos algunas clases interesantes, por ejemplo las clases Authenticator y AuthenticatorBean dentro del directorio src\main\com\autentia\tutoriales\entity para securizar nuestra biblioteca y que únicamente puedan acceder usuarios autorizados. Por defecto añade el siguiente código:

5. Generando la funcionalidad del proyecto

Ahora vamos a crear las entidades de nuestro modelo y la lógica de negocio para las operaciones CRUD (alta, baja, modificación y listado) de las entidades a partir de las tablas de la base de datos. Para ello ejecutamos la tarea de ant seam generate-entities

Esta tarea genera el código de las entidades Libro, Usuario y Reserva y los componentes Seam que se encargarán de la lógica de negocio.

Por otro lado crea toda la parte web, pantalla de login, página de inicio de la aplicación, menú de navegación, páginas de creación y listado de cada entidad, reglas de navegación, configuración de componentes, seguridad, etc.

6. Despliegue del proyecto

Con lo que ya tenemos podemos desplegar la aplicación en un servidor de aplicaciones (recordar que dijimos en la configuración del proyecto que queríamos empaquetar la aplicación como un ear). En nuestro caso utilizaremos JBoss ya que los fuentes generados están preparados para este servidor aunque si queremos desplegar en Glassfish no habría problema, se incluye un script de Ant (glassfish-build.xml), que lo permite.

Gracias al build.xml que se encuentra en el raíz del proyecto, el despliegue se reduce a ejecutar la tarea deploy. Podemos ejecutarla a través de Netbeans (o Eclipse) o bien desde la consola ejecutanto ant deploy

La tarea deploy se encarga de compilar el proyecto, empaquetarlo como un ear y echarlo al directorio deploy del servidor JBoss. También copiará el datasource necesario para la conexión a la base de datos.

7. Probando la aplicación

Antes de arrancar el servidor será necesario copiar el driver MySQL al directorio server/default/lib de JBoss. Para arrancar ejecutamos el script D:\Servidores\jboss-5.1.0.GA\bin\run.bat y entramos en la aplicación mediante http://localhost:8080/biblioteca

Nos logamos en la aplicación pinchando en la opción ‘Login’ situada en la parte superior derecha. Por defecto Seam configura la seguridad de manera que permite ver los listados sin necesidad de estar logado pero sí que lo requiere para dar de alta, modificar o borrar una entidad. Esta lógicamente podremos configurarlo en función de nuestras necesidades. Observad también que los textos no están están en inglés. Para ponerlos en español basta con crear un messages_es.properties y añadir un nuevo soporte para el idioma español en el faces-config.xml




Ya sólo nos queda probar la aplicación que nos ha generado Seam. Para ello accedemos a las opciones ‘Libro List’ y ‘Socio List’ para dar de alta unos cuantos datos con los que probar.

Alta de un libro


Listado de libros


Listado de socios


Realizada un reserva, pestaña libro


Realizada un reserva, pestaña socio



La funcionalidad que se ha generado automáticamente contiene todo lo necesario para realizar login/logout de usuarios, crear, editar, borrar, listar, ordenar los campos del listado, paginación de los resultados, búscador avanzado de cada entidad por cualquiera de sus atributos, etc. Como véis sin escribir ni una sóla línea de código. Únicamente tendríamos que internacionalizar los textos y cambiar los patrones de formateo de fechas ya que están en formato MM/dd/yyyy y tendríamos una aplicación completa eso sí, al gusto de Seam.

Esto puede que no nos cuadre con nuestros requisitos aunque sí que nos sirve para ver cómo montan la arquitectura del proyecto que se centraliza en los componentes anotados con @Name. Por ejemplo para el caso de la entidad Libro, nos ha creado los componentes LibroHome y LibroList. El primero se encarga de la creación de nuevas instancias de tipo Libro extendiendo la clase EntityHome que proprociona la funcionalidad para realizar todas las operaciones necesarias para los CRUD. El segundo componente se encarga de añadir los parámetros de búsqueda de la entidad para listar los libros extendiendo de EntityQuery que ya se encarga de lanzar las queries.

Componente LibroHome

Componente LibroList

Si queremos generar la interfaz con ICEFaces en lugar de Richfaces únicamente tendríamos que cambiar el parámetro ‘icefaces=y’ dentro del build.properties generado dentro de D:\Desarrollo\jboss-seam-2.2.0.GA\seam-gen\build.properties.

8. Conclusiones.

Como aspecto más importante a destacar de la utilidad seam-gen de JBoss Seam es su facilidad de uso y la flexibilidad que te da, ya que permite configurar el proyecto a nuestro gusto. También es verdad que no aporta todo lo que necesitamos pero es útil para empezar con un proyecto con JBoss Seam desde cero.

Como aspecto negativo está que no nos crea el proyecto para maven, espero que esto lo mejoren en futuras versiones.

Un saludo.

Juan