[QueryDSL] 1. QueryDSL 소개

 

https://www.inflearn.com/course/Querydsl-%EC%8B%A4%EC%A0%84/dashboard

실전! Querydsl - 인프런 | 강의

인프런 - 실전! QueryDSL 강의를 듣고, 공부한 내용을 정리했습니다. 😇

 

 

1️⃣ 프로젝트 환경 설정 

https://start.spring.io/

스프링 부트 스타터에 들어가서 프로젝트를 생성해 줄 것이다. 

 

사용 기능: spring web, spring data jpa, h2 database, lombok 

SpringBoot version: 2.7.4 (강의에서는 2.2.2 버전을 사용했지만 시간이 많이 지난 지금 들으니 버전이 많이 올라갔다.) 

groupId: study 

artifactId: querydsl 

 

build.gradle 

implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.springframework.boot:spring-boot-starter-validation'
implementation 'org.springframework.boot:spring-boot-devtools'
compileOnly 'org.projectlombok:lombok'
runtimeOnly 'com.h2database:h2'
annotationProcessor 'org.projectlombok:lombok'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
implementation 'com.github.gavlyukovskiy:p6spy-spring-boot-starter:1.8.0'

implementation 'com.fasterxml.jackson.datatype:jackson-datatype-hibernate5'

 

김영한 강사님 커리를 계속 따라가다보니 이제는 자동으로 설정해주는 

IntelliJ Gradle 대신 자바로 바로 실행하도록 설정해주고, 롬복 적용 해주기 

인텔리제이 사용하는 분들 참고하시길,, 

 

 

 

2️⃣ Querydsl 설정과 검증

build.gradle에 Querydsl 추가해주기 

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

-> 강의에서 제공하는 설정을 하고 돌리는데 에러가 나서 다른 방법을 찾아서 추가했다. 

 

그리고 밑에 

//Querydsl 추가, 자동 생성된 Q클래스 gradle clean으로 제거
clean {
   delete file('src/main/generated')
}

이거 추가해주기 

 

Hello

-> Querydsl 환경설정 검증하기 위해 Hello 엔티티를 생성했다. 

 

검증용 Q타입 생성

Gradle -> Tasks -> build -> clean 

Gradle -> Tasks -> other -> compileJava

 

Q타입 생성 확인

build -> generated -> querydsl

study.querydsl.entity.QHello.java 파일이 생성되어 있어야 한다!

 

QHello

 

❗️참고

Q타입은 컴파일 시점에 자동으로 생성되기 때문에 버전관리 (git) 에 포함하지 않는 것이 좋다. 

gradle build 폴더 아래에 생성되도록 했으면 이 부분은 자도으로 해결해준다.( 대부분 gradle build 폴더는 git 에 포함하지 않는다.) 

 

 

 

QuerydslApplicationTest

: 테스트 케이스로 실행 검증하기 

우선 jpa에서 모든 데이터 변경은 트랜잭션 안에서 수행되어야 하기 때문에 @Transactional 어노테이션을 사용한다. 

그리고 EntityManager를 주입받고, 

Querydsl Q타입이 동작하는지 확인해봤다.

-> 테스트 수행 결과 초록빛이 돌면 테스트 성공!

 

🐥 참고

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

 

 

3️⃣ 라이브러리 살펴보기 

 

- 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 커넥션 풀 

  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 사용 

 mockito : 목 라이브러리 

 assertj : 테스트 코드를 좀 더 편하게 작성하게 도와주는 라이브러리 

spring-test: 스프링 통합 테스트 지원 

 

 

⭐️ 핵심 라이브러리 

- 스프링 MVC

- JPA, 하이버네이트

- 스프링 데이터 JPA

- QueryDSL

 

🌙 기타 라이브러리 

- h2 데이터베이스 클라이언트 

- 커넥션 풀: 부트 기본은 HicariCP

- 로깅 slf4j & Logback

- 테스트 

 

 

4️⃣ H2 데이터베이스 설치 

https://www.h2database.com

: 개발이나 테스트 용도로 가볍고 편리한 DB, 웹 화면 제공 

 

5️⃣ 스프링 부트 설정 - JPA, DB

application.yml

spring:
  datasource:
    url: jdbc:h2:tcp://localhost/~/querydsl
    username: sa
    password:
    driver-class-name: org.h2.Driver

  jpa:
    hibernate:
      ddl-auto: create
    properties:
      hibernate:
        format_sql: true

logging:
  level:
    org.hibernate.SQL: debug
    org.hibernate.type: trace

spring.jpa.hibernate.ddl-auto: create 

: 이 옵션을 사용하면 애플리케이션 실행 시점에 테이블을 모두 drop 하고 다시 생성한다. 

-> 테스트 용도로만 추천..!!!

 

❗️참고 : 모든 로그 출력은 가급적 로거를 통해 남겨야 한다. 

jpa.properties.hiberante.show_sql : true 

-> show_sql 옵션은 System.out에 하이버네이트 실행 sql을 남기기 때문에 추천 x 

logging.level.org.hibernate.SQL: debug 

-> 이 옵션은 logger를 통해서 하이버네이트 실행 sql을 남긴다. 이거 사용!

 

😀 쿼리 파라미터 로그 남기기 

logging.level.org.hibernate.type = trace

-> SQL 실행 파라미터를 로그로 남긴다. 

 

😎 외부 라이브러리를 사용해 쿼리 파라미터 로그 남기기 

implementation 'com.fasterxml.jackson.datatype:jackson-datatype-hibernate5'

build.gradle에 추가 

 

❗️참고

쿼리 파라미터를 로그로 남기는 외부 라이브러리는 시스템 자원을 사용하기 때문에, 개발 단계에서는 편하게 사용해도 되지만, 

운영시스템에 적용하기 위해서는 꼭 성능 테스트를 하고 사용하는 것이 좋다.