[실전! Querydsl] 01. 프로젝트 환경설정

스프링 부트 2.6 이상, Querydsl 5.0 지원 방법

 

build.gradle 설정 방법

buildscript {
 ext {
 queryDslVersion = "5.0.0"
 }
}
plugins {
 id 'org.springframework.boot' version '2.6.2'
 id 'io.spring.dependency-management' version '1.0.11.RELEASE'
 //querydsl 추가
 id "com.ewerk.gradle.plugins.querydsl" version "1.0.10"
 id 'java'
}
group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'
configurations {
 compileOnly {
 extendsFrom annotationProcessor
 }
}
repositories {
 mavenCentral()
}
dependencies {
 implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
 implementation 'org.springframework.boot:spring-boot-starter-web'
 //querydsl 추가
 implementation "com.querydsl:querydsl-jpa:${queryDslVersion}"
 annotationProcessor "com.querydsl:querydsl-apt:${queryDslVersion}"
 compileOnly 'org.projectlombok:lombok'
 runtimeOnly 'com.h2database:h2'
 annotationProcessor 'org.projectlombok:lombok'
 //테스트에서 lombok 사용
 testCompileOnly 'org.projectlombok:lombok'
 testAnnotationProcessor 'org.projectlombok:lombok'
 testImplementation('org.springframework.boot:spring-boot-starter-test') {
 exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
 }
}
test {
 useJUnitPlatform()
}
//querydsl 추가 시작
def querydslDir = "$buildDir/generated/querydsl"
querydsl {
 jpa = true
 querydslSourcesDir = querydslDir
}
sourceSets {
 main.java.srcDir querydslDir
}
configurations {
 querydsl.extendsFrom compileClasspath
}
compileQuerydsl {
 options.annotationProcessorPath = configurations.querydsl
}
//querydsl 추가 끝

querydsl-jpa , querydsl-apt 를 추가하고 버전을 명시해야 한다.

 

참고로 위 설정은 JUnit은 4를 사용한다.

JUnit 5를 사용하려면 다음 설정을 제거하면 된다.

exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'

 

Gradle 전체 설정(구 설정)

build.gradle 설정 방법

plugins {
	id 'org.springframework.boot' version ‘2.2.2.RELEASE'
	id 'io.spring.dependency-management' version '1.0.8.RELEASE'
	id 'java'
}
    
group = 'study'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	compileOnly 'org.projectlombok:lombok'
	runtimeOnly 'com.h2database:h2'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation('org.springframework.boot:spring-boot-starter-test') {
		exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
	}
}

test {
	useJUnitPlatform()
}

