Cara membuat Pagination REST API di Spring Boot

Pada project-project Springboot sebelumnya, ketika melakukan Respose REST API find all untuk menampilkan semua data, biasanya kita menggunakan return Collection misalnya List. Cara ini tidak salah tapi bukan merupakan best practice apabila data yang dipanggil dalam jumlah yang banyak, misal datanya ada 1 juta, maka data tersebut akan dipanggil semua. Tentunya cara ini tidak efisien dan akan membuat aplikasi kita menjadi lambat.

Untuk mengatasi Overload Data tersebut maka kita dapat menggunakan pagination. Dengan menggunakan pagination akan memungkinkan untuk menampilkan data secara bertahap, sehingga mengurangi beban memori dan meningkatkan kinerja aplikasi.

Collection vs Pagination

• Collection

[
  {
    "id": 1,
    "name": "Iphone 16",
    "description": "The new generation Iphone",
    "price": 20000000
  },
  {
    "id": 2,
    "name": "Asus ROG",
    "description": "The best laptop for gaming",
    "price": 30000000
  }
]

• Pagination

{
  "content": [
    {
      "id": 1,
      "name": "Iphone 16",
      "description": "The new Iphone Generation",
      "price": 15000000
    },
    {
    "id": 2,
    "name": "Asus ROG",
    "description": "The best laptop for gaming",
    "price": 30000000
  }
  ],
  "page": {
    "size": 20,
    "number": 0,
    "totalElements": 2,
    "totalPages": 1
  }
}

Dengan menggunakan Collection data akan ditampilkan sesuai result dari operasi select all, sedangkan menggunakan pagination akan lebih terfilter karna data yang ditampilkan dapat dicustom jumlahnya.

Menambahkan Pagination di Aplikasi Spring Boot

Untuk menambahkan pagination pada aplikasi Spring Boot application, kita cukup melakukan masuk ke dalam layer Controller dengan menambahkan parameter dengan type Pageable.

@RestController
@RequestMapping("/api/product")
public class ProductController {

    private final ProductService productService;

    public ProductController(ProductService productService) {
        this.productService = productService;
    }

    @GetMapping
    public ResponseEntity<Page<ProductDTO>> getAll(
            @SortDefault(sort = "id") @PageableDefault(size = 20) final Pageable pageable) {
        return ResponseEntity.ok(productService.findAll(pageable));
    }

    // ...
}

Pada contoh di atas kita set default data yang ditampilkan adalah 20 dan sorting data berdasarkan id secara ascending. Parameter query dari page, size dan sort akan secara otomatis dibuat oleh Spring Boot.

Untuk layer Service akan memanggil data Page yang berasal dari Repository yang di mapping ke DTO.

@Service
public class ProductService {

    // ...

    public Page<ProductDTO> findAll(final Pageable pageable) {
        final Page<Product> page = productRepository.findAll(pageable);
        return new PageImpl<>(page.getContent()
                .stream()
                .map(productMapper::toDTO)
                .collect(Collectors.toList()),
                pageable, page.getTotalElements());
    }
}

Sedangkan untuk layer Repository dengan meng-extends JpaRepository, kita dapat memanggil object data dari database menggunakan findAll().

public interface ProductRepository extends JpaRepository<Product, Long> {
}

Konfigurasi menggunakan PagedModel

Namun ketika aplikasi dijalankan tanpa konfigurasi tambahan maka akan menghasilkan log warning seperti ini:

Serializing PageImpl instances as-is is not supported, meaning that there is no guarantee about the stability of the resulting JSON structure!
For a stable JSON structure, please use Spring Data's PagedModel or Spring HATEOAS and Spring Data's PagedResourcesAssembler.

Hal ini terjadi class PageImpl tidak diserialkan untuk dikembalikan menjadi REST API.

Untuk menghapus peringatan tersebut, kita hanya perlu menambahkan anotasi berikut ke salah satu class konfigurasi yang ada atau membuat class konfigurasi baru:

@Configuration
@EnableSpringDataWebSupport(
        pageSerializationMode = EnableSpringDataWebSupport.PageSerializationMode.VIA_DTO
)
public class JacsonConfig {
}

Konfigurasi di atas digunakan untuk secara otomatis mentransform PageImpl menjadi PagedModel.

🔥 Testing

Konfigurasi pada layer controller di atas kita membuat secara default menampilkan data 20, misalnya kita punya data 5 maka akan ditampilkan semua datanya:

• URL: http://localhost:8080/api/product

• Body response:

{
  "content": [
    {
      "id": 1,
      "name": "Iphone 16",
      "description": "The new Iphone Generation",
      "price": 15000000
    },
    {
      "id": 2,
      "name": "Asus ROG",
      "description": "The best laptop for gaming",
      "price": 30000000
    },
    {
      "id": 3,
      "name": "Infinix Hot 50 Pro+",
      "description": "The New Best Android Phone Low Price",
      "price": 3000000
    },
    {
      "id": 4,
      "name": "Google Pixel 9",
      "description": "The New Android Phone from Google",
      "price": 15000000
    },
    {
      "id": 5,
      "name": "Samsung Galaxy S24 FE",
      "description": "The New Android Phone from Samsung with Galaxy AI",
      "price": 10000000
    }
  ],
  "page": {
    "size": 20,
    "number": 0,
    "totalElements": 5,
    "totalPages": 1
  }
}

Informasi page secara otomatis akan digenerate oleh Page Spring Boot, seperti:

• size = jumlah data element
• number = index page (index dimulai dari 0)
• totalElements = jumlah element dalam page yang sedang aktif
• totalPages = jumlah total page

Bagaimana kalo misalnya kita ingin custom data yang ingin ditampikan, contoh setiap page hanya ingin menampilkan 2 data saja, maka dari data di atas akan dibuat 3 page.

• URL: http://localhost:8080/api/product?size=2&page=0

• Body:

{
  "content": [
    {
      "id": 1,
      "name": "Iphone 16",
      "description": "The new Iphone Generation",
      "price": 15000000
    },
    {
      "id": 2,
      "name": "Asus ROG",
      "description": "The best laptop for gaming",
      "price": 30000000
    }
  ],
  "page": {
    "size": 2,
    "number": 0,
    "totalElements": 5,
    "totalPages": 3
  }
}

info

INFO: Index page dimulai dari 0.

Untuk pindah halaman page cukup mengganti value path variable, contoh berpindah ke page 1 http://localhost:8080/api/product?size=2&page=1.

🌐 Baca Juga

• https://bootify.io/spring-boot/pagination-in-spring-boot-rest-api.html