Query phân trang bằng Pageable

Trong phần lớn ứng dụng, chúng ta thường không lấy toàn bộ dữ liệu từ cơ sở dữ liệu, mà chỉ cần một phần nhất định và chia thành từng trang. Điều này giúp tiết kiệm băng thông, tăng hiệu suất và giảm dữ liệu không cần thiết. Trong bài viết này, chúng ta sẽ tìm hiểu cách thực hiện phân trang dữ liệu bằng Spring JPA sử dụng Pageable.

Trước tiên, hãy đảm bảo rằng bạn đã thêm dependency spring-boot-starter-data-jpa vào tệp pom.xml của dự án Spring Boot của bạn. Dưới đây là một phần của tệp pom.xml:

<!-- Thêm dependency spring-boot-starter-data-jpa -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

Trong ví dụ này, chúng tôi sử dụng cơ sở dữ liệu H2 để minh họa. H2 là cơ sở dữ liệu trong bộ nhớ, dữ liệu sẽ tồn tại trong bộ nhớ RAM và sẽ bị xóa khi ứng dụng tắt.

Tạo Model và Repository

Đầu tiên, chúng ta sẽ tạo một đối tượng model đơn giản, ví dụ là "User", và sau đó chúng ta sẽ thêm một số dữ liệu mẫu vào cơ sở dữ liệu.

Model "User"

@Entity
@Data
@Builder
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;
}

Repository "UserRepository"

public interface UserRepository extends JpaRepository<User, Long> {
}

DatasourceConfig

Chúng ta cũng cần một lớp cấu hình để chèn dữ liệu mẫu vào cơ sở dữ liệu. Dưới đây là một ví dụ:

@Configuration
@RequiredArgsConstructor
public class DatasourceConfig {
    private final UserRepository userRepository;

    @PostConstruct
    public void initData() {
        // Chèn 100 User vào cơ sở dữ liệu
        userRepository.saveAll(
            IntStream.range(0, 100)
                .mapToObj(i -> User.builder()
                                   .name("name-" + i)
                                   .build())
                .collect(Collectors.toList())
        );
    }
}

Sử dụng Pageable

Để truy vấn dữ liệu dưới dạng trang, chúng ta sử dụng Pageable. Hàm findAll(Pageable pageable) sẽ trả về một đối tượng Page chứa dữ liệu của trang cụ thể.

Dưới đây là cách lấy ra 5 bản ghi đầu tiên:

Page<User> page = userRepository.findAll(PageRequest.of(0, 5));

Để lấy ra 5 bản ghi tiếp theo, bạn có thể sử dụng một trong các cách sau:

// Sử dụng đối tượng Page trước đó
page.nextPageable()

// Sử dụng PageRequest mới
PageRequest.of(1, 5)

Sắp xếp dữ liệu

Bạn có thể yêu cầu dữ liệu được sắp xếp theo một trường cụ thể bằng cách sử dụng Sort:

Page<User> page = userRepository.findAll(PageRequest.of(1, 5, Sort.by("name").descending()));

Tùy chỉnh Query

Ngoài ra, bạn có thể tùy chỉnh các truy vấn để trả về danh sách theo yêu cầu của mình. Ví dụ, dưới đây là một ví dụ về tạo một phương thức tùy chỉnh trong UserRepository để lấy danh sách User theo tên:

public interface UserRepository extends JpaRepository<User, Long> {
    List<User> findAllByNameLike(String name, Pageable pageable);
}

Ví dụ DEMO

Dưới đây là ví dụ hoàn chỉnh về cách sử dụng Pageable và các phương thức tương ứng:

@SpringBootApplication
@RequiredArgsConstructor
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }

    private final UserRepository userRepository;

    @Bean
    CommandLineRunner run() {
        return args -> {
            // Lấy ra 5 User đầu tiên
            Page<User> page = userRepository.findAll(PageRequest.of(0, 5));
            System.out.println("In ra 5 User đầu tiên: ");
            page.forEach(System.out!!!println);

            // Lấy ra 5 User tiếp theo
            page = userRepository.findAll(page.nextPageable());
            System.out.println("In ra 5 User tiếp theo: ");
            page.forEach(System.out!!!println);

            // In ra số lượng User ở page hiện tại
            System.out.println("In ra số lượng User ở page hiện tại: " + page.getSize());

            // In ra tổng số lượng User
            System.out.println("In ra tổng số lượng User: " + page.getTotalElements());

            // In ra tổng số page
            System.out.println("In ra tổng số page: " + page.getTotalPages());

            // Lấy ra 5 User ở page 1, sắp xếp theo tên giảm dần


            page = userRepository.findAll(PageRequest.of(1, 5, Sort.by("name").descending()));
            System.out.println("In ra 5 User ở page 1, sắp xếp theo tên giảm dần:");
            page.forEach(System.out!!!println);

            // Sử dụng phương thức tùy chỉnh
            List<User> list = userRepository.findAllByNameLike("name-%", PageRequest.of(0, 5));
            System.out.println(list);
        };
    }
}

Kết quả thực hiện các truy vấn sử dụng Pageable và tùy chỉnh query: