Spring boot PAGINATION example

Return to site

Spring boot PAGINATION example

· java

Sometimes, your JPA query returns a lot of results.

To handle such amount of data, you should use pagination.

And thanksfully, JPA provides an API for such needs.

1️⃣ 𝐓𝐡𝐞 𝐫𝐞𝐩𝐨𝐬𝐢𝐭𝐨𝐫𝐲 💾 👇👇👇

@Repository
public interface EmployeeRepository 
    extends 𝐏𝐚𝐠𝐢𝐧𝐠𝐀𝐧𝐝𝐒𝐨𝐫𝐭𝐢𝐧𝐠𝐑𝐞𝐩𝐨𝐬𝐢𝐭𝐨𝐫𝐲<EmployeeEntity, Long> {
 }

2️⃣ 𝐓𝐡𝐞 𝐬𝐞𝐫𝐯𝐢𝐜𝐞 👨‍🔧 👇👇👇

@Service
public class EmployeeService 
{
  @Autowired
  EmployeeRepository 𝐫𝐞𝐩𝐨𝐬𝐢𝐭𝐨𝐫𝐲;
   
  public List<EmployeeEntity> getAllEmployees(Integer pageNo, Integer pageSize, String sortBy)
  {
    𝐏𝐚𝐠𝐞𝐚𝐛𝐥𝐞 𝐩𝐚𝐠𝐢𝐧𝐠 = 𝐏𝐚𝐠𝐞𝐑𝐞𝐪𝐮𝐞𝐬𝐭.𝐨𝐟(𝐩𝐚𝐠𝐞𝐍𝐨, 𝐩𝐚𝐠𝐞𝐒𝐢𝐳𝐞, 𝐒𝐨𝐫𝐭.𝐛𝐲(𝐬𝐨𝐫𝐭𝐁𝐲));
 
    Page<EmployeeEntity> pagedResult = 𝐫𝐞𝐩𝐨𝐬𝐢𝐭𝐨𝐫𝐲.findAll(paging);
     
    if(pagedResult.hasContent()) {
      return pagedResult.getContent();
    } else {
      return new ArrayList<EmployeeEntity>();
    }
  }
}

3️⃣ 𝐓𝐡𝐞 𝐜𝐨𝐧𝐭𝐫𝐨𝐥𝐥𝐞𝐫 👮‍♂️ 👇👇👇

@RestController
@RequestMapping("/employees")
public class EmployeeController 
{
  @Autowired
  EmployeeService 𝐬𝐞𝐫𝐯𝐢𝐜𝐞;
 
  @GetMapping
  public ResponseEntity<List<EmployeeEntity>> getAllEmployees(
            @RequestParam(defaultValue = "0") Integer pageNo, 
            @RequestParam(defaultValue = "10") Integer pageSize,
            @RequestParam(defaultValue = "id") String sortBy) 
  {
    List<EmployeeEntity> list = 𝐬𝐞𝐫𝐯𝐢𝐜𝐞.getAllEmployees(pageNo, pageSize, sortBy);
 
    return new ResponseEntity<List<EmployeeEntity>>(list, new HttpHeaders(), HttpStatus.OK); 
  }
}

Details 🔎