[Querydsl] Querydsl 이란?

QueryDsl 이란?

Querydsl은 정적 타입을 이용해서 SQL과 같은 쿼리를 생성할 수 있도록 해주는 라이브러리 입니다.

Querydsl은 쿼리를 type-safe하게 개발할 수 있게 지원하는 라이브러리로 주로 JPA Query ( JPQL )에서 사용합니다.

 

DSL은 Domain Specific Language로 특정한 토메인에 초점을 맞춘 제한적인 표현력을 가진 컴퓨터 프로그래밍 언어로 단순하고, 간결합니다.

 

이 DSL을 쿼리에 적용시켜 쿼리에 특화된 프로그래밍 언어로 제공한 것이 QueryDSL입니다.

 

기존 방식에는 어떤 문제가 있었을까?

 

- Query를 직접 작성해야 하는 SQL Mapper 방식이나 JPA에서 JPQL을 사용해 Query가 잘못 작성되는 경우 컴파일 시점에서 체크가 불가능하고 오직 런타임 시점에서 체크를 하기 때문에 개발자가 오류를 찾는데 어려움이 있었습니다. 이런 문제는 'type-safe 하지 않다'고 말합니다.

 

'type-safe 하다' -> 컴파일 시점에서 문제를 잡을 수 있다.

[Java] Type Safe란?

 

- Querydsl을 사용하면 쿼리를 메소드로 제어해서 컴파일 시점에서 쿼리의 오류를 잡아줄 수 있습니다. 앞서 살펴본 Spring Data JPA에는 ( 동적인 쿼리에 대한 ) 조회에서 약점이 있었습니다.

Querydsl로 복잡한 조회 기능을 보완하고 그 외 단순한 경우는 Spring Data JPA를 사용합시다.

---

QueryDSL - JPA 동작 

Querydsl은 @Entity 어노테이션이 붙은 도메인을 읽어 Query Domain을 생성해줍니다. (ex) Item -> QItem, Member - > QMember) 

JPAQueryFactory query = new JPAQueryFactory (entityManager); 
QMember m = QMember.member;

List<Member> list = query.select(m)
                    	.from(m) 
                        .where(m.age.between(20, 40).and(m.name.like("김%")))
                        .orderBy(m.age.desc()) .limit(3)
                        .fetch(m);

EntityManager를 주입받아 JPAQueryFactory 객체를 하나 만들고, 객체의 메소드를 통해 쿼리를 만들 수 있습니다.

메소드를 통해서 쿼리를 만들게 되면 type-safe한 이점을 얻습니다. (ex) 메소드의 이름을 잘못 작성하는 경우 컴파일 시점에서 에러를 잡아줍니다)

• fetch() : 목록 조회
• fetchOne() : 단건 조회

생성된 쿼리

select id, age, name
from MEMBER
where age between 20 and 40 and name like '김%'
order by age desc
limit 3

 

기능 

• from
• innerJoin, join, leftjoin, fullJoin, on
• where (and,or,allOf,anyOf)
• groupBy
• having
• orderBy(desc,asc)
• limit, offset, restrict 

 

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 파일 생성 확인

1. Gradle -> Tasks -> build -> clean
2. Gradle -> Tasks -> other -> compileJava
build -> generated - > sources -> annotationProcessor -> java/main 하위 확인 

+ 참고: Q타입은 컴파일 시점에 자동 생성되므로 버전관리(GIT)에 포함하지 않는 것이 좋습니다.

---

Querydsl 적용

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

• Querydsl을 사용하려면 JPAQueryFactory가 필요합니다. JPAQueryFactory는 JPA 쿼리인 JPQL을 만들기 때문에 EntityManager가 필요합니다.
• 물론 JPAQueryFactory를 스프링 빈으로 등록해서 사용해도 됩니다.

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

• save(), update(), findById() 같은 기본 기능들은 JPA가 제공하는 기본 기능 사용

Querydsl을 적용해 동적 쿼리 문제 해결

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> results = query.select(item)
            .from(item)
            .where(builder)
            .fetch();

    return results;
}

• BooleanBuilder를 사용해서 원하는 where조건들을 넣어줍니다.

 

더 깔끔하게 리펙토링

 

@Override
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();
}

• 1) Qitem static import -> item
• Querydsl에서 where(A,B)에 다양한 조건들을 직접 넣을 수 있는데, 이렇게 넣으면 and로 처리됩니다. 조건이 null인 경우 해당 조건 무시

+ config 설정

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

---

<정리>

• Querydsl을 사용해 동적 쿼리를 깔끔하게 처리해보았습니다.
• Querydsl을 사용하면 type-safe하기 때문에 개발자 입장에서는 오류를 찾기 쉽습니다.
• where문 내에 메소드로 조건을 만들었기 때문에 다른 동적 쿼리에서도 재사용의 여지가 있습니다.

---

<참고자료>

스프링 DB 2편 - 데이터 접근 활용 기술 - 인프런 | 강의