• 동작 확인
  • 기본 테스트 케이스 실행
  • 스프링 부트 메인 실행 후 에러페이지로 간단하게 동작 확인(`http://localhost:8080')
  • 테스트 컨트롤러를 만들어서 spring web 동작 확인(http://localhost:8080/hello)

 

테스트 컨트롤러

package study.querydsl.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
	@GetMapping("/hello")
	public String hello() {
		return "hello!";
	}
}

 

Querydsl 설정과 검증

build.gradle 에 주석을 참고해서 querydsl 설정 추가

 

plugins {
	id 'org.springframework.boot' version ‘2.2.2.RELEASE'
	id 'io.spring.dependency-management' version '1.0.8.RELEASE'
	//querydsl 추가
	id "com.ewerk.gradle.plugins.querydsl" version "1.0.10"
	id 'java'
}

group = 'study'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	//querydsl 추가
	implementation 'com.querydsl:querydsl-jpa'
	compileOnly 'org.projectlombok:lombok'
	runtimeOnly 'com.h2database:h2'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation('org.springframework.boot:spring-boot-starter-test') {
		exclude group: ‘org.junit.vintage’, module: ‘junit-vintage-engine'
	}
}

test {
	useJUnitPlatform()
}

//querydsl 추가 시작
def querydslDir = "$buildDir/generated/querydsl"

querydsl {
	jpa = true
	querydslSourcesDir = querydslDir
}

sourceSets {
	main.java.srcDir querydslDir
}

configurations {
	querydsl.extendsFrom compileClasspath
}

compileQuerydsl {
	options.annotationProcessorPath = configurations.querydsl
}
//querydsl 추가 끝

 

Querydsl 환경설정 검증

검증용 엔티티 생성

package study.querydsl.entity;

import lombok.Getter;
import lombok.Setter;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

@Entity
@Getter @Setter
public class Hello {
	@Id @GeneratedValue
	private Long id;
}

 

검증용 Q 타입 생성

Gradle IntelliJ 사용법

• Gradle → Tasks → build → clean
• Gradle → Tasks → other → compileQuerydsl

 

Gradle 콘솔 사용법

./gradlew clean compileQuerydsl

 

Q 타입 생성 확인

• build → generated → querydsl
  • study.querydsl.entity.QHello.java 파일이 생성되어 있어야 함

 

Eclipse Gradle 사용법

grdle task에서 build를 한번 실행하면 생성된다.(블로그 필자 추가)

 

참고: Q타입은 컴파일 시점에 자동 생성되므로 버전관리(GIT)에 포함하지 않는 것이 좋다. 앞서 설정에서 생성 위치를 gradle build 폴더 아래 생성되도록 했기 때문에 이 부분도 자연스럽게 해결된다. (대부분 gradle build 폴더를 git에 포함하지 않는다.)

 

테스트 케이스로 실행 검증

package study.querydsl;

import com.querydsl.jpa.impl.JPAQueryFactory;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.annotation.Commit;
import org.springframework.transaction.annotation.Transactional;
import study.querydsl.entity.Hello;
import study.querydsl.entity.QHello;
import javax.persistence.EntityManager;
import java.util.List;

@SpringBootTest
@Transactional
class QuerydslApplicationTests {

	@Autowired
	EntityManager em;

	@Test
	void contextLoads() {

		Hello hello = new Hello();
		em.persist(hello);

		JPAQueryFactory query = new JPAQueryFactory(em);

		QHello qHello = QHello.hello; //Querydsl Q타입 동작 확인

		Hello result = query
							.selectFrom(qHello)
							.fetchOne();

		Assertions.assertThat(result).isEqualTo(hello);

		//lombok 동작 확인 (hello.getId())
		Assertions.assertThat(result.getId()).isEqualTo(hello.getId());
	}
}

• Querydsl Q타입이 정상 동작하는가?
• lombok이 정상 동작 하는가?

참고: 스프링 부트에 아무런 설정도 하지 않으면 h2 DB를 메모리 모드로 JVM안에서 실행한다.

 

라이브러리 살펴보기

 

gradle 의존관계 보기

./gradlew dependencies --configuration compileClasspath

 

Querydsl 라이브러리 살펴보기

• querydsl-apt: Querydsl 관련 코드 생성 기능 제공
• querydsl-jpa: querydsl 라이브러리

 

예제 도메인 모델

예제 도메인 모델과 동작확인

 

엔티티 클래스

 

ERD

 

Member 엔티티

package study.querydsl.entity;

import lombok.*;
import javax.persistence.*;

@Entity
@Getter @Setter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@ToString(of = {"id", "username", "age"})
public class Member {

	@Id
	@GeneratedValue
	@Column(name = "member_id")
	private Long id;

	private String username;

	private int age;

	@ManyToOne(fetch = FetchType.LAZY)
	@JoinColumn(name = "team_id")
	private Team team;
 
	public Member(String username) {
		this(username, 0);
	}
 
	public Member(String username, int age) {
		this(username, age, null);
	}
 
	public Member(String username, int age, Team team) {
    
		this.username = username;
		this.age = age;
        
		if (team != null) {
			changeTeam(team);
		}
	}
 
	public void changeTeam(Team team) {
		this.team = team;
		team.getMembers().add(this);
 	}
}

• 롬복 설명
  • @Setter: 실무에서 가급적 Setter는 사용하지 않기
  • @NoArgsConstructor AccessLevel.PROTECTED: 기본 생성자 막고 싶은데, JPA 스팩상 PROTECTED로 열어두어야 함
  • @ToString은 가급적 내부 필드만(연관관계 없는 필드만)
• changeTeam() 으로 양방향 연관관계 한번에 처리(연관관계 편의 메소드)

 

Team 엔티티

package study.querydsl.entity;

import lombok.*;
import javax.persistence.*;
import java.util.ArrayList;
import java.util.List;

@Entity
@Getter @Setter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@ToString(of = {"id", "name"})
public class Team {

	@Id @GeneratedValue
	@Column(name = "team_id")
	private Long id;
    
	private String name;
    
	@OneToMany(mappedBy = "team")
	private List<Member> members = new ArrayList<>();

	public Team(String name) {
		this.name = name;
	}
}

Member와 Team은 양방향 연관관계, Member.team 이 연관관계의 주인, Team.members 는 연관관계의 주인이 아님, 따라서 Member.team 이 데이터베이스 외래키 값을 변경, 반대편은 읽기만 가능

 

데이터 확인 테스트

package study.querydsl.entity;

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.annotation.Commit;
import org.springframework.transaction.annotation.Transactional;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;
import java.util.List;

@SpringBootTest
@Transactional
@Commit
public class MemberTest {

	@PersistenceContext
	EntityManager em;

	@Test
	public void testEntity() {
 
		Team teamA = new Team("teamA");
		Team teamB = new Team("teamB");
		em.persist(teamA);
		em.persist(teamB);

		Member member1 = new Member("member1", 10, teamA);
		Member member2 = new Member("member2", 20, teamA);
		Member member3 = new Member("member3", 30, teamB);
		Member member4 = new Member("member4", 40, teamB);
		em.persist(member1);
		em.persist(member2);
		em.persist(member3);
		em.persist(member4);
 
		//초기화
		em.flush();
		em.clear();
 
		//확인
		List<Member> members = em.createQuery("select m from Member m", Member.class).getResultList();
 
		for (Member member : members) {
			System.out.println("member=" + member);
			System.out.println("-> member.team=" + member.getTeam());
		}
	}
}

• 가급적 순수 JPA로 동작 확인 (뒤에서 변경)
• db 테이블 결과 확인
• 지연 로딩 동작 확인