[Mybatis] Spring Boot와 Mybatis를 이용한 Paging 처리와 검색 기능 구현

Git Hub 주소 : https://github.com/junyharang-Development-Lab/mybatis-paging-search-test/tree/main

 

 

🚀 Mybatis를 이용한 Paging 처리와 검색 기능 구현

 

 

마이바티스 프로그래밍:JDBC를 대체하는 쉽고 빠른 자바 데이터베이스 프레임워크

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

    🔽  초기 구성

 

DB Table 내용

최초 DB에는 위와 같이 study라는 DB안에 board라는 Table을 만들어주고, 안에 내용을 넣어 주었어요.

 

 

        📦 Project 구성 

이번 실습에서 주니하랑은 Gradle과 함께 아래와 같이 의존성을 구성해 주었습니다.

plugins {
   id 'org.springframework.boot' version '2.7.0'
   id 'io.spring.dependency-management' version '1.0.11.RELEASE'
   id 'java'
}

group = 'com.junyharang.mybatis'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

configurations {
   compileOnly {
      extendsFrom annotationProcessor
   }
}

repositories {
   mavenCentral()
}

dependencies {
   implementation 'org.springframework.boot:spring-boot-starter-jdbc'
   implementation 'org.springframework.boot:spring-boot-starter-web'
   implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.2.2'
    implementation 'org.springframework.boot:spring-boot-starter-test'
   implementation 'junit:junit:4.13.2'
   compileOnly 'org.projectlombok:lombok'
   developmentOnly 'org.springframework.boot:spring-boot-devtools'
   implementation group: 'org.mariadb.jdbc', name: 'mariadb-java-client', version: '2.4.1'
   annotationProcessor 'org.projectlombok:lombok'
   testImplementation 'org.springframework.boot:spring-boot-starter-test'

   // Page Helper
   // https://mvnrepository.com/artifact/com.github.pagehelper/pagehelper-spring-boot-starter
   implementation 'com.github.pagehelper:pagehelper-spring-boot-starter:1.4.2'

   // Mybatis Test
   // https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter-test
   testImplementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter-test:2.2.2'

   // SQL query show
   implementation 'org.bgee.log4jdbc-log4j2:log4jdbc-log4j2-jdbc4.1:1.16'
   
}

tasks.named('test') {
   useJUnitPlatform()
}

이번 실습에서 중요한 부분이 바로 Page Helper인 것이에요.

Paging처리를 위해 하나하나 수작업으로 만들지 않고, JPA의 Pageable과 같은 객체를 찾아보던 중 아주 좋은 것을 발견하여 실습해보고, 내용을 정리 해 봅니다.

주니하랑은 DataBase를 Maria DB를 이용하고 있어요!

 

 

 

    🔽  Controller

        📦 MybatisPagingTestController

package com.junyharang.mybatis.mybatispagingtest.controller;

import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.junyharang.mybatis.mybatispagingtest.CustomBaseResponse;
import com.junyharang.mybatis.mybatispagingtest.model.dto.request.BoardListSearchDTO;
import com.junyharang.mybatis.mybatispagingtest.model.dto.request.BoardWriteRequestDTO;
import com.junyharang.mybatis.mybatispagingtest.model.vo.BoardResponseVO;
import com.junyharang.mybatis.mybatispagingtest.service.MybatisPagingTestServiceImpl;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

MybatisPagingTestController

 

최초 Controller를 만들어 주었고, 위와 같이 글 등록, 목록 조회 API를 만들어 주었어요.

이번 포스팅에서 주요 쟁점은 Paging 처리 기능을 갖는 목록 조회이기 때문에 목록 조회에 대한 내용만 정리를 해 보겠습니다.

41 ~ 45번째 줄에서 Client에게 요청 받은 내용 중 pageNum과 pageSize에 대한 값이 없다면 400 Error를 반환하게 해 주었어요.

API URI는 /api/junyharang/board로 설정을 해 주었고, HTTP Method는 Get으로 설정을 해주었어요.
그리고, 해당 Method를 호출할 때는 BoardListSearchDTO Type의 값을 받도록 설정이 되어 있어요.

그런 뒤 PageHelper 안에 startPage()를 호출하여 Client의 요청 객체를 전달해 주고 있어요.

이렇게 해 주게 되면 시작 Page에 대한 계산을 해 주게 된답니다.

우리가 주목해야 될 곳은 return이에요. PageInfo는 pagehelper-spring-boot-starter에 있는 Class인데, PageInfo는 아래와 같은 Filed 변수를 가지고 있어요.

