[JPA] 실전! 스프링 부트와 JPA 활용1_1. 프로젝트 환경설정

유진·2024년 7월 9일

실전 JPA 활용1

목록 보기

1/7

출처 : 인프런 > 실전! 스프링 부트와 JPA 활용1 - 웹 애플리케이션 개발 강의를 듣고 작성한 글입니다.
강의 링크 : 실전! 스프링 부트와 JPA 활용1 - 웹 애플리케이션 개발

섹션 1. 프로젝트 환경설정

📘 프로젝트 생성

스프링 부트 스타터(https://start.spring.io/) 사이트에 들어가서 위와 같이 프로젝트 설정을 하고 생성을 해준다.

Project: Gradle - Groovy Project
groupId: jpabook, artifactId: jpashop
사용 기능: web, thymeleaf, jpa, h2, lombok, validation

생성을 마친 후 인텔리제이로 프로젝트를 실행해준다.
롬복 테스트를 위해 아래와 같이 코드를 작성한다.

src\main\java\jpabook\jpashop\Hello.java

package jpabook.jpashop;

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
class Hello {

    private String data;
}

src\main\java\jpabook\jpashop\JpashopApplication.java

package jpabook.jpashop;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class JpashopApplication {

	public static void main(String[] args) {

		Hello hello = new Hello();
		hello.setData("hello");
		String data = hello.getData();
		System.out.println("data = " + data);

		SpringApplication.run(JpashopApplication.class, args);
	}

}

정상적으로 롬복이 돌아가는 걸 확인했다.

📘 라이브러리 살펴보기

gradle 의존관계 보기

맥 : ./gradlew dependencies —configuration compileClasspath
윈도우 : gradlew dependencies

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

테스트 라이브러리

✅ 참고: 스프링 데이터 JPA는 스프링과 JPA를 먼저 이해하고 사용해야 하는 응용기술이다.

📘 View 환경 설정

thymeleaf 템플릿 엔진

스프링 부트 thymeleaf viewName 매핑
- resources:templates/ +{ViewName}+ .html

jpashop\src\main\java\jpabook\jpashop\HelloController.java

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!!!");
        return "hello"; // return = 화면 이름, hello.html로 이동
    }
}

jpashop\src\main\resources\templates\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>

서버를 다시 실행 해보면 아래와 같이 정상적으로 나타난다.

렌더링 안하는 순수한 정적인 페이지
jpashop\src\main\resources\static\index.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>
Hello
<a href="/hello">hello</a>
</body>
</html>

✅ 참고: spring-boot-devtools 라이브러리를 추가하면, html 파일을 컴파일만 해주면 서버 재시작 없이 View 파일 변경이 가능하다.
인텔리J 컴파일 방법: 메뉴 build Recompile

📘 H2 데이터베이스 설치

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

https://www.h2database.com/

데이터베이스 파일 생성 방법
- jdbc:h2:~/jpashop (최소 한번)
- ~/jpashop.mv.db 파일 생성 확인
- 이후 부터는 jdbc:h2:tcp://localhost/~/jpashop 이렇게 접속

📘 JPA와 DB 설정, 동작확인

src\main\resources\application.yml

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

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

logging.level:
  org.hibernate.SQL: debug
# org.hibernate.type: trace #스프링 부트 2.x, hibernate5
# org.hibernate.orm.jdbc.bind: trace #스프링 부트 3.x, hibernate6

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 가 됩니다. 다음 코드에 주석으로 띄어쓰기를 적어두었습니다.

📖 실제 동작하는지 확인하기

회원 엔티티
src\main\java\jpabook\jpashop\Member.java

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;

}

회원 리포지토리
src\main\java\jpabook\jpashop\MemberRepository.java

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);
    }

}

테스트
src\test\java\jpabook\jpashop\MemberRepositoryTest.java

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;

import static org.junit.Assert.*;

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

    @Autowired MemberRepository memberRepository;

    @Test
    @Transactional // 테스트가 끝난 다음에 Rollback을 함
    @Rollback(false)
    public void testMember() throws Exception {
        //given
        Member member = new Member();
        member.setUsername("memberA");

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

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

}

테스트를 실행해보면 위와 같이 MEMBER 테이블이 생성된 것을 확인할 수 있다. 하지만 memberA가 추가되지는 않았다. 이는 @Transactional 애노테이션이 test 케이스에 있으면 테스트가 끝나면 데이터가 들어있는 상태의 반복적인 테스를 막아주기 위해 바로 Rollback을 해버린다. @Rollback(false)을 넣어주면 memberA가 insert 된다.

✅ 참고: 스프링 부트를 통해 복잡한 설정이 다 자동화 되었다. persistence.xml 도 없고, LocalContainerEntityManagerFactoryBean 도 없다. 스프링 부트를 통한 추가 설정은 스프링 부트 메뉴얼을 참고하고, 스프링 부트를 사용하지 않고 순수 스프링과 JPA 설정 방법은 자바 ORM 표준 JPA 프로그래밍 책을 참고하자.

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

로그에 다음을 추가하기: SQL 실행 파라미터를 로그로 남긴다.
org.hibernate.orm.jdbc.bind: trace

외부 라이브러리 사용
- https://github.com/gavlyukovskiy/spring-boot-data-source-decorator
스프링 부트를 사용하면 이 라이브러리만 추가하면 된다.
implementation 'com.github.gavlyukovskiy:p6spy-spring-boot-starter:1.9.0'

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

유진

유진진입니덩

다음 포스트