Programmation Web Avancée avec Hibernate

(1)

Hibernate

Thierry Hamon

Bureau H202 - Institut Galilée Tél. : 33 1.48.38.35.53 Bureau 150 – LIM&BIO – EA 3969 Université Paris 13 - UFR Léonard de Vinci 74, rue Marcel Cachin, F-93017 Bobigny cedex Tél. : 33 1.48.38.73.07, Fax. : 33 1.48.38.73.55

thierry.hamon@univ-paris13.fr

(2)

Introduction

Hibernate :

Framework Java

Gestion de persistance des objets dans les BD relationnelles

Solution pour faire le lien entre la programmation objet et les

SGBD :

les acc`

es `

a la base de donn´

ees sont g´

er´

es par des objets et des

m´

ethodes Java

les JavaBean masquent la structure et les sp´

ecificit´

es de la BD

Hibernate (3) : Repr´

esentation XML du r´

esultat de la requˆ

ete

Autre repr´

esentation des objets : Plain Old Java Object (POJO)

(3)

Architecture

El´

ements n´

ecessaires :

Classe de persistance : une classe de JavaBean pour

l’encapsulation des donn´

ees d’une table

Correspondance entre la classe et la table : fichier de mapping

Propri´

et´

es de configuration : Informations permettant la

connexion `

a la BD

(4)

Architecture

Fichiers de mapping

Propriétés de configuration

Hibernate

Application

Classes de persistance

Bases de données

(5)

Persistance

Non-persistance : Perte des objets manipul´

es par une

application lors la fin d’une session

Persistance : Sauvegarde des objets manipul´

es par une

application pour pouvoir les recr´

eer lors d’une autre session

Moyen : utilisation d’une BD

Rendre une application persistante :

insertion et mise `

a jour de donn´

ees dans une BD

`

a partir de donn´

ees XML de mani`

ere similaire `

a la

manipulation d’objets Java

(6)

Gestion de la persistance

Plusieurs aspects :

Connexion `

a la BD

Cr´

eation de tous les objets ou uniquement de ceux n´

ecessaires

Transformation (mapping ) de la structure de la BD pour

l’adapter aux objets

Chargement en m´

emoire des donn´

ees en une seule fois ou au

fur et `

a mesure

Hibernate : Framework en charge de la persistance des donn´

ees

dans une application Web

(7)

Mise en œuvre simple

Exemple tir´

e du tutoriel http://docs.jboss.org/

hibernate/orm/3.5/reference/en/html/tutorial.html

(VF : http://www.dil.univ-mrs.fr/~massat/docs/

hibernate-3.1/reference/fr/html/tutorial.html)

Persistance grˆ

ace `

a la BD interne d’Hibernate

D´

efinition

Configuration (propri´

et´

es et mapping)

Classe de persistance

(8)

Configuration

Fichier de mapping (nom du fichier : nom de la classe,

extension .hbm.xml)

(9)

Fichier de mapping

Chargement et stockage des donn´

ees persistantes

Indication des tables et de la BD `

a utiliser

D´

efinition de la structure des tables

D´

efinition des cl´

es primaires

Correspondance entre les noms et les types des objets et les

noms des colonnes

(10)

Exemple de fichier de mapping

fichier Event.hbm.xml

<? xml v e r s i o n=” 1 . 0 ” ?>

<!DOCTYPE h i b e r n a t e −mapping PUBLIC

”−// H i b e r n a t e / H i b e r n a t e Mapping DTD 3 . 0 / / EN”

” h t t p : // h i b e r n a t e . s o u r c e f o r g e . n e t / h i b e r n a t e −mapping − 3 . 0 . d t d ”> <h i b e r n a t e −mapping>

<many−to−many c o l u m n=”PERSON ID” c l a s s =” e v e n t s . P e r s o n ” /> </ s e t>

</ c l a s s> </ h i b e r n a t e −mapping>

(11)

Explications

Balise hibernate-mapping : d´

efinition des mappings

Balise class : d´

efinition de la classe et de la table concern´

ees

par le mapping

classe : events.Event

table : EVENTS

(12)

Explications

Balise id : d´

eclaration de la propri´

et´

e de l’identifiant

name="id" : identifiant Java conduisant Hibernate `

