[bootBoard] N:1(다대일) 연관관계: 11-1. 검색처리: JQPL을 사용한 검색

FK를 이용해서 @ManyToOne과 같은 연관관계를 작성한 경우 가장 어려운 작업은 JPQL을 구성하는 것이다.

 

• 하나의 엔티티 타입만으로 사용하는 경우 JPQL을 사용하여 동적 쿼리를 만드는 게 간편했다.
• 그러나 여러 엔티티 타입을 JPQL로 직접 처리하는 과정 자체가 기존과 달라지고 더욱 복잡해 진다
• 흔히 Tuple이라고 부르는 Object[ ] 타입으로 나오기 때문이다.

 

그러나 이 방식은 어떤 상황에서도 사용할 수 있는 가장 강력한 JPQL을 구성하는 방식이기도 하다.

 

1. 프로젝트의 변경 (build.gradle에 Querydsl 설정 추가)

bootBoard 프로젝트의 경우 지금까지는 Querydsl 설정이 없는 상태에서 작성되었다. 따라서 build.gradle에 Querydsl 설정을 추가해주는 작업부터 시작한다.

 

• 아래 코드 가운데 '###' 이 붙은 부분이 새로 추가해 준 부분이다.
• 만약 'Could not find method querydsl()' 오류가 난다면 plugin이나 dependencies에 querydsl을 추가해 줬는지 확인할 필요가 있다.

코드를 수정한 이후에는 반드시 build.gradle 파일을 refresh해 줄 것.

 

Build.gradle 전문

 

원래 버전은 자꾸 unable to load class 'com.mysema.codegen.model.type'. gradle 오류가 나서 예전에 사용하던 build.gradle 파일의 코드를 복사해 넣었다.

//querydsl 버전정보 추가####
buildscript {
    ext {
        queryDslVersion = "5.0.0"
    }
}


plugins {
    id 'org.springframework.boot' version '2.7.1'
    id 'io.spring.dependency-management' version '1.0.11.RELEASE'
    id 'java'
    id 'war'
    id 'com.ewerk.gradle.plugins.querydsl' version '1.0.10' //querydsl 플러그인 추가####
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    developmentOnly 'org.springframework.boot:spring-boot-devtools'
    annotationProcessor 'org.projectlombok:lombok'
    providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
    testImplementation('org.springframework.boot:spring-boot-starter-test') {//괄호 넣어줌
        //아래에 mariadb관련 jdbc 드라이버 추가. jpa 관련 설정 추가, thymeleaf에서 쓸 java8 날짜 라이브러리 추가
        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
    }

//    compile, runtime, testCompile, testRuntime 은 Gradle 4.10 (2018.8.27) 이래로
//    deprecate 되었다. 그리고 Gradle 7.0 (2021.4.9) 부터 삭제되었다.
//    삭제된 네 명령은 각각 implementation, runtimeOnly, testImplementation, testRuntimeOnly 으로 대체되었다.
//    compile group: 'org.mariadb.jdbc', name: 'mariadb-java-client'
//    compile group: 'org.thymeleaf.extras', name: 'thymeleaf-extras-java8time'
//    아래와 같이 써준다.
    implementation('org.thymeleaf.extras:thymeleaf-extras-java8time')
    implementation('org.mariadb.jdbc:mariadb-java-client')
    implementation('org.thymeleaf.extras:thymeleaf-extras-java8time')
    // ' : ' 콜론을 띄어 쓰며 오류남.

//    implementation 'com.querydsl:querydsl-jpa'
    implementation "com.querydsl:querydsl-jpa:${queryDslVersion}" //querydsl 의존성 추가####
    implementation "com.querydsl:querydsl-apt:${queryDslVersion}"

}

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


//querydsl 추가 시작####

// querydsl에서 사용할 경로 설정
def querydslDir = "$buildDir/generated/querydsl"

// JPA 사용 여부와 사용할 경로를 설정
querydsl {
    jpa = true
    querydslSourcesDir = querydslDir
}

// build 시 사용할 sourceSet 추가
sourceSets{
    main.java.srcDir querydslDir
}

// querydsl 컴파일시 사용할 옵션 설정
compileQuerydsl {
    options.annotationProcessorPath = configurations.querydsl
    //build.gradle을 갱신하면 여기가 실행가능한 task가 됨.
}

