데이터 접근 기술 - Querydsl
Querydsl 소개
기존 방식의 문제점
QUERY의 문제점
- QUERY는 문자이므로 Type-check 불가능
- 실행하기 전까지 작동여부 확인 불가
JPA에서 QUERY 방법은 크게 3가지
- JPQL(HQL)
- 장점
- SQL QUERY와 비슷해서 금방 익숙해짐
- 단점
- type-safe 아님
- 동적쿼리 생성이 어려움
- Criteria API
- 장점
- 동적쿼리 생성 가능
- 단점
- type-safe 아님
- 너무 너무 너무 복잡함
- 알아야 할 게 너무 많음
- MetaModel Criteria API(type-safe)
root.get("age")→root.get(Member_.age)- Criteria API + MetaModel
- Criteria API와 거의 동일
- type-safe
- 복잡하긴 마찬가지
해결
DSL
- 도메인(Domain) + 특화(Specific) + 언어(Language)
- 특정한 도메인에 초점을 맞춘 제한적인 표현력을 가진 컴퓨터 프로그래밍 언어
- 특징 : 단순, 간결, 유창
QueryDSL
- 쿼리 + 도메인 + 특화 + 언어
- 쿼리에 특화된 프로그래밍 언어
- 단순, 간결, 유창
- 다양한 저장소 쿼리 기능 통합 → JPA, MongoDB, SQL 같은 기술들을 위해 type-safe SQL을 만드는 프레임워크
데이터 쿼리 기능 추상화 
Type-safe Query Type 생성 
작동 방식 
SpringDataJPA + Querydsl
- SpringData프로젝트의 약점은 조회
- Querydsl로 복잡한 조회 기능 보완
- 복잡한 쿼리
- 동적 쿼리
- 단순한 경우 : SpringDataJPA
- 복잡한 경우 : Querydsl 직접 사용
Querydsl 설정
build.gradle
plugins {
id 'org.springframework.boot' version '2.6.5'
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
id 'java'
}
group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'
ext["hibernate.version"] = "5.6.5.Final"
configurations {
compileOnly {
extendsFrom annotationProcessor
}
}
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
implementation 'org.springframework.boot:spring-boot-starter-web'
//JdbcTemplate 추가
//implementation 'org.springframework.boot:spring-boot-starter-jdbc'
//MyBatis 추가
implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.2.0'
//JPA, 스프링 데이터 JPA 추가
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
//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"
//H2 데이터베이스 추가
runtimeOnly 'com.h2database:h2'
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
//테스트에서 lombok 사용
testCompileOnly 'org.projectlombok:lombok'
testAnnotationProcessor 'org.projectlombok:lombok'
}
tasks.named('test') {
useJUnitPlatform()
}
//Querydsl 추가, 자동 생성된 Q클래스 gradle clean으로 제거
clean {
delete file('src/main/generated')
}
Querydsl로 추가된 부분은 다음 두 부분
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 추가, 자동 생성된 Q클래스 gradle clean으로 제거
clean {
delete file('src/main/generated')
}
검증 - Q 타입 생성 확인 방법
- Preferences → Build, Execution, Deployment → Build Tools → Gradle
여기에 가면 크게 2가지 옵션을 선택할 수 있는데 옵션은 둘다 같게 맞추어야 함
- Gradle: Gradle을 통해서 빌드
- IntelliJ IDEA: IntelliJ가 직접 자바를 실행해서 빌드
옵션 선택1 - Gradle - Q타입 생성 확인 방법 Gradle IntelliJ 사용법
Gradle -> Tasks -> build -> cleanGradle -> Tasks -> other -> compileJava
Gradle 콘솔 사용법
./gradlew clean compileJava
Q 타입 생성 확인
build -> generated -> sources -> annotationProcessor -> java/main하위에hello.itemservice.domain.QItem이 생성되어 있어야 함
참고: Q타입은 컴파일 시점에 자동 생성되므로 버전관리(GIT)에 포함하지 않는 것이 좋다. gradle 옵션을 선택하면 Q타입은
gradle build폴더 아래에 생성되기 때문에 여기를 포함하지 않아야 한다. 대부분 gradle build 폴더를 git에 포함하지 않기 때문에 이 부분은 자연스럽게 해결된다.
Q타입 삭제 gradle clean을 수행하면 build 폴더 자체가 삭제되므로 별도의 설정 불필요
옵션 선택2 - IntelliJ IDEA - Q타입 생성 확인 방법 Build -> Build Project 또는 Build -> Rebuild 또는 main(), 또는 테스트를 실행
src/main/generated 하위에 hello.itemservice.domain.QItem이 생성되어 있어야 함
참고: Q타입은 컴파일 시점에 자동 생성되므로 버전관리(GIT)에 포함하지 않는 것이 좋다. IntelliJ IDEA 옵션을 선택하면 Q타입은
src/main/generated폴더 아래에 생성되기 때문에 여기를 포함하지 않는 것이 좋다.
Q타입 삭제
//Querydsl 추가, 자동 생성된 Q클래스 gradle clean으로 제거
clean {
delete file('src/main/generated')
}
IntelliJ IDEA 옵션을 선택하면 src/main/generated에 파일이 생성되고, 필요한 경우 Q파일을 직접 삭제해야 함 gradle에 해당 스크립트를 추가하면 gradle clean 명령어를 실행할 때 src/main/generated의 파일도 함께 삭제
참고
Querydsl은 이렇게 설정하는 부분이 사용하면서 조금 귀찮은 부분인데, IntelliJ가 버전업 하거나 Querydsl의 Gradle 설정이 버전업 하면서 적용 방법이 조금씩 달라지기도 함. 그리고 본인의 환경에 따라서 잘 동작하지 않기도 함. 공식 메뉴얼에 소개 되어 있는 부분이 아니기 때문에, 설정에 수고로움이 있지만 querydsl gradle 로 검색하면 본인 환경에 맞는 대안을 금방 찾을 수 있음
Querydsl 적용
JpaItemRepositoryV3
import com.querydsl.core.BooleanBuilder;
import com.querydsl.core.types.dsl.BooleanExpression;
import com.querydsl.jpa.impl.JPAQueryFactory;
import hello.itemservice.domain.Item;
import hello.itemservice.domain.QItem;
import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;
import org.springframework.stereotype.Repository;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.util.StringUtils;
import javax.persistence.EntityManager;
import java.util.List;
import java.util.Optional;
import static hello.itemservice.domain.QItem.*;
@Repository
@Transactional
public class JpaItemRepositoryV3 implements ItemRepository {
private final EntityManager em;
private final JPAQueryFactory query;
public JpaItemRepositoryV3(EntityManager em) {
this.em = em;
this.query = new JPAQueryFactory(em);
}
@Override
public Item save(Item item) {
em.persist(item);
return item;
}
@Override
public void update(Long itemId, ItemUpdateDto updateParam) {
Item findItem = findById(itemId).orElseThrow();
findItem.setItemName(updateParam.getItemName());
findItem.setPrice(updateParam.getPrice());
findItem.setQuantity(updateParam.getQuantity());
}
@Override
public Optional<Item> findById(Long id) {
Item item = em.find(Item.class, id);
return Optional.ofNullable(item);
}
public List<Item> findAllOld(ItemSearchCond itemSearch) {
String itemName = itemSearch.getItemName();
Integer maxPrice = itemSearch.getMaxPrice();
QItem item = QItem.item;
BooleanBuilder builder = new BooleanBuilder();
if (StringUtils.hasText(itemName)) {
builder.and(item.itemName.like("%" + itemName + "%"));
}
if (maxPrice != null) {
builder.and(item.price.loe(maxPrice));
}
List<Item> result = query
.select(item)
.from(item)
.where(builder)
.fetch();
return result;
}
@Override
public List<Item> findAll(ItemSearchCond cond) {
String itemName = cond.getItemName();
Integer maxPrice = cond.getMaxPrice();
List<Item> result = query
.select(item)
.from(item)
.where(likeItemName(itemName), maxPrice(maxPrice))
.fetch();
return result;
}
private BooleanExpression likeItemName(String itemName) {
if (StringUtils.hasText(itemName)) {
return item.itemName.like("%" + itemName + "%");
}
return null;
}
private BooleanExpression maxPrice(Integer maxPrice) {
if (maxPrice != null) {
return item.price.loe(maxPrice);
}
return null;
}
}
공통
- Querydsl을 사용하려면
JPAQueryFactory가 필요.JPAQueryFactory는 JPA 쿼리인 JPQL을 만들기 때문에EntityManager가 필요 - 설정 방식은
JdbcTemplate을 설정하는 것과 유사 - 참고로
JPAQueryFactory를 스프링 빈으로 등록해서 사용해도 됨
save(), update(), findById() 기본 기능들은 JPA가 제공하는 기본 기능을 사용
findAllOld Querydsl을 사용해서 동적 쿼리 문제를 해결 BooleanBuilder를 사용해서 원하는 where 조건들을 넣음 이 모든 것을 자바 코드로 작성하기 때문에 동적 쿼리를 매우 편리하게 작성할 수 있음
findAll 앞서 findAllOld에서 작성한 코드를 깔끔하게 리팩토링
List<Item> result = query
.select(item)
.from(item)
.where(likeItemName(itemName), maxPrice(maxPrice))
.fetch();
- Querydsl에서
where(A,B)에 다양한 조건들을 직접 넣을 수 있는데, 이렇게 넣으면 AND 조건으로 처리됨. 참고로 where() 에null을 입력하면 해당 조건은 무시 - 이 코드의 또 다른 장점은
likeItemName(),maxPrice()를 다른 쿼리를 작성할 때 재사용 할 수 있다는 점. 쉽게 이야기해서 쿼리 조건을 부분적으로 모듈화 할 수 있음. 자바 코드로 개발하기 때문에 얻을 수 있는 큰 장점
QuerydslConfig
package hello.itemservice.config;
import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.jpa.JpaItemRepositoryV3;
import hello.itemservice.service.ItemService;
import hello.itemservice.service.ItemServiceV1;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.persistence.EntityManager;
@Configuration
@RequiredArgsConstructor
public class QuerydslConfig {
private final EntityManager em;
@Bean
public ItemService itemService() {
return new ItemServiceV1(itemRepository());
}
@Bean
public ItemRepository itemRepository() {
return new JpaItemRepositoryV3(em);
}
}
ItemServiceApplication - 변경
//@Import(SpringDataJpaConfig.class)
@Import(QuerydslConfig.class)
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")
public class ItemServiceApplication {}
QuerydslConfig를 사용하도록 변경
예외 변환 Querydsl에서 별도의 스프링 예외 추상화를 지원하지 않는 대신 JPA에서 학습한 것처럼 @Repository에서 스프링 예외 추상화를 처리
정리
Querydsl 장점
Querydsl 덕분에 동적 쿼리를 매우 깔끔하게 사용할 수 있음
List<Item> result = query
.select(item)
.from(item)
.where(likeItemName(itemName), maxPrice(maxPrice))
.fetch();
- 쿼리 문장에 오타가 있어도 컴파일 시점에 오류를 막을 수 있음
- 메서드 추출을 통해서 코드를 재사용할 수 있음. 예를 들어서 여기서 만든
likeItemName(itemName),maxPrice(maxPrice)메서드를 다른 쿼리에서도 함께 사용할 수 있음
Querydsl을 사용해서 자바 코드로 쿼리를 작성하는 것이 장점. 그리고 동적 쿼리 문제도 깔끔하게 해결. Querydsl은 이 외에도 수 많은 편리한 기능을 제공. 예를 들어서 최적의 쿼리 결과를 만들기 위해서 DTO로 편리하게 조회하는 기능은 실무에서 자주 사용하는 기능. JPA를 사용한다면 스프링 데이터 JPA와 Querydsl은 실무의 다양한 문제를 편리하게 해결하기 위해 선택하는 기본 기술