[Spring Boot] 검색 기능

💻 검색 기능 구현하기!

데이터가 계속 쌓여가는 게시판이므로 검색기능은 필수라고 할 수 있다.

검색할 내용이 질문의 제목, 질문의 내용, 질문 작성자, 답변의 내용, 답변 작성자에 존재하는지 찾아보고 그 결과를 화면에 출력해보자!

📝 "스프링"을 포함한 글자 조회하는 쿼리

select
    distinct q.id,
    q.author_id,
    q.content,
    q.create_date,
    q.modify_date,
    q.subject 
from question q 
left outer join site_user u1 on q.author_id=u1.id 
left outer join answer a on q.id=a.question_id 
left outer join site_user u2 on a.author_id=u2.id 
where
    q.subject like '%스프링%' 
    or q.content like '%스프링%' 
    or u1.username like '%스프링%' 
    or a.content like '%스프링%' 
    or u2.username like '%스프링%' 

Specification

위의 쿼리에서 본 것과 같이 여러 테이블에서 데이터를 검색해야 할 경우에는 JPA가 제공하는 Specification 인터페이스를 사용하는 것이 편리하다.

참고 : https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#specifications

💾 QuestionService에 search 메서드를 추가

import com.mysite.sbb.answer.Answer;
import jakarta.persistence.criteria.CriteriaBuilder;
import jakarta.persistence.criteria.CriteriaQuery;
import jakarta.persistence.criteria.Join;
import jakarta.persistence.criteria.JoinType;
import jakarta.persistence.criteria.Predicate;
import jakarta.persistence.criteria.Root;
import org.springframework.data.jpa.domain.Specification;

private Specification<Question> search(String kw) {
		
        return new Specification<>() {
            private static final long serialVersionUID = 1L;
            @Override
            // Root<Question> q : 기준을 의미하는 Question 엔티티의 객체
            public Predicate toPredicate(Root<Question> q, CriteriaQuery<?> query, CriteriaBuilder cb) {
                query.distinct(true);  // 중복을 제거 
                
                /* 
                 * from question q
                 * left outer join site_user u1 on q.author_id = u1.id
                 */
                // Question, SiteUser 엔티티는 author 속성으로 연결되어 있기 때문에 q.join("author")와 같이 조인
                Join<Question, SiteUser> u1 = q.join("author", JoinType.LEFT);
                
                /* 
                 * from question q
                 * left outer join answer a on q.id=a.question_id
                 */
                // Question과 Answer 엔티티는 "answerList"로 연결되어있다.
                Join<Question, Answer> a = q.join("answerList", JoinType.LEFT);
                
                /* 
                 * left outer join site_user u2 on a.author_id = u2.id
                 */
                // Answer, SiteUser 엔티티는 "author"로 연결되어 있다.
                Join<Answer, SiteUser> u2 = a.join("author", JoinType.LEFT);
                
                // 입력받은 문자 "kw"를 포함되어 있는 것을 리턴
                return cb.or(cb.like(q.get("subject"), "%" + kw + "%"), // 질문 제목 
                        cb.like(q.get("content"), "%" + kw + "%"),      // 질문 내용 
                        cb.like(u1.get("username"), "%" + kw + "%"),    // 질문 작성자 
                        cb.like(a.get("content"), "%" + kw + "%"),      // 답변 내용 
                        cb.like(u2.get("username"), "%" + kw + "%"));   // 답변 작성자 
            }
        };
    }

💾 QuestionRepository에 수정(Specification을 사용하기 위해)

import java.util.List;

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.data.jpa.repository.JpaRepository;

public interface QuestionRepository extends JpaRepository<Question, Integer> {
    Question findBySubject(String subject);
    Question findBySubjectAndContent(String subject, String content);
    List<Question> findBySubjectLike(String subject);
    Page<Question> findAll(Pageable pageable);
    Page<Question> findAll(Specification<Question> spec, Pageable pageable);
}

✅ 추가 : Page<Question> findAll(Specification<Question> spec, Pageable pageable);

💾 QuestionService getList 메소드 수정

    // 검색어를 의미하는 kw 매개변수에 추가 
	public Page<Question> getList(int page, String kw){
		List<Sort.Order> sorts = new ArrayList<>();
		sorts.add(Sort.Order.desc("createDate"));
		Pageable pageable = PageRequest.of(page, 10, Sort.by(sorts));
		Specification<Question> spec = search(kw); // 객체를 생성
		return this.questionRepository.findAll(spec, pageable); // 검색결과 리턴
	}

💾 QuestionController list 메소드 수정

@GetMapping("/list")
	// 검색어에 해당하는 kw 파라미터를 추가했고 디폴트값으로 빈 문자열을 설정
	public String list(Model model, @RequestParam(value="page", defaultValue="0") int page, @RequestParam(value="kw", defaultValue="") String kw) {
		Page<Question> paging = this.questionService.getList(page, kw); 
		model.addAttribute("paging", paging);
		
		// 화면에서 입력한 검색어를 화면에 유지하기 위해 model.addAttribute("kw", kw)로 kw 값을 저장
		model.addAttribute("kw", kw);
		return "question_list";
	}

💾 question_list.html 수정하기

✅ 원하는 위치에 검색창을 추가해보자!

   <div class="row my-3">
        <div class="col-6">
            <div class="input-group">
                <input type="text" id="search_kw" class="form-control" th:value="${kw}">
                <button class="btn btn-outline-secondary" type="button" id="btn_search">찾기</button>
            </div>
        </div>
    </div>

✅ <input type="text" id="search_kw" class="form-control" th:value="${kw}">

자바 스크립트에서 이 텍스트창에 입력된 값을 읽기 위해 다음처럼 텍스트창 id 속성에 "search_kw"라는 값을 추가하였다.

