[20250214] querydsl 기본 예시로 사용방법 알아보기!

Querydsl 완전 정복 가이드: 초보자도 이해하는 핵심 개념과 활용법

Querydsl은 복잡한 SQL 쿼리를 자바 코드로 쉽고 간결하게 작성할 수 있도록 도와주는 오픈소스 프레임워크입니다. 마치 SQL을 자바 언어처럼 다루어 프로그래밍적인 접근이 가능하게 해줍니다. 복잡한 쿼리 작성의 어려움을 해결하고 생산성을 높여주기 때문에 많은 개발자들이 애용하고 있습니다.

 

1. Querydsl, 왜 사용할까요?

• 가독성 향상: SQL 쿼리를 문자열로 작성하는 대신 자바 코드로 표현하여 가독성을 높이고 유지보수를 용이하게 합니다.
• 생산성 향상: 복잡한 쿼리를 간단하게 작성할 수 있어 개발 시간을 단축시켜줍니다.
• 타입 안정성: 컴파일 시점에 오류를 발견하여 런타임 오류를 줄여줍니다.
• 유연성: 다양한 데이터베이스와 ORM 프레임워크를 지원하여 활용 범위를 넓혀줍니다.

 

2. Querydsl 핵심 개념 파헤치기

• Q-Type: Querydsl은 엔티티 클래스를 기반으로 Q-Type이라는 쿼리 타입을 생성합니다. 이 Q-Type을 사용하여 쿼리 작성 시 필드명이나 엔티티명을 직접 참조할 수 있습니다.
• JPA QL: Querydsl은 JPA QL이라는 JPQL 기반의 쿼리 언어를 사용합니다. JPA QL은 SQL과 유사하면서도 엔티티 중심의 쿼리 작성을 지원합니다.
• Predicate: Querydsl에서 where 절의 조건을 나타내는 인터페이스입니다. Predicate를 사용하여 다양한 조건을 조합하고 쿼리에 적용할 수 있습니다.
• Querydsl API: Querydsl은 다양한 API를 제공하여 쿼리 작성, 실행, 결과 처리 등을 지원합니다.

 

3. Querydsl, 이렇게 사용해요!

 

1. Querydsl 의존성 추가: 프로젝트에 Querydsl 의존성을 추가합니다.
2. Q-Type 생성: 엔티티 클래스를 기반으로 Q-Type을 생성합니다.
3. Querydsl 인스턴스 생성: 쿼리 실행을 위한 Querydsl 인스턴스를 생성합니다.
4. 쿼리 작성: Q-Type과 Querydsl API를 사용하여 원하는 쿼리를 작성합니다.
5. 쿼리 실행: 작성된 쿼리를 실행하고 결과를 반환받습니다.

Querydsl 기본 예시: 간단한 회원 관리 기능

Querydsl을 사용하여 간단한 회원 관리 기능을 구현하는 예시를 통해 기본적인 사용법을 익혀보겠습니다.

 

1. 프로젝트 설정

• Spring Boot 프로젝트를 생성하고 Querydsl 의존성을 추가합니다.
• 회원 엔티티(Member)를 생성합니다.

 

Java

@Entity
public class Member {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;
    private int age;

    // ... getter, setter 등
}

 

2. Q-Type 생성

• 엔티티 클래스를 기반으로 Q-Type을 생성합니다. (IntelliJ IDEA 등 IDE에서 지원)

3. Querydsl 인스턴스 생성

• JPAQueryFactory를 사용하여 Querydsl 인스턴스를 생성합니다.

 

Java

@PersistenceContext
private EntityManager entityManager;

private JPAQueryFactory queryFactory;

@BeforeEach
public void setUp() {
    queryFactory = new JPAQueryFactory(entityManager);
}

 

4. 쿼리 작성 및 실행

• Q-Type과 Querydsl API를 사용하여 원하는 쿼리를 작성하고 실행합니다.

 

Java

QMember member = QMember.member;

// 이름으로 회원 조회
Member findMember = queryFactory
    .selectFrom(member)
    .where(member.name.eq("홍길동"))
    .fetchOne();

// 나이순으로 회원 정렬 후 조회
List<Member> members = queryFactory
    .selectFrom(member)
    .orderBy(member.age.asc())
    .fetch();

 

5. 예시 코드 전체

 

Java

@SpringBootTest
public class MemberRepositoryTest {

    @PersistenceContext
    private EntityManager entityManager;

    private JPAQueryFactory queryFactory;

    @BeforeEach
    public void setUp() {
        queryFactory = new JPAQueryFactory(entityManager);
    }

    @Test
    public void 회원_이름으로_조회() {
        QMember member = QMember.member;

        Member findMember = queryFactory
            .selectFrom(member)
            .where(member.name.eq("홍길동"))
            .fetchOne();

        assertThat(findMember.getName()).isEqualTo("홍길동");
    }

    @Test
    public void 회원_나이순으로_정렬후_조회() {
        QMember member = QMember.member;

        List<Member> members = queryFactory
            .selectFrom(member)
            .orderBy(member.age.asc())
            .fetch();

        assertThat(members.get(0).getAge()).isLessThanOrEqualTo(members.get(1).getAge());
    }
}

 

6. 실행 결과

• 위 예시 코드를 실행하면 회원 이름으로 조회하거나 나이순으로 정렬된 회원 목록을 조회할 수 있습니다.

Querydsl 동적 쿼리 사용: 검색 기능 구현 예시