// 현재 페이지
private int pageNum ;
// 페이지당 수량
private int pageSize ;
// 현재 페이지 수
private int size ;
// 현재 페이지의 첫 번째 요소가 데이터베이스에 있는 줄 번호
private long startRow ;
// 현재 페이지의 마지막 요소가 데이터베이스에 있는 줄 번호
private long endRow ;
// 전체 페이지 수
private int pages ;
// 이전 페이지
private int prePage ;
// 다음 페이지
private int nextPage ;
// 첫 페이지인지 여부
private boolean isFirstPage = false ;
// 마지막 페이지인지 여부
private boolean isLastPage = false ;
// 이전 페이지가 있는지 여부
private boolean hasPreviousPage = false ;
// 다음 페이지가 있는지 여부
private boolean hasNextPage = false ;
// 내비게이션 페이지 번호
private int navigatePages ;
// 모든 내비게이션 페이지 번호
private int [ ] navigatepageNums ;
// 내비게이션 바의 첫 페이지
private int navigateFirstPage ;
// 내비게이션 바의 마지막 페이지
private int navigateLastPage ;

이렇게 PageInfo는 Paging 처리와 관련된 정보와 Paging 처리가 완료된 Data List를 반환해 주게 되어 있어요.

이번엔 BoardListSearchDTO를 한번 만나러 가봐요!

 

 

 

    🔽  RequestDTO

        📦 BoardListSearchDTO

 

BoardListSearchDTO

 

Client는 목록 조회를 위해 API에게 요청을 보낼 때, 현재 이용자의 Page 위치 번호와 한 Page 당 출력될 게시글 개수를 무조건 보내줘야 해요. 안 그럼 Exception이 터지게 된답니다!

그리고, 목록 조회와 함께 검색 기능 구현을 위해 검색 Type과 검색어를 함께 받을 수 있도록 DTO를 구성하여 주었어요.

Mybatis는 JPA와 다르게 구동할 때 참조할 객체에 Getter와 Setter를 모두 필요로 하기 때문에 @Data를 넣어주었습니다.

JPA를 이용한다면 Entity에 Setter를 넣으면 안되는 것이에요.

이번에는 Service 즉, Businees Logic을 만나러 가볼게요!

    🔽  Businees Logic

        📦 MybatisPagingTestService

MybatisPagingTestService Interface

 

MybatisPagingTestServiceImpl

 

주니하랑은 SOLID의 OCP (Open/Closed Principle) : 개방 - 폐쇄 원칙을 준수하기 위해 Interface와 구현체를 나누어 주었어요.

구현체에 getPaging()을 보게 되면 Client에게 전달 받은 Paging 처리에 필요한 값과 검색 처리에 필요한 값을 받고, 이를 Mybatis를 이용해 DB 조회를 위해 Mapper의 findByPagingAndSearch()를 호출하여 해당 객체를 전달해 주고, 조회된 여러 종류에 결과값을 List로 전달을 하는데, BoardResponseVO Type에 맞는 값을 가져오기 위해 Return Type을 지정해 주었어요.

    🔽  DataBase Query

        📦 MybatisPagingTestMapper

 

MybatisPagingTestMapper

이 친구는 실제로 Annotation을 통해 Query를 적어줄 수도 있는 곳이고, 따로 xml을 만들어 동적 Query를 만들어 Mapping할 수 있는 Mapper Class에요.

24번째 줄에 Client에게 온 객체를 전달 받고 있고, Service 때와 마찬가지로 DB에서 조회된 결과값을 List로 반환하는데, BoardResponseVO에 맞는 값을 전달 해 주고 있어요.

반응형

 

 

        📦 MybatisPagingTestMapper.xml

 

MybatisPagingTestMapper.xml

실제 Query를 작성하는 xml File내용이에요.

18번째줄 부터 목록 조회를 위한 Query문을 작성한 곳인데, board Table에 모든 내용을 가져오는데, 검색 Type이 null이 아니고, 공백이 아니고, 검색 Type이 title인데, 검색어가 입력이 안 되었을 때 Error를 방지 하기 위해 모든 내용을 반환하려고 하였어요. 그래서 26번째 줄에 검색어가 비어 있거나, 공백이면 모든 내용을 조회하여 반환하게 해 주었고, 비어 있지 않다면 30번째 줄에 해당되어서 검색어에 해당하는 내용을 DB에서 조회하도록 되어 있어요.

만약 검색 Type이 contents라면 내용을 검색하도록 검색 기능을 구현하였습니다.

그리고, 반환 Type은 BoardResponseVO 객체로 해주었고, 매개 변수는 BoardListSearchDTO로 해주었어요.

그런데, 여기서 주목해야 하는 부분은 SQL을 통해 Paging 처리를 하지 않는다는 것이에요.
즉, LIMIT Query문이 없는 것이 보이시나요?

이것은 Page Helper라는 친구가 SQL에 힘을 빌리지 않고, Code 상에서 Paging처리를 할 수 있게 해준다는 장점을 갖고 있는 것이에요.

    🔽  Response DTO

        📦 BoardResponseVO

 

BoardResponseVO

DB에서 조회가 끝나면 위 VO 객체에 맞게 id, title, contents를 반환하도록 VO를 구성해 주었습니다.

    🔽  정상 작동 검사

 

POSTMAN TEST

먼저 POSTMAN을 통해 현재 이용자 위치 Page를 1 Page(pageNum = 1)로 주고, 한 Page 당 출력될 게시글 개수를 10(pageSize)로 설정을 해 주었어요.