id 속성은 자바스크립트에서 읽을 수 있다.

✅ page와 kw를 동시에 GET으로 요청할 수 있는 searchForm 추가

(... 생략 ...)
    <!-- 페이징처리 끝 -->
    <form th:action="@{/question/list}" method="get" id="searchForm">
        <input type="hidden" id="kw" name="kw" th:value="${kw}">
        <input type="hidden" id="page" name="page" th:value="${paging.number}">
    </form>
</div>
</html>

GET 방식으로 요청해야 하므로 method 속성에 "get"을 설정했다. kw와 page는 이전에 요청했던 값을 기억하고 있어야 하므로 value에 값을 유지할수 있도록 했다.

💡 GET 방식을 사용하는 이유

---

만약 GET이 아닌 POST 방식으로 검색과 페이징을 처리한다면 웹 브라우저에서 "새로고침" 또는 "뒤로가기"를 했을 때 "만료된 페이지입니다."라는 오류를 종종 만나게 될 것이다. 왜냐하면 POST 방식은 동일한 POST 요청이 발생할 경우 중복 요청을 방지하기 위해 "만료된 페이지입니다." 라는 오류를 발생시키기 때문에 여러 파라미터를 조합하여 게시물 목록을 조회할 때는 GET 방식을 사용하는 것이 좋다.

✅ 기존 페이징을 처리하는 부분을 직접 URL을 링크하는 방식이 아닌 값을 읽어 폼에 설정하도록 수정해야한다.

why? 검색어가 있을 경우 검색어와 페이지 번호를 함께 전송해야 하기 때문이다.

✅ 수정 전 : th:href="@{|?page=${paging.number-1}|}"
✅ 수정 후 : href="javascript:void(0)" th:data-page="${paging.number-1}"

✅ page, kw 파라미터를 동시에 요청할 수 있는 자바스크립트를 다음과 같이 추가

<script layout:fragment="script" type='text/javascript'>

const page_elements = document.getElementsByClassName("page-link");
Array.from(page_elements).forEach(function(element) {
    element.addEventListener('click', function() {
        document.getElementById('page').value = this.dataset.page;
        document.getElementById('searchForm').submit();
    });
});

const btn_search = document.getElementById("btn_search");
btn_search.addEventListener('click', function() {
    document.getElementById('kw').value = document.getElementById('search_kw').value;
    document.getElementById('page').value = 0;  // 검색버튼을 클릭할 경우 0페이지부터 조회한다.
    document.getElementById('searchForm').submit();
});

</script>

const page_elements = document.getElementsByClassName("page-link");
Array.from(page_elements).forEach(function(element) {
    element.addEventListener('click', function() {
        document.getElementById('page').value = this.dataset.page;
        document.getElementById('searchForm').submit();
    });
});

✔ 이 class 속성값으로 "page-link"라는 값을 가지고 있는 링크를 클릭하면
이 링크의 data-page 속성값을 읽어 searchForm의 page 필드에 설정하여 searchForm을 요청한다.

const btn_search = document.getElementById("btn_search");
btn_search.addEventListener('click', function() {
    document.getElementById('kw').value = document.getElementById('search_kw').value;
    document.getElementById('page').value = 0;  // 검색버튼을 클릭할 경우 0페이지부터 조회한다.
    document.getElementById('searchForm').submit();
});

✔ 검색버튼을 클릭하면 검색어 텍스트창에 입력된 값을 searchForm의 kw 필드에 설정하여 searchForm을 요청하도록 스크립트를 추가했다. 검색버튼을 클릭하는 경우는 새로운 검색에 해당되므로 page에 항상 0을 설정하여 첫 페이지로 요청하도록 했다.

💡 Specification 대신 직접 쿼리를 작성하여 수행하는 방법

---

💾 QuestionRepository에 메서드 추가

✅ @Query 애너테이션이 적용된 findAllByKeyword 메서드를 추가

import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;

@Query("select "
            + "distinct q "
            + "from Question q " 
            + "left outer join SiteUser u1 on q.author=u1 "
            + "left outer join Answer a on a.question=q "
            + "left outer join SiteUser u2 on a.author=u2 "
            + "where "
            + "   q.subject like %:kw% "
            + "   or q.content like %:kw% "
            + "   or u1.username like %:kw% "
            + "   or a.content like %:kw% "
            + "   or u2.username like %:kw% ")
Page<Question> findAllByKeyword(@Param("kw") String kw, Pageable pageable);

✅ QuestionService에서 Page getList 메소드 수정하기

✔ 수정 전 : return this.questionRepository.findAll(spec, pageable);
✔ 수정 후 : return this.questionRepository.findAllByKeyword(kw, pageable);

@Query를 작성할 때에는 반드시 테이블 기준이 아닌 엔티티 기준으로 작성해야 한다. 즉, site_user와 같은 테이블명 대신 SiteUser처럼 엔티티명을 사용해야 하고 조인문에서 보듯이 q.author_id=u1.id와 같은 컬럼명 대신 q.author=u1처럼 엔티티의 속성명을 사용해야 한다.

그리고 @Query에 파라미터로 전달할 kw 문자열은 메서드의 매개변수에 @Param("kw")처럼 @Param 애너테이션을 사용해야 한다. 검색어를 의미하는 kw 문자열은 @Query 안에서 :kw로 참조된다.

---

✨ 이번 챕터에서 배운 부분

✅ 데이터 조회시에 많이 사용되는 Specification 인터페이스
✅ 데이터 조회시 POST방식이 아닌 GET방식을 사용하는 이유

📝 공부할 부분

✅ Specification 인터페이스 / JPA공부하기
✅ 자바스크립트 공부