{"id":37082,"date":"2017-03-28T10:11:04","date_gmt":"2017-03-28T08:11:04","guid":{"rendered":"\/blog\/?p=12540"},"modified":"2023-07-05T23:57:20","modified_gmt":"2023-07-05T21:57:20","slug":"developper-avec-jpa-et-exo-platform","status":"publish","type":"post","link":"https:\/\/www.exoplatform.com\/blog\/fr\/developper-avec-jpa-et-exo-platform\/","title":{"rendered":"Developper avec JPA et eXo Platform"},"content":{"rendered":"

Depuis la version 4.3, eXo Platform fournit une int\u00e9gration native avec JPA<\/strong> (Java Persistence API).<\/p>\n

JPA <\/strong>est une sp\u00e9cification d\u2019API Java<\/strong> pour la gestion de donn\u00e9es relationnelles dans les applications Java. Cette API permet de lier une classe Java (appel\u00e9e Entit\u00e9) avec une table de base de donn\u00e9es relationnelles \u00e0 l\u2019aide d\u2019annotations Java ou de configuration XML.<\/p>\n

<\/p>\n

La sp\u00e9cification d\u00e9finit aussi une API EntityManager pour g\u00e9rer le traitement des requ\u00eates et des transactions sur les objets Java sur la base de donn\u00e9es.<\/p>\n

\"Developper<\/a><\/p>\n

Pour avoir plus d\u2019informations sur JPA, n\u2019h\u00e9sitez pas \u00e0 parcourir la documentation officielle<\/a>.<\/p>\n

L\u2019int\u00e9gration faite dans eXo Platform nous a permis de d\u00e9marrer notre transition vers un nouveau mod\u00e8le de donn\u00e9es<\/a> et de donner aux d\u00e9veloppeurs la capacit\u00e9 de cr\u00e9er leurs propres applications bas\u00e9es sur JPA.<\/p>\n

Cet article d\u00e9crit cette int\u00e9gration et explique comment d\u00e9velopper des applications en utilisant JPA dans eXo Platform.<\/p>\n

Integration JPA<\/h2>\n

Hibernate<\/a> est l\u2019impl\u00e9mentation JPA utilis\u00e9e, c\u2019est l\u2019impl\u00e9mentation de r\u00e9f\u00e9rence de la sp\u00e9cification. Depuis eXo Platform 4.3 il est possible de \u201cmapper\u201d facilement des entit\u00e9s (classes) Java avec JPA\/Hibernate.<\/p>\n

Nous avons tout pr\u00e9par\u00e9 pour vous : la datasource, la persistence unit, des annotations pour les entit\u00e9s et un DAO g\u00e9n\u00e9rique.<\/p>\n

Datasource<\/h3>\n

Une nouvelle datasource est disponible par d\u00e9faut dans eXo Platform, appel\u00e9e \u201cexo-jpa_portal\u201d (le nom peut \u00eatre chang\u00e9 \u00e0 l\u2019aide de la propri\u00e9t\u00e9 \u201cexo.jpa.datasource.name\u201d dans le fichier exo.properties<\/a>).<\/p>\n

Cette datasource est utilis\u00e9e pour toutes les op\u00e9rations qui utilisent la persistence unit eXo.<\/p>\n

Persistence unit et entity manager<\/h3>\n

Toutes les op\u00e9rations JPA doivent utiliser une persistence unit et un entity manager pour interagir avec la base de donn\u00e9es. La persistence unit d\u00e9finie la datasource \u00e0 utiliser, les entit\u00e9s \u00e0 g\u00e9rer et un ensemble d\u2019autres param\u00e8tres de configuration.<\/p>\n

Nous avons ajout\u00e9 une persistence unit par d\u00e9faut dans eXo Platform, appel\u00e9 exo-pu<\/strong>, qui utilise la datasource par d\u00e9faut exo-jpa_portal, et qui ne d\u00e9clare aucune entit\u00e9 :<\/p>\n

<persistence xmlns=”http:\/\/java.sun.com\/xml\/ns\/persistence”<\/i><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/i> xmlns:xsi=”http:\/\/www.w3.org\/2001\/XMLSchema-instance”<\/i><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/i> xsi:schemaLocation=”http:\/\/java.sun.com\/xml\/ns\/persistence http:\/\/java.sun.com\/xml\/ns\/persistence\/persistence_2_0.xsd”<\/i><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/i> version=”2.0″><\/i><\/p>\n

\u00a0\u00a0\u00a0<persistence-unit name=”exo-pu” transaction-type=”RESOURCE_LOCAL”><\/i><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<provider>org.hibernate.ejb.HibernatePersistence<\/provider><\/i><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<non-jta-data-source>java:\/comp\/env\/exo-jpa_portal<\/non-jta-data-source><\/i><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<properties><\/i><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<property name=”persistenceUnitName” value=”exo-pu”><\/property><\/i><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/properties><\/i><\/p>\n

\u00a0\u00a0\u00a0<\/persistence-unit><\/i><\/p>\n

<\/persistence><\/i><\/p>\n

La configuration de cette persistence unit peut \u00eatre modifi\u00e9 facilement en d\u00e9finissant le param\u00e8tre dans le fichier exo.properties<\/a>, pr\u00e9fix\u00e9 par \u201cexo.jpa.\u201d.<\/p>\n

Par exemple, pour demander \u00e0 Hibernate de tracer toutes les requ\u00eates SQL, il suffit d\u2019ajouter la ligne suivante :<\/p>\n

exo.jpa.hibernate.show_sql=true<\/i><\/p>\n

Entiti\u00e9s<\/h3>\n

eXo Platform fournit une annotation pour ajouter une entit\u00e9 JPA dans la persistence unit (exo-pu): @ExoEntity<\/strong>. Voici un example :<\/p>\n

 <\/p>\n

@Entity(name = “TaskTask”)<\/i><\/p>\n

@ExoEntity<\/i><\/p>\n

public class Task {<\/i><\/p>\n

\u00a0\u00a0\u00a0@Id<\/i><\/p>\n

\u00a0\u00a0\u00a0@SequenceGenerator(name=”SEQ_TASK_TASKS_TASK_ID”, sequenceName=”SEQ_TASK_TASKS_TASK_ID”)<\/i><\/p>\n

\u00a0\u00a0\u00a0@GeneratedValue(strategy=GenerationType.AUTO, generator=”SEQ_TASK_TASKS_TASK_ID”)<\/i><\/p>\n

\u00a0\u00a0\u00a0@Column(name = “TASK_ID”)<\/i><\/p>\n

\u00a0\u00a0\u00a0private long \u00a0\u00a0\u00a0<\/i> id;<\/i><\/p>\n

 <\/p>\n

\u00a0\u00a0\u00a0private String \u00a0<\/i> title;<\/i><\/p>\n

 <\/p>\n

\u00a0\u00a0\u00a0private String \u00a0<\/i> description;<\/i><\/p>\n

 <\/p>\n

\u00a0\u00a0\u00a0…<\/i><\/p>\n

}<\/i><\/p>\n

Ceci est un extrait de l\u2019entit\u00e9 task. Comme vous pouvez le voir, il s\u2019agit d\u2019une entit\u00e9 JPA standard (annot\u00e9 avec @Entity). La seule diff\u00e9rence est l\u2019ajout de l\u2019annotation @ExoEntity.<\/p>\n

Ajouter cette annotation et mettre cette classe dans le classpath ajoute automatiquement cette entit\u00e9 dans la persistence unit eXo.<\/p>\n

Transactions<\/h3>\n

@ExoEntity n\u2019est pas la seule annotation fournie par eXo Platform; nous avons \u00e9galement ajout\u00e9 une annotation pour d\u00e9finir une m\u00e9thode transactionnelle : @ExoTransactional.<\/p>\n

Apposer cette annotation sur une m\u00e9thode permet d\u2019utiliser automatiquement l\u2019entity manager pour d\u00e9marrer une transaction et la fermer, ou d\u2019utiliser une transaction existante si elle a d\u00e9j\u00e0 \u00e9t\u00e9 ouverte.<\/p>\n

@ExoTransactional<\/i><\/p>\n

public Task createTask(Task task) {<\/i><\/p>\n

\u00a0\u00a0\u00a0…<\/i><\/p>\n

}<\/i><\/p>\n

Le plugin Maven JCabi doit \u00eatre activ\u00e9 pour le bon fonctionnement de cette annotation. Pour cela, 2 fa\u00e7ons de proc\u00e9der existent :<\/p>\n