TIL_0211 - QueryDSL ?

MSA프로젝트 실습 관련 강의를 보던 중 QueryDSL에 대해 강사님이 말하시는데 첨 듣는거라 당황했다... 아무래도 JPA를 잘몰라서 그런듯 ㅜㅜ
앞으로의 프로젝트를 위해 알고가면 좋다고 말씀하셔서 QueryDSL이 뭔지 찾아보게 되었다.

먼저 DSL 이란?

DSL (Domain-Specific-Languages)
특정 도메인에서 발생하는 문제를 효과적으로 해결하기 위해 설계된 언어

Querydsl 이란?

SQL 형식의 쿼리를 Type-Safe 하게 생성할 수 있도록 하는 DSL을 제공하는 라이브러리

• Type-Safe : 타입 안전한 쿼리를 작성해 오류를 미리 방지하고 안정적인 코드를 유지한다는 뜻

Querydsl 설정 방법

1. Querydsl - jpa 의존성 추가
   implementation "com.querydsl:querydsl-jpa:5.0.0:jakarta"

2. QClass 생성을 위한 annotationProcesser 추가

annotationProcessor "com.querydsl:querydsl-apt:5.0.0:jakarta"
annotationProcessor "jakarta.annotation:jakarta.annotation-api"
annotationProcessor "jakarta.persistence:jakarta.persistence-api"

• QClass 란?
  엔티티의 메타데이터를 제공하여 Type-safe 하게 쿼리를 작성할 수 있도록 도와줍니다.
  예를 들어, User 엔티티가 있다면, 쿼리DSL은 자동으로 QUser 클래스를 생성하여 이를 통해 쿼리를 작성할 수 있습니다.

간단한 예시

1. User 엔티티

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String username;
    private int age;

    // getters and setters
}

2. QUser 클래스
   QUser 클래스는 JPA에서 자동 생성되며, QueryDSL을 사용하여 User 엔티티에 대한 메타데이터를 제공한다.
   QUser.user로 참조할 수 있다.

3. 쿼리DSL로 쿼리 작성하기
   쿼리DSL로 User 테이블에서 age가 19이상인 사용자를 조회하는 쿼리를 작성해보면

@Autowired
private EntityManager entityManager;

public List<User> findUsers() {
    JPAQueryFactory queryFactory = new JPAQueryFactory(entityManager);
    QUser qUser = QUser.user;

    List<User> users = queryFactory
        .selectFrom(qUser)
        .where(qUser.age.goe(19))
        .fetch();

    return users;
}

이렇게 하면 age가 19세 이상인 사용자만 조회됩니다.
즉, 쿼리DSL을 사용하여 SQL을 작성하지 않고도 데이터를 조회할 수 있습니다.

---

JpaRepository 와 함께 사용하는 법

1. 사용할 JpaRepository 선언

@Repository
public interface ProductRepository extends JpaRepository<Product, Long> {
}

2. JPAQueryFactory 빈등록

@Component
public class ProductServiceApplicationQueryDslConfig {
    @Bean
    JPAQueryFactory jpaQueryFactory(EntityManager em){
        return new JPAQueryFactory(em);
    }
}

3. CustomRepository 인터페이스 생성

public interface ProductRepositoryCustom {
    Page<ProductResponseDto> searchProducts(ProductSearchDto searchDto, Pageable pageable);
}

4. CustomRepositoryImpl 클래스 구현

@RequiredArgsConstructor
public class ProductRepositoryImpl implements ProductRepositoryCustom{
	private final JPAQueryFactory queryFactory;
    @Override
    public Page<ProductResponseDto> searchProducts(ProductSearchDto searchDto, Pageable pageable) {
    return /* querydsl 코드 */
}

5. 사용할 JPA 레포지터리 수정

@Repository
public interface ProductRepository extends JpaRepository<Product, Long>, ProductRepositoryCustom {
}

---

쿼리 DSL 장단점

장점

• 복잡한 쿼리를 객체지향적으로 생성할 수 있음
• SQL에 대한 타입 안정성 제공
• 동적 쿼리 작성에 유용함 (검색 기능 만들 때 매우 유용!)

단점

• 코딩을 더ㅓㅓㅓㅓ 많이 해야 하고 복잡하다..

---

마무리

QueryDSL의 사용법과 장단점, 그리고 어떻게 활용할 수 있는지에 대해 이해했으니
JOIN, GROUP BY, HAVING, ORDER BY 같은 SQL의 다양한 기능과 페이지네이션도 QueryDSL로 하는 법에 대해 더 공부해봐야겠다.. 😂