[java] Querydsl을 사용하여 데이터베이스 엔터티 관계 매핑하기

17 Nov 2023

java

Querydsl은 자바 기반의 오픈 소스 라이브러리로, SQL과 유사한 쿼리문을 자바 코드로 작성할 수 있게 해줍니다. 이를 통해 데이터베이스의 엔터티 관계를 매핑하는 것이 편리해집니다.

1. Querydsl 설정하기

Querydsl을 사용하기 위해서는 먼저 프로젝트에 Querydsl 라이브러리를 추가해야 합니다. Maven을 사용하는 경우, pom.xml 파일에 다음 종속성을 추가합니다.

<dependency>
    <groupId>com.querydsl</groupId>
    <artifactId>querydsl-core</artifactId>
    <version>4.4.0</version>
</dependency>

Gradle을 사용하는 경우, build.gradle 파일에 다음 종속성을 추가합니다.

implementation 'com.querydsl:querydsl-core:4.4.0'

2. JPA 엔터티 생성하기

Querydsl을 사용하여 데이터베이스의 엔터티 관계를 매핑하기 위해서는 우선 JPA로 데이터베이스 엔터티를 생성해야 합니다. 예를 들어, 다음과 같은 User 및 Role 엔터티를 생성합니다.

@Entity
@Table(name = "users")
public class User {

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

    private String username;

    // Getter, Setter 등 생략
}

@Entity
@Table(name = "roles")
public class Role {

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

    private String name;

    // Getter, Setter 등 생략
}

3. Querydsl Q클래스 생성하기

Querydsl을 사용하기 위해 Q클래스를 생성해야 합니다. Q클래스는 코드 생성 도구를 사용하여 자동으로 생성됩니다. Maven으로 코드 생성을 설정하려면, pom.xml 파일에 다음 설정을 추가합니다.

<dependencies>
    <!-- 기타 의존성들 -->
    ...
</dependencies>

<build>
    <plugins>
        <!-- Querydsl 코드 생성 플러그인 -->
        <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>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Gradle로 코드 생성을 설정하려면, build.gradle 파일에 다음 설정을 추가합니다.

plugins {
    id 'net.ltgt.apt' version '0.20'
}

dependencies {
    // 기타 의존성들
    ...
}

apt {
    processor 'com.querydsl.apt.jpa.JPAAnnotationProcessor'
}

sourceSets {
    main {
        java {
            srcDirs = ['src/main/java', 'target/generated-sources/java']
        }
    }
}

위 설정을 추가하고 프로젝트를 빌드하면, Q클래스가 target/generated-sources/java (Maven) 또는 build/generated/sources/apt/main (Gradle) 디렉토리에 생성됩니다.

4. Querydsl을 사용하여 엔터티 조회하기

이제 Querydsl을 사용하여 엔터티를 조회하는 방법을 알아보겠습니다. 예를 들어, User 엔터티와 Role 엔터티 사이의 관계를 조회하고 싶다고 가정해봅시다. 다음 코드를 참조하여 관계를 조회할 수 있습니다.

QUser user = QUser.user;
QRole role = QRole.role;

JPAQueryFactory queryFactory = new JPAQueryFactory(entityManager);

List<User> users = queryFactory.selectFrom(user)
        .leftJoin(user.roles, role)
        .where(role.name.eq("admin"))
        .fetch();

위 코드는 User 엔터티와 Role 엔터티 사이의 관계를 조회하여 admin 권한을 가진 사용자들을 가져옵니다.

결론

Querydsl을 사용하여 데이터베이스의 엔터티 관계를 매핑하는 방법을 알아보았습니다. Querydsl은 SQL과 유사한 쿼리문을 자바 코드로 작성할 수 있게 해주어 개발자들에게 편리한 기능을 제공합니다. 자세한 내용은 Querydsl 공식 문서를 참고하시기 바랍니다.

참고: 이 문서는 Java 언어를 기준으로 작성되었습니다.