Sử dụng Jakarta Persistence (JPA) với Spring Framework

Trong Jakarta Persistence thì đối tượng EntityManagerFactory là một đối tượng factory chịu trách nhiệm quản lý các cấu hình liên quan đến persistence configuration và tạo ra các EntityManager instances. Việc sử dụng Spring để quản lý đối tượng này sẽ giúp chúng ta rất nhiều trong việc phát triển các ứng dụng Java có sử dụng Jakarta Persistence và Spring Framework. Trong bài viết này, mình sẽ hướng dẫn các bạn cách sử dụng Jakarta Persistence với Spring Framework, các bạn nhé!

Đầu tiên, mình sẽ tạo mới một Maven project để làm ví dụ:

Spring framework dependency:

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-context</artifactId>
  <version>7.0.10</version>
</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-context</artifactId>

</dependency>

Để làm việc với Jakarta Persistence, chúng ta cũng cần thêm spring-orm dependency nữa:

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-orm</artifactId>
  <version>7.0.10</version>
</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-orm</artifactId>

</dependency>

Ở đây, mình sẽ sử dụng Jakarta Persistence với implementation của Hibernate nên mình sẽ thêm Hibernate dependency như sau:

<dependency>
  <groupId>org.hibernate.orm</groupId>
  <artifactId>hibernate-core</artifactId>
  <version>7.4.14.Final</version>
</dependency>

<groupId>org.hibernate.orm</groupId>

<artifactId>hibernate-core</artifactId>

<version>7.4.14.Final</version>

</dependency>

MySQL Connector:

<dependency>
  <groupId>com.mysql</groupId>
  <artifactId>mysql-connector-j</artifactId>
  <version>26.10.0</version>
</dependency>

<groupId>com.mysql</groupId>

<artifactId>mysql-connector-j</artifactId>

</dependency>

Để đơn giản, trong ví dụ này, mình chỉ định nghĩa một table chứa thông tin sinh viên với 2 cột như sau:

CREATE TABLE `students` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `name` varchar(50) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

CREATE TABLE `students` (

`id` bigint(20) NOT NULL AUTO_INCREMENT,

`name` varchar(50) DEFAULT NULL,

PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Để làm ví dụ thì mình đã thêm một số sample data như sau:

Entity của table Student có nội dung như sau:

package com.huongdanjava.spring;

import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.Id;
import jakarta.persistence.Table;

@Table(name = "students")
@Entity
public class Student {

  @Id
  @GeneratedValue
  private Long id;

  @Column
  private String name;

  public Long getId() {
    return id;
  }

  public void setId(Long id) {
    this.id = id;
  }

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  @Override
  public String toString() {
    return "Student [id=" + id + ", name=" + name + "]";
  }
}

package com.huongdanjava.spring;

import jakarta.persistence.Column;

import jakarta.persistence.Entity;

import jakarta.persistence.GeneratedValue;

import jakarta.persistence.Id;

import jakarta.persistence.Table;

@Table(name = "students")

@Entity

public class Student {

@Id

@GeneratedValue

private Long id;

@Column

private String name;

public Long getId() {

return id;

}

public void setId(Long id) {

this.id = id;

}

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

@Override

public String toString() {

return "Student [id=" + id + ", name=" + name + "]";

}

Để làm việc với Jakarta Persistence, chúng ta cần có một tập tin cấu hình persistence.xml cho nó. Các bạn hãy tạo mới tập tin persistence.xml nằm trong thư mục /src/main/resources/META-INF, các bạn nhé!

Nội dung của tập tin này như sau:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<persistence xmlns="http://xmlns.jcp.org/xml/ns/persistence"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/persistence http://xmlns.jcp.org/xml/ns/persistence/persistence_3_2.xsd"
  version="3.2">

  <persistence-unit name="springPU">
    <class>com.huongdanjava.spring.Student</class>

    <provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>

    <properties>
      <property name="jakarta.persistence.jdbc.driver" value="com.mysql.cj.jdbc.Driver"/>
      <property name="jakarta.persistence.jdbc.url" value="jdbc:mysql://localhost:3307/example"/>
      <property name="jakarta.persistence.jdbc.user" value="root"/>
      <property name="jakarta.persistence.jdbc.password" value="123456"/>
    </properties>
  </persistence-unit>
</persistence>

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<persistence xmlns="http://xmlns.jcp.org/xml/ns/persistence"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/persistence http://xmlns.jcp.org/xml/ns/persistence/persistence_3_2.xsd"

version="3.2">

<persistence-unit name="springPU">

<class>com.huongdanjava.spring.Student</class>

<provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>

</properties>

</persistence-unit>

</persistence>

Các bạn có thể xem thêm về tập tin persistence.xml ở đây.

Bây giờ sẽ là phần quan trọng nhất: khai báo đối tượng EntityManagerFactory trong Spring container.

Trong Spring, hiện tại chúng ta có hai class hỗ trợ cho việc khai báo đối tượng EntityManagerFactory đó là:

LocalContainerEntityManagerFactoryBean
LocalEntityManagerFactoryBean

Với class LocalEntityManagerFactoryBean thì tập tin cấu hình của Jakarta Persistence, persistence.xml, thường nằm trong thư mục /src/main/resources/META-INF. Với class LocalContainerEntityManagerFactoryBean thì location của tập tin persistence.xml sẽ linh hoạt hơn. Chúng ta có thể override lại location của nó và việc sử dụng LocalContainerEntityManagerFactoryBean sẽ giúp các bạn có thể khai báo JDBC DataSource linh hoạt hơn nữa.

Các bạn có thể xem thêm bảng so sánh giữa 2 class này như sau:

	LocalEntityManagerFactoryBean	LocalContainerEntityManagerFactoryBean
`persistence.xml`	Required	Supported
Spring `DataSource`	No	Yes
Spring transaction integration	Limited	Full
Advanced configuration	Limited	Yes
Typical use	Simple standalone/test	Spring applications

Mình sẽ tạo mới tập tin spring.xml ở thư mục /src/main/resources để cấu hình cho Spring.

Mình sẽ sử dụng LocalContainerEntityManagerFactoryBean trong ví dụ này với khai báo ban đầu cho nó trong Spring container như sau:

<bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
</bean>

1 2	<bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean"> </bean>

Với khai báo này thì Spring sẽ sử dụng tất cả các cấu hình được khai báo trong tập tin persistence.xml ở thư mục mặc định là /src/main/resources/META-INF, để khởi tạo đối tượng EntityManagerFactory trong Spring container đó các bạn.

Bây giờ thì các bạn có thể lấy bean của đối tượng EntityManagerFactory trong Spring container để chạy ứng dụng như sau:

package com.huongdanjava.spring;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import jakarta.persistence.EntityManager;
import jakarta.persistence.EntityManagerFactory;

public class Application {

  public static void main(String[] args) {
    ApplicationContext ac = new ClassPathXmlApplicationContext("spring.xml");
    EntityManagerFactory emf = (EntityManagerFactory) ac.getBean("entityManagerFactory");
    EntityManager em = emf.createEntityManager();

    Student student = em.find(Student.class, Long.valueOf(1));
    System.out.println(student.getName());
  }
}

package com.huongdanjava.spring;

import org.springframework.context.ApplicationContext;

import org.springframework.context.support.ClassPathXmlApplicationContext;

import jakarta.persistence.EntityManager;

import jakarta.persistence.EntityManagerFactory;

public class Application {

public static void main(String[] args) {

ApplicationContext ac = new ClassPathXmlApplicationContext("spring.xml");

EntityManagerFactory emf = (EntityManagerFactory) ac.getBean("entityManagerFactory");

EntityManager em = emf.createEntityManager();

Student student = em.find(Student.class, Long.valueOf(1));

System.out.println(student.getName());

}

Kết quả:

Sử dụng class LocalContainerEntityManagerFactory thì các bạn có thể khai báo tất cả các thông tin được định nghĩa trong tập tin persistence.xml như sau:

<bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
  <property name="packagesToScan" value="com.huongdanjava.spring"/>
  <property name="dataSource" ref="dataSource"/>
  <property name="persistenceUnitName" value="springPU"/>
  <property name="jpaVendorAdapter">
    <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter"/>
  </property>
</bean>

</property>

</bean>

Như các bạn thấy, có 4 thuộc tính mà chúng ta có thể khai báo cùng với class LocalContainerEntityManagerFactory đó là:

packagesToScan: thuộc tính này định nghĩa tên của Java package chứa thông tin của các entity trong Jakarta Persistence đó các bạn.
dataSource: thuộc tính này dùng để khai báo DataSource cho EntityManagerFactory của chúng ta. DataSource ở đây, các bạn có thể hiểu nôm na là phần quản lý kết nối tới database. Chúng ta có thể khai báo nhiều loại DataSource khác nhau do nhiều tổ chức khác nhau implement interface javax.sql.DataSource.
persistenceUnitName: đây là tên của Persistence Unit mà chúng ta đã khai báo trong tập tin cấu hình của Jakarta Persistence, persistence.xml. Sử dụng Spring Framework thì các bạn cũng có thể không cần khai báo tên của Persistence Unit, các bạn nhé.
jpaVendorAdapter: thuộc tính này dùng để khai báo Persistence provider mà chúng ta sẽ sử dụng cho phần implementation của Jakarta Persistence. Trong ví dụ này, mình sử dụng Hibernate nên khai báo là HibernateJpaVendorAdapter. Nếu các bạn sử dụng EclipseLink làm implementation của Jakarta Persistence thì hãy khai báo thuộc tính này là org.springframework.orm.jpa.vendor.EclipseLinkJpaVendorAdapter.

Phần dataSource trong ví dụ này mình sẽ sử dụng DriverManagerDataSource với các khai báo như chúng ta làm cho JDBC, như sau:

<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
  <property name="driverClassName" value="com.mysql.cj.jdbc.Driver" />
  <property name="url" value="jdbc:mysql://localhost:3307/example" />
  <property name="username" value="root" />
  <property name="password" value="123456" />
</bean>

</bean>

Nếu các bạn sử dụng Jakarta Persistence với Spring Framework thì phần khai báo các thuộc tính cho bean LocalContainerEntityManagerFactory sẽ có độ ưu tiên cao hơn so với trong tập tin persistence.xml, các bạn nhé.

Sau khi đã định nghĩa hết thông tin với class LocalContainerEntityManagerFactory thì các bạn cũng có thể remove tập tin persistence.xml luôn cũng được. Bây giờ thì tất cả các thông tin liên quan đến Jakarta Persistence đã được quản lý bởi Spring Framework rồi.

Chạy lại ví dụ thì các bạn cũng sẽ thấy kết quả như trên.

6 thoughts on “Sử dụng Jakarta Persistence (JPA) với Spring Framework”

độ

24 Tháng 5, 2019 at 5:14 chiều

anh có fb hay gì ko ạ cho em xin em hỏi chút vấn đề ạ
1. Khanh Nguyen
  
  24 Tháng 5, 2019 at 8:41 chiều
  
  Hỏi ở đây nè em https://www.facebook.com/groups/721409674679531/?ref=bookmarks
Hung Pham

4 Tháng 1, 2019 at 2:49 chiều

Bạn cho mình hỏi là khi khai báo :

Nhưng khi dùng :
EntityManagerFactory emf = (EntityManagerFactory) ac.getBean(“entityManagerFactory”);

Mình xem thì ko thấy mối liên hệ nào giữa LocalContainerEntityManagerFactoryBean và EntityManagerFactory.

làm sao để spring hiểu được như vậy? Thanks!
1. Khanh Nguyen
  
  4 Tháng 1, 2019 at 5:50 chiều
  
  Bạn xem như thế nào thế?
thuong_java

11 Tháng 7, 2018 at 1:10 chiều

anh xem giúp e lỗi này là gì ạ
Error creating bean with name ‘studentDaoImpl’: Injection of persistence dependencies failed; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name ‘entityManagerFactory’
1. Khanh Nguyen
  
  12 Tháng 7, 2018 at 1:53 sáng
  
  File cấu hình Spring của bạn như thế nào nhỉ?

Khanh Nguyen

Share this post

Tags

Sử dụng Jakarta Persistence (JPA) với Spring Framework

6 thoughts on “Sử dụng Jakarta Persistence (JPA) với Spring Framework”

Add Comment Hủy

Khanh Nguyen

Share this post

Tags

You might also like...

Làm thế nào để integrate Jakarta Persistence với Spring Framework

JPQL là gì? So sánh SQL và JPQL | Giới thiệu về Jakarta Persistence Query Language

JPA là gì? Tìm hiểu về Jakarta Persistence, ORM và Hibernate

Spring 7 BeanRegistrar Explained: Register Beans Programmatically

6 thoughts on “Sử dụng Jakarta Persistence (JPA) với Spring Framework”

Add Comment Hủy