프로젝트 환경설정

프로젝트 생성

프로젝트 선택

Project: Gradle Project
Language: Java
Spring Boot: 2.4.x
Packaging: Jar
Java: 11
Dependencies: Spring Web, Thymeleaf, Spring Data JPA, H2, Lombok, Validation

라이브러리 살펴보기

gradle 의존관계 보기

./gradlew dependencies —configuration compileClasspath

IntelliJ를 사용할 경우 Gradle탭 - 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
테스트

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

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-templateengines

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

@Controller
public class HelloController {
    
    @GetMapping("hello")
    public String hello(Model model) {
        model.addAttribute("data", "hello!!");
        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>

위치: resources/templates/hello.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 이렇게 접속

H2 데이터베이스 설치 - 02

참고 : -tcpPort 옵션을 통하여 H2 Database 실행 포트를 설정할 수 있음.

H2 데이터베이스 설치 - 03

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

JPA와 DB 설정, 동작확인

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

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 가 된다.

실제 동작하는지 확인하기

회원 엔티티

@Entity
@Getter @Setter
public class Member {
    
    @Id @GeneratedValue
    private Long id;
    private String username;
    ...
}

회원 리포지토리

@Repository
public class MemberRepository {
    
    @PersistenceContext
    EntityManager em;
    
    public Long save(Member member) {
        em.persist(member);
        return member.getId();
    }
    
    public Member find(Long id) {
        return em.find(Member.class, id);
    }
}

테스트

import jpabook.jpashop.domain.Member;
import jpabook.jpashop.repository.MemberRepository;
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.context.junit4.SpringRunner;

import org.springframework.transaction.annotation.Transactional;
import javax.persistence.EntityManager;

@RunWith(SpringRunner.class)
@SpringBootTest
public class MemberRepositoryTest {
    
    @Autowired MemberRepository memberRepository;
    
    @Test
    @Transactional
    @Rollback(false)
    public void testMember() {
        // 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를 사용해야 한다.

Entity, Repository 동작 확인
jar 빌드해서 동작 확인

./gradlew.bat build
cd build
cd libs
java -jar jpashop-0.0.1-SNAPSHOT.jar

오류: 테스트를 실행했는데 다음과 같이 테스트를 찾을 수 없는 오류가 발생하는 경우 No tests found for given includes: [jpabook.jpashop.MemberRepositoryTest] (filter.includeTestsMatching) 해결: 스프링 부트 2.1.x 버전을 사용하지 않고, 2.2.x 이상 버전을 사용하면 Junit5가 설치된다. 이때는 build.gradle 마지막에 다음 내용을 추가하면 테스트를 인식할 수 있다. Junit5 부터는 build.gradle 에 다음 내용을 추가해야 테스트가 인식된다.

build.gradle 마지막에 추가

test {
	useJUnitPlatform()
}

참고: 스프링 부트를 통해 복잡한 설정이 다 자동화 되었다. persistence.xml 도 없고, LocalContainerEntityManagerFactoryBean 도 없다.

쿼리 파라미터 로그 남기기

로그에 다음을 추가하기 org.hibernate.type : SQL 실행 파라미터를 로그로 남긴다.
외부 라이브러리 사용
- https://github.com/gavlyukovskiy/spring-boot-data-source-decorator
  
  스프링 부트를 사용하면 이 라이브러리만 추가하면 된다. implementation 'com.github.gavlyukovskiy:p6spy-spring-boot-starter:1.5.6'

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