프로젝트 환경설정

목차

• 프로젝트 생성
• 라이브러리 살펴보기
• 스프링 데이터 JPA와 DB 설정, 동작확인

---

프로젝트 환경설정 

 

프로젝트 생성

• 스프링 부트 스타터(https://start.spring.io/) 
• 사용 기능: web, jpa, h2, lombok
  • SpringBootVersion: 2.2.1 
  • groupId: study
  • artifactId: data-jpa 

 

Gradle 전체 설정

plugins {
   id 'org.springframework.boot' version '2.6.6'
   id 'io.spring.dependency-management' version '1.0.11.RELEASE'
   id 'java'
}

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

configurations {
   compileOnly {
      extendsFrom annotationProcessor
   }
}

repositories {
   mavenCentral()
}

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

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

• 동작 확인
  
  • 기본 테스트 케이스 실행
  • 스프링 부트 메인 실행 후 에러페이지로 간단하게 동작 확인(`http://localhost:8080') 
  • 테스트 컨트롤러를 만들어서 spring web 동작 확인(http://localhost:8080/hello)

 

테스트 컨트롤러

package study.datajpa.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @RequestMapping("/hello")
    public String hello(){
        return "hello";
    }
}

 

참고: 최근 IntelliJ 버전은 Gradle로 실행을 하는 것이 기본 설정이다. 이렇게 하면 실행속도가 느리다. 다음과 같이 변경하면 자바로 바로 실행하므로 좀 더 빨라진다.

> Preferences Build, Execution, Deployment Build Tools Gradle 

> Build and run using: Gradle IntelliJ IDEA
> Run tests using: Gradle IntelliJ IDEA

 

 

롬복 적용

1. Preferences plugin lombok 검색 실행 (재시작)
2. Preferences Annotation Processors 검색 Enable annotation processing 체크 (재시작) 

3. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인

 

 

---

라이브러리 살펴보기

 

gradle 의존관계 보기
./gradlew dependencies --configuration compileClasspath

 

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

• 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 
  • 스프링 ORM
  • JPA, 하이버네이트
  • 스프링 데이터 JPA
• 기타 라이브러리
  
  • H2 데이터베이스 클라이언트
  • 커넥션 풀: 부트 기본은 HikariCP 
  • 로깅 SLF4J & LogBack
  • 테스트 

---

스프링 데이터 JPA와 DB 설정, 동작확인

 

application.yml

spring:
  datasource:
    url: jdbc:h2:tcp://localhost/~datajpa
    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

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

 

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

show_sql : 옵션은 System.out 에 하이버네이트 실행 SQL을 남긴다.

org.hibernate.SQL : 옵션은 logger를 통해 하이버네이트 실행 SQL을 남긴다.

 

실제 동작하는지 확인하기

 

회원 엔티티

package study.datajpa.entity;

import lombok.Getter;
import lombok.Setter;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

@Entity
@Getter
@Setter
public class Member {

    @Id
    @GeneratedValue
    private Long id;

    private String username;

    public Member() {
    }

    public Member(String username) {
        this.username = username;
    }
}

 

회원 JPA 리포지토리

package study.datajpa.repository;

import org.springframework.stereotype.Repository;
import study.datajpa.entity.Member;

import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;

@Repository
public class MemberJpaRepository {

    @PersistenceContext
    private EntityManager em;

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

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

 

JPA 기반 테스트

package study.datajpa.repository;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.annotation.Rollback;
import study.datajpa.entity.Member;

import javax.transaction.Transactional;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest
@Transactional
@Rollback(value = false)
class MemberJpaRepositoryTest {

    @Autowired
    MemberJpaRepository memberJpaRepository;

    @Test
    public void testMember(){
        Member member = new Member("memberA");

        Member saveMember = memberJpaRepository.save(member);

        Member findMember = memberJpaRepository.find(saveMember.getId());

        assertThat(findMember.getId()).isEqualTo(member.getId());
        assertThat(findMember.getUsername()).isEqualTo(member.getUsername());

        assertThat(findMember).isEqualTo(member);   // JPA 엔티티 동일

    }
}

 

 

스프링 데이터 JPA 리포지토리

package study.datajpa.repository;

import org.springframework.data.jpa.repository.JpaRepository;
import study.datajpa.entity.Member;

public interface MemberRepository extends JpaRepository<Member, Long> {
}

 

스프링 데이터 JPA 기반 테스트

package study.datajpa.repository;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.annotation.Rollback;
import study.datajpa.entity.Member;

import javax.transaction.Transactional;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest
@Transactional
@Rollback(value = false)
public class MemberRepositoryTest {


    @Autowired
    MemberRepository memberRepository;

    @Test
    public void testMember() {
        Member member = new Member("memberA");

        Member saveMember = memberRepository.save(member);

        Member findMember = memberRepository.findById(saveMember.getId()).get();

        assertThat(findMember.getId()).isEqualTo(member.getId());
        assertThat(findMember.getUsername()).isEqualTo(member.getUsername());

        assertThat(findMember).isEqualTo(member);   // JPA 엔티티 동일

    }
}

 

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

 

쿼리 파라미터 로그 남기기

• 로그에 다음을 추가하기 org.hibernate.type : SQL 실행 파라미터를 로그로 남긴다. 
• 외부 라이브러리 사용
  • https://github.com/gavlyukovskiy/spring-boot-data-source-decorator   

스프링 부트를 사용하면 이 라이브러리만 추가하면 된다.

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

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