[Querydsl] 1. 프로젝트 환경 설정

📌 프로젝트 생성

⚡ 개발 환경

✔ Java 17
✔ IDE : IntelliJ

 

🔶 스프링 프로젝트 생성

⚡ 프로젝트 선택

Project : Gradle-Groovy Project
Spring Boot : 3.x.x
Language : Java
Packaging : Jar
Java : 17
groupId : study
artifactId : querydsl
사용 기능: Spring Web, jpa, h2, lombok

 

➡ Generate

 

 

📌 Querydsl 설정과 검증

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

⚡ Gradle 전체 설정 - 스프링 부트 3.x 버전 이상

링크 참조

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.2.2'
    id 'io.spring.dependency-management' version '1.1.4'
}

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

java {
    sourceCompatibility = '17'
}

configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'com.github.gavlyukovskiy:p6spy-spring-boot-starter:1.9.0'
    compileOnly 'org.projectlombok:lombok'
    runtimeOnly 'com.h2database:h2'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'

    //test 롬복 사용
    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'

    //Querydsl 추가
    implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
    annotationProcessor "com.querydsl:querydsl-apt:${dependencyManagement.importedProperties['querydsl.version']}:jakarta"
    annotationProcessor "jakarta.annotation:jakarta.annotation-api"
    annotationProcessor "jakarta.persistence:jakarta.persistence-api"

}

tasks.named('test') {
    useJUnitPlatform()
}
clean {
    delete file('src/main/generated')
}

 

 

 

 

📌 Querydsl 환경 설정 검증

⚡ 검증용 엔티티 생성

package study.querydsl.entity;

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

@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 파일이 생성되어 있어야 함

 

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

 

 

 

테스트 케이스로 실행 검증

package study.querydsl;

import com.querydsl.jpa.impl.JPAQueryFactory;
import jakarta.persistence.EntityManager;
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.transaction.annotation.Transactional;
import study.querydsl.entity.Hello;
import study.querydsl.entity.QHello;

@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이 정상 동작 하는가?

 

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

 

 

 

📌 라이브러리 살펴보기

gradle 의존관계 보기

./gradlew dependencies --configuration compileClasspath

 

 

⚡ Querydsl 라이브러리 살펴보기

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

 

 

⚡ 스프링 부트 라이브러리 살펴보기

• spring-boot-starter-web
  • spring-boot-starter-tomcat: 톰캣 (웹서버)
  • spring-webmvc: 스프링 웹 MVC
• spring-boot-starter-data-jpa
  • spring-boot-starter-aop
  • spring-boot-starter-jdbc
    • HikariCP 커넥션 풀 (부트 2.0 기본)
  • hibernate + JPA: 하이버네이트 + JPA
  • spring-data-jpa: 스프링 데이터 JPA
• spring-boot-starter(공통): 스프링 부트 + 스프링 코어 + 로깅
  • spring-boot
    • spring-core
  • spring-boot-starter-logging
    • logback, slf4j

 

 

 

⚡ 테스트 라이브러리

• spring-boot-starter-test
  • junit: 테스트 프레임워크, 스프링 부트 2.2부터 junit5( jupiter ) 사용
    • 과거 버전은 vintage
  • mockito: 목 라이브러리
  • assertj: 테스트 코드를 좀 더 편하게 작성하게 도와주는 라이브러리
    • https://joel-costigliola.github.io/assertj/index.html
  • spring-test: 스프링 통합 테스트 지원
• 핵심 라이브러리
  • 스프링 MVC
  • JPA, 하이버네이트
  • 스프링 데이터 JPA
  • Querydsl
• 기타 라이브러리
  • H2 데이터베이스 클라이언트
  • 커넥션 풀: 부트 기본은 HikariCP
  • 로깅 SLF4J & LogBack
  • 테스트

반응형

 

 

📌 H2 데이터베이스 설치

• 개발이나 테스트 용도로 가볍고 편리한 DB, 웹 화면 제공
• 주의!❗ 스프링 부트 3.0 이상을 사용한다면 H2 데이터베이스를 2.1.214 버전 이상으로 사용해주세요.*
• 다운로드 및 설치
  • 스프링 부트 2.x를 사용하면 1.4.200 버전을 다운로드 받으면 된다.
  • 스프링 부트 3.x를 사용하면 2.1.214 버전 이상 사용해야 한다.
  • h2 데이터베이스 버전은 스프링 부트 버전에 맞춘다.
• 권한 주기: chmod 755 h2.sh
  데이터베이스 파일 생성 방법
  • jdbc:h2:~/querydsl (최소 한번)
  • ~/querydsl.mv.db 파일 생성 확인
  • 이후 부터는 jdbc:h2:tcp://localhost/~/querydsl 이렇게 접속
• 주의: H2 데이터베이스의 MVCC 옵션은 H2 1.4.198 버전부터 제거되었습니다. 최신 버전에서는 MVCC 옵션
  을 사용하면 오류가 발생합니다. 영상에서 나오는 MVCC 옵션은 제거해주세요.

 

 

스프링 부트 설정 - JPA, DB

🔶 application.yml

spring:
  datasource:
    url: jdbc:h2:tcp://localhost/~/querydsl
    hikari:
      username: sa
      password:
      driver-class-name: org.h2.Driver
  h2:
    console:
      enabled: true
  jpa:
    hibernate:
      ddl-auto: create
    properties:
      hibernate:
        show_sql: true
        format_sql: true
logging.level:
  org.hibernate.SQL: debug

#  org.hibernate.type: trace

• spring.jpa.hibernate.ddl-auto: create
  • 이 옵션은 애플리케이션 실행 시점에 테이블을 drop 하고, 다시 생성한다.

cf) 모든 로그 출력은 가급적 로거를 통해 남겨야 한다.
show_sql : 옵션은 System.out 에 하이버네이트 실행 SQL을 남긴다.
org.hibernate.SQL : 옵션은 logger를 통해 하이버네이트 실행 SQL을 남긴다.

spring:
  h2:
    console:
      enabled: true

• 이걸 설정해주지 않으면 404 에러가 난다. 

 

 

 

쿼리파라미터 로그 남기기

• 로그에 다음을 추가하기 org.hibernate.type : SQL 실행 파라미터를 로그로 남긴다.
• 외부 라이브러리 사용
• 스프링 부트 3.0 이상을 사용하면 이 라이브러리만 추가하면 된다.

implementation 'com.github.gavlyukovskiy:p6spy-spring-boot-starter:1.9.0'

 

cf) 쿼리 파라미터를 로그로 남기는 외부 라이브러리는 시스템 자원을 사용하므로, 개발 단계에서는 편하게 사 용해도 된다. 하지만 운영시스템에 적용하려면 꼭 성능테스트를 하고 사용하는 것이 좋다.

 

 

 

 

김영한님의 <실전! Querydsl>을 수강하고 작성한 글입니다

 

 

 

 

 

---

NEXT