ProgrammingBackendSpring

[Spring] JPA with Querydsl

, ,

Query DSL

  • JPA, JDO, SQL 같은 백엔드를 위해 type-safe SQL을 만드는 프레임워크
  • Domain Specific Language
  • 특정한 도메인에 초점을 맞춘 제한적인 표현력을 가진 컴퓨터 프로그래밍 언어

특징

  • type-safe
  • 조회에 특화된 프로그래밍 언어
  • 단순, 간결
  • 다양한 저장소 조회 기능 통합 (데이터 조회 기능 추상화)

동작 방식

  • Member java or Member table의 메타 데이터를 참조하여 코드 생성기를 통해 QMember.java를 생성합니다.
  • APT: Annotation Processing Tool
  • Table Meta: Querydsl-maven-plugin

기능

  • Query: from, where, join
  • Path: QMember, Qmember.name
  • Expression: name.eq, name.qt

세부기능

  • from
  • innerJoin, join, leftJoin, fetchJoin, fullJoin, on
  • where (and, or, allOf, anyOf)
  • groupBy
  • having
  • order By (desc, asc)
  • limit, offset, restrict(limit + offset) (Paging)
  • list
  • listResults (list + Paging Info(totalCount))
  • iterate
  • count
  • singleResult, uniqueResult

사용 방법

설정

Spring Boot 프로젝트의 pom.xml 에 의존성과 플러그인을 추가합니다.

QueryDSL을 사용하기 위해서는 com.querydsl에서 제공하는 querydsl-jpa와 querydsl-apt에 대한 의존성이 필요합니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!-- dependencies 에 추가 -->
<dependency>
  <groupId>com.querydsl</groupId>
  <artifactId>querydsl-jpa</artifactId>
</dependency>

<dependency>
  <groupId>com.querydsl</groupId>
  <artifactId>querydsl-apt</artifactId>
</dependency>

<dependency>
  <groupId>com.querydsl</groupId>
  <artifactId>querydsl-jdo</artifactId>
</dependency>

com.mysema.maven에서 제공하는 apt-maven-plugin을 설치합니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<!-- build - plugins 에 추가 -->
<plugin>
  <groupId>com.mysema.maven</groupId>
  <artifactId>apt-maven-plugin</artifactId>
  <version>1.1.3</version>
  <executions>
    <execution>
      <goals>
        <goal>process</goal>
      </goals>
      <configuration>
        <outputDirectory>target/generated-sources/java</outputDirectory>
        <processor>com.querydsl.apt.jpa.JPAAnnotationProcessor</processor>
        <sourceEncoding>UTF-8</sourceEncoding>
      </configuration>
    </execution>
  </executions>
</plugin>

이제 프로젝트 우클릭 후 maven -> Update Project… 수행하면 Entity에 대한 Q 클래스들이 target/generated-sources/java 경로에 생성된 것을 확인할 수 있습니다.

도메인 클래스 생성

테이블 도메인 클래스를 생성합니다.

1
2
3
4
5
6
7
8
9
10
11
@Entity
@Table(name = "tb_team")
public class Team {
  @Id
  private int id;

  @Column(name = "name", nullable = false)
  private String name;

  private int rating;
}

Repository 인터페이스를 작성합니다.

1
2
public interface TeamRepository extends JpaRepository<Team, Integer> {
}

Querydsl 사용 예

Repository 인터페이스에 QuerydslPredicateExecutor 를 확장합니다.

1
2
public interface TeamRepository extends JpaRepository<Team, Integer>, QuerydslPredicateExecutor<Team> {
}
1
2
3
4
5
6
7
8
9
10
11
@Service
@RequiredArgsConstructor
public class TeamService {

  private final TeamRepository teamRepository;

  public void testQuerydsel {
    teamRepository.findAll(QTeam.team.name.eq("test"1));
    teamRepository.findOne(QTeam.team.rating.loe(100));
  }
}

JPAQuery 사용 예

JPAQuery을 Bean 등록 후 사용 가능합니다.

1
2
3
4
5
6
7
8
9
10
11
@SpringBootApplication
public class TestWebApplication {
    public static void main(String[] args) {
      SpringApplication.run(TestWebApplication.class, args);
    }

    @Bean
    public JPAQueryFactory jpaQueryFactory(EntityManager em) {
        return new JPAQueryFactory(em);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@Service
@RequiredArgsConstructor
public class TeamService {

  private final JPAQueryFactory factory;

  public void testQuerydsl() {
    QTeam team = QTeam.team;

    List<Team> teams = query.from(team)
                            .where(team.name.eq("test1").or(team.name.like("hgko%")))
                            .list(team);
    System.out.println("querydsl =>" + teams);
  }
}

BooleanBuilder 사용 예

상황에 따라 동적으로 변경되는 쿼리를 작성할 경우 BooleanBuilder 를 사용하면 간편하게 쿼리를 작성할 수 있습니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
@Service
@RequiredArgsConstructor
public class TeamService {

    private final JPAQueryFactory factory;

    public void testQuerydsl(String name) {
        QTeam team = QTeam.team;

        // 검색 조건에 따른 동적 쿼리 작성
        BooleanBuilder builder = new BooleanBuilder();
        if (StringUtils.hasText(name)) {
            builder.and(team.name.contains(name));
        }

        List<Team> teams = factory.selectFrom(team).where(builder).fetch();
        System.out.println("querydsl =>" + teams);
    }
}
Share