{
    "errorCode": 0,
    "title": "",
    "message": "",
    "data": {
        "total": 7,
        "list": [
            {
                "id": 1,
                "title": "제목 입니다!",
                "contents": "내용 입니다!"
            },
            {
                "id": 2,
                "title": "하이염!",
                "contents": "주니하랑 입니다!"
            },
            {
                "id": 3,
                "title": "코딩은 재밌어요!",
                "contents": "넘나 재밌어요!!"
            },
            {
                "id": 4,
                "title": "Full Stack!",
                "contents": "Front도 열심히!"
            },
            {
                "id": 5,
                "title": "JAVA 만세!",
                "contents": "JAVA가 제일 편해요!"
            },
            {
                "id": 6,
                "title": "Spring이 좋아!",
                "contents": "넘나넘나!"
            },
            {
                "id": 7,
                "title": "mariadb 최고!!",
                "contents": "좋아요!"
            }
        ],
        "pageNum": 1,
        "pageSize": 10,
        "size": 7,
        "startRow": 1,
        "endRow": 7,
        "pages": 1,
        "prePage": 0,
        "nextPage": 0,
        "isFirstPage": true,
        "isLastPage": true,
        "hasPreviousPage": false,
        "hasNextPage": false,
        "navigatePages": 8,
        "navigatepageNums": [
            1
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 1
    },
    "success": true
}

참고로 주니하랑은 CustomBaseResponse라는 응답 객체를 만들어 주었어요.
이에 대한 내용은 주니하랑 Git Hub을 참고해 주시고, 이 설정들에 따라 위와 같이 반환되는 결과값이 조금은 다를 수 있어요.

이번에는 이용자가 1 Page에 있고, 총 5개의 게시글을 가져오도록 해 주었어요.

{
    "errorCode": 0,
    "title": "",
    "message": "",
    "data": {
        "total": 7,
        "list": [
            {
                "id": 1,
                "title": "제목 입니다!",
                "contents": "내용 입니다!"
            },
            {
                "id": 2,
                "title": "하이염!",
                "contents": "주니하랑 입니다!"
            },
            {
                "id": 3,
                "title": "코딩은 재밌어요!",
                "contents": "넘나 재밌어요!!"
            },
            {
                "id": 4,
                "title": "Full Stack!",
                "contents": "Front도 열심히!"
            },
            {
                "id": 5,
                "title": "JAVA 만세!",
                "contents": "JAVA가 제일 편해요!"
            }
        ],
        "pageNum": 1,
        "pageSize": 5,
        "size": 5,
        "startRow": 1,
        "endRow": 5,
        "pages": 2,
        "prePage": 0,
        "nextPage": 2,
        "isFirstPage": true,
        "isLastPage": false,
        "hasPreviousPage": false,
        "hasNextPage": true,
        "navigatePages": 8,
        "navigatepageNums": [
            1,
            2
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 2
    },
    "success": true
}

이번에는 이용자가 2 Page에 있고, 5개의 게시글을 가져오도록 해 주었어요.

{
    "errorCode": 0,
    "title": "",
    "message": "",
    "data": {
        "total": 7,
        "list": [
            {
                "id": 6,
                "title": "Spring이 좋아!",
                "contents": "넘나넘나!"
            },
            {
                "id": 7,
                "title": "mariadb 최고!!",
                "contents": "좋아요!"
            }
        ],
        "pageNum": 2,
        "pageSize": 5,
        "size": 2,
        "startRow": 6,
        "endRow": 7,
        "pages": 2,
        "prePage": 1,
        "nextPage": 0,
        "isFirstPage": false,
        "isLastPage": true,
        "hasPreviousPage": true,
        "hasNextPage": false,
        "navigatePages": 8,
        "navigatepageNums": [
            1,
            2
        ],
        "navigateFirstPage": 1,
        "navigateLastPage": 2
    },
    "success": true
}

Controller에서 Client가 pageNum이나, pageSize를 보내지 않았다면 400 Error가 터지도록 해 주었어요.
이 부분에 대해 한번 Test 해 볼게요.

먼저 pageNum에 값이 들어오지 않았을 때 위와 같이 400 Error가 터지는 것을 확인할 수 있어요.

마찬가지로 pageSize도 들어오지 않는다면 400 Error가 반환되도록 되어 있습니다.

이번엔 검색 기능이 제대로 구현 되는지 한번 확인 해 볼게요.

DB Table 내용

여기서 제목이 JAVA 만세라는 내용을 검색해 볼게요.

JAVA라는 값만 넣어서 다시 검색을 해 볼까요?

이렇게 JAVA만 넣었는데도 JAVA 만세가 검색되는 이유는 SQL을 적은 XML에 CONCAT('%', #{~~}, '%')를 넣어주었기 때문인데, 이 것은 앞,뒤에 중간 내용을 포함하는 모든 내용을 가져오라는 의미에요.

 

 

 

 

 

마이바티스 프로그래밍:JDBC를 대체하는 쉽고 빠른 자바 데이터베이스 프레임워크

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."