Hung Nguyen 🧠🌳

Search

SearchSearch

Spring Data Integration

Apr 20, 20249 min read

Tổng hợp về Spring Data

Mục tiêu của Spring Data Repository là giảm đáng kể số lượng mã mẫu cần thiết để truy cập các kho lưu trữ dữ liệu.

Khái niệm cốt lõi

Repository là interface cốt lõi của Spring Data. Interface này chủ yếu được sử dụng như một interface đánh dấu, để nắm bắt các loại sẽ sử dụng và giúp bạn phát hiện các interface kế thừa từ interface này. CrudRepository và ListCrudRepository cung cấp chức năng CRUD phức tạp cho các lớp thực thể được quản lý. ListCrudRepository cung cấp các phương thức tương đương nhưng chúng trả về List, trong khi các phương thức CrudRepository trả về Iterable.

Định nghĩa interface CrudRepository:

public interface CrudRepository<T, ID> extends Repository<T, ID> {
 
  <S extends T> S save(S entity);
 
  Optional<T> findById(ID primaryKey);
 
  Iterable<T> findAll();
 
  long count();
 
  void delete(T entity);
 
  boolean existsById(ID primaryKey);
 
  // … more functionality omitted.
}

Các dự án Spring Data cũng cung cấp một số abstract interface cho các công nghệ lưu trữ cụ thể, như: JpaRepository hoặc MongoRepository. Những interface này kế thừa CrudRepository và tiết lộ một số chức năng cơ bản của công nghệ lưu trữ.

Ngoài CrudRepository, còn có một interface PagingAndSortingRepository mà thêm vào các phương thức bổ sung để đơn giản hóa việc truy cập phân trang đến các thực thể:

public interface PagingAndSortingRepository<T, ID>  {
 
  Iterable<T> findAll(Sort sort);
 
  Page<T> findAll(Pageable pageable);
}

【Ví dụ】Để truy cập trang thứ hai của User với kích thước trang là 20, bạn có thể thực hiện như sau:

PagingAndSortingRepository<User, Long> repository = // … get access to a bean
Page<User> users = repository.findAll(PageRequest.of(1, 20));

Ngoài các phương thức truy vấn, truy vấn cũng có sẵn khi đếm và xóa.

【Ví dụ】Đếm theo họ

interface UserRepository extends CrudRepository<User, Long> {
  long countByLastname(String lastname);
}

【Ví dụ】Xóa theo họ

interface UserRepository extends CrudRepository<User, Long> {
 
  long deleteByLastname(String lastname);
 
  List<User> removeByLastname(String lastname);
}

Phương thức truy vấn

Để truy vấn cơ sở dữ liệu bằng Spring Data, bạn cần thực hiện bốn bước sau:

  1. Khai báo một interface kế thừa Repository hoặc một interface con của nó và chỉ định kiểu dữ liệu chung (lớp thực thể và kiểu ID), như ví dụ dưới đây:

    interface PersonRepository extends Repository<Person, Long> { … }

  2. Trong interface, khai báo các phương thức truy vấn

    interface PersonRepository extends Repository<Person, Long> {
  List<Person> findByLastname(String lastname);
}

  3. Sử dụng JavaConfig hoặc Cấu hình XML để tạo các đối tượng proxy cho các interface này

    @EnableJpaRepositories
class Config { … }

  4. Tiêm vào đối tượng Repository và sử dụng nó

    class SomeClient {
 
  private final PersonRepository repository;
 
  SomeClient(PersonRepository repository) {
    this.repository = repository;
  }
 
  void doSomething() {
    List<Person> persons = repository.findByLastname("Matthews");
  }
}

Định nghĩa Repository

Đầu tiên, bạn cần định nghĩa một interface Repository, interface này phải kế thừa từ Repository và chỉ định các kiểu dữ liệu chung (lớp thực thể và kiểu ID). Nếu bạn muốn tiếp cận các phương thức CRUD cho thực thể này, bạn có thể kế thừa interface CrudRepository.

Tinh chỉnh định nghĩa Repository

Spring Data cung cấp nhiều loại Repository để đáp ứng các tình huống yêu cầu khác nhau.

CrudRepository cung cấp các chức năng CRUD.

ListCrudRepository tương tự như CrudRepository, nhưng các phương thức trả về một List thay vì Iterable để sử dụng dễ dàng hơn.

Nếu bạn sử dụng framework phản ứng, bạn có thể sử dụng ReactiveCrudRepository hoặc RxJava3CrudRepository.

CoroutineCrudRepository hỗ trợ tính năng coroutine của Kotlin.

PagingAndSortingRepository cung cấp chức năng phân trang và sắp xếp.

Nếu bạn không muốn kế thừa các interface Spring Data, bạn có thể sử dụng annotation @RepositoryDefinition trên interface Repository của bạn. Khi làm như vậy, bạn có thể thay đổi kiểu trả về của các phương thức. Nếu có thể, Spring Data sẽ tuân thủ kiểu trả về. Ví dụ, đối với các phương thức trả về nhiều thực thể, bạn có thể chọn Iterable<T>, List<T>, Collection<T> hoặc danh sách VAVR.

Khi tạo một interface Repository tùy chỉnh, bạn phải đánh dấu nó với @NoRepositoryBean. Điều này ngăn Spring Data cố gắng tạo một phiên bản của nó và thất bại vì nó không thể xác định thực thể của Repository vì nó vẫn chứa một biến kiểu chung.

Dưới đây là ví dụ về cách chọn lọc các phương thức CRUD (trong trường hợp này là findById và save):

@NoRepositoryBean
interface MyBaseRepository<T, ID> extends Repository<T, ID> {
 
  Optional<T> findById(ID id);
 
  <S extends T> S save(S entity);
}
 
interface UserRepository extends MyBaseRepository<User, Long> {
  User findByEmailAddress(EmailAddress emailAddress);
}

Sử dụng nhiều module Spring Data

Đôi khi, trong chương trình cần sử dụng nhiều module Spring Data. Trong trường hợp này, cần phải phân biệt công nghệ lưu trữ. Khi phát hiện nhiều Repository Factory trên đường dẫn lớp, Spring Data chuyển sang chế độ cấu hình nghiêm ngặt.

Nếu Repository được định nghĩa kế thừa từ Repository trong một module cụ thể, nó sẽ là ứng cử viên hợp lệ cho module Spring Data cụ thể đó.

Nếu lớp thực thể sử dụng annotation loại cụ thể của module, nó sẽ là ứng cử viên hợp lệ cho module Spring Data cụ thể đó. module Spring Data chấp nhận annotation bên thứ ba (ví dụ: @Entity của JPA) hoặc cung cấp annotation riêng (ví dụ: @Document cho Spring Data MongoDB và Spring Data Elasticsearch).

Ví dụ dưới đây cho thấy một Repository sử dụng interface cụ thể cho module JPA:

interface MyRepository extends JpaRepository<User, Long> { }
 
@NoRepositoryBean
interface MyBaseRepository<T, ID> extends JpaRepository<T, ID> { … }
 
interface UserRepository extends MyBaseRepository<User, Long> { … }

MyRepository và UserRepository kế thừa JpaRepository. Chúng là ứng cử viên hợp lệ cho module Spring Data JPA.

Ví dụ dưới đây cho thấy một Repository sử dụng interface chung:

interface AmbiguousRepository extends Repository<User, Long> { … }
 
@NoRepositoryBean
interface MyBaseRepository<T, ID> extends CrudRepository<T, ID> { … }
 
interface AmbiguousUserRepository extends MyBaseRepository<User, Long> { … }

AmbiguousRepository và AmbiguousUserRepository chỉ kế thừa Repository và CrudRepository. Mặc dù điều này tốt khi chỉ sử dụng một module Spring Data duy nhất, nhưng khi có nhiều module, không thể phân biệt được Repository này nên liên kết với module Spring Data cụ thể nào.

Ví dụ dưới đây cho thấy một Repository sử dụng lớp thực thể được annotation:

interface PersonRepository extends Repository<Person, Long> { … }
 
@Entity
class Person { … }
 
interface UserRepository extends Repository<User, Long> { … }
 
@Document
class User { … }

PersonRepository tham chiếu đến Person, nó được đánh dấu bằng annotation @Entity của JPA, do đó Repository này rõ ràng thuộc về Spring Data JPA. UserRepository tham chiếu đến User, nó được đánh dấu bằng annotation @Document của Spring Data MongoDB.

Ví dụ lỗi dưới đây cho thấy một Repository sử dụng lớp thực thể có annotation kết hợp:

