[Spring Boot] JPA + Pageable 을 이용한 페이징 처리

작성자: -
안녕하세요. 남산돈가스 입니다.

오늘은 Spring Boot JPA를 이용하여 API 개발 시 간단하게 Pagination 와 Sorting을 처리할 수 있도록 도와주는 Pageable에 대해서 알아보려고 합니다.

웹 개발 시 Pagination 과 Sorting은 필수적이라 할 수 있지만, 실제 개별적으로 구현 시 번거로운 작업이 생기기 마련입니다. 또한 각 데이터베이스마다 페이징 쿼리가 다를 수 있다는 점에서 모든 요구조건을 만족하기 어려운 부분들이 존재하기 마련입니다.

Spring Data JPA와 Pageable을 이용하면 이런 문제들을 아주 쉽게 해결할 수 있어 비즈니스 로직에 집중할 수 있게 도와줍니다.

우선 Pageable을 사용하여 얻을 수 있는 이점은 대표적으로 두 가지 입니다.
  1. 요건에 맞는 Pagination을 구현할 수 있다.
  2. 정렬이 필요한 데이터를 쉽게 Sorting 할 수 있다.
예제를 들어 설명하겠습니다.

@Entity
@Table(name="post")
@Getter
public class Post extends Audity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name="id")
    private Long id;

    @Column(name="title")
    private String title;

    @Column(length = 2000, name="content")
    private String content;

    @Column(length = 50, name="writer")
    private String writer;
}

간단한 예제를 들기 위하여, "Post" 라는 Entity를 작성하였고, 예제를 위하여 약 20건의 데이터를 생성해두었습니다.

@Repository
public interface PostRepository extends JpaRepository<Post, Long> {
}

생성한 Post Entity를 접근하기 위하여 JpaRepository를 상속받는 PostRepository를 생성합니다.


위 다이어그램에서와 같이 생성한 PostRepository는 JpaRepository를 상속받았고, 또 JpaRepository는 PagingAndSortingRepository를 상속받은 것을 확인할 수 있습니다.
이렇게 PagingAndSortingRepository만 상속받은 Repository를 생성한다면, Pageable을 매개변수로 Pagination / Sorting 을 처리할 준비가 끝난 것 입니다.

@RestController
@RequestMapping("/posts")
public class PostController {

    @Autowired
    private PostRepository postRepository;

    @GetMapping
    public ResponseEntity retrievePosts(final Pageable pageable) {
        Page<Post> posts = postRepository.findAll(pageable);
        return new ResponseEntity<>(posts,HttpStatus.OK);
    }
}

그럼 이제, 외부에서 Post를 조회할 수 있도록 Controller를 생성합니다.
이 예제에서는 블로그 목적에 맞게 Pageable을 설명하기 위함이므로 Controller -> Repository 를 호출하는 구조로 작성하였습니다. 실제 구현 시에는 Service와 목적에 맞는 DTO를 생성하여 처리하는 것이 안전합니다.
- 파라미터 정보 없이 요청한 경우




