Super Kawaii Cute Cat Kaoani [스프링 데이터 JPA] 1. 프로젝트 환경설정

[스프링 데이터 JPA] 1. 프로젝트 환경설정

2024. 1. 24. 01:11
728x90
SMALL

📌 프로젝트 생성

✔ 개발 환경

  • Java 17
  • IntelliJ IDEA

스프링 부트 스타터 사이트에서 프로젝트 생성

  • 프로젝트 선택
    • Project : Gradle-Groovy Project
    • Language : Java
    • Spring boot 3.2.1
  • Project Metadata
    • Group : study
    • Artifact : data-jpa
    • Name : data-jpa
    • Package name : study.data-jpa
    • Packing : Jar
    • Java 17
  • Dependencies: web, jpa, h2, lombok

 

🔶 build.gradle

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

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

java {
    sourceCompatibility = '17'
}

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()
}
  • 동작 확인

 

 

 

⚡ 테스트 컨트롤러

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";
    }
}
주의! 스프링 부트 3.2부터 JDK 17과 Gradle 옵션을 선택

 

 

📌 라이브러리 살펴보기

⚡ 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: 테스트 코드를 좀 더 편하게 작성하게 도와주는 라이브러리
    • spring-test: 스프링 통합 테스트 지원
  • 핵심 라이브러리
    • 스프링 MVC
    • 스프링 ORM
    • JPA, 하이버네이트
    • 스프링 데이터 JPA
  • 기타 라이브러리
    • H2 데이터베이스 클라이언트
    • 커넥션 풀: 부트 기본은 HikariCP
    • 로깅 SLF4J & LogBack
    • 테스트

 

 

📌 H2 데이터베이스 설치

주의! H2 데이터베이스를 2.1.214 버전 이상으로 사용
  • 개발이나 테스트 용도로 가볍고 편리한 DB, 웹 화면 제공
  • 다운로드 및 설치
    • 스프링 부트 3.x를 사용하면 2.1.214 버전 이상 사용
    • h2 데이터베이스 버전은 스프링 부트 버전에 맞춤
  • 권한 주기: chmod 755 h2.sh
  • 데이터베이스 파일 생성 방법
    • jdbc:h2:~/datajpa (최소 한번)
    • ~/datajpa.mv.db 파일 생성 확인
    • 이후 부터는 jdbc:h2:tcp://localhost/~/datajpa 이렇게 접속

 

반응형

 

📌 스프링 데이터 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:
#        show_sql: true
        format_sql: true
logging.level:
  org.hibernate.SQL: debug
#  org.hibernate.type: trace
  • spring.jpa.hibernate.ddl-auto: create
    • 이 옵션은 애플리케이션 실행 시점에 테이블을 drop 하고, 다시 생성

cf) 모든 로그 출력은 가급적 로거를 통해 남겨야 함

 

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

 

 

 

⚡ 실제 동작하는지 확인

회원 엔티티

🔶 study/datajpa/entity/Member

package study.datajpa.entity;

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

 

 

회원 JPA 리포지토리

🔶 study/datajpa/repository/MemberRepository

package study.datajpa.repository;

import jakarta.persistence.EntityManager;
import jakarta.persistence.PersistenceContext;
import org.springframework.stereotype.Repository;
import study.datajpa.entity.Member;

@Repository
public class MemberRepository {

    @PersistenceContext
    private EntityManager em;

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

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

 

 

JPA 기반 테스트

🔶 test/.../study/datajpa/repository/MemberRepositoryTest

package study.datajpa.repository;

import org.assertj.core.api.Assertions;
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 org.springframework.transaction.annotation.Transactional;
import study.datajpa.entity.Member;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.*;

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

    @Autowired
    MemberJpaRepository memberJpaRepository;

    @Test
    public void testMember() {

        Member member = new Member("memberA");
        Member savedMember = memberJpaRepository.save(member);

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

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

 

 

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

🔶 study/datajpa/repository/MemberRepository

package study.datajpa.repository;

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

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

 

 

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

🔶 test/.../study/datajpa/repository/MemberRepositoryTest

package study.datajpa.repository;

import org.assertj.core.api.Assertions;
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 org.springframework.transaction.annotation.Transactional;
import study.datajpa.entity.Member;

import static org.junit.jupiter.api.Assertions.*;

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

    @Autowired
    MemberRepository memberRepository;

    @Test
    public void testMember() {
        //given
        Member member = new Member("memberA");
        Member savedMember = memberRepository.save(member);

        //when
        Member findMember = memberRepository.findById(savedMember.getId()).get();

        //then
        Assertions.assertThat(findMember.getId()).isEqualTo(member.getId());
        Assertions.assertThat(findMember.getUsername()).isEqualTo(member.getUsername());
        Assertions.assertThat(findMember).isEqualTo(member); //JPA 엔티티 동일성 보장
    }
}
  • Entity, Repository 동작 확인
  • jar 빌드해서 동작 확인

cf) 스프링 부트를 통해 복잡한 설정이 다 자동화 됨

 

  • persistence.xml도 없고, LocalContainerEntityManagerFactoryBean 도 없음

 

 

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

  • 로그에 다음을 추가하기 org.hibernate.type : SQL 실행 파라미터를 로그로 남김
  • 외부 라이브러리 사용

✔ 스프링 부트를 사용하면 이 라이브러리만 추가
✔ 스프링 부트 3.0 이상을 사용하면 라이브러리 버전을 1.9.0 이상을 사용해야 함

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

 

cf) 쿼리 파라미터를 로그로 남기는 외부 라이브러리는 시스템 자원을 사용하므로, 개발 단계에서는 편하게 사용해도 됨.
➡  운영 시스템에 적용하려면 꼭 성능테스트 하고 사용!!

 

 

 

 

김영한님의 <실전! 스프링 데이터 JPA>을 수강하고 작성한 글입니다

 

 

 

 

 


NEXT

 

[스프링 데이터 JPA] 2. 예제 도메인 모델

📌 예제 도메인 모델과 동작확인 ⚡ Member 엔티티 package study.datajpa.entity; import jakarta.persistence.*; import lombok.*; @Entity @Getter@Setter @NoArgsConstructor(access = AccessLevel.PROTECTED) @ToString(of = {"id", "username", "age"

nyeroni.tistory.com

 

728x90
LIST

BELATED ARTICLES

more