일반적인 시작 안내 문서 대신 Querydsl이 지원하는 주요 백엔드 기술에 대한 안내 문서를 제공한다.
Querydsl은 영속 도메인 모델에 대해 쿼리할 수 있는 범용적인 정적 타입 구문을 정의하고 있다. JDO와 JPA는 Querydsl이 지원하는 주요 기술이다. 이 안내 문서에서는 JPA와 함께 Querydsl을 사용하는 방법을 설명한다.
Querydsl은 JPQL과 Criteria 쿼리를 모두 대체할 수 있다. Querydsl은 Criteria 쿼리의 동적인 특징과 JPQL의 표현력을 타입에 안전한 방법으로 제공한다.
메이븐 프로젝트의 의존 설정에 다음을 추가한다.
<dependency> <groupId>com.mysema.querydsl</groupId> <artifactId>querydsl-apt</artifactId> <version>${querydsl.version}</version> <scope>provided</scope> </dependency> <dependency> <groupId>com.mysema.querydsl</groupId> <artifactId>querydsl-jpa</artifactId> <version>${querydsl.version}</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>1.6.1</version> </dependency>
다음으로 메이븐 APT 플러그인을 설정한다.
<project> <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.mysema.query.apt.jpa.JPAAnnotationProcessor</processor> </configuration> </execution> </executions> </plugin> ... </plugins> </build> </project>
JPAAnnotationProcessor는 javax.persistence.Entity 애노테이션을 가진 도메인 타입을 찾아서 쿼리 타입을 생성한다.
도메인 타입으로 Hibernate 애노테이션을 사용하면, APT 프로세서로
com.mysema.query.apt.hibernate.HibernateAnnotationProcessor를 사용해야 한다.
mvn clean install 을 실행하면, target/generated-sources/java 디렉토리에 Query 타입이 생성된다.
이클립스를 사용할 경우, mvn eclipse:eclipse 를 실행하면 target/generated-sources/java 디렉토리가 소스 폴더에 추가된다.
생성된 Query 타입을 이용하면 JPA 쿼리 인스턴스와 쿼리 도메인 모델 인스턴스를 생성할 수 있다.
클래스패스에 full-deps에 포함된 jar 파일들을 위치시키고, 다음 태스크를 이용해서 Querydsl 코드를 생성한다.
<!-- APT based code generation -->
<javac srcdir="${src}" classpathref="cp">
<compilerarg value="-proc:only"/>
<compilerarg value="-processor"/>
<compilerarg value="com.mysema.query.apt.jpa.JPAAnnotationProcessor"/>
<compilerarg value="-s"/>
<compilerarg value="${generated}"/>
</javac>
<!-- compilation -->
<javac classpathref="cp" destdir="${build}">
<src path="${src}"/>
<src path="${generated}"/>
</javac>
src를 메인 소스 폴더로 변경하고, generated를 생성된 소스를 위한 폴더로 변경하고, build를 클래스 생성 폴더로 변경한다.
스프링 Roo에서 Querydsl JPA를 사용한다면,
com.mysema.query.apt.jpa.JPAAnnotationProcessor 대신
com.mysema.query.apt.roo.RooAnnotationProcessor를 사용할 수 있다.
RooAnnotationProcessor는 @Entity가 적용된 클래스 대신
@RooJpaEntity와 @RooJpaActiveRecord 애노테이션이 적용된
클래스를 처리한다.
APT 기반의 코드 생성 기능은 AspectJ IDT에는 잘 동작하지 않는다.
하이버네이트에서 XML 기반 설정을 사용하고 있다면, Querydsl 모델을 생성하기 위해 XML 메타정보를 사용할 수 있다.
com.mysema.query.jpa.codegen.HibernateDomainExporter가 이 기능을 제공한다.
HibernateDomainExporter exporter = new HibernateDomainExporter( "Q", // name prefix new File("target/gen3"), // target folder configuration); // instance of org.hibernate.cfg.Configuration exporter.export();
HibernateDomainExporter는 리플렉션을 이용해서 도메인의 프로퍼티 타입을 확인하기 때문에, HibernateDomainExporter를 실행하려면 클래스패스에 도메인 타입이 위치해야 한다.
모든 JPA 어노테이션은 무시되지만, @QueryInit이나 @QueryType과 같은 Querydsl 애노테이션은 처리한다.
Querydsl을 이용해서 쿼리를 작성하려면, 변수와 Query 구현체를 생성해야 한다. 먼저 변수부터 시작해보자.
다음과 같은 도메인 타입이 있다고 가정하다.
@Entity public class Customer { private String firstName; private String lastName; public String getFirstName(){ return firstName; } public String getLastName(){ return lastName; } public void setFirstName(String fn){ firstName = fn; } public void setLastName(String ln) { lastName = ln; } }
Querydsl은 Customer와 동일한 패키지에 QCustomer라는 이름을 가진 쿼리 타입을 생성한다. Querydsl 쿼리에서 Customer 타입을 위한 정적 타입 변수로 QCustomer를 사용한다.
QCustomer는 기본 인스턴스 변수를 갖고 있으며, 다음과 같이 정적 필드로 접근할 수 있다.
QCustomer customer = QCustomer.customer;
다음처럼 Customer 변수를 직접 정의할 수도 있다.
QCustomer customer = new QCustomer("myCustomer");
Querdsl JPA 모듈은 JPA와 Hibernate API를 모두 지원한다.
JPA API를 사용하려면 다음과 같이 JPAQuery 인스턴스를 사용하면 된다.
// where entityManager is a JPA EntityManager JPAQuery query = new JPAQuery(entityManager);
Hibernate를 사용한다면, HibernateQuery를 사용하면 된다.
// where session is a Hibernate session HibernateQuery query = new HibernateQuery(session);
JPAQuery와 HibernateQuery는 둘 다 JPQLQuery 인터페이스를 구현하고 있다.
firstName 프로퍼티가 Bob인 Customer를 조회하고 싶다면 다음의 쿼리를 사용하면 된다.
QCustomer customer = QCustomer.customer; JPAQuery query = new JPAQuery(entityManager); Customer bob = query.from(customer) .where(customer.firstName.eq("Bob")) .uniqueResult(customer);
from 메서드는 쿼리 대상(소스)을 지정하고, where 부분은 필터를 정의하고, uniqueResult는 프로젝션을 정의하고, 1개 결과만 리턴하라고 지시한다.
여러 소스로부터 쿼리를 만들고 싶다면 다음처럼 쿼리를 사용한다.
QCustomer customer = QCustomer.customer; QCompany company = QCompany.company; query.from(customer, company);
여러 필터를 사용하는 방법은 다음과 같다.
query.from(customer)
.where(customer.firstName.eq("Bob"), customer.lastName.eq("Wilson"));
또는, 다음과 같이 해도 된다.
query.from(customer)
.where(customer.firstName.eq("Bob").and(customer.lastName.eq("Wilson")));
위 코드를 JPQL 쿼리로 작성하면 다음과 같을 것이다.
from Customer as customer
where customer.firstName = "Bob" and customer.lastName = "Wilson"
필터 조건을 or로 조합하고 싶다면 다음 패턴을 사용한다.
query.from(customer)
.where(customer.firstName.eq("Bob").or(customer.lastName.eq("Wilson")));
Querydsl은 JPQL의 이너 조인, 조인, 레프트 조인, 풀조인을 지원한다. 조인 역시 타입에 안전하며 다음 패턴에 따라 작성한다.
QCat cat = QCat.cat; QCat mate = new QCat("mate"); QCate kitten = new QCat("kitten"); query.from(cat) .innerJoin(cat.mate, mate) .leftJoin(cat.kittens, kitten) .list(cat);
위 쿼리를 JPQL로 작성하면 다음과 같다.
from Cat as cat
inner join cat.mate as mate
left outer join cat.kittens as kitten
다음은 조인을 사용하는 또 다른 예다.
query.from(cat)
.leftJoin(cat.kittens, kitten)
.on(kitten.bodyWeight.gt(10.0))
.list(cat);
위 코드의 JPQL 버전은 다음과 같다.
from Cat as cat
left join cat.kittens as kitten
on kitten.bodyWeight > 10.0
JPQLQuery 인터페이스의 cascading 메서드는 다음과 같다.
from: 쿼리 소스를 추가한다.
innerJoin, join, leftJoin, fullJoin, on: 조인 부분을 추가한다. 조인 메서드에서 첫 번째 인자는 조인 소스이고, 두 번재 인자는 대상(별칭)이다.
where: 쿼리 필터를 추가한다. 가변인자나 and/or 메서드를 이용해서 필터를 추가한다.
groupBy: 가변인자 형식의 인자를 기준으로 그룹을 추가한다.
having: Predicate 표현식을 이용해서 "group by" 그룹핑의 필터를 추가한다.
orderBy: 정렬 표현식을 이용해서 정렬 순서를 지정한다. 숫자나 문자열에 대해서는 asc()나 desc()를 사용하고, OrderSpecifier에 접근하기 위해 다른 비교 표현식을 사용한다.
limit, offset, restrict: 결과의 페이징을 설정한다. limit은 최대 결과 개수, offset은 결과의 시작 행, restrict는 limit과 offset을 함께 정의한다.
정렬을 위한 구문은 다음과 같다.
QCustomer customer = QCustomer.customer;
query.from(customer)
.orderBy(customer.lastName.asc(), customer.firstName.desc())
.list(customer);
위 코드는 다음의 JPQL과 동일하다.
from Customer as customer
order by customer.lastName asc, customer.firstName desc
그룹핑은 다음과 같은 코드로 처리한다.
query.from(customer)
.groupBy(customer.lastName)
.list(customer.lastName);
동등한 JPQL은 다음고 같다.
select customer.lastName
from Customer as customer
group by customer.lastName
Querydsl JPA에서 DeleteClause는 간단한 delete-where-execute 형태를 취한다. 다음은 몇 가지 예다.
QCustomer customer = QCustomer.customer; // delete all customers new JPADeleteClause(entityManager, customer).execute(); // delete all customers with a level less than 3 new JPADeleteClause(entityManager, customer).where(customer.level.lt(3)).execute();
JPADeleteClause 생성자의 두 번째 파라미터는 삭제할 엔티티 대상이다. where는 필요에 따라 추가할 수 있으며, execute를 실행하면 삭제를 수행하고 삭제된 엔티티의 개수를 리턴한다.
Hibernate 이용시, HibernateDeleteClause를 사용하면 된다.
JPA의 DML 절은 JPA 레벨의 영속성 전파 규칙을 따르지 않고, 2차 레벨 캐시와의 연동되지 않는다.
Querydsl JPA의 UpdateClause은 간단한 update-set/where-execute 형태를 취한다. 다음은 몇 가지 예다.
QCustomer customer = QCustomer.customer; // rename customers named Bob to Bobby new JPAUpdateClause(session, customer).where(customer.name.eq("Bob")) .set(customer.name, "Bobby") .execute();
JPAUpdateClause 생성자의 두 번째 파라미터는 수정할 엔티티 대상이다. set은 SQL의 update 스타일로 프로퍼티 수정을 정의하고, execute를 실행하면 수정을 실행하고 수정된 엔티티의 개수를 리턴한다.
Hibernate 이용시, HibernateUpdateClause를 사용한다.
JPA에서 DML 절은 JPA 레벨의 영속성 전파 규칙을 따르지 않고, 2차 레벨 캐시와 연동되지 않는다.
서브쿼리를 만들려면 JPASubQuery를 사용하면 된다. 서브쿼리를 만들기 위해 from 메서드로 쿼리 파라미터를 정의하고, unique나 list를 이용한다. unique는 단일 결과를 위해 사용하고 list는 리스트 결과를 위해 사용한다. 서브쿼리도 쿼리처럼 타입에 안전한 Querydsl 표현식이다.
QDepartment department = QDepartment.department; QDepartment d = new QDepartment("d"); query.from(department) .where(department.employees.size().eq( new JPASubQuery().from(d).unique(d.employees.size().max()) )).list(department);
다른 예제
QEmployee employee = QEmployee.employee; QEmployee e = new QEmployee("e"); query.from(employee) .where(employee.weeklyhours.gt( new JPASubQuery().from(employee.department.employees, e) .where(e.manager.eq(employee.manager)) .unique(e.weeklyhours.avg()) )).list(employee);
Hibernate를 사용할 경우, HibernateSubQuery를 사용하면 된다.
만약 쿼리를 실행하기 전에 JPA Query를 구하고 싶다면, 다음 코드를 사용한다.
JPAQuery query = new JPAQuery(entityManager); Query jpaQuery = query.from(employee).createQuery(employee); // ... List results = jpaQuery.getResultList();
JPASQLQuery 클래스를 사용하면 JPA의 네이티브 SQL을 Querydsl에서 사용할 수 있다.
이걸 사용하려면 SQL 스키마를 위한 Querydsl 쿼라 티입을 생성해야 한다. 다음은 이를 위한 Maven 설정 예를 보여주고 있다.
<project> <build> <plugins> ... <plugin> <groupId>com.mysema.querydsl</groupId> <artifactId>querydsl-maven-plugin</artifactId> <version>${querydsl.version}</version> <executions> <execution> <goals> <goal>export</goal> </goals> </execution> </executions> <configuration> <jdbcDriver>org.apache.derby.jdbc.EmbeddedDriver</jdbcDriver> <jdbcUrl>jdbc:derby:target/demoDB;create=true</jdbcUrl> <packageName>com.mycompany.mydomain</packageName> <targetFolder>${project.basedir}/target/generated-sources/java</targetFolder> </configuration> <dependencies> <dependency> <groupId>org.apache.derby</groupId> <artifactId>derby</artifactId> <version>${derby.version}</version> </dependency> </dependencies> </plugin> ... </plugins> </build> </project>
지정한 위치에 쿼리 타입을 성공적으로 생성했다면, 쿼리에서 그 타입을 사용할 수 있다.
한 개 컬럼 쿼리:
// serialization templates SQLTemplates templates = new DerbyTemplates(); // query types (S* for SQL, Q* for domain types) SAnimal cat = new SAnimal("cat"); SAnimal mate = new SAnimal("mate"); QCat catEntity = QCat.cat; JPASQLQuery query = new JPASQLQuery(entityManager, templates); List<String> names = query.from(cat).list(cat.name);
한 쿼리에서 엔티티(예, QCat)와 테이블(예, SAnimal)에 대한 참조를 섞어 쓰고 싶다면, 같은 변수명을 갖도록 해야 한다. SAnimal.animal은 "animal"이란 변수명을 가지므로 새로운 인스턴스 (new SAnimal("cat"))을 대신 사용했다.
다음과 같이 할 수도 있다.
QCat catEntity = QCat.cat;
SAnimal cat = new SAnimal(catEntity.getMetadata().getName());
다중 컬럼 쿼리:
query = new JPASQLQuery(entityManager, templates);
List<Object[]> rows = query.from(cat).list(cat.id, cat.name);
모든 컬럼 쿼리:
List<Object[]> rows = query.from(cat).list(cat.all());
SQL로 쿼리를 하고, 결과는 엔티티로 구하기:
query = new JPASQLQuery(entityManager, templates);
List<Cat> cats = query.from(cat).orderBy(cat.name.asc()).list(catEntity);
조인을 이용한 쿼리:
query = new JPASQLQuery(entityManager, templates); cats = query.from(cat) .innerJoin(mate).on(cat.mateId.eq(mate.id)) .where(cat.dtype.eq("Cat"), mate.dtype.eq("Cat")) .list(catEntity);
쿼리 결과를 DTO로 구하기:
query = new JPASQLQuery(entityManager, templates); List<CatDTO> catDTOs = query.from(cat) .orderBy(cat.name.asc()) .list(ConstructorExpression.create(CatDTO.class, cat.id, cat.name));
JPA API 대신 하이버네이트 API를 사용한다면, HibernateSQLQuery를 사용한다.