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

[YONGHYNG]

QueryDSL 설정

build.gradle

plugins {
	id 'org.springframework.boot' version '3.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'

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

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

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

###QueryDSL 적용

JpaItemRepositoryV3

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
 * 데이터베이스와 연결되는 클래스에 붙이는 어노테이션
 * Spring이 자동으로 관리, @Component처럼 빈으로 등록
 * 원래 JPA는 PersistenceException 같은 예외를 던짐
 * 붙이면 Spring이 자동으로 DataAccessException으로 변환
 *
 * Spring이 자동으로 관리, 예외 처리 쉽게 해줌
 * */
@Repository

/**
 * @Transactional
 * 트랜잭션을 자동으로 관리
 * 디비에 작업을 하나의 단위로 묶는 것
 * Spring이 자동으로 트랜잭션을 시작하고, 끝나면 commit함
 *
 * 데이터 변경을 안전하게, 오류 발생 시 rollback 해줌
 * */
@Transactional
public class JpaItemRepositoryV3 implements ItemRepository {

    //JPA의 EntityManager를 사용하여 데이터베이스와 상호 작용
    private final EntityManager em;

    //JPAQueryFactory query : QueryDSL을 활용한 동적 쿼리 생성을 위해 JPAQueryFactory 사용
    private final JPAQueryFactory query;

    //생성자를 통해 EntityManager를 주입받고, JPAQueryFactory 초기화
    public JpaItemRepositoryV3(EntityManager em) {
        this.em = em;
        this.query = new JPAQueryFactory(em);
    }

    @Override
    /**
     * 아이템 저장(save)
     * em.persist(item)를 통해 새로운 Item 엔티티를 영속화(디비에 저장)
     * 저장된 엔티티를 그대로 반환
     * */
    public Item save(Item item) {
        em.persist(item);
        return item;
    }

    @Override
    /**
     * 아이템 수정(uodate)
     * ID로 기존 아이템을 찾고, 전달받은 updateParam 반영하여 수정
     * findById(itemId).orElseThrow() - 해당 ID의 아이템이 없으면 예외 발생
     * JPA는 트랜잭션 범위 내에서 엔티티를 변경하면 자동으로 변경 사항을 감지하여 디비에 반영
     * */
    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
    /**
     * 아이템 조회(findById)
     * em.find(Item.class, id) - JPA의 기본 메서드 사용, ID로 Item 조회
     * Optional.ofNullable(item) - null일 경우 대비, Optional로 감싸 반환
     * */
    public Optional<Item> findById(Long id) {
        Item item = em.find(Item.class, id);
        return Optional.ofNullable(item);
    }

    /**
     * 동적 검색 - 기존 방식(findAllOld)
     * QueryDSL의 BooleanBuilder를 사용, 동적 검색 조건을 적용
     * itemName이 있으면 item.itemName.like("%" + itemName + "%")로 필터링
     * maxPrice가 있으면 item.price.loe(maxPrice)로 가격 제한 적용
     * 최종적으로 QueryDSL의 fetch()를 사용하여 결과 리스트 반환
     * */
    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
    /**
     * 동적 검색 - 개선된 방식(findAll)
     * 기존 BooleanBuilder 대신 개별적인 BooleanExpression 메서드를 활용, 코드가 더 깔끔해짐
     * */
    public List<Item> findAll(ItemSearchCond cond) {

        String itemName = cond.getItemName();
        Integer maxPrice = cond.getMaxPrice();

        return query
                .select(item)
                .from(item)
                .where(likeItemName(itemName), maxPrice(maxPrice))
                .fetch();
    }

    /**
     * itemName이 있으면 LIKE 조건을 적용
     * QueryDSL에서는 null 반환, 해당 조건을 무시, BooleanBuilder 없이도, 동적 검색 가능
     * */
    private BooleanExpression likeItemName(String itemName) {
        if (StringUtils.hasText(itemName)) {
            return item.itemName.like("%" + itemName + "%");
        }
        return null;
    }

    /**
     * maxPrice가 설정되어 있으면 가격이 maxPrice 이하인 조건을 적용
     * */
    private BooleanExpression maxPrice(Integer maxPrice) {
        if (maxPrice != null) {
            return item.price.loe(maxPrice);
        }
        return null;
    }
}

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
 * 자동으로 생성자 주입
 * EntityManager는 JPA에서 DB와 연결을 관리하는 중요한 객체
 * 덕분에 EntityManager를 자동으로 생성자 주입
 * 즉, new QuerydslConfig(em)처럼 자동으로 주입
 * */
@RequiredArgsConstructor // final 필드(EntityManager)를 자동으로 주입
public class QuerydslConfig {

    private final EntityManager em;//JPA에서 DB와 연결을 도와주는 객체

    @Bean//스프링이 이 메서드를 실행하고, 반환 값을 관리(Bean) 등록
    public ItemService itemService() {
        return new ItemServiceV1(itemRepository());
    }

    @Bean
    public ItemRepository itemRepository() {
        return new JpaItemRepositoryV3(em);
    }
}

QueryDSL 장점

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

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