JPA: Java Persistence API

Transcription

1 1 2 Objet JPA JPA: Java Persistence public class Vin implements = GenerationType.IDENTITY) private Long id = null; private String nomvin; Javabeans synchronisables avec la base de données Autres noms: Hibernate, EJB3 public Long getid() { // getters setters, générés par Eclipse return id; public void setid(long id) { this.id = id; public String getnomvin() { return nomvin; 3 4 Objet JPA avec attributs non public class Vin implements = GenerationType.IDENTITY) private Long id = null; private String nomvin; transient private String flag; // pas dans la BD, pas private String caracteristique; // getters / setters // pas dans la BD // les transients ne sont utilisés que dans la JSF, pas dans la BD Importations dans un JPA import javax.persistence.entity; import javax.persistence.generatedvalue; import javax.persistence.generationtype; import public class Vin implements java.io.serializable {...

2 5 6 Insérer un objet dans la base de données javax.persistence.entitymanager em = ejb3_utility.manager.open(); javax.persistence.entitytransaction tx = em.gettransaction(); Vin vin = new Vin(nomV, cepage, annee); em.persist(vin); // or tx.rollback(); ejb3_utility.manager.close(); Manager.java est lié à un thread (détails) private static ThreadLocal<Manager> threadmanager = new ThreadLocal<Manager>() { // nameless class protected synchronized Manager initialvalue() { return (new Manager()); ; 7 8 Manager.java (partiel) private EntityManager em = null; public static EntityManager open() { Manager manager = (Manager) threadmanager.get(); if (manager.em == null) { Manager.emf = Persistence.createEntityManagerFactory("NomDeManager"); manager.em = Manager.emf.createEntityManager(); manager.em.setflushmode(flushmodetype.commit); return manager.em; Création d un projet contenant des JPAs

3 9 10 Projet avec objets JPA Créer un Dynamic Web Project Ajouter la liste de.jar dans WebContent/WEB-INF/lib Ajouter ejb3_utility/manager.java dans src Ajouter META-INF/persistence.xml dans le répertoire src et introduire le nom de chaque JPA dans ce fichier Ajouter mysql_connector.jar dans Tomcat/lib Persistence.xml (partie) <persistence-unit name="nomdemanager"> <class>db.vin</class> <properties> <property name="hibernate.dialect" value="org.hibernate.dialect.mysqldialect"/> <property name="hibernate.hbm2ddl.auto" value="update"/> <property name="hibernate.connection.driver_class" value="com.mysql.jdbc.driver"/> <property name="hibernate.connection.username" value="username"/> <property name="hibernate.connection.password" value="password"/> <property name="hibernate.connection.url" value="jdbc:mysql://localhost:3306/test"/> <property name="javax.persistence.transactiontype" value="resource_local"/> </properties> </persistence-unit> </persistence> 11 Intégration d'un JPA dans un projet Structure selon Usager.java Introduire le JPA dans les ManagedBean, s'il est affiché dans une JSF Introduire son package.nom dans persistence.xml Introduire un objet dans la base de données javax.persistence.entitymanager em = ejb3_utility.manager.open(); javax.persistence.entitytransaction tx = em.gettransaction(); Vin vin = new Vin(nomV, cepage, annee); em.persist(vin); // les modifications faites ici sont aussi introduites dans la BD // or tx.rollback(); ejb3_utility.manager.close(); // persist ajoute automatiquement un id dans le de l'objet

4 Modification d un objet dans la BD: merge() A la fin d'une méthode, avant de retourner à la page à afficher dans le navigateur, on doit naturellement fermer la transaction. Lorsque l'on affiche un objet sur une page, on n'est donc plus dans la transaction Lorsque l utilisateur demande à la page de transmettre les modifications (<form action=" ">), elle appelle une nouvelle action Dans cette action, il faut ouvrir une nouvelle transaction et y réintroduire l'objet merge() pour que les modifications soient enregistrées dans la BD p = new () em.persist(p) Première transaction Opération merge Manager p p1 DB // les modifications de p1 sont transmises dans la BD p1 = em.merge(p) Deuxième transaction Fonctionnement du merge Opération merge Manager Page Page Page Page 5 p Id : 5 p1 Id : 5 session p1 = em.merge(p) p1 est une copie de p Seules les modifications sur p1 seront transmises à la base de données à la fermeture de la transaction A programmer explicitement em.persist(p) p = em.merge(p) DB p = em.merge(p)

5 merge d'un objet déjà dans la transaction merge d'un objet déjà dans la transaction p1 Id : 5 p3 = em.merge(p1) Manager 5 mémorisation p3 On suppose que p1 et p2 ont été créés par un moyen quelconque, par exemple en introduisant directement 5 dans l'id Si l'id est déjà référencé, le contenu du nouvel objet est copié dans l'objet référencé et l'objet référencé est retourné Id : 5 p1 Id : 5 Manager 5 mémorisation p3 p4 p3 = em.merge(p1) p2 On suppose que p1 et p2 ont été créés par un moyen quelconque, par exemple en introduisant directement 5 dans l' id. Le premier merge introduit p3 dans la transaction Comme l' id de p2 est déjà référencé, le deuxième merge copie le contenu du nouvel objet dans l'objet p3 puis la référence de cet objet est retournée dans p4 Id : 5 Id : 5 copie du contenu p4 = em.merge(p2) session Indirection dans la session (p reste dans la session) Relations entre JPAs Business p; public void action() {... p = em.merge(p);...

6 21 22 Relations entre JPA 1:1 Relations entre JPA 1:N Marchand nommarchand vin 1 1 Vin nomvin cepage annee marchand Marchand nommarchand vins 1 N Vin nomvin cepage annee marchand Dans Marchand (il faut choisir un côté pour private Vin vin; Dans private Collection<Vin> private Marchand marchand; Dans private Marchand marchand; Dans Vin // Getters setters pour les deux champs // Getters setters pour la collection et pour le champ marchand Relations entre JPA N:M Marchand nommarchand vins N M Vin nomvin cepage annee marchands Dans Marchand Relations entre JPA N:M, (cascade = CascadeType.ALL) Dans private Collection<Vin> vins; private Collection<Vin> vins = private Collection marchands; Dans Vin private Collection marchands = new ArrayList<Marchand>(); Dans Vin // Getters setters pour les deux collections // Persistence et remove cascadés

7 25 Relation dans la base de données et dans les objets Insertion de JPAs dans les relations C'est la responsabilité du développeur d'introduire les relations dans les deux sens entre les objets. Pour qu'elles soient introduites dans la base de données, il faut faire cette opération dans une transaction du manager. C'est-àdire que le principal soit attaché (voir plus loin) et l'objet ajouté pas libre. De plus il faut introduire au moins l'élément du côté qui n'a pas l'indication mappedby Relations entre JPA private Vin vin; Relations entre JPA private Collection<Vin> private Marchand private Marchand marchand; marchand = em.merge(marchand); em.persist(v); marchand.setvin(v); vin = em.merge(vin); em.persist(m); vin.setmarchand(m); marchand = em.merge(marchand); em.persist(v); marchand.vins.add(v); vin = em.merge(vin); em.persist(m); vin.setmarchand(m); // nécessaire et suffisant pour // introduire la relation dans la BD // nécessaire et suffisant pour // introduire la relation dans la BD

8 29 Relations entre JPA private Collection<Vin> private Collection marchands; marchand = em.merge(marchand); em.persist(v); marchand.vins.add(v); // les instructions d'un seul côté suffisent // pour entrer la relation dans la BD vin = em.merge(vin); em.persist(m); vin.marchands.add(m); Parcourir des éléments d'une relation x:n public class Marchand private Collection<Vin> vins; public void setvins( ) { public Collection<Vin> getvins( ) { //... transaction... marchand = em.merge(marchand); for (Vin v: marchand.getvins()) { // relation System.out.println(v.getNom()); // Les vins sont automatiquement "mergés" quand // on parcourt la collection c merge dans les relations Cours id=8 id=4 id=7 c merge dans les relations Cours et id=8 id=4 id=7 c1 = em.merge(c) c1 = em.merge(c) et = em.merge(et) Manager id: 3, 8, 4, 7 c1 Cours pas de copie Manager 3, 8, 4, 7 c1 Cours et id=4 for (Vin v: marchand.getvins()) { System.out.println(v.getNom()); // mergés automatiquement for (Vin v: marchand.getvins()) { System.out.println(v.getNom()); // le 4 est repris car il est déjà mergé BD extraction c1 Cours id=8 id=4 id=7 Les modifications sur les objets bleus sont répercutées dans la BD c1 Cours id=8 id=7

9 Rattachement à la base de données Comme décrit précédemment, les objets JPA sont créés indépendamment de la base de données et leur synchronisation avec celle-ci est faite de façon explicite. Un objet peut donc être libre (pas d'id), attaché (un ID et dans une transaction) ou détaché (a conservé son ID, mais n'est pas lié à une transaction). Un objet mémorisé dans la session HTTP peut garder son ID d'une page à l'autre. Pour le réintégrer dans une transaction, il faut utiliser merge, comme expliqué sur les pages qui précèdent. De même pour un objet qui serait lu par une query, il obtient un ID, mais il n'est pas attaché à la transaction. em = Manager.open(); client = new Client("Hans"); // libre em.persist(p); // attaché Manager.close(); // détaché, son id reste initialisé client.setid(0); // libre client = (Client) result.getsingleresult(); // détaché Elements attachés merge() Client client = (Client)result.getSingleResult(); // détaché, son id est initialisé client2 = em.merge(client); // attaché, les modifications seront enregistrées au commit // em.merge() retourne une copie intégrée dans la transaction // Donc attention, si client est enregistré dans la session // HTTP, il faudra le ré-enregistrer dans cette session! Mises à jour Quand un objet attaché est mis à jour, ses modifications sont suivies dans le manager et lors du commit, elles sont transmise dans la base de données. Il en est de même avec les relations. Pour vérifier que le système réagit selon nos plans, il suffit d'afficher les tables en utilisant le moniteur de MySQL

10 37 38 JQL Adaptation de SQL aux JPA Utilisation de JQL Query result = em.createquery("select v FROM Vin v"); vin = (Vin)result.getSingleResult(); // une seule ligne, // une exception est jetée si la commande // en définit plusieurs vins = (ArrayList<Vin>) result.getresultlist(); // plusieurs lignes // le find est automatiquement attaché au manager 40 Elimination d'un élément Query result = em.createquery( "SELECT v FROM Vin v WHERE v.nomvin="bourgogne" ); vin = (Vin)result.getSingleResult();... em.remove(vin); JQL avec relations Relation 1:1 SELECT m FROM Marchand m WHERE m.vin.nom='epesse (m.vin est un attribut) Relation 1:N, N:N SELECT m FROM Marchand m, IN(m.sesVins) v WHERE v.nom='epesse' (m.sesvins est une collection)

11 42 Introduire un élément dans une relation Lazy loading (1) Query result = em.createquery( "SELECT c FROM Client c WHERE c.nom=' "+nomclient+" ' "); Client client = (Client) result.getsingleresult(); client.getpanier().add(p); // or tx.rollback(); Lorsque le manager charge une relation qui ne nécessite qu un attribut (1:1, 1:N), il charge directement l unique élément de la relation. Lorsqu il doit charger une liste (N:M, N:1), il ne charge les éléments que lorsqu ils sont accédés. Ainsi, dans l exemple ci-desous, les éléments ne sont plus accessibles, car la transaction est fermée avant d accéder aux éléments (on suppose que client a une relation 1:N avec produits): Client client = (Client)result.getSingleResult(); client2 = em.merge(client); for (Produit p: client2.listeproduits) { print(p); // ne sont plus accessibles 43 Lazy loading (2) Pour forcer le chargement pendant que la liste est dans la transaction, il faut y accéder, par exemple en appelant la fonction size(): Client client = (Client)result.getSingleResult(); Client client2 = em.merge(client); client2.size(); // juste pour forcer le chargement for (Produit p: client2.listeproduits) { print(p); // disponibles // Note: on pourrait aussi spécifier que le chargement soit fait d office // (eager loading) dans les paramètres du JPA (voir la doc spécialisée). Transactions gérées par version Soit la séquence d'événements: On crée ou lit un JPA depuis une page Dans un page suivante, on merge ce JPA pour le modifier La modification est faite correctement On relit une JPA depuis une page Un autre utilisateur lit la même JPA Il la modifie (La modification est faite correctement) Le premier utilisateur clique sur sa page Il modifie le JPA La première modification est oubliée. Le champ de version va permettre de signaler ce problème.

12 Transactions gérées par private int uneversion; // getters / setters Transactions gérées par version public void enregistrer() { // création d'un JPA this.id = null; try { javax.persistence.entitymanager em = ejb3_utility.manager.open(); javax.persistence.entitytransaction tx = em.gettransaction(); em.persist(this); // or tx.rollback(); finally { ejb3_utility.manager.close(); // rien de particulier Transactions gérées par version public void modifier() { try { javax.persistence.entitymanager em = ejb3_utility.manager.open(); javax.persistence.entitytransaction tx = em.gettransaction(); Produit2 p = em.merge(this); p.prix ++; // or tx.rollback() finally { ejb3_utility.manager.close(); // si un autre usager a modifié la même JPA, une exception est // levée car la version a changé depuis la dernière modification Transactions gérées par version public void modifier() { try { javax.persistence.entitymanager em = ejb3_utility.manager.open(); javax.persistence.entitytransaction tx = em.gettransaction(); Produit2 p = em.merge(this); // reprend la version de l objet pas celle p.prix ++; // de la BD // or tx.rollback() finally { ejb3_utility.manager.close(); // à la deuxième modification, exception de mise à jour // car la version a changé depuis la dernière modification

13 Transactions gérées par version (gestion correcte sans concurrence) public void modifieraveclecture() { try { javax.persistence.entitymanager em = ejb3_utility.manager.open(); Query result = em.createquery( "SELECT p FROM Produit2 p WHERE p.nom='" + nom + "'"); Produit2 prod = (Produit2) result.getsingleresult(); // prod obtient la dernière valeur de la version // suite comme dans le transparent précédent MySQL Pour initialiser MySQL sur les stations de la salle de l'epfl, aller à la page et charger l'avant-dernier fichier.zip dans votre répertoire. Ouvrir une fenêtre terminal, aller dans le répertoire bin du nouveau répertoire et appeler mysqld u root console ou simplement mysqld Les mots de passe, si vous en utilisez, doivent être entrés dans le fichier persistence.xml. Ouvrir ensuite une nouvelle fenêtre et appeler: mysql Vous pouvez ensuite taper des commandes telles celles-ci: use test show tables; select * from vin; Exercice Entrer les produits de l'épicerie dans la base de données Voir résumé sur JPA: App Engine de Google Download the Google Plugin for Eclipse Créez un compte Dans Eclipse: New > Web Application Project Clic droit sur le nom de projet > Web Application (exécution comme Tomcat) Clic sur dans le menu principal > remplir champs (exécution sur serveur Google) Erreurs: Sign up > application-id > logs Fichiers pour créer un "disque" dans AppEngine:

14 53 Documentation des JPAs Essais avec JPA: Remplacer / copier les fichiers ci-dessous dans le projet Copier persistence.xml src/meta-inf Documentation: Site App Engine > Getting started Getting started > Java (overview) Java (JPA)