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

[6om1n]

1️⃣ Querydsl 설정

스프링 부트 3.x 설정

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

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

검증 - Q타입 생성 확인 방법

• Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle
  

Gradle - Q 타입 생성 확인 방법

• Gradle -> Tasks -> build -> clean
• Gradle -> Tasks -> other -> compileJava

Q 타입 생성 확인

• build -> generated -> sources -> annotationProcessor -> java/main 하위에 hello.itemservice.domain.QItem 생성 확인

Q 타입 삭제

• gradle clean 을 수행하면 build 폴더 자체가 삭제된다. 별도의 설정은 없어도 된다.

---

2️⃣ Querydsl 적용

• JpaItemRepositoryV3

package hello.itemservice.repository.jpa;

import com.querydsl.core.BooleanBuilder;
import com.querydsl.jpa.impl.JPAQueryFactory;
import hello.itemservice.domain.Item;
import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;
import org.apache.ibatis.ognl.BooleanExpression;
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;

@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.JpaItemRepositoryV2;
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 JpaItemRepositoryV2(em);
    }
}

ItemServiceApplication - 변경

@Import(QuerydslConfig.class)
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")
public class ItemServiceApplication {

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

---