[스프링 DB 2편] #7. 데이터 접근 기술 - Querydsl

[Develop-KIM]

Querydsl 소개1 - 기존 방식의 문제점

긴급 요구사항

• 검색 조건 추가
• 나이
• 이름

쿼리 추가

String sql = "select * from member" + "where name like ?" + "and age between ? and ?"

버그 발생
문자를 합치면

"select * from memberwhere name like ?and age between ? and ?"

QUERY의 문제점

• QUERY는 문자, Type-check 불가능
• 실행하기 전까지 작동여부 확인 불가

에러는 크게 2가지

• 런타임 에러
• 컴파일 에러

SQL, JPQL

• 만약 SQL이 클래스처럼 타입이 있고 자바 코드로 작성할 수 있다면?
• type-safe

Type-safe

• 컴파일시 에러 체크 가능
• Code-assistant x 100!!!
• CTRL + SPACE + .(DOT)

QueryDSL

• 쿼리를 Java로 type-safe하게 개발할 수 있게 지원하는 프레임워크
• 주로 JPA 쿼리(JPQL)에 사용

JPA에서 QUERY 방법은 크게 3가지

1. JPQL(HQL)
2. Criteria API
3. MetaModel Criteria API(type-safe)

JPQL(HQL)
장점 : SQL QUERY와 비슷해서 금방 익숙해진다.
단점: type-safe 아니라 동적쿼리 생성이 어렵다.

Criteria API
장점 : 동적쿼리 생성이 쉽다.
단점 : type-safe 가 아니다. 복잡하다.

MetaModel Criteria API (type-safe)

• Criteria API + MetaModel
• Criteria API와 거의 동일하다.
• type-safe
• 복잡하다.

QueryDSL 분석

• Domain(도메인)
• Specific(특화)
• Language(언어)

DSL

• 도메인 + 특화 + 언어
• 특정한 도메인에 초점을 맞춘 제한적인 표현력을 가진 컴퓨터 프로그래밍 언어
• 특징 : 단순, 간결, 유창

QueryDSL

• 쿼리 + 도메인 + 특화 + 언어
• 쿼리에 특화된 프로그래밍 언어
• 단순, 간결, 유창
• 다양한 저장소 쿼리 기능 통합

JPA, MongoDB, SQL 같은 기술들을 위해 type-safe SQL을 만드는 프레임워크이다.

Querydsl-JPA

• 장점
  • type-safe
  • 단순하다.
  • 쉽다.
• 단점
  • Q코드 생성을 위한 APT를 설정해야 한다.

Querydsl-JPA 기능

구성

• Query
  • 예시) from, where, join
• Path
  • 예시) QMember, QMember.name
• Expression
  • 예시) name.eq, name.gt

기능 살펴보기

• from
• innerJoin, join, leftJoin, fullJoin, on
• where (and, or, allOf, anyOf)
• groupBy
• having
• orderBy (desc, asc)
• limit, offset, restrict(limit + offset) (Paging)
• list
• iterate
• count
• fetch(): 목록 조회
• fetchOne(): 단건 조회

SpringDataJPA + Querydsl

• SpringData 프로젝트의 약점은 조회이다.
• Querydsl로 복잡한 조회 기능 보완
  • 복잡한 쿼리
  • 동적 쿼리
• 단순한 경우 : SpringDataJPA
• 복잡한 경우 : Querydsl 직접 사용

Querydsl 설정

스프링 부트 2.x와 스프링 부트 3.x의 설정이 다르다.

스프링 부트 2.x 설정

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'
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'

//	implementation 'org.springframework.boot:spring-boot-starter-data-jdbc'

	implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.2.2'
	testImplementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter-test:2.2.2'

    // 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"

	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')
}

스프링 3.x 설정

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

Q타입 삭제

//Querydsl 추가, 자동 생성된 Q클래스 gradle clean으로 제거
clean {
    delete file('src/main/generated')
}

Querydsl 적용

JpaItemRepositoryV3

@Transactional
@Repository
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 = em.find(Item.class, itemId);
        findItem.setItemName(updateParam.getItemName());
        findItem.setPrice(updateParam.getPrice());
        findItem.setQuantity(updateParam.getQuantity());
    }

    @Override
    public Optional<Item> findById(Long id) {
        return Optional.ofNullable(em.find(Item.class, id));
    }

    @Override
    public List<Item> findAll(ItemSearchCond cond) {
        return query
            .select(item)
            .from(item)
            .where(likeItemName(cond.getItemName()), maxPrice(cond.getMaxPrice()))
            .fetch();
    }

    private BooleanExpression likeItemName(String itemName) {
        if (StringUtils.hasText(itemName)) {
            return item.itemName.like("%" + itemName + "%");
        }
        return null;
    }

    private Predicate 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

@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(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은 실무의 다양한 문제를 편리하게 해결하기 위해 선택하는 기본 기술이라 생각한다.