[JPA] 프로젝트 환경 설정

목차

• 프로젝트 생성
• 라이브러리 살펴보기
• View 환경 설정
• H2 데이터베이스 설치
• JPA와 DB 설정, 동작확인
• 쿼리 파라미터 로그 남기기

 

프로젝트 생성

 

 

build.gradle

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

group = 'jpabook'
version = '0.0.1-SNAPSHOT'

java {
    toolchain {
       languageVersion = JavaLanguageVersion.of(17)
    }
}

configurations {
    compileOnly {
       extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

dependencies {
    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'
    compileOnly 'org.projectlombok:lombok'
    runtimeOnly 'com.h2database:h2'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

tasks.named('test') {
    useJUnitPlatform()
}

 

 

Validation (JSR-303 validation with Hibernate validator) 모듈을 꼭! 추가

implementation 'org.springframework.boot:spring-boot-starter-validation'

 

 

JUnit4 추가

//JUnit4 추가
testImplementation("org.junit.vintage:junit-vintage-engine") {
    exclude group: "org.hamcrest", module: "hamcrest-core"
}

 

 

최종 build.gralde

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

group = 'jpabook'
version = '0.0.1-SNAPSHOT'

java {
    toolchain {
       languageVersion = JavaLanguageVersion.of(17)
    }
}

configurations {
    compileOnly {
       extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-validation'
    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'

    //JUnit4 추가
    testImplementation("org.junit.vintage:junit-vintage-engine") {
       exclude group: "org.hamcrest", module: "hamcrest-core"
    }
    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

tasks.named('test') {
    useJUnitPlatform()
}

 

 

주의! 스프링 부트 3.2부터 JDK 17과 Gradle 옵션을 선택하자.

스프링 부트 3.2 부터 JDK 17 이상과, 빌드시 IntelliJ IDEA가 아니라 Gradle을 선택해야 한다.

 

다음으로 이동합니다.

• Windows: File Settings(Ctrl+Alt+S)
• Mac: IntelliJ IDEA | Preferences(⌘,)

 

Preferences => Build, Execution, Deployment => Build Tools => Gradle

• 빨간색 박스의 Build and run using를 Gradle로 선택합니다.
• 빨간색 박스의 Build tests using를 Gradle로 선택합니다.
• 빨간색 박스 Gradle JVM을 새로 설치한 자바 17또는 그 이상으로 지정합니다.

 

 

Lombok 적용

1. Preferences plugin lombok 검색 실행 (재시작)
2. Preferences Annotation Processors 검색 Enable annotation processing 체크 (재시작)
3. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인

 

 

라이브러리 살펴보기

 

gradle 의존관계 보기

./gradlew dependencies

 

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

 

spring-boot-starter-web

• spring-boot-starter-tomcat: 톰캣 (웹서버)
• spring-webmvc: 스프링 웹 MVC

 

spring-boot-starter-thymeleaf: 타임리프 템플릿 엔진(View)

 

 

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: 테스트 프레임워크
• mockito: 목 라이브러리
• assertj: 테스트 코드를 좀 더 편하게 작성하게 도와주는 라이브러리
• spring-test: 스프링 통합 테스트 지원

 

핵심 라이브러리

• 스프링 MVC
• 스프링 ORM
• JPA, 하이버네이트
• 스프링 데이터 JPA

기타 라이브러리

• H2 데이터베이스 클라이언트
• 커넥션 풀: 부트 기본은 HikariCP
• WEB(thymeleaf)
• 로깅 SLF4J & LogBack
• 테스트

 

 

View 환경 설정

 

thymeleaf 템플릿 엔진
thymeleaf 공식 사이트: https://www.thymeleaf.org/
스프링 공식 튜토리얼: https://spring.io/guides/gs/serving-web-content/
스프링부트 메뉴얼: https://docs.spring.io/spring-boot/docs/2.1.6.RELEASE/reference/html/boot-features-developing-web-applications.html#boot-features-spring-mvc-template-engines

 

스프링 부트 thymeleaf viewName 매핑

resources:templates/ +{ViewName}+ .html

 

 

jpabook.jpashop.HelloController

package jpabook.jpashop;


import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class HelloController {

    @GetMapping("hello")
    public String hello(Model model) {
        model.addAttribute("data", "Hello World");
        return "hello";
    }
}

 

 

thymeleaf 템플릿엔진 동작 확인(hello.html)

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>Hello</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
<p th:text="'안녕하세요. ' + ${data}" >안녕하세요. 손님</p>
</body>
</html>

 

 

spring-boot-devtools 라이브러리를 추가하면, html 파일을 컴파일만 해주면 서버 재시작 없이 View 파일 변경이 가능하다.

developmentOnly 'org.springframework.boot:spring-boot-devtools'

 

 

 

 

H2 데이터베이스 설치

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

 

다운로드 및 설치

• 스프링 부트 2.x를 사용하면 1.4.200 버전을 다운로드 받으면 된다.
• 스프링 부트 3.x를 사용하면 2.1.214 버전 이상 사용해야 한다.

데이터베이스 파일 생성 방법

• jdbc:h2:~/jpashop (최소 한번, 세션 키 유지한 상태로 실행)
• ~/jpashop.mv.db 파일 생성 확인
• 이후 부터는 jdbc:h2:tcp://localhost/~/jpashop 이렇게 접속

주의: H2 데이터베이스의 MVCC 옵션은 H2 1.4.198 버전부터 제거되었다. 
최신 버전에서는 MVCC 옵션을 사용하면 오류가 발생한다.

 

 

 

 

JPA와 DB 설정, 동작확인

 

main/resources/application.yml

spring:
  datasource:
    url: jdbc:h2:tcp://localhost/D:/inflearn/jpashop;
    username: sa
    password:
    driver-class-name: org.h2.Driver

  jpa:
    hibernate:
      ddl-auto: create # <- 애플리케이션 실행 시점에 가지고 있는 테이블을 지우고 다시 생성
    properties:
      hibernate:
#        show_sql: true <- System.out으로 찍음
        format_sql: true

logging:
  level:
    org.hibernate.SQL: debug # <- logger를 통해서 찍음(권장)

 

 

spring.jpa.hibernate.ddl-auto: create

• 이 옵션은 애플리케이션 실행 시점에 테이블을 drop 하고, 다시 생성한다.

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

주의! application.yml 같은 yml 파일은 띄어쓰기(스페이스) 2칸으로 계층을 만듭니다. 
따라서 띄어쓰기 2칸을 필수로 적어줘야 한다.
예를 들어서 아래의 datasource 는 spring: 하위에 있고 앞에 띄어쓰기 2칸이 있으므로 spring.datasource 가 됩니다. 

 

 

yml 설정 참고

https://spring.io/projects/spring-boot#learn

Spring Boot

 

 

회원 엔티티

package jpabook.jpashop;

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

@Entity
@Getter @Setter
public class Member {

    @Id
    @GeneratedValue
    private Long id;
    private String username;

}

 

 

회원 리포지토리

package jpabook.jpashop;


import jakarta.persistence.EntityManager;
import jakarta.persistence.PersistenceContext;
import org.springframework.stereotype.Repository;

@Repository
public class MemberRepository {

    @PersistenceContext
    private EntityManager em;

    public Long save(Member member) {
        em.persist(member);
        return member.getId();
    }

    public Member find(Long id) {
        return em.find(Member.class, id);
    }
}

 

 

테스트

package jpabook.jpashop;

import org.assertj.core.api.Assertions;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.annotation.Rollback;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.transaction.annotation.Transactional;


@RunWith(SpringRunner.class)
@SpringBootTest
public class MemberRepositoryTest {

    @Autowired MemberRepository memberRepository;

    @Test
    @Transactional
    // @Rollback(false)
    // 1. EntityManager 를 통한 모든 데이터 변경은 @Transactional 안에서 일어나야 한다.
    // 2. @Transactional 이 테스트 케이스에 있으면 테스트가 끝난 후 바로 롤백을 한다.
    // 3. @Rollback(false) 로 설정해 놓으면 롤백을 하지 않고 커밋한다.
    public void testMember() throws Exception {
        // given
        Member member = new Member();
        member.setUsername("memberA");

        // when
        Long savedId = memberRepository.save(member);
        Member findMember = memberRepository.find(savedId);

        // then
        Assertions.assertThat(findMember.getId()).isEqualTo(member.getId());
        Assertions.assertThat(findMember.getUsername()).isEqualTo(member.getUsername());
        Assertions.assertThat(findMember).isEqualTo(member); //JPA 엔티티 동일성 보장
    }
}

주의! @Test는 JUnit4를 사용하면 org.junit.Test를 사용하셔야 합니다. 

 

 

 

 

쿼리 파라미터 로그 남기기

 

스프링 부트 3.x, hibernate6

org.hibernate.orm.jdbc.bind: trace

 

 

외부 라이브러리 사용

 

스프링 부트 3.0 이상을 사용하면 라이브러리 버전을 1.9.0 이상을 사용해야 한다.

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

insert into member (username,id) values (?,?)
insert into member (username,id) values ('memberA',1);

 

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