Hibernate
Site de référence : www.hibernate.org
Hibernate est un produit Open source sous licence GNU LGPL, développé par une équipe issue de la communauté JBOSS, aujourd'hui filiale de la société Red Hat.
Principale fonctionnalité :
Le rôle principal d'Hibernate est de remplacer l'accès aux bases de données par l'appel de méthodes objet de haut niveau.
Hibernate 3, version avec laquelle nous allons travailler, est capable de gérer la persistance avec des bases de données relationnelles, mais aussi avec des bases de données objet et des fichiers XML.
Il existe également une version d'Hibernate pour .net : NHibernate.
Ressources
Fichiers
Documentation
Configuration logicielle
Vous disposez de :
Eclipse Juno J2EE
Hibernate 3
Mysql Server
Driver JDBC pour Mysql
Sous partie
Contexte
Nous allons travailler à partir d'un cas simple, et assez couramment utilisé :
Un SI composé de produits, classés en catégories (1 CIF).
Des commandes de produits effectuées, dont le détail est stocké dans des lignes (1 CIM).
Mise en place
Mise en place la configuration logicielle.
Dans Eclipse
Créer un nouveau Dynamic Web Project dans Eclipse
Intégrer les jars d'Hibernate 3 et le driver JDBC pour mysql dans le dossier WebContent/WEB-INF/lib
Copier le fichier xml de configuration d'Hibernate dans le dossier src du projet.
Dans phpMyAdmin
Afficher le concepteur pour visualiser les tables, et les relations :
Pour chaque table, notez les contraintes d'intégrité :
d'entité (clé primaire)
référentielle (relations)
Exemple :
Produit :
Hibernate
Ouvir le fichier de configuration d'Hibernate dans le dossier src :
Vérifiez les paramètres de connexion à Mysql.
Propriété | Valeur | Signification |
hbm2ddl.auto | validate | Permet de vérifier la correspondance entre le schéma de la base et les classes métiers |
show_sql | true | Permet d'afficher les instructions SQL exécutées dans la console Eclipse |
Les lignes suivantes vont permettre d'assurer la persistance des classes que nous allons créer : Categorie et Produit.
<mapping class="metier.Categorie" />
<mapping class="metier.Produit" />
- hibernate.cfg.xml
<?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="connection.url">jdbc:mysql://localhost/orm</property>
<property name="connection.username">root</property>
<property name="connection.driver_class">com.mysql.jdbc.Driver</property>
<property name="dialect">org.hibernate.dialect.MySQLDialect</property>
<property name="connection.password"></property>
<property name="connection.pool_size">10</property>
<property name="current_session_context_class">thread</property>
<property name="cache.provider_class">org.hibernate.cache.NoCacheProvider</property>
<property name="hbm2ddl.auto">validate</property>
<property name="show_sql">true</property>
<property name="format_sql">true</property>
<mapping class="metier.Categorie" />
<mapping class="metier.Produit" />
</session-factory>
</hibernate-configuration>
Création d'une classe de lancement de session Hibernate
Il est maintenant nécessaire de créer une classe Java permettant de piloter une session Hibernate.
Cette classe n'ayant besoin d'être instanciée qu'une seule fois pour ensuite nous permettre d'effectuer le mapping entre classes et base de données, nous utiliserons une classe statique, ou un singleton. (c'est une pratique recommandée par la communauté JBoss).
Créer la classe HibernateUtil dans le package hibernate
- |h HibernateUtil.java
package hibernate;
import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.AnnotationConfiguration;
public class HibernateUtil {
private static final SessionFactory sessionFactory = buildSessionFactory();
private static SessionFactory buildSessionFactory() {
try {
// Create the SessionFactory from hibernate.cfg.xml
return new AnnotationConfiguration().configure().buildSessionFactory();
}
catch (Throwable ex) {
// Make sure you log the exception, as it might be swallowed
System.err.println("Initial SessionFactory creation failed." + ex);
throw new ExceptionInInitializerError(ex);
}
}
public static SessionFactory getSessionFactory() {
return sessionFactory;
}
public static void shutdown() {
// Close caches and connection pools
getSessionFactory().close();
}
public Session getSession(){
return getSessionFactory().openSession();
}
}
Modèle relationnel et modèle objet
Modèle relationnel :
Modèle Objet (diagramme de classes) correspondant :
Nous allons modifier le modèle Objet pour le rendre compatible avec Hibernate et permettre le mapping, en ajoutant des membres qui serviront d'identifiants (habituellement inutiles dans le monde Objet) :
Création des classes métier
La Java persistence API (JPA) sera utilisée pour définir le mapping relationnel/objet. Elle va permettre de mettre des annotations sur les classes métier de façon à définir leur persistance.
Produits et catégories
Ci-dessous le début de l'implémentation des classes :
Les principes de construction des classes métiers à mapper avec hibernate sont les suivants :
A chaque champ de la base correspond un membre de données de la classe
les types de données java et sql doivent être compatibles (consulter la documentation hibernate pour voir la correspondance entre les types)
La classe doit être un java Bean pour permettre à Hibernate de travailler :
elle doit disposer d'un constructeur sans paramètre
Chacun de ses membres doit disposer d'accesseurs
Le mapping avec la base de données est défini au travers des annotations JPA posées sur les membres de la classe.
- Implémenter les classes Categorie et Produit dans le package metier
- Utiliser la complétion pour faire les imports
- Générer les accesseurs, le constructeur sans paramètre
- Ajouter un constructeur initialisant les membres de données
- Ajouter un toString affichant les champs proprement concaténés
A partir de l'observation de cette première implémentation et en utilisant à bon escient la documentation, répondez aux questions suivantes :
Comment est déclarée la table assurant la persistance d’un objet ?
Comment est déclaré le mapping entre un membre de la classe et un champ de la table relationnelle ?
Comment est déclarée la clé primaire de la table ?
Quelles sont les possibilités de déclaration des clés primaires ?
Réaliser un tableau montrant la correspondance de type (entier, chaine, etc.) entre les propriétés d’une classe et les champs d’une table.
Montrez à l’aide d’un schéma (par ex. deux classes liées au dessus de deux tables liées) comment se paramètre le lien bidirectionnel entre deux classes (en spécifiant les éléments à fournir dans les annotations)
Programme de test
- Implémenter le programme suivant dans un package nommé console, rendez le exécutable.
- Exécutez le code puis observez la base de données.
Analysez le code du programme et répondez aux questions en vous aidant au besoin de la documentation :
À quoi correspond la méthode persist() ?
À quoi correspond la méthode commit () ?
Comment ont été traduits les liens objet entre le membre categorie et produits entre ces classes dans les tables de la base ?
Quelles requêtes SQL ont été créées par Hibernate pour réaliser la persistance ?
Pourquoi comportent t-elles des points d'interrogation ?
Chargement d'un objet
Observation du chargement d'un objet, par l'intermédiaire de sa clé primaire.
Programme de chargement d'un produit
- Implémenter le programme suivant dans le package nommé console, rendez le exécutable.
- Exécutez le code et regardez le résultat.
- Mettez le point d'arrêt indiqué et inspectez l'objet aProduit, et son membre catégorie .
Programme de chargement d'une catégorie
- Implémenter le programme suivant dans le package nommé console, rendez le exécutable.
- Exécutez le code et regardez le résultat.
- Mettez le point d'arrêt indiqué et inspectez l'objet aCategorie, et son membre produits.
- Exécutez en pas à pas (step over) et inspectez toujours l'objet aCategorie, et son membre produits.
A partir de ses 2 programmes et de leur exécution :
Précisez ce que charge exactement Hibernate lors du chargement d'un Objet
Précisez comment sont chargés les instances liées à un objet chargé pour les liens onToMany et manyToOne
En quoi consiste le chargement paresseux d'Hibernate et la qualification lazy (rechercher dans l'aide)
Chargement de listes d'objets
Interrogation de données avec Hibernate :
Projection
Créer le programme suivant
A partir de ce programme :
Interprétez la forme de la requête passée à la méthode createQuery, pourquoi n'est-elle pas complète ?
Renseignez-vous sur HQL dans la documentation
Modifiez la méthode toString de la classe Categorie :
@Override
public String toString() {
return "Categorie [id=" + id + ", libelle=" + libelle + ", produits="
+ produits + "]";
}
Modifiez le programme pour qu'il utilise cette méthode :
for(Categorie categorie:categories)
System.out.println(categorie);
A partir de l'exécution du programme modifié :
Interprétez et expliquez le résultat obtenu
Sélection
Créer le programme suivant
A partir du programme :
Interprétez les requêtes SQL exécutées par Hibernate
Créer le programme suivant
A partir du programme :
Interprétez les requêtes SQL exécutées par Hibernate
Sélection avec distinct et projection
Créer le programme suivant
A partir du programme :
Expliquer ce que fait le programme
Interprétez la requêtes SQL exécutée par Hibernate : quel est le service rendu par l'ORM dans ce cas ?
Gestion des commandes
Implémenter les classes métier Commande et Ligne, en utilisant le début de leur implémentation donné ci dessous, et le diagramme de classe :
- Ne pas oublier les règles citées précédemment (bean + réf dans le fichier de configuration + annotations JPA)
- Ajouter un constructeur avec paramètres permettant d'instancier correctement une ligne et une commande
Commande
Ligne
Justifiez les annotations permettant de mettre en oeuvre la contrainte d'intégrité multiple
Interprétez l'annotation sur le membre dateCommande, en allant voir comment ce champ est défini dans la base de données
Création de commandes
Implémenter le programme suivant.
Exécutez le.
Analysez puis commentez chaque ligne (dans le code) de ce programme
Interprétez la réponse apportée par Hibernate à l'exécution
Corriger le programme en conséquence, vérifiez les résultats obtenus dans la base de données.
Test Web
- Dans un package technics, Écrire une classe Gateway disposant de méthodes statiques permettant d'obtenir les résultats suivants :
- La liste des catégories ;
- la liste des produits d’une catégorie donnée ;
- enregistrant une ligne ;
- enregistrant une commande.
- Créer une classe Display disposant d'une méthode statique
- Retournant une liste au format HTML à partir d'une ArrayList passée en paramètre
- Construire les pages JSP répondant au service suivant :
- l’utilisateur lance l’application dans son navigateur ;
- il voit une liste déroulante de catégories ;
- il sélectionne une catégorie dans la liste et voit une liste déroulante des produits de cette catégorie ;
- il sélectionne un produit et saisit une quantité voulue ;
- un bouton lui permet de continuer le remplissage de son panier (retour à 2)
- un bouton lui permet de valider son panier : la commande est alors enregistrée.
Ajouter toutes les classes (servlet) et méthodes nécessaires pour éviter d'avoir à effectuer un quelconque traitement dans les JSP.
Manipulations et contexte en partie inspirés d'un TD Hibernate de JP PUJOL