[JPA] SpringBoot(2.x version)에 QueryDsl JPA 적용 (gradle 설정)

 

QueryDsl은 SQL, JPQL 등을 코드로 작성할 수 있게 하는 builder opensource framework 이다.

 : 사람이 Query를 짜다보면 보통 수작업으로 하기에 오류가 생길 여지가 있는데 (String이다 보니)

컴파일 단계에서 오류가 있는지 알 수 없다. 

 

QueryDsl은 Query 생성을 자동화 하여 자바 코드로 작성하므로, 위와 같은 문제에 대응할 수 있고

복잡한 쿼리나 동적 쿼리를 구현하는데에 있어 한계가 있는 순수 JPA를 보완하기 위해서도 사용한다.

 

아직 실무에서 쓰고있지는 않으나, 실무에 많이 적용한다고 해서 얕게나마 파보았다.

 

---

 

1.  build.gradle 셋팅

dependencies {
	...
    //querydsl
    implementation 'com.querydsl:querydsl-jpa'
    annotationProcessor "com.querydsl:querydsl-apt:${dependencyManagement.importedProperties['querydsl.version']}:jpa"
    annotationProcessor "jakarta.annotation:jakarta.annotation-api"
    annotationProcessor "jakarta.persistence:jakarta.persistence-api"
}


//querydsl option

// querydsl QClass 파일 생성 위치를 지정
// def generated = "$buildDir/generated/querydsl"
def generated = 'src/main/generated'

tasks.withType(JavaCompile) {
    options.getGeneratedSourceOutputDirectory().set(file(generated))
}

// java source set Qclass 위치 추가
sourceSets {
    main.java.srcDirs += [ generated ]
}

// gradle clean 시, QClass 디렉토리 삭제
clean {
    delete file(generated)
}

 

  : gradle 설정 후, gradle clean > gradle build > gradle compileJava 순으로 실행

 그럼 generated 에 정의한 위치에 새로운 디렉토리와 함께 Qclass 파일이 생성된다.

 

Qclass는 Entity를 기반으로 생성되며

JPAAnnotationProcessor가 컴파일 시점에 @Entity 등의 어노테이션을 찾아 분석해 만든다.

(엔티티와 동일한 파일 명 앞에 Q가 붙어있다.)

QueryDsl은 쿼리 작성 시, 이러한 Qclass를 기반으로 Query를 실행한다.

 

 

---

2.  Config 설정

@Configuration
public class QueryDslConfig {
	@PersistenceContext
    private EntityManager entityManager;
    @Bean
    public JPAQueryFactory jpaQueryFactory() { return new JPAQueryFactory(entityManager); }
}

  : JPAQueryFactory를 Bean으로 등록해 프로젝트 전역에서 사용할 수 있도록 한다.

 

❗ JPAQueryFactory 객체가 import 되지 않아서 고생을 많이 했는데 intellij 캐시 삭제 하니까 깔끔하게 해결됐다 ;;;;

내시간 돌려줘요 ;;; 동일 문제 발생 시,  File > invalidate Caches 를 눌러 캐시 삭제하기

 

 

---

 

3.  .gitignore 설정 (디렉토리가 $buildDir/generated/querydsl인 경우 패스)

  :  build.gradle 파일에서 "$buildDir/generated/querydsl" 로 디렉토리를 지정해주었으면 상관없으나

 (build 루트는 애초에 .gitignore에 설정되어 있음)

나의 경우에는 build 루트로 만들면 Qclass가 제대로 import되지 않아서, src 아래에 폴더를 만들도록 했다.

 

.gitignore에 추가하여 버전관리가 되지 않도록 한다.

/src/main/generated/

 

---

 

그럼 이제 기본적인 셋팅은 끝났으니 간단한 예제로 테스트를 해보자 !

 

 SELECT * FROM TEST WHERE FIELD_1 IN ('테스트1', '테스트2');

---

0. Entity

@Entity
@Getter
@Setter
@Table(name = "testTable")
public class Test {
	@Id
	@column(name = "field_1")
    private String field1;
}

 

 1. Controller에 테스트용 조회 API 추가

@PostMapping("/Test")
public ResponseEntity select(@RequestBody String[] arr) {
	return new ResponseEntity(service.select(arr), HttpStatus.OK);
}

 

 

2. Service

public List<Test> select(String[] arr) {
	List<Test> rslt = testRepo.findByField1(arr);
	return rslt;
}

 

 

3. Repository

@Repository
public interface TestRepo extends JpaRepository<Test>, TestRepoCustom {
}

 

 

4. RepositoryCustom

public interface TestRepoCustom {
	List<Test> findByField1(String[] arr);
}

 

5. RepositoryImpl

@RequiredArgsConstructor
public class TestRepoImpl implements TestRepoCustom {
	private final JPAQueryFactory jpaQueryFactory;
    
    @Override
    public List<Test> findByField1(String[] arr) {
    	return jpaQueryFactory
        .selectFrom(test)
        .where(test.field1.in(arr))
        .fetch();
    }
}