{
    "content": [
        {
            "createdDate": "2020-03-13T07:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 1,
            "title": "1번 게시글",
            "content": "안녕하세요",
            "writer": "남산돈가스"
        },
        {
            "createdDate": "2020-03-13T08:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 2,
            "title": "2번 게시글",
            "content": "안녕하세요",
            "writer": "남산돈가스"
        },
        {
            "createdDate": "2020-03-13T09:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 3,
            "title": "3번 게시글",
            "content": "안녕하세요",
            "writer": "명동교자\n"
        },
        {
            "createdDate": "2020-03-13T10:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 4,
            "title": "4번 게시글",
            "content": "안녕하세요",
            "writer": "남산돈가스"
        },
        {
            "createdDate": "2020-03-13T11:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 5,
            "title": "5번 게시글",
            "content": "안녕하세요",
            "writer": "남산타워"
        },
        {
            "createdDate": "2020-03-13T12:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 6,
            "title": "6번 게시글",
            "content": "안녕하세요",
            "writer": "남산돈가스"
        },
        {
            "createdDate": "2020-03-13T13:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 7,
            "title": "7번 게시글",
            "content": "안녕하세요",
            "writer": "남산돈가스"
        },
        {
            "createdDate": "2020-03-13T14:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 8,
            "title": "8번 게시글",
            "content": "안녕하세요",
            "writer": "명동교자\n"
        },
        {
            "createdDate": "2020-03-13T15:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 9,
            "title": "9번 게시글",
            "content": "안녕하세요",
            "writer": "남산돈가스"
        },
        {
            "createdDate": "2020-03-13T16:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 10,
            "title": "10번 게시글",
            "content": "안녕하세요",
            "writer": "남산돈가스"
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "offset": 0,
        "pageSize": 10,
        "pageNumber": 0,
        "paged": true,
        "unpaged": false
    },
    "totalElements": 18,
    "last": false,   // 마지막 페이지 여부 
    "totalPages": 2,   // 전체 페이지 갯수 총 18건 데이터 중 10개의 요청이므로 2개 페이지 존재
    "size": 10,    // 페이지 당 출력 갯수  
    "number": 0,  
    "numberOfElements": 10,  // 요청 페이지에서 조회 된 데이터의 갯수
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "first": true,   // 첫 페이지 여부
    "empty": false
}

위 와 같이 contents 에는 실제 DB로부터 요청한 결과가 보여지며, 그 이외는 Paging 결과를 확인할 수 있는 값들이 다양하게 표현되어 있습니다. 이 값들을 가지고 공통적으로 처리되는 페이징 결과를 만들어 처리할 수 있을 것 같습니다.

그럼 이제 실제 요청 값에 페이징 정보를 전달해보겠습니다.
Controller의 매개변수인 Pageable은 Spring MVC가 요청파라미터로부터 기본 설정 된 파라미터 값이 존재하면 Pageable 객체를 생성하려고 시도합니다. 이때 기본 설정 된 파라미터는 아래와 같습니다.
  • page : 요청할 페이지 번호
  • size : 한 페이지 당 조회 할 갯수 (default : 20)
  • sort : Sorting에 대한 값 설정하는 파라미터로, 기본적으로 오름차순이다. 표기는 정렬한 필드명,정렬기준 ex) createdDate,desc
제가 사용한 예제에서는 default size를 10, sort 파라미터를 sortBy, 구분자를 '-' 로 커스터마이징하여서 사용하였습니다. pageable 를 커스터마이징하는 방법은 추후에 포스팅하도록 하겠습니다.  
- size : 3 , page = 2 로 호출한 경우

