Spring Data jpa: Get paginated results

'PagingAndSortingRepository' interface provides 'findAll' method, it return a Page of entities meeting the paging restriction provided in the Pageable object.

Example

Sort sort = new Sort(Direction.ASC, Arrays.asList("age","firstName"));

int pageIndex = 0;

int size = 2;

PageRequest pageRequest = PageRequest.of(pageIndex, size, sort);

Page<Employee> empsPage = employeeRepository.findAll(pageRequest);

Above snipper get first 2 results using the given sorted order. If you set 'pageIndex' to 0, then it represents 1st page, pageIndex=1 represent 2nd page and soon.

Find the below working application.

Employee.java

package com.sample.app.model;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

@Entity
@Table(name = "my_employee")
public class Employee {
  @Id
  @GeneratedValue(strategy = GenerationType.AUTO)
  private int id;

  @Column(name = "first_name")
  private String firstName;

  @Column(name = "last_name")
  private String lastName;

  @Column(name = "age")
  private int age;

  @Column(name = "salary")
  private double salary;


  public int getId() {
    return id;
  }

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

  public String getFirstName() {
    return firstName;
  }

  public void setFirstName(String firstName) {
    this.firstName = firstName;
  }

  public String getLastName() {
    return lastName;
  }

  public void setLastName(String lastName) {
    this.lastName = lastName;
  }

  public int getAge() {
    return age;
  }

  public void setAge(int age) {
    this.age = age;
  }

  public double getSalary() {
    return salary;
  }

  public void setSalary(double salary) {
    this.salary = salary;
  }

  public static EmployeeBuilder builder() {
    return new EmployeeBuilder();
  }


  public static class EmployeeBuilder {
    private Employee emp;

    public EmployeeBuilder() {
      emp = new Employee();
    }

    public EmployeeBuilder firstName(String firstName) {
      emp.setFirstName(firstName);
      return this;
    }

    public EmployeeBuilder lastName(String lastName) {
      emp.setLastName(lastName);
      return this;
    }

    public EmployeeBuilder age(int age) {
      emp.setAge(age);
      return this;
    }

    public EmployeeBuilder salary(double salary) {
      emp.setSalary(salary);
      return this;
    }

    public Employee build() {
      return emp;
    }
  }

  @Override
  public String toString() {
    StringBuilder builder = new StringBuilder();
    builder.append("Employee [id=").append(id).append(", firstName=").append(firstName).append(", lastName=")
        .append(lastName).append(", age=").append(age).append(", salary=").append(salary).append("]");
    return builder.toString();
  }

}

EmployeeRepository.java

package com.sample.app.repository;


import org.springframework.data.repository.PagingAndSortingRepository;

import com.sample.app.model.Employee;

public interface EmployeeRepository extends PagingAndSortingRepository<Employee, Integer> {

}

App.java

package com.sample.app;

import java.util.Arrays;
import java.util.List;

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.data.domain.Sort.Direction;

import com.sample.app.model.Employee;
import com.sample.app.repository.EmployeeRepository;

import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Sort;
import org.springframework.data.domain.Pageable;

@SpringBootApplication
public class App {

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

  @Bean
  public CommandLineRunner demo(EmployeeRepository employeeRepository) {
    return (args) -> {
      Employee emp1 = Employee.builder().firstName("Ram").lastName("Gurram").age(32).salary(100000.23).build();
      Employee emp2 = Employee.builder().firstName("Joel").lastName("Chelli").age(43).salary(60000).build();
      Employee emp3 = Employee.builder().firstName("Gopi").lastName("Battu").age(45).salary(1000000).build();
      Employee emp4 = Employee.builder().firstName("Bomma").lastName("Srikanth").age(39).salary(60000).build();
      Employee emp5 = Employee.builder().firstName("Surendra").lastName("Sami").age(32).salary(100000.23).build();

      employeeRepository.save(emp1);
      employeeRepository.save(emp2);
      employeeRepository.save(emp3);
      employeeRepository.save(emp4);
      employeeRepository.save(emp5);
      
      Sort sort = new Sort(Direction.ASC, Arrays.asList("age","firstName"));
      int pageIndex = 0;
      int size = 2;
      
      PageRequest pageRequest = PageRequest.of(pageIndex, size, sort);
      Page<Employee> empsPage = employeeRepository.findAll(pageRequest);
      
      do {
        System.out.println("\n*********************************");
        List<Employee> emps = empsPage.getContent();
        
        for(Employee emp: emps) {
          System.out.println(emp);
        }
        
        if(!empsPage.hasNext()) {
          break;
        }
        
        Pageable pageable = empsPage.nextPageable();
        empsPage = employeeRepository.findAll(pageable);
        System.out.println("*********************************");
        
      }while(true);
      

    };
  }

}

Create ‘application.properties’ file under src/main/resources folder.

application.properties

logging.level.root=WARN
logging.level.org.hibernate=ERROR

## H2 specific properties
spring.h2.console.enabled=true
spring.h2.console.path=/h2

spring.datasource.url=jdbc:h2:file:~/db/myOrg.db;DB_CLOSE_ON_EXIT=FALSE;DB_CLOSE_DELAY=-1;

spring.datasource.username=krishna
spring.datasource.password=password123

spring.datasource.driverClassName=org.h2.Driver

## JPA specific properties
# Creates the schema, destroying previous data.
spring.jpa.hibernate.ddl-auto=create

spring.jpa.database-platform=org.hibernate.dialect.H2Dialect

#spring.jpa.show-sql=true
#spring.jpa.properties.hibernate.format_sql=true

## Database connection pooling properties
# Number of ms to wait before throwing an exception if no connection is available.
spring.datasource.max-wait=10000

# Maximum number of active connections that can be allocated from this pool at the same time.
spring.datasource.tomcat.max-active=10
spring.datasource.tomcat.max-idle=5
spring.datasource.tomcat.min-idle=3

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>springJPA</groupId>
  <artifactId>springJPA</artifactId>
  <version>1</version>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.6.RELEASE</version>
  </parent>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>



  <dependencies>


    <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-data-jpa -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>


    <!-- https://mvnrepository.com/artifact/com.h2database/h2 -->
    <dependency>
      <groupId>com.h2database</groupId>
      <artifactId>h2</artifactId>
    </dependency>


  </dependencies>

</project>

Total project structure looks like below.

Run App.java, you can see below messages in console.    

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.1.6.RELEASE)


*********************************
Employee [id=1, firstName=Ram, lastName=Gurram, age=32, salary=100000.23]
Employee [id=5, firstName=Surendra, lastName=Sami, age=32, salary=100000.23]
*********************************

*********************************
Employee [id=4, firstName=Bomma, lastName=Srikanth, age=39, salary=60000.0]
Employee [id=2, firstName=Joel, lastName=Chelli, age=43, salary=60000.0]
*********************************

*********************************
Employee [id=3, firstName=Gopi, lastName=Battu, age=45, salary=1000000.0]

You can download the complete working application from this location.

    

Previous                                                    Next                                                    Home