DEV Community

Cover image for Spring Boot Pagination & Filter example
bezkoder
bezkoder

Posted on

Spring Boot Pagination & Filter example

In this tutorial, I will continue to make Server side Pagination and Filter with Spring Data JPA and Pageable.

Full Article: https://bezkoder.com/spring-boot-pagination-filter-jpa-pageable/

For MongoDB database:
Spring Boot MongoDB Pagination & Filter example with Spring Data

Spring Boot Pagination & Filter example overview

One of the most important things to make a website friendly is the response time, and pagination comes for this reason. For example, this bezkoder.com website has hundreds of tutorials, and we don't want to see all of them at once. Paging means displaying a small number of all, by a page.

Assume that we have tutorials table in database like this:

spring-boot-pagination-filter-example-spring-jpa-pageable-table

Here are some url samples for pagination (with/without filter):

  • /api/tutorials?page=1&size=5
  • /api/tutorials?size=5: using default value for page
  • /api/tutorials?title=data&page=1&size=3: pagination & filter by title containing 'data'
  • /api/tutorials/published?page=2: pagination & filter by 'published' status

This is structure of the Server side pagination result that we want to get from the APIs:

{
    "totalItems": 8,
    "tutorials": [...],
    "totalPages": 3,
    "currentPage": 1
}
Enter fullscreen mode Exit fullscreen mode

Read Tutorials with default page index (0) and page size (3):

spring-boot-pagination-filter-example-spring-jpa-pageable-default

Indicate page index = 2 but not specify size (default: 3) for total 8 items:

  • page_0: 3 items
  • page_1: 3 items
  • page_2: 2 items

spring-boot-pagination-filter-example-spring-jpa-pageable-page

Indicate size = 5 but not specify page index (default: 0):

spring-boot-pagination-filter-example-spring-jpa-pageable-size

For page index = 1 and page size = 5 (in total 8 items):

spring-boot-pagination-filter-example-spring-jpa-pageable-page-size

Pagination and filter by title that contains a string:

spring-boot-pagination-filter-example-spring-jpa-pageable-title

Pagination and filter by published status:

spring-boot-pagination-filter-example-spring-jpa-pageable-status

For more details, implementation and source code, please visit:
https://bezkoder.com/spring-boot-pagination-filter-jpa-pageable/

Further Reading

To bring pagination and sorting together, please visit:
Spring Boot Pagination and Sorting example

Handle Exception for this Rest APIs is necessary:
Spring Boot @ControllerAdvice & @ExceptionHandler example

You can also know how to deploy this Spring Boot App on AWS (for free) with this tutorial.

React Pagination Client that works with this Server:
React Pagination with API using Material-UI

Alt Text

Angular Client working with this server:

Or Vue Client:

Happy learning! See you again.

Top comments (0)