a utiliser

les getter/setter standard (getId/setId )

generator : strat´

egie de g´

en´

eration de l’identifiant

native : choix entre les valeurs identity (colonne du

SGBD), sequence (s´

equence fournie par le SGBD) ou hilo

(g´

en´

eration sp´

ecifique `

a Hibernate)

increment : identifiants entiers (`

a utiliser lorsque qu’aucun

autre processus acc`

ede `

a la table

Possibilit´

e d’´

ecrire sa propre strat´

egie de g´

en´

eration

d’identifiant

(13)

Explications

Propri´

et´

e title :

le nom de la propri´

et´

e est le nom de la colonne

d´

etermination du type de mapping et de la conversion par

Hibernate

Propri´

et´

e date :

attribut column : correspondance avec la colonne EVENT DATE

(date pouvant ˆ

etre r´

eserv´

e)

attribut type : sp´

ecification du type de mapping et de la

conversion

Balise set : d´

efinition d’une association (table PERSON EVENT)

NB : le mapping pour la table PERSON est `

a ´

ecrire

(14)

Configuration de Hibernate

Fichier hibernate.properties ou hibernate.cfg.xml

(prioritaire)

Balise hibernate-configuration : configuration de

hibernate pour l’application courante

Balise session-factory : Fabrique de session

D´

efinition des param`

etres de connexion

Pilote du SGBD (propri´

et´

e connection.driver class)

Autres valeurs possibles :

com.mysql.jdbc.Driver (MySQL)

org.postgresql.Driver (Postgresql)

oracle.jdbc.driver.OracleDriver (Oracle)

(15)

Configuration de Hibernate

D´

efinition des param`

etres de connexion (suite)

URL du serveur (propri´

et´

e connection.url)

Autres valeurs possibles :

jdbc:mysql://localhost/hibernateAppli (MySQL)

jdbc:postgresql://localhost/hibernateAppli

(Psotgresql)

jdbc:oracle:thin:@localhost:1521:oracle (Oracle - `

a

v´

erifier)

Nom d’utilisateur et mot de passe (propr´

et´

es

connection.username et connection.password)

Nombre de connexion simultan´

ee (propri´

et´

e

(16)

Configuration de Hibernate

D´

efinition des param`

etres de connexion (suite)

Dialecte SQL `

a utiliser (propri´

et´

e dialect)

Autres valeurs :

org.hibernate.dialect.MySQLDialect (MySQL)

org.hibernate.dialect.PostgreSQLDialect (Postgresql)

org.hibernate.dialect.OracleDialect,

org.hibernate.dialect.Oracle10gDialect (Oracle)

Fichiers de mapping : balise mapping

Propri´

et´

e hbm2ddl.auto

comportement au d´

emarrage du serveur de BD Hibernate

(validation, mise `

a jour de la BD existante, suppression et

cr´

eation de la BD)

valeurs possibles : validate, update, create, create-drop)

cette propri´

et´

e est `

a supprimer pour garder les informations

entre deux arrˆ

et du serveur BD Hibernate

(17)

Exemple de fichier de configuration Hibernate

hibernate.cfg.xml

<? xml v e r s i o n= ’ 1 . 0 ’ e n c o d i n g= ’ u t f −8 ’ ?> <!DOCTYPE h i b e r n a t e −c o n f i g u r a t i o n PUBLIC ”−// H i b e r n a t e / H i b e r n a t e C o n f i g u r a t i o n DTD 3 . 0 / / EN” ” h t t p : // h i b e r n a t e . s o u r c e f o r g e . n e t / h i b e r n a t e −c o n f i g u r a t i o n − 3 . 0 . d t d ”> <h i b e r n a t e −c o n f i g u r a t i o n> <s e s s i o n −f a c t o r y> <!−− D a t a b a s e c o n n e c t i o n s e t t i n g s −−>

o r g . h s q l d b . j d b c D r i v e r j d b c : h s q l d b : h s q l : // l o c a l h o s t s a

<!−− JDBC c o n n e c t i o n p o o l ( u s e t h e b u i l t −i n ) −−> 1 <!−− SQL d i a l e c t −−>

o r g . h i b e r n a t e . d i a l e c t . H S Q L D i a l e c t <!−− E n a b l e H i b e r n a t e ’ s a u t o m a t i c s e s s i o n c o n t e x t management −−> t h r e a d <!−− D i s a b l e t h e s e c o n d−l e v e l c a c h e −−>

(18)

Exemple de fichier de configuration Hibernate

hibernate.cfg.xml

<!−− Echo a l l e x e c u t e d SQL t o s t d o u t −−> t r u e

<!−− Drop and r e−c r e a t e t h e d a t a b a s e schema on s t a r t u p −−> c r e a t e

(19)

Classe de persistance

Classe JavaBean

Utilisation de convention de nommage JavaBean pour les

m´

ethodes getter et setter

Visibilit´

e des champs : priv´

ee

Visibilit´

e de la classe : public recommand´

ee

Contraintes :

Propri´

et´

e obligatoire : id

(20)

Exemple de classe de persistance

p a c k a g e e v e n t s ; i m p o r t j a v a . u t i l . ∗ ; p u b l i c c l a s s E v e n t { p r i v a t e Long i d ; p r i v a t e S t r i n g t i t l e ; p r i v a t e Date d a t e ; p u b l i c E v e n t ( ) {} p u b l i c Long g e t I d ( ) { r e t u r n i d ; } p r i v a t e v o i d s e t I d ( Long i d ) { t h i s . i d = i d ; } p u b l i c Date g e t D a t e ( ) { r e t u r n d a t e ; } p u b l i c v o i d s e t D a t e ( Date d a t e ) { t h i s . d a t e = d a t e ; }

(21)

Exemple de classe de persistance

p u b l i c S t r i n g g e t T i t l e ( ) { r e t u r n t i t l e ; } p u b l i c v o i d s e t T i t l e ( S t r i n g t i t l e ) { t h i s . t i t l e = t i t l e ; } p r i v a t e S e t p a r t i c i p a n t s = new H a s h S e t ( ) ; p u b l i c S e t g e t P a r t i c i p a n t s ( ) { r e t u r n p a r t i c i p a n t s ; } p u b l i c v o i d s e t P a r t i c i p a n t s ( S e t p a r t i c i p a n t s ) { t h i s . p a r t i c i p a n t s = p a r t i c i p a n t s ; } }

(22)

Gestion de la session

Fichier HibernateUtil.java

D´

emarrage de Hibernate

Cr´

eation de la fabrique de session SessionFactory

puis cr´

eation de la session (un thread )

(23)

Fichier HibernateUtil.java

p a c k a g e u t i l ; i m p o r t o r g . h i b e r n a t e . ∗ ; i m p o r t o r g . h i b e r n a t e . c f g . ∗ ; p u b l i c c l a s s H i b e r n a t e U t i l { p r i v a t e s t a t i c f i n a l S e s s i o n F a c t o r y s e s s i o n F a c t o r y ; s t a t i c { t r y { // C r e a t e t h e S e s s i o n F a c t o r y f r o m h i b e r n a t e . c f g . xml s e s s i o n F a c t o r y = new C o n f i g u r a t i o n ( ) . c o n f i g u r e ( ) . b u i l d S e s s i o n F a c t o r y ( ) ; } c a t c h ( T h r o w a b l e e x ) { // Make s u r e you l o g t h e e x c e p t i o n , a s i t m i g h t be s w a l l o w e d S y s t e m . e r r . p r i n t l n ( ” I n i t i a l S e s s i o n F a c t o r y c r e a t i o n f a i l e d . ” + e x ) ; t h r o w new E x c e p t i o n I n I n i t i a l i z e r E r r o r ( e x ) ; } } p u b l i c s t a t i c S e s s i o n F a c t o r y g e t S e s s i o n F a c t o r y ( ) { r e t u r n s e s s i o n F a c t o r y ; } }

(24)

Mise en œuvre et d´

eploiement

Ecriture d’une servlet

Utilisation de Ant pour g´

en´

erer l’archive war

Tests suppl´

ementaires

(25)

Exemple de servlet

El´

ements :

Initiation de la session et cr´

eation de la transaction dans la

m´

ethode doGet

R´

ecup´

eration de la fabrique de session getSessionFactory()

R´

ecup´

eration de la session courante dans la fabrique

getCurrentSession()

D´

emarrage de la transaction beginTransaction()

M´

ethodes d’acc`

es (ajout d’un enregistrement, r´

ecup´

eration

des enregistrements)

Sauvegarde d’un enregistrement : m´

ethode save(objet)

Etape pr´

eliminaire : cr´

eation de l’objet correspondant `

a

l’enregistrement

(26)

Exemple de Servlet

Initialisation de la transaction

p a c k a g e e v e n t s ; i m p o r t u t i l . H i b e r n a t e U t i l ; i m p o r t j a v a x . s e r v l e t . h t t p . ∗ ; i m p o r t j a v a x . s e r v l e t . S e r v l e t E x c e p t i o n ; i m p o r t j a v a . i o . ∗ ; i m p o r t j a v a . u t i l . ∗ ; i m p o r t j a v a . t e x t . S i m p l e D a t e F o r m a t ; p u b l i c c l a s s E v e n t M a n a g e r S e r v l e t e x t e n d s H t t p S e r v l e t { . . . p r o t e c t e d v o i d d o G e t ( H t t p S e r v l e t R e q u e s t r e q u e s t , H t t p S e r v l e t R e s p o n s e r e s p o n s e ) t h r o w s S e r v l e t E x c e p t i o n , I O E x c e p t i o n { t r y { // B e g i n u n i t o f work H i b e r n a t e U t i l . g e t S e s s i o n F a c t o r y ( ) . g e t C u r r e n t S e s s i o n ( ) . b e g i n T r a n s a c t i o n ( ) ; // W r i t e HTML h e a d e r P r i n t W r i t e r o u t = r e s p o n s e . g e t W r i t e r ( ) ;

o u t . p r i n t l n ( ”<html><head><t i t l e >E v e n t Manager</ t i t l e ></head><body>” ) ; . . . S t r i n g e v e n t T i t l e = r e q u e s t . g e t P a r a m e t e r ( ” e v e n t T i t l e ” ) ; S t r i n g e v e n t D a t e = r e q u e s t . g e t P a r a m e t e r ( ” e v e n t D a t e ” ) ; . . . c r e a t e A n d S t o r e E v e n t ( e v e n t T i t l e , d a t e F o r m a t t e r . p a r s e ( e v e n t D a t e ) ) ; . . .

(27)

Exemple de Servlet

Sauvegarde

p r o t e c t e d v o i d c r e a t e A n d S t o r e E v e n t ( S t r i n g t i t l e , Date t h e D a t e ) { E v e n t t h e E v e n t = new E v e n t ( ) ; t h e E v e n t . s e t T i t l e ( t i t l e ) ; t h e E v e n t . s e t D a t e ( t h e D a t e ) ; H i b e r n a t e U t i l . g e t S e s s i o n F a c t o r y ( ) . g e t C u r r e n t S e s s i o n ( ) . s a v e ( t h e E v e n t ) ; }

(28)

Exemple de Servlet

Interrogation

p r i v a t e v o i d l i s t E v e n t s ( P r i n t W r i t e r o u t ) { L i s t r e s u l t = H i b e r n a t e U t i l . g e t S e s s i o n F a c t o r y ( ) . g e t C u r r e n t S e s s i o n ( ) . c r e a t e C r i t e r i a ( E v e n t . c l a s s ) . l i s t ( ) ; i f ( r e s u l t . s i z e ( ) > 0 ) { . . . f o r ( I t e r a t o r i t = r e s u l t . i t e r a t o r ( ) ; i t . h a s N e x t ( ) ; ) { E v e n t e v e n t = ( E v e n t ) i t . n e x t ( ) ; . . . } . . . } }

(29)

Ant

Outil de construction de projet similaire `

a make mais en Java

G´

en´

eration de classes ou d’archives `

a partir d’un fichier de

construction build.xml

D´

efinition de cibles (balise target, attribut name) et de

d´

ependances (attribut depends)

R´

ealisation d’op´

eration sur une architecture d´

efinie dans le

fichier de construction

(30)

Fichier build.xml

< f i l e s e t d i r =”${ l i b r a r y d i r }”> </ f i l e s e t> <t a r g e t name=” c l e a n ”> <d e l e t e d i r =”${ t a r g e t d i r }” /> <m k d i r d i r =”${ t a r g e t d i r }” /> </ t a r g e t> <t a r g e t name=” c o m p i l e ” d e p e n d s=” c l e a n , copy−r e s o u r c e s ”> <j a v a c s r c d i r =”${ s o u r c e d i r }” d e s t d i r =”${ t a r g e t d i r }” c l a s s p a t h r e f =” l i b r a r i e s ” /> </ t a r g e t>

(31)

Fichier build.xml

(32)

Ant - Utilisation

commande : ant

sans cible : cible par d´

efaut

avec une cible :

ant war : g´

en´

eration de l’archive WAR (pour le d´

eploiement

sur tomcat – n´

ecessite un fichier web.xml)

ant run -Daction=list : ex´

ecution de la classe

(33)

Architecture de l’application Web

R´

epertoire racine : hibernateTutorial

Sous-r´

epertoires :

lib : contient les .jar n´

ecessaires `

a Hibernate

ls :

antlr.jar commons-collections3.jar hibernate3.jar

asm3-all.jar commons-collections.jar hibernate-commons-annotations.jar asm3.jar commons-logging.jar hibernate-core.jar

cglib.jar dom4j-1.6.1.jar hibernate-ehcache.jar hibernate-entitymanager.jar javassist.jar slf4j-api.jar hibernate-jdbc4-testing.jar jta.jar slf4j-log4j12.jar hibernate-jpa-2.0-api.jar log4j-1.2.jar

hsqldb.jar readme.txt

(34)

Architecture de l’application Web

src : sources de l’application

Fichier hibernate.cfg.xml

Fichier log4j.properties (gestion de logs)

R´

epertoire util : chemin vers le code Java

HibernateUtil.java

R´

epertoire events : chemin vers le code Java de l’application

et les fichiers de mapping

ls :

Event.hbm.xml Event.java EventManager.java EventManagerServlet.java Person.hbm.xml Person.java

(35)

Proc´

edure de test de l’exemple

on se situe dans le r´

epertoire hibernateTutorial

Compilation : ant

G´

en´

eration de l’archive : ant war

Lancement du serveur BD Hibernate :

java -classpath ../lib/hsqldb.jar

org.hsqldb.Server

NB : Utiliser le script runCleanDatabase.sh (pr´

esent dans

l’archive)

(36)

Proc´

edure de test de l’exemple

D´

eploiement sur le serveur Tomcat

URL d’acc`

es :

http ://marseille2 :8080/hibernate-tutorial/eventmanager

NB : modifier eventmanager en incluant votre nom (voir le

fichier web.xml

(un extrait des logs du serveur tomcat est pr´

esent dans le fichier

log.txt)