[스프링 DB 2편] #7. Querydsl

[Pracrobo]

소개 1: 기존 방식의 문제점

Query 는 문자

인지를 잘 할 수 있는

컴파일 에러 : 좋은 에러

런타임 에러 : 나쁜 에러(고객이 직접 실행할 때 나는 에러)

SQL 컬럼명을 모두 외울 수 있을까?

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

QueryDSL

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

JPA Query : Java ORM

1. JPQL(HQL)

• 장점: SQL Query랑 비슷해서 금방 익숙해짐
• 단점: type-safe 아님, 동적 쿼리 생성이 어려움

1. Critieria API

• 장점: 동적 쿼리 생성이 쉽다?
• 단점
  • type-safe 아님
  • 너무 복잡함
  • 알아야 할 게 너무 많음

1. MetaModel Criteria API (type-safe)

• Critieria API + MetaModel
• 복잡
• type-safe

Querydsl 소개2 : 해결

DSL 도메인 특화 언어

: 특정 도메인에 초점을 맞춘 제한적인 표현력을 가진 컴퓨터 프로그래밍 언어

특징 : 단순, 간결, 유창

QueryDSL : 쿼리 + 도메인 + 특화 + 언어

쿼리 + 도메인 + 특화 + 언어

쿼리에 특화된 프로그래밍 언어

단순, 간결 , 유창

다양한 저장소 쿼리 기능 통합

작동 방식은 QUERY DSL → JPQL → SQL

생성순으로 간다.

querydsl - JPA

장점

• type- safe
• 단순함
• 쉬움

단점

• Q코드 생성을 위한 APT를 설정해야함

SpringDataJPA + Querydsl

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

QueryDSL 설정(Spring boot 3.x)

build.gradle

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

annotationProcessor : entity annotation을 읽어서 QItem이라는 Querydsl을 처리하기 위한 클래스를 만들어주기 위한 처리기

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

• 플러그인, Intellij, querydsl version에 따라 설정이 달라질 수 있음 > 검색을 참고

설정이 환경에 따라 다름

Option1 ) Gradle - Q타입 생성 확인 방법

• Gradle → Tasks → build → Clean : 과거의 gradle 초기화
• Gradle → Tasks → other → compileJava 실행
• Gradle로 설정시 build 폴더 생김 → generated → sources → annotationProcessor → Java → main → QItem 파일 생김
• 패키지 hello.itemservice.domain
• hello.itemservice.domain.QItem이 생성되어 있어야 한다.

Gradle 콘솔 사용법
./gradlew clean compileJava

Q타입은 컴파일 시점에 자동 생성되므로 버전관리에 포함하지 않는것이 좋다
gradle 옵션을 선택하면 Q타입은 gradle build 폴더 아래에 생성되기 때문에 여기를 포함하지 않아야 한다.
대부분 gradle build 폴더에 git에 포함하지 않기 때문에 이 부분은 자연스럽게 해결된다.

삭제방법
gradle → clean 실행하면 삭제됨

Option 2) Intellij - Q타입 생성 확인 방법

main() Run → generated → Q타입 확인
build → BuildProject 또는 Rebuild(캐시 최적화때문에 안될경우) → QItem 파일 생성 확인

git ignore 를 generated 파일로 지정해서 빼주기

삭제방법
수동 삭제

적용

package hello.itemservice.repository.jpa;

import com.querydsl.core.BooleanBuilder;
import com.querydsl.core.types.Predicate;
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;   //JPA를 쓰려면 이게 필요

    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) {
        Item item = em.find(Item.class, id);
        return Optional.ofNullable(item);
    }

    public List<Item> findAllOld(ItemSearchCond cond) {

        String itemName = cond.getItemName();
        Integer maxPrice = cond.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();

// querydsl 쓰는 방법
        return query
                .select(item)
                .from(item)
                .where(likeItemName(itemName), maxPrice(maxPrice))
                .fetch();
    }

    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;
    }
}

loe : Less or Equal 즉 작거나 같다를 뜻하고
크거나 같다는 goe를 사용해주면 된다.
또 eq, between 등 다양한 조건을 거는 것이 가능하며 굉장히 직관적이다.

        List<Item> result = query
                .select(item)
                .from(item)
                .where(builder)
                .fetch();

        return result;

정리

Querydsl 장점

동적 쿼리 깔끔하게 사용할 수 있다.

List<Item> result = query
    .select(item)
    .from(item)
    .where(likeItemName(itemName), maxPrice(maxPrice))
    .fetch();

• 쿼리 문장에 오타가 있어도 컴파일 시점에 오류를 막을 수 있다.
• 메서드 추출을 통해서 코드를 재사용할 수 있다.
• 예를 들어 likeItemName(itemName), maxPrice(maxPrice) 메서드를 다른 쿼리에서도 함께 사용할 수 있다.