Débuter avec Hibernate sous Eclipse

Par Minosis (Homepage)
 

Les applications d'entreprises s'orientent de plus en plus vers des architectures n-tiers. La technologie J2EE et les frameworks qui se sont créés autour offrent beaucoup d'outils pour répondre aux besoins modernes. Nous allons nous intéresser dans cet article, sous la forme d'un tutorial, au framework de mapping objet-relationnel le plus populaire pour J2EE appelé Hibernate. Et après l'article : détente avec du sudoku.
Téléchargez la version pdf.

Introduction

Source : hibernate.org

1. Création de la base de données

• Ouvrez Entreprise Manager et déroulez l'arborescence jusqu'à obtenir la liste des bases.
• Faites "Bouton droit" sur le répertoire "Bases de données" et cliquez sur "Nouvelle base de données ...". Nommez la base "Base1".
• Cliquez sur "Base1" qui vient d'apparaître dans l'arborescence puis faites "Bouton droit" sur "Tables" et cliquez sur "Nouvelle table ...".
• Insérez les informations suivantes :

Ne définissez pas le champs "id" en clé primaire mais comme un champs normal. En effet, le type Primary Key sera défini dans le fichier xml de mapping plus tard.

• Nommez cette table "t_contact".
• Déroulez le dossier "Sécurité" de l'arborescence et faites "Bouton droit" sur "Connexion" puis "Nouvelle connexion".
• Indiquez dans le premier onglet les informations suivantes :

Le mot de passe choisit ici est "password".

• Cliquez sur l'onglet "Accès aux bases de données", cochez "Base1" et donnez comme rôle "db_datareader" et "db_datawriter" uniquement.
• Double-cliquez sur "Base1 > Tables > t_contact" et cliquez sur "Autorisations". Cochez SELECT, INSERT, UPDATE et DELETE.

2. Installation de Hibernate Synchronizer

• Téléchargez et installez J2SE 1.4 SDK.
• Si vous ne disposez pas d'Eclipse, téléchargez-le et installez le.

• Ouvrez Eclipse. Nous allons installer le plugin Hibernate Synchroniser.
• Cliquez sur "Help > Software Updates > Find and Install"
• Sélectionnez "Search for new features to install"
• Cliquez sur "New Remote Site" et entrez l'URL suivante : "http://hibernatesynch.sourceforge.net". Donnez comme nom au site "Hibernate Sync".
• Cochez "Synchronizer" :

• Faites "Next", attendez que la recherche se fasse puis cochez "Hibernate Synchronizer". Continuez jusqu'au bout du processus en acceptant toutes les demandes.
• Eclipse devrait télécharger et installer automatiquement le plugin aprés avoir cliqué sur "Installer". Le programme vous demande ensuite de redémarrer. Cliquez sur "Yes".

3. Utilisation de Hibernate

3.1. Création et préparation du projet

• Faites "Fichier>New>Project"
• Choisissez "Java Project" puis donnez au projet les caractéristiques suivantes :

Veillez à bien cocher "Create separate source and output folders".

• Si Eclipse vous demande de passer en Java Perspective, répondez "Yes".
• Créez à partir de l'explorateur windows un répertoire "lib" dans la racine de votre projet : /eclipse/workspace/HibernateTest/lib
• Téléchargez l'archive libs_tuto.zip : ici. Décompressez son contenu dans le répertoire "lib". hibernate2.jar contient les principaux packages nécessaires au bon fonctionnement d'Hibernate. jtds-0.8.1.jar est un driver JDBC opensource pour se connecter à SQLServer 2000. Les autres packages sont indispensables à Hibernate.
• Revenez à Eclipse et faites sur le nom du projet "HibernateTest" : "Bouton droit > Refresh". Le répertoire "lib" a dû apparaître.
• A ce moment précis, si vous déroulez le répertoire "lib", le projet doit ressembler à ça :

• Faites sur le projet "HibernateTest" : "Bouton Droit > Properties"
• Cliquez sur "Java Build Path" puis sur l'onglet "Librairies".
• Cliquez sur "Add jars". Une fenêtre apparaît. Déroulez l'arborescence qui soit être "HibernateTest > lib" et sélectionnez tous les jar présents. Puis cliquez sur "OK".
• Tous les packages devraient apparaître dans la liste de "Librairies". Cliquez sur "OK" dans la fenêtre "Properties for HibernateTest".
• Le projet doit être maintenant comme ceci :

3.2. Création des éléments de Hibernate

3.2.1. Création du fichier de configuration xml

• Sur le dossier "src", faites "Bouton droit > New > Other" et choissez "Hibernate > Hibernate Configuration File"

• Dans la fenêtre qui apparaît ensuite, indiquez les informations suivantes :

• Cliquez sur "Finish". hibernate.cfg.xml est créé.
• Le fichier devrait s'ouvrir dans votre éditeur xml par défaut. Le mieux est de l'ouvrir sous Eclipse : "Bouton droit sur le fichier > Open With > Text Editor".

• Mettez ces lignes en commentaire :

<!--
<property name="hibernate.transaction.factory_class">
	net.sf.hibernate.transaction.JTATransactionFactory
</property>
<property name="jta.UserTransaction">
	java:comp/UserTransaction
</property>
-->

• Placez en dessous la nouvelle ligne suivante :

<!--
<property name="hibernate.transaction.factory_class">
	net.sf.hibernate.transaction.JTATransactionFactory
</property> <property name="jta.UserTransaction">
	java:comp/UserTransaction
</property>
-->
<property name="hibernate.transaction.factory_class">
   net.sf.hibernate.transaction.JDBCTransactionFactory
</property>

3.2.2. Création du fichier de mapping xml

• Faites sur "src" dans le projet : "Bouton droit > New > Package" et donnez comme nom, par exemple : "com.minosis.hibernate".
• Sur le dossier "src", faites "Bouton droit > New > Other" et choissez "Hibernate > Hibernate Mapping File"
• Indiquez les informations suivantes :

Pour obtenir automatiquement la liste des tables de la base, mettez "password" dans Password et cliquez sur "Refresh". Si les tables apparaîssent, c'est que la connexion à la base de données a eu lieu correctement, félicitation ;-)

<?xml version="1.0"?>
   <!DOCTYPE hibernate-mapping
 PUBLIC "-//Hibernate/Hibernate Mapping DTD//EN"
 "http://hibernate.sourceforge.net/hibernate-mapping-2.0.dtd">

<hibernate-mapping>

 <class name="com.minosis.hibernate.TContact" table="t_contact">

 <id name="Id" type="integer">
 <column name="id" sql-type="int(4)"/>
 <generator class="increment" />
 </id>

 <property name="Nom" type="string">
 <column name="nom" sql-type="char(50)" not-null="true"/>
 </property>

 <property name="Prenom" type="string">
 <column name="prenom" sql-type="char(50)" not-null="true"/>
 </property>

 <property name="Age" type="integer">
 <column name="age" sql-type="int(4)" not-null="true"/>
 </property>

 </class>

</hibernate-mapping>

4. Test des classes

4.1. Classe HibernateUtil

• Dans votre projet HibernateTest, faites sur "com.minosis.bdd" : "Bouton droit > New > File". Donnez-lui comme nom "HibernateUtil.java".
• Copiez dans ce fichier vide, le contenu suivant :

package com.minosis.hibernate;

import net.sf.hibernate.*;
import net.sf.hibernate.cfg.*;

public class HibernateUtil {

 private static final SessionFactory sessionFactory;

 static {
   try {
   // Crée la SessionFactory
   sessionFactory =
	 new Configuration().configure().buildSessionFactory();
   } catch (HibernateException ex) {
   throw new RuntimeException("Problème de configuration : "
   + ex.getMessage(), ex);
   }
   }

 public static final ThreadLocal session = new ThreadLocal();

 public static Session currentSession()
		throws HibernateException {
   Session s = (Session) session.get();
   // Ouvre une nouvelle Session, si ce Thread n'en a aucune
   if (s == null) {
   s = sessionFactory.openSession();
   session.set(s);
   }
   return s;
   }

 public static void closeSession()
		throws HibernateException {
   Session s = (Session) session.get();
   session.set(null);
   if (s != null)
   s.close();
   }
 }

4.2. Classe Test

• Faites sur le répertoire "src" : "Bouton droit > New > File". Nommez le fichier "Test.java".

• Placez dans Test.java, le code suivant :

import java.util.*;
import net.sf.hibernate.*;
import com.minosis.hibernate.*;

public class Test {

 public static void main(String[] args)
	throws HibernateException {

 }
}

• Pour exécuter le programme (qui ne fait rien pour le moment), cliquez sur "Run > Run...". Puis sélectionnez "Java Application" et cliquez sur le bouton "New".

4.2.1. Insertion

• Placez le code suivant dans la méthode main() :

Session session = HibernateUtil.currentSession();
   
Transaction tx = session.beginTransaction();

TContact contact = new TContact();
contact.setNom("Dupont");
contact.setPrenom("Jean");
contact.setAge(new Integer(44));
session.save(contact);

contact = new TContact();
contact.setNom("Lambert");
contact.setPrenom("Julie");
contact.setAge(new Integer(27));
session.save(contact);
   
tx.commit();

HibernateUtil.closeSession();

4.2.2. Mise à jour

• Placez le code suivant dans la méthode main() (on la suppose vide) :

Session session = HibernateUtil.currentSession();
   
Transaction tx = session.beginTransaction();


TContact contact =
(TContact) session.load(TContact.class, new Integer(1));

contact.setPrenom("Jacques");
session.save(contact);

tx.commit();

HibernateUtil.closeSession();

4.2.3. Lecture

• Placez le code suivant dans la méthode main() (on la suppose vide) :

List list = session.find("from TContact where nom like '%t'");
Iterator it = list.iterator();
while(it.hasNext())
{
  TContact contact = (TContact)it.next();
  System.out.println(contact.getNom());
}

HibernateUtil.closeSession();

• Cliquez sur l'icône "Run" pour tester ces exemples.

Conclusion