Plugin Hibernate3 para Maven
En este tutorial vamos a ver las posibilidades que nos ofrece el plugin de Hibernate3 para Maven.
¿Qué nos aporta este plugin?
Este plugin principalmente nos aporta la siguiente funcionalidad a través de goals de maven:
- Generación del esquema de base de datos a partir de clases con anotaciones (también desde archivos *.hbm.xml).
- Generación de los archivos de mapeo (archivos *.hbm.xml) desde clases Java.
- Generación de clases Java a partir de sus archivos de mapeo (archivos *.hbm.xml).
- Generación de documentación en HTML del modelo de datos.
- Generación del archivo de configuración de hibernate (hibernate.cfg.xml).
El camino se hace al andar, un ejemplo:
A continuación vamos a probar el plugin, concremente veremos los tres primeros puntos (uno,dos,tres) basándonos en un ejemplo, modelaremos mediante clases Java anotadas los siguientes requisitos:
- Un libro tiene un título, un precio y un número de páginas, además un libro pertenece a una única editorial, puede estar escrito por varios autores y puede pertenecer a varias categorías.
- Un autor tiene un nombre y una dirección de correo, ambos son requeridos y además no puede haber dos autores con el mismo email.
- Una categoría tiene un nombre requerido y opcionalmente una descripción.
- Una editorial tiene un nombre y una url, ambos requeridos.
Trabajaremos con el gestor de datos Mysql 5, pero podremos migrarlo fácilmente a Oracle o cualquier otro, simplemente cambiando las propiedades de configuración.
Si quieres trastear, puedes descargarte el código fuente desde clic aquí
Modelo con clases Java anotadas:
Autores de libros:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
package com.autentia.tutoriales.bookstore.entities; import javax.persistence.*; /** * Autor de libros * @author Carlos García. Autentia. */ @Entity @Table(name="autores") public class Autor { @Id @GeneratedValue private int id; @Column(length=255, nullable=false) private String nombre; @Column(length=200, nullable=false, unique=true) private String email; public Autor() { super(); } public String getNombre() { return this.nombre; } public void setNombre(String nombre) { this.nombre = nombre; } public String getEmail() { return this.email; } public void setEmail(String email) { this.email = email; } } |
Categorías de libros:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
package com.autentia.tutoriales.bookstore.entities; import javax.persistence.*; /** * Categoría de libros. * @author Carlos García. Autentia. */ @Entity @Table(name="categorias") public class CategoriaLibro { @Id @GeneratedValue private int id; @Column(length=200, nullable=false) private String nombre; @Column(length=1024) private String descripcion; public CategoriaLibro() { super(); } public String getNombre() { return nombre; } public void setNombre(String nombre) { this.nombre = nombre; } public String getDescripcion() { return descripcion; } public void setDescripcion(String descripcion) { this.descripcion = descripcion; } } |
Editoriales de libros:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
package com.autentia.tutoriales.bookstore.entities; import javax.persistence.*; @Entity @Table(name="editoriales") public class Editorial { @Id @GeneratedValue private int id; @Column(length=200, nullable=false) private String nombre; @Column(length=200, nullable=false) private String url; public Editorial(){ super(); } public String getNombre() { return this.nombre; } public void setNombre(String nombre) { this.nombre = nombre; } public String getUrl() { return this.url; } public void setUrl(String url) { this.url = url; } } |
Libros:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
package com.autentia.tutoriales.bookstore.entities; import javax.persistence.*; /** * Representa un libro * @author Carlos García. Autentia. */ @Entity @Table(name="libros") public class Libro { @Id @GeneratedValue private int id; @Column(length=200, nullable=false) private String titulo; private double precio; private short paginas; @ManyToOne(optional=false) private Editorial editorial; @ManyToMany(fetch=FetchType.LAZY) private java.util.Set<CategoriaLibro> categorias; @ManyToMany(fetch=FetchType.LAZY) private java.util.Set<Autor> autores; public Libro(){ super(); } public String getTitulo() { return titulo; } public void setTitulo(String titulo) { this.titulo = titulo; } public double getPrecio() { return precio; } public void setPrecio(double precio) { this.precio = precio; } public short getPaginas() { return paginas; } public void setPaginas(short paginas) { this.paginas = paginas; } public Editorial getEditorial() { return editorial; } public void setEditorial(Editorial editorial) { this.editorial = editorial; } public java.util.Set<CategoriaLibro> getCategorias() { return categorias; } public void setCategorias(java.util.Set<CategoriaLibro> categorias) { this.categorias = categorias; } public java.util.Set<Autor> getAutores() { return autores; } public void setAutores(java.util.Set<Autor> autores) { this.autores = autores; } } |
Propiedades de conexión a la base de datos: /src/main/resources/db.properties:
Este archivo es usado por el plugin a través del archivo de configuración de hibernate (/src/main/resources/hibernate.cfg.xml) y
se relacionan en la configuración del plugin de hibernate 3 para maven a través de su archivo de configuración pom.xml.
|
1 2 3 4 5 |
hibernate.connection.username=invitado hibernate.connection.password=invitado hibernate.connection.url=jdbc:mysql://127.0.0.1/test hibernate.connection.driver_class=com.mysql.jdbc.Driver hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect |
Archivo de configuración de hibernate /src/main/resources/hibernate.cfg.xml:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> <hibernate-configuration> <session-factory> <property name="hibernate.connection.username">${hibernate.connection.username}</property> <property name="hibernate.connection.password">${hibernate.connection.password}</property> <property name="hibernate.connection.url">${hibernate.connection.url}</property> <property name="hibernate.connection.driver_class">${hibernate.connection.driver_class}</property> <property name="hibernate.dialect">${hibernate.dialect}</property> <!-- Clases anotadas --> <mapping class="com.autentia.tutoriales.bookstore.entities.Libro" /> <mapping class="com.autentia.tutoriales.bookstore.entities.Autor" /> <mapping class="com.autentia.tutoriales.bookstore.entities.CategoriaLibro" /> <mapping class="com.autentia.tutoriales.bookstore.entities.Editorial" /> </session-factory> </hibernate-configuration> |
Registramos en el archivo de configuración de Maven (pom.xml) el plugin de Hibernate 3:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.autentia.tutoriales</groupId> <artifactId>bookstore</artifactId> <packaging>jar</packaging> <version>1.0-SNAPSHOT</version> <name>book_store</name> <url>http://www.adictosaltrabajo.com</url> <build> <plugins> <!-- Usamos Java 6 --> <plugin> <artifactId>maven-compiler-plugin</artifactId> <configuration> <source>1.6</source> <target>1.6</target> <encoding>UTF-8</encoding> </configuration> </plugin> <!-- Plugin de Hibernate 3 para Maven: http://mojo.codehaus.org/maven-hibernate3/hibernate3-maven-plugin/ --> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>hibernate3-maven-plugin</artifactId> <version>2.2</version> <configuration> <!-- Puedes ver más propiedades aquí: http://mojo.codehaus.org/maven-hibernate3/hibernate3-maven-plugin/componentproperties.html --> <componentProperties> <!-- Indicamos que NO nos borre las tablas en caso de que existan --> <drop>false</drop> <!-- Propiedades de conexión a la bd para realizar las tareas OJO, los nombres de las propiedades deben ser los estandar --> <propertyfile>src/main/resources/db.properties</propertyfile> <!-- Indicamos que nos genere el script sql DDL (data definition lenguaje) --> <outputfilename>boolStore.sql</outputfilename> <!-- Indicamos que el script lo queremos con tabulaciones, saltos de linea... --> <format>true</format> </componentProperties> </configuration> <dependencies> <!-- Dependencia al driver jdbc de la bd a la que necesites trabajar --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.6</version> </dependency> </dependencies> </plugin> </plugins> </build> <dependencies> <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-annotations</artifactId> <version>3.3.1.GA</version> </dependency> </dependencies> </project> |
Generación del esquema de base de datos a partir de clases (con y sin anotaciones).
Ejecutamos el siguiente comando (compilamos antes por las anotaciones):
mvn compile hibernate3:hbm2ddl.
Resultados del comando:
Archivo generado: target\hibernate3\sql\bookStore.sql
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
create table autores ( id integer not null auto_increment, email varchar(200) not null unique, nombre varchar(255) not null, primary key (id) ) ENGINE=InnoDB; create table categorias ( id integer not null auto_increment, descripcion varchar(1024), nombre varchar(200) not null, primary key (id) ) ENGINE=InnoDB; create table editoriales ( id integer not null auto_increment, nombre varchar(200) not null, url varchar(200) not null, primary key (id) ) ENGINE=InnoDB; create table libros ( id integer not null auto_increment, paginas smallint not null, precio double precision not null, titulo varchar(200) not null, editorial_id integer not null, primary key (id) ) ENGINE=InnoDB; create table libros_autores ( libros_id integer not null, autores_id integer not null, primary key (libros_id, autores_id) ) ENGINE=InnoDB; create table libros_categorias ( libros_id integer not null, categorias_id integer not null, primary key (libros_id, categorias_id) ) ENGINE=InnoDB; alter table libros add index FKBE414D3151DCF8E7 (editorial_id), add constraint FKBE414D3151DCF8E7 foreign key (editorial_id) references editoriales (id); alter table libros_autores add index FK49C77B83877AEB39 (autores_id), add constraint FK49C77B83877AEB39 foreign key (autores_id) references autores (id); alter table libros_autores add index FK49C77B839C036D78 (libros_id), add constraint FK49C77B839C036D78 foreign key (libros_id) references libros (id); alter table libros_categorias add index FKF502D56E5B881BC (categorias_id), add constraint FKF502D56E5B881BC foreign key (categorias_id) references categorias (id); alter table libros_categorias add index FKF502D56E9C036D78 (libros_id), add constraint FKF502D56E9C036D78 foreign key (libros_id) references libros (id); |
Captura de MySql Query Browser
Generación de los archivos de mapeo (archivos *.hbm.xml) desde clases Java.
Ejecutamos el siguiente comando:
mvn hibernate3:hbm2hbmxml.
Resultados del comando:
Maven nos deja los archivos generados en el directorio target\hibernate3\generated-mappings
Generación de clases Java a partir de sus archivos de mapeo (archivos *.hbm.xml).
Ejecutamos el siguiente comando:
mvn hibernate3:hbm2java.
Resultados del comando:
Maven nos deja los archivos generados en el directorio target\hibernate3\generated-sources
Conclusiones
Sin lugar a dudas, Maven ha supuesto un antes y un después en la construcción de proyectos, en este caso, este plugin es una alternativa ideal a usar ant con hibernate tools.
En Autentia, estamos constantemente formándonos para conocer cuales son las herramientas que hay en el mercado y cuales se adaptan mejor en cada caso. Espero nos tengais en cuenta si necesitais algún tipo de consultaría o formación a medida.
Bueno, eso es todo, un saludo.
Carlos García. Creador de MobileTest.
Increible, siempre me ha costado muchísimo configurar el Hibernate Tools para Eclipse para poder conseguir lo que ahora me hace Maven… Hace poco que empiezo a utilizar Maven2 por mi cuenta (antes todo estaba ya hecho en los proyectos en lo que trabajo) y este tutorial me ha servido muchísimo para proyectos personales.
He hecho una adaptación mínima, para poder usar HSQLDB, y he de decir que los resultados son fantásticos.
Gracias por vuestra inestimable ayuda, como siempre!
Por cierto… para realizar ingeniería inversa necesitaréis añadir una dependencia al plugin, la CGLib:
cglib
cglib
2.2