// querydsl 이 compileClassPath 를 상속하도록 설정
configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
    querydsl.extendsFrom compileClasspath
}

//querydsl 추가 끝####

 

그 후에 구동 버튼을 눌러 프로젝트를 시작한다.

그러면 이처럼 querydsl 폴더 내에 Q도메인이 생김

 

2. Repository 확장

Spring Data JPA의 Repository를 확장하는 위한 단계

• 쿼리메서드나 @Query 등으로 처리할 수 없는 기능은 별도의 인터페이스로 설계 
• 별도의 인터페이스에 대한 구현 클래스 작성. 이 때 QuerydslRepositorySupport라는 클래스를 부모클래스로 사용
• 구현 클래스에 인터페이스 기능을 Q도메인 클래스와 JPQLQuery를 이용하여 구현

 

2-1. QuerydslRepositorySupport 동작 확인

• QuerydslRepositorySupport 클래스는 Spring Data JPA에 포함된 클래스이다.
• Querydsl 라이브러리를 이용해서 사용자가 직접 기능을 구현할 때 사용한다.
• 따라서 개발자가 원하는 기능하는 Repository를 작성하는 데 가장 중요한 클래스라고 할 수 있다.

2-2. QuerydslRepositorySupport를 사용하기: search 기능 추가

Repository 패키지 내에 search 패키지 추가: 여기에 검색 기능 만들 예정.

이렇게 추가된 패키지에는 확장하고 싶은 기능을 인터페이스로 선언한다. 예제에서는 검색 기능을 확장코자 한다.

 

• 이 때 인터페이스 내의 이름은 가능하면 쿼리 메서드와 구별 가능토록 작성한다.
• SearchBoardRepository 인터페이스 선언
• SearchBoardRepositoryImpl 클래스 선언(단, 이 때 구현 클래스명은 "인터페이스명 + Impl"이 돼야 한다.) 

 

2-3. SearchBoardRepository 인터페이스 작성

//SearchBoardRepository.java

package com.example.bootboard.repository.search;

import com.example.bootboard.entity.Board;

public interface SearchBoardRepository {
    Board search1();
}

 

2-4. SearchBoardRepositoryImpl 클래스 작성

SearchBoardRepository 인터페이스에 작성된 메서드를 오버라이드 한다.

여기서는 로그를 사용해서 동작 여부를 확인한다.

 

• SearchBoardRepositoryImpl에서 가장 중요한 것은 QuerydslRepositorySupport 클래스를 상속한다는 점이다.
• QuerydslRepositorySupport는 생성자가 존재하므로 클래스 내에서 super()를 이용해서 호출해야 한다.
• 이 때 도메인 클래스를 정하는데 null은 넣을 수 없다.

 

package com.example.bootboard.repository.search;

import com.example.bootboard.entity.Board;
import lombok.extern.log4j.Log4j2;
import org.springframework.data.jpa.repository.support.QuerydslRepositorySupport;

@Log4j2
public class SearchBoardRepositoryImpl extends QuerydslRepositorySupport 
        implements SearchBoardRepository {
    
    //생성자
    public SearchBoardRepositoryImpl(){
        super(Board.class); //여기서 super는 querydslRepositorySupport이다.
    }
    
    @Override
    public Board search1(){
        log.info("search1............");
        return null;
    }
}

 

2-5. BoardRepository 수정

 

//BoardRepository.java

package com.example.bootboard.repository;

import java.util.List;
                    //SearchBoardRepository 인터페이스를 상속
public interface BoardRepository extends JpaRepository<Board, Long>, SearchBoardRepository {

//...

}

 

3. 테스트

BoardRepositoryTests 클래스에 코드 테스트 코드 추가

//BoardRepositoryTests.java

@SpringBootTest
public class BoardRepositoryTests {

...    
    @Test
    public void testSearch1(){
        boardRepository.search1();
    }

...

}

 

콘솔 로그

search1...............가 보인다. 확장된 Repository 동작확인. 아직 sql을 실행하지 않은 상태이지만 log,info()는 동작 여부확인 가능

 

해당 메서드를 호출했을 때 로그가 찍히는 것을 확인하였으니 다음에는 여기에 실제 JPQL을 작성할 것