interface JpaPersonRepository extends Repository<Person, Long> { … }
 
interface MongoDBPersonRepository extends Repository<Person, Long> { … }
 
@Entity
@Document
class Person { … }

Trong ví dụ này, lớp thực thể sử dụng annotation của cả JPA và Spring Data MongoDB. Đã định nghĩa hai Repository: JpaPersonRepository và MongoDBPersonRepository. Một cái cho JPA và một cái cho MongoDB. Spring Data không còn có thể phân biệt được Repository, điều này dẫn đến hành vi không xác định.

Phương pháp phân biệt Repository cuối cùng là xác định phạm vi quét gói của Repository.

@EnableJpaRepositories(basePackages = "com.acme.repositories.jpa")
@EnableMongoRepositories(basePackages = "com.acme.repositories.mongo")
class Configuration { … }

Định nghĩa các phương thức truy vấn

Repository proxy có hai phương thức để tạo ra các truy vấn cụ thể cho lưu trữ từ tên phương thức:

  • Tạo truy vấn trực tiếp từ tên phương thức.
  • Sử dụng truy vấn được định nghĩa thủ công.

Các tùy chọn có sẵn phụ thuộc vào lưu trữ thực tế. Tuy nhiên, phải có một chiến lược để quyết định tạo ra truy vấn thực tế nào.

Chiến lược truy vấn

Các chiến lược sau có sẵn cho cơ sở hạ tầng Repository để giải quyết các truy vấn. Trong Java configuration, bạn có thể sử dụng thuộc tính queryLookupStrategy của annotation EnableJpaRepositories. Một số cơ sở dữ liệu cụ thể có thể không hỗ trợ một số chiến lược.

  • CREATE: Cố gắng tạo truy vấn cụ thể cho lưu trữ từ tên phương thức.
  • USE_DECLARED_QUERY: Cố gắng tìm kiếm truy vấn đã được khai báo, nếu không tìm thấy sẽ ném ra ngoại lệ.
  • CREATE_IF_NOT_FOUND (mặc định): Kết hợp CREATE và USE_DECLARED_QUERY.

Tạo truy vấn

Spring Data có một cơ chế xây dựng truy vấn tích hợp sẵn, có thể tự động ánh xạ các phương thức phù hợp với các quy tắc về tên và tham số.

interface PersonRepository extends Repository<Person, Long> {
 
  List<Person> findByEmailAddressAndLastname(EmailAddress emailAddress, String lastname);
 
  // Kích hoạt cờ distinct cho truy vấn
  List<Person> findDistinctPeopleByLastnameOrFirstname(String lastname, String firstname);
  List<Person> findPeopleDistinctByLastnameOrFirstname(String lastname, String firstname);
 
  // Kích hoạt bỏ qua việc phân biệt chữ hoa chữ thường cho một thuộc tính cụ thể
  List<Person> findByLastnameIgnoreCase(String lastname);
  // Kích hoạt bỏ qua việc phân biệt chữ hoa chữ thường cho tất cả các thuộc tính phù hợp
  List<Person> findByLastnameAndFirstnameAllIgnoreCase(String lastname, String firstname);
 
  // Kích hoạt ORDER BY tĩnh cho một truy vấn
  List<Person> findByLastnameOrderByFirstnameAsc(String lastname);
  List<Person> findByLastnameOrderByFirstnameDesc(String lastname);
}

Phân tích tên phương thức truy vấn thành chủ ngữ và vị ngữ. Phần đầu tiên (find…By, exists…By) xác định chủ ngữ của truy vấn, phần thứ hai tạo thành vị ngữ. Chủ ngữ có thể chứa các biểu thức kế thừa hơn. Bất kỳ văn bản nào giữa find (hoặc từ khóa giới thiệu khác) và By được coi là mô tả, trừ khi sử dụng một trong các từ khóa giới hạn kết quả như Distinct để đặt cờ khác nhau trên truy vấn được tạo ra hoặc Top/First để giới hạn kết quả truy vấn.

Tham khảo:

Các từ khóa chủ ngữ truy vấn được hỗ trợ bởi Spring Data

Các từ khóa vị ngữ truy vấn được hỗ trợ bởi Spring Data

Tạo các phiên bản Repository

Tự định nghĩa triển khai Repository

Kế thừa Spring Data

Graph View

Backlinks