La persistance des données est habituellement gérée par une base de données relationnelles.
Le problème est que suite à l’évolution des POJO par exemple en ajoutant une date de création à notre POJO Todo, il faut souvent recoder toutes les requêtes SQL et modifier la structure des tables.
Avec les annotations Java qui permettent d’indiquer des informations additionnelles au code Java, on peut informer un framework de persistance comme Hibernate de ce qu’il doit faire de chaque méthode et propriété d’un POJO.
On a par exemple utilisé l’annoation @WebServlet({ « /Controleur » }) pour indiquer à Tomcat quel est la Servlet qui va être activée par l’URL /Controleur.
Nous avons donc une classe Todo dont nous voulons faire persister les instances avec des annotations à ajouter:
/* Import des packages générique qui sont des interfaces d'hibernate
ou d'autres outils de persistance */
import javax.persistence.Basic;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
// Annotation pour indiquer que l'on fait persister ce POJO
@Entity
// Nom de la table créé, indication optionnelle le nom de la table
// est habituellement le nom de la classe
@Table(name = "todo")
public class Todo {
private Integer id;
private String texte = "";
private boolean actif = false;
// Nom de la colonne information optionnelle habituellement
// c'est le nom du champ qui sert de nom à la colonne
@Column(name = "texte")
public String getTexte() {
return texte;
}
// Champ créé par défaut le nom de la colonne "actif"
public boolean isActif() {
return actif;
}
// Clef unique des instances pour
@Id
@Column(name = "id")
// 2 annotations pour indiquer que la génération de cette
// information est assurée par l'identité
@GeneratedValue(strategy=GenerationType.IDENTITY)
@Basic
public Integer getId() {
return id;
}
}
Maintenant il faut configurer la liaison entre la base de données et notre projet en ajoutant un fichier de configuration hibernate.cfg.xml dans le dossier src de notre projet.
<?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="show_sql">true</property> <property name="format_sql">true</property> <property name="dialect">fr.ema.lgi2p.emacs.hibernate.SQLiteDialect</property> <property name="connection.driver_class">org.sqlite.JDBC</property> <property name="connection.url">jdbc:sqlite:c:/Developpement/todoHibernate2.sqlite</property> <property name="connection.username"></property> <property name="connection.password"></property> <property name="hibernate.hbm2ddl.auto">update</property> <!-- <mapping class="fr.ema.lgi2p.emacs.metier.Todo"/> --> </session-factory> </hibernate-configuration>
Ce fichier indique la nature de la base de données utilisée (sqlite) avec les nom et mot de passe utilisateur (ici aucun à la différence de MySql par exemple), le nom de du driver SQLiteDialect, le connecteur JDBC, l’url pour se connecter à la base de données. J’ai ajouté show-sql et format_sql pour afficher dans les logs les requêtes SQL.
Le réglages hibernate.hbm2ddl.auto permet ici d’indiquer que l’on souhaite créer les tables de bases de données et les modifier mais sans effacer les colonnes. Si par exemple on retire une propriété par exemple « actif » à notre POJO, la base de données n’enlèvera pas de données.
Nous devons ajouter un Dialect spécifique pour Sqlite suite à un bug sur le driver officiel.Il est téléchargeable à cette adresse : SQLiteDialect. Il faut bien sur le dézipper et le mettre dans le bon package.
Pour utiliser maintenant la couche de persistance il faut créer une classe spécialisée DaoManagerHibernate:
private DaoManagerHiberante() {
// Ouvrir le fichier hibernate.cfg.xml pour lire la configuration
Configuration configuration = new Configuration();
configuration.configure();
// Indique que la classe Todo.class est à analyser
configuration.addAnnotatedClass(Todo.class);
// Ouvre le gestionnaire de connexion
serviceRegistry = new ServiceRegistryBuilder()
.applySettings(configuration.getProperties())
.buildServiceRegistry();
// Fabrique une session de connexion, on a une seule connexion
// mais il est possible d'avoir plusieurs connexions en même temps
sessionFactory = configuration
.buildSessionFactory(serviceRegistry);
// Ouverture de la session de connexion
session = sessionFactory.openSession();
}
// Méthode pour sauver un Todo
public void addTodo(Todo todo){
// Ouvre une transaction sur la base de données
Transaction tx = session.beginTransaction();
// Avec la session, nous sauvons le todo passé en paramètre
session.save( todo );
// Validation de la sauvegarde réellement dans la base de données
// Parfois il est utile de ne garder l'objet en mémoire et d'écrire
// dans la base de données plus tardivement pour optimiser le temps
session.flush();
// La transaction est validé, tout est OK, le todo est sauevgardé
tx.commit();
}
// Retourne toues les todos de la base de données
public List<Todo> getLestTodos(){
@SuppressWarnings("unchecked")
// sur la session on créer une requête HQL (H=Hibernate)
// Finalement assez proche du SQL, on peut rajouter des clauses
// comme en SQL "from Todo where Todo.actif = true
List<Todo> todos = session.createQuery("from Todo").list();
return todos;
}
Pour finir, il faut ajouter les packages hibernate et Sqlite avec leur logger et des classes utilitaires additionnelles (dom4j pour ouvrir les fichiers xml par exemple).
Vous pouvez les télécharger à cette adresse pour ma version de démonstration (Hibernate-jars) à dézipper et à placer dans le dossier WEB-INF/lib/ de votre projet.
Finalement, après configuration, on va se concentrer sur les classes annoté @Entity qui vont être sauvegarder et la classe DaoManagerHibernate qui assure la gestion de la session de connexion avec la base de données.
Hibernate est framework de persistance très performant, donc avec beaucoup d’option. Au début de son utilisation on se retrouve avec beaucoup de réglages mais ensuite en fonctionnement normal, on n’intervient que sur très peu de réglages et récupère enfin les avantages de l’utilisation d’un tel framework complexe.
