콘텐츠로 이동

API 레퍼런스 (Javadoc)

매 릴리즈는 core 아티팩트와 옵션 reactive 아티팩트 둘 다에 대한 javadoc.jar를 게시합니다. 두 가지 방법으로 읽을 수 있습니다.

온라인 (javadoc.io)

javadoc.io는 Maven Central의 모든 아티팩트에 대한 Javadoc을 자동으로 미러링합니다 — 별도 설정 불필요.

Core (easy-paging-spring-boot-starter):

Reactive (easy-paging-spring-boot-starter-reactive, 0.4.0부터):

새 버전을 처음 방문할 때는 javadoc.io가 Maven Central에서 jar를 가져오느라 약간 느리지만, 이후 방문부터는 캐시되어 빠릅니다.

IDE 안에서

의존성을 추가하면 IntelliJ IDEA, Eclipse, VS Code (Java 확장) 가 Maven Central에서 javadoc.jar를 자동으로 가져옵니다. @AutoPaginate, @KeysetPaginate, PageResponse, KeysetPage 같은 타입 위에 마우스를 올리면 Javadoc 툴팁이 보입니다.

IDE에서 안 보이면 의존성 새로고침:

./gradlew dependencies --refresh-dependencies

mvn dependency:resolve -Dclassifier=javadoc

주요 진입점

API를 읽기 시작할 때 좋은 지도:

클래스 역할
@AutoPaginate Offset 페이지네이션용 컨트롤러 어노테이션
@KeysetPaginate 커서 페이지네이션용 컨트롤러 어노테이션
PageResponse Offset 응답 봉투
KeysetPage Keyset 응답 봉투
KeysetRequest Keyset 요청에서 해결된 커서 + 페이지 크기
CursorCodec Keyset 커서 인코딩/디코딩 (HMAC-SHA256 서명)
PageResponseFactory 기본 응답 봉투를 교체하는 SPI
ReactivePagingSupport 블로킹 MyBatis 호출용 Reactor 헬퍼 (core 아티팩트)
EasyPagingProperties 모든 easy-paging.* 설정 키

옵션 reactive 아티팩트 (easy-paging-spring-boot-starter-reactive):

클래스 역할
R2dbcOffsetPagingSupport R2DBC offset/limit 페이지네이션 → Mono<PageResponse<T>>
R2dbcKeysetSupport R2DBC keyset/커서 페이지네이션 — 사전순(lexicographic) WHERE 빌더 + 헬퍼
ReactiveKeysetRequestArgumentResolver WebFlux KeysetRequest 인자 리졸버 (자동 등록)