{
    "content": [
        {
            "createdDate": "2020-03-13T10:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 4,
            "title": "4번 게시글",
            "content": "안녕하세요",
            "writer": "남산돈가스"
        },
        {
            "createdDate": "2020-03-13T11:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 5,
            "title": "5번 게시글",
            "content": "안녕하세요",
            "writer": "남산타워"
        },
        {
            "createdDate": "2020-03-13T12:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 6,
            "title": "6번 게시글",
            "content": "안녕하세요",
            "writer": "남산돈가스"
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "offset": 3,
        "pageSize": 3,
        "pageNumber": 1,
        "paged": true,
        "unpaged": false
    },
    "totalElements": 18,
    "last": false,
    "totalPages": 6,
    "size": 3,
    "number": 1,
    "numberOfElements": 3,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "first": false,
    "empty": false
}


- size : 5, page :4, sorting : 생성일자 기준 내림차순 정렬


{
    "content": [
        {
            "createdDate": "2020-03-13T09:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 3,
            "title": "3번 게시글",
            "content": "안녕하세요",
            "writer": "명동교자\n"
        },
        {
            "createdDate": "2020-03-13T08:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 2,
            "title": "2번 게시글",
            "content": "안녕하세요",
            "writer": "남산돈가스"
        },
        {
            "createdDate": "2020-03-13T07:05:46",
            "updatedDate": "2020-03-13T07:05:46",
            "id": 1,
            "title": "1번 게시글",
            "content": "안녕하세요",
            "writer": "남산돈가스"
        }
    ],
    "pageable": {
        "sort": {
            "sorted": true,
            "unsorted": false,
            "empty": false
        },
        "offset": 15,
        "pageSize": 5,
        "pageNumber": 3,
        "paged": true,
        "unpaged": false
    },
    "totalElements": 18,
    "last": true,
    "totalPages": 4,
    "size": 5,
    "number": 3,
    "numberOfElements": 3,
    "sort": {
        "sorted": true,
        "unsorted": false,
        "empty": false
    },
    "first": false,
    "empty": false
}

총 18개 데이터에서 5개씩 4번째 페이지를 요청한 결과 마지막 페이지의 3개의 데이터가 조회되었으며, 정렬조건으로 생성일자 내림차순으로 요청하여 최신으로 생성 된 세개의 결과가 조회되었습니다.

결론적으로, 이렇게 Spring Data JPA와 Pageable을 유연하게 사용하시면 매번 Pagination 이나 Sorting에 대한 부담 및 고민을 쉽게 해결하실 수 있으실 것이라고 생각됩니다.

감사합니다.

댓글

댓글 쓰기

주간 인기글

[정보] 인스타그램은 당신의 소리를 '듣고' 있을 수도 있습니다

작성자: -
이미지
[그림출처]  https://medium.com/@damln/instagram-is-listening-to-you-97e8f2c53023 인스타그램은 당신의 소리를 '듣고' 있을 수도 있습니다. 문자 그대로. SNS는 사용자들이 자발적으로 공유하는 글, 사진 등의 정보를 모아서 그 데이터를 기반으로 어떤 사용자가 무엇에 관심이 있는지 파악하여 사용자들에게 가장 관심 있을 만한 광고를 보여주곤 합니다. 몇 년 전부터 페이스북은 앱의 마이크 접근 권한 을 사용하여 핸드폰 주위의 모든 대화 등의 소리를 수집.파악하여 폰 사용자가 무엇에 관심 있는지 데이터를 얻고, 타겟 맞춤 광고에 이 정보를 활용한다고 하는 의혹을 받아왔습니다. 페이스북에 인수된 인스타그램도 마찬가지로요. 저도 가끔 의아했습니다. 어떻게 내가 검색창에서 검색한 적도 없고, 사진도 찍은 적 없고, 글로 쓴 적도 없는 어떤 것에 대해서 인스타그램이 나에게, 그것에 관해 얘기한 지 10분 만에 정확히 그와 관련된 상품을 광고로 보여줄 수가 있지? 그런데 동일한 의문을 품은 유저들이 여러 명 있었던 것 같습니다. (관련글  https://www.imore.com/how-stop-facebook-accessing-your-microphone https://medium.com/@damln/instagram-is-listening-to-you-97e8f2c53023  ) 물론  페이스북이나 인스타그램은 공식적으로 '절대로 그렇지 않다' 고 발표하지만, 그렇다고 하더라도 혹시 있을 수 있는 사생활 침해에서 앱의 마이크 접근 권한을 차단하는 것은 나쁘지 않은 것 같습니다. 만약을 위해 사생활을 보호하려면, 페이스북이나 인스타그램 앱 설정 부분에서 페이스북 앱, 인스타그램 앱의 마이크 접근 권한을 비활성화 하시면 됩니다. 1. 아이폰 또는 설정에서 아래로 스크롤해서, 인스타그램 앱을 선택한 다음, 해당 앱의 마이크 권한 비활성화를 해도...
자세한 내용 보기

[Angular] 모델, 값이 바뀌었는데 화면 template 이 업데이트 되지 않을 때 조치 팁

작성자: -
안녕하세요. 명동섞어찌개입니다. Angular 로 화면을 만들다 보면 종종 서버에서 값을 읽어와서 비동기로 화면이 업데이트 되는 상황에서, 화면에 바뀐 값이 반영되지 않는 경우가 생깁니다. 분명 ts (typescript) 의 값은 바뀌었고, 서버에도 문제가 없는데 html template 화면만 값이 제대로 표시되지 않는 경우가 있습니다. 이럴 때 사용할 수 있는 간단한 방법을 공유하려고 합니다. 1. ngIf = "flag == true" 를 씁니다. data.html 1 2 3 4 5 < div * ngIf = "data.length > 1" > < span * ngFor = "let item of data; let idx=index" > < span >{{ item }}</ span > </ span > </ div > data.ts 1 2 3 4 5 6 7 8 9 10 11 12 13 14 data = null ; . . . getData () { this . dataService . getDatas (). subscribe ( data => { this . data = data . result ; }, ( { error } ) => { } ) } 비동기로 서버에서 값을 읽어올 때, 값이 들어온 시점에 (data.length > 1) 정확히 데이터를 들고 화면을 그려주기 위해 template 쪽에 ngIf 문을 이용해서 그려줍니다. 저런식으로 화면 일부가 데이터가 계속 바뀜에 따라 지속적으로 업데이트 되어야 하는데, 값은 잘 들어오지만 template 은 새로 그려지지 않을...
자세한 내용 보기

[AWS] Lambda + API GateWay를 이용해 간단한 RESTful API 만들기 #1

작성자: -
이미지
안녕하세요. '남산 아래 개발자들' 블로그에서 막내를 담당하고 있는 남산돈가스 입니다. 이번 블로그에선 AWS에서 제공하고 있는 서비스인 API Gateway와 Lambda를 이용해 간단한 RESTful API를 만들어보는 시간을 가질 예정입니다. 내용의 이해를 돕기 위해서 #1, #2를 각각 나누어 Lambda와 API Gateway를 나누어 게시하도록 하겠습니다. 그렇다면 우선 Lambda는 무엇인가 싶으실텐데요. Lambda란? AWS Lambda를 사용하면 서버를 프로비저닝하거나 관리할 필요 없이 코드를 실행할 수 있습니다. 사용한 컴퓨팅 시간만큼만 비용을 지불하고, 코드가 실행되지 않을 때는 요금이 부과되지 않습니다. Lambda에서는 사실상 모든 유형의 애플리케이션이나 백엔드 서비스에 대한 코드를 별도의 관리 없이 실행할 수 있습니다. 코드를 업로드하기만 하면, Lambda에서 높은 가용성으로 코드를 실행 및 확장하는 데 필요한 모든 것을 처리합니다. 다른 AWS 서비스에서 코드를 자동으로 트리거하도록 설정하거나 웹 또는 모바일 앱에서 직접 코드를 호출할 수 있습니다. [출처] https://aws.amazon.com/ko/lambda/ 이 정도 설명으론 Lambda를 이해하기엔 조금 어려울 수 있을텐데요. 쉽게 얘기하자면 기존의 AWS 사용자는 EC2인스턴스를 통해서 그들의 컴퓨팅 환경을 구성하고 그 안에서 각자의 런타임환경을 통해 코드를 실행하여 백엔드서비스를 제공해왔습니다. 하지만 Lambda를 이용하면 EC2환경이 아닌 단순히 소스코드를 업로드함으로써 Lambda에서 제공하는 Runtime환경 내에서 코드들을 실행할 수 있다는 얘기입니다. 그럼, 이제부터 실제 Lambda를 이용해 간단한 소스코드를 등록하고 실행해보겠습니다. 1. AWS Console에 접속해 Lambda 검색하여 서비스 이동 2. 처음 시작한다면 Get Started No...
자세한 내용 보기

[AWS] Lambda + API GateWay를 이용해 간단한 RESTful API 만들기 #2

작성자: -
이미지
지난 시간에 이어서 Lambda + API Gateway를 이용해 간단한 RESTful API 만들기 2편을 진행하겠습니다. 이전 포스팅에서 Lambda를 이용하여 함수를 작성해보는 것 까지 진행했었는데요. 그렇다면 이번 포스팅에서는 API Gateway를 통해 요청 된 리소스들을 작성한 Lambda Function이 실행되도록 연결해보도록 하겠습니다. 먼저 API Gateway 서비스로 이동합니다. 시작을 누르고 나오는 화면에서 우리는 새로운 API를 만드려고하니까 새 API를 체크하시고 이름과 설명을 작성합니다. 작성 후 API 생성 버튼을 누르면 새로운 API Gateway가 생성됩니다. 여기까지 왔다면, 이제 실제 API를 정의하고 만들어봐야겠죠? 상단의 작업 버튼을 누르면 여러가지 작업들의 목록이 보여집니다. 여기서 먼저 리소스를 생성하겠습니다. 리소스는 말 그대로 이 API가 어떤 내용을 가지고 있는 것인지를 나타내는데요. 예를 들어 회원에 대한 API를 만드실거면 리소스이름을 member로 설정하시면 이 API의 경로는 /(루트) 하위의 member 라는 리소스를 가지게되는 것입니다. 여기선 실제로 member라는 리소스를 사용하겠습니다. 리소스를 생성하면 아래와 같이 /member라는 리소스가 생성됩니다. 그럼 이제 이 member라는 리소스에 메서드를 추가시킬 건데요. 여기서 메서드는 HTTP 메소드를 의미합니다. 기본적으로는 GET, POST, PUT, DELETE 등이 있습니다. 간단하게 알아보자면. GET – URL이 가진 정보를 검색하기 위해 서버 측에 요청하는 메소드 POST – URL에 폼 입력을 처리하기 위해 구성한 메소드 PUT – POST와 유사한 방식이며 일반적으로 웹서버에 변경을 요청하는 메소드 DELETE – 말 그대로 URL에 삭제를 요청하는 메소드 로 정리할 수 있다. 우리는 먼저 POST 메소드 부터 추가해보겠습니다. 위와 같이 작업목록에서 이번엔 메서드 생성 버튼을 누르고...
자세한 내용 보기

안드로이드에서 당겨서 새로고침(SwipeRefreshLayout) 쉽게 구현하기

작성자: -
앱을 개발 하다보면 필수 기능중에 하나가 보고 있는 리스트나 상세 페이지등을 새로고침 하는 것 입니다. 몇년 전 까지만 하더라도 새로 고침 기능이라고 하면 아이폰 처럼 뷰를 당기면 공간이 벌어지면서 새로고침 하는 방식을 많이 사용 했습니다.(여전히 이 방법을 사용하는 앱은 많습니다.) 해당 새로고침을 기능을 제공 하려면 개발가 하나하나 구현 해야해서 쉽지 않은 기능 중 하나였습니다. 하지만 지금은 android 레이아웃중 SwipeRefreshLayout을 제공하여 레이아웃만 추가한다면 별다른 구현 없이도 위에서 아래로 내려오는 새로고침 기능을 사용 할수 있게 되었습니다. SwipeRefreshLayout을 간단하게 구현하는 샘플 코드를 작성해 보겠습니다. 1단계 : 레이아웃 새로고침이 될 뷰를 SwipeRefreshLayout으로 자식뷰로 만듭니다.       <android.support.v4.widget.SwipeRefreshLayout android:layout_width="match_parent" android:layout_height="match_parent" android:id="@+id/swipe_refresh"> <WebView android:layout_width="match_parent" android:layout_height="match_parent" android:id="@+id/webView"></WebView> </android.support.v4.widget.SwipeRefreshLayout> 2단계 : 새로고침 이벤트 해당 뷰 영역을 위에서 아래로 당기면...
자세한 내용 보기