Querydsl을 사용하여 동적 쿼리를 구현하는 것은 검색 기능과 같이 다양한 조건에 따라 쿼리가 달라져야 하는 경우에 유용합니다. 다음은 기본적인 예시를 통해 Querydsl 동적 쿼리 사용법을 설명합니다.

 

1. 프로젝트 설정 및 엔티티 생성

• Spring Boot 프로젝트를 생성하고 Querydsl 의존성을 추가합니다.
• 검색 대상 엔티티(Product)를 생성합니다.

 

Java

@Entity
public class Product {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;
    private String category;
    private int price;

    // ... getter, setter 등
}

 

2. Q-Type 생성 및 Querydsl 인스턴스 생성

• 엔티티 클래스를 기반으로 Q-Type을 생성합니다.
• JPAQueryFactory를 사용하여 Querydsl 인스턴스를 생성합니다.

 

Java

@PersistenceContext
private EntityManager entityManager;

private JPAQueryFactory queryFactory;

@BeforeEach
public void setUp() {
    queryFactory = new JPAQueryFactory(entityManager);
}

 

3. 동적 쿼리 작성

• BooleanBuilder를 사용하여 동적 조건을 생성합니다.
• 검색 조건에 따라 BooleanBuilder에 조건을 추가합니다.

 

Java

@Test
public void 상품_검색() {
    QProduct product = QProduct.product;
    BooleanBuilder builder = new BooleanBuilder();

    String name = "운동화";
    String category = "의류";
    Integer price = 10000;

    if (StringUtils.hasText(name)) {
        builder.and(product.name.contains(name));
    }

    if (StringUtils.hasText(category)) {
        builder.and(product.category.eq(category));
    }

    if (price != null) {
        builder.and(product.price.goe(price));
    }

    List<Product> products = queryFactory
        .selectFrom(product)
        .where(builder)
        .fetch();

    // ... 결과 처리
}

 

4. 예시 코드 전체

 

Java

@SpringBootTest
public class ProductRepositoryTest {

    @PersistenceContext
    private EntityManager entityManager;

    private JPAQueryFactory queryFactory;

    @BeforeEach
    public void setUp() {
        queryFactory = new JPAQueryFactory(entityManager);
    }

    @Test
    public void 상품_검색() {
        QProduct product = QProduct.product;
        BooleanBuilder builder = new BooleanBuilder();

        String name = "운동화";
        String category = "의류";
        Integer price = 10000;

        if (StringUtils.hasText(name)) {
            builder.and(product.name.contains(name));
        }

        if (StringUtils.hasText(category)) {
            builder.and(product.category.eq(category));
        }

        if (price != null) {
            builder.and(product.price.goe(price));
        }

        List<Product> products = queryFactory
            .selectFrom(product)
            .where(builder)
            .fetch();

        // ... 결과 처리
    }
}

 

5. 실행 결과

• 위 예시 코드를 실행하면 검색 조건에 따라 상품 목록을 조회할 수 있습니다.

Querydsl 페이징 처리: 간단한 예시와 함께 알아보기

Querydsl을 사용하여 페이징 처리를 구현하면 대량의 데이터를 효율적으로 관리하고 사용자에게 필요한 부분만 보여줄 수 있습니다. 다음은 기본적인 예시를 통해 Querydsl 페이징 처리 방법을 설명합니다.

1. 프로젝트 설정 및 엔티티 생성

• Spring Boot 프로젝트를 생성하고 Querydsl 의존성을 추가합니다.
• 페이징 처리 대상 엔티티(Product)를 생성합니다.

 

Java

@Entity
public class Product {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;
    private int price;

    // ... getter, setter 등
}

 

2. Q-Type 생성 및 Querydsl 인스턴스 생성

• 엔티티 클래스를 기반으로 Q-Type을 생성합니다.
• JPAQueryFactory를 사용하여 Querydsl 인스턴스를 생성합니다.

 

Java

@PersistenceContext
private EntityManager entityManager;

private JPAQueryFactory queryFactory;

@BeforeEach
public void setUp() {
    queryFactory = new JPAQueryFactory(entityManager);
}

 

3. 페이징 쿼리 작성

• Querydsl의 offset()과 limit()을 사용하여 페이징 처리를 구현합니다.
• offset()은 시작 위치를, limit()은 페이지 크기를 지정합니다.

 

Java

@Test
public void 상품_페이징() {
    QProduct product = QProduct.product;
    int page = 0; // 페이지 번호 (0부터 시작)
    int size = 10; // 페이지 크기

    List<Product> products = queryFactory
        .selectFrom(product)
        .orderBy(product.id.asc()) // 정렬 기준 (id 역순)
        .offset(page * size) // 시작 위치 계산
        .limit(size) // 페이지 크기
        .fetch();

    // ... 결과 처리
}

 

4. 예시 코드 전체

 

Java

@SpringBootTest
public class ProductRepositoryTest {

    @PersistenceContext
    private EntityManager entityManager;

    private JPAQueryFactory queryFactory;

    @BeforeEach
    public void setUp() {
        queryFactory = new JPAQueryFactory(entityManager);
    }

    @Test
    public void 상품_페이징() {
        QProduct product = QProduct.product;
        int page = 0; // 페이지 번호 (0부터 시작)
        int size = 10; // 페이지 크기

        List<Product> products = queryFactory
            .selectFrom(product)
            .orderBy(product.id.asc()) // 정렬 기준 (id 역순)
            .offset(page * size) // 시작 위치 계산
            .limit(size) // 페이지 크기
            .fetch();

        // ... 결과 처리
    }
}

 

5. 실행 결과

• 위 예시 코드를 실행하면 상품 목록을 페이지 단위로 조회할 수 있습니다.