[Spring Boot] 2주차 3장 스프링 부트에서 JPA로 DB 다루기

🎆[03장] 스프링 부트에서 JPA로 DB 다루기

1. 프로젝트에 Spring Data JPA 적용하기
2. Spring Data JPA 테스트 코드 작성하기
3. 등록/수정/조회 API 만들기
4. JPA Auditing으로 생성시간/수정시간 자동화하기

🌸JPA 소개

• 관계형 DB는 SQL만 인식 가능. SQL의 단순 반복 작업 문제
• 데이터 저장 방법에 따라 패러다임 불일치 문제 발생
  • 관계형 DB: 어떻게 저장할 것인지에 초점
  • 객체지향 프로그래밍 언어: 기능과 속성을 한 곳에서 관리
    • 객체지향에서 만든 부모와 자식 관계가 DB에서 깨짐 → 상속, 1:N 등 다양한 객체 모델링을 DB에서 구현 불가 → 데이터 베이스 모델링에만 집중...
• JPA가 문제 해결 : 패러다임 일치시켜줌
  • 개발자 - 객체지향적 프로그래밍
  • JPA: 이를 관계형 DB에 맞게 SQL 대신 생성, 실행
• 객체 중심 개발! 생산성 향상, 유지보수에 편함

🌸Spring Data JPA

• 인터페이스인 JPA를 사용하기 위해서 구현체 필요.
• JPA (인터페이스)← Hibernate (구현체) ← Spring Data JPA (모듈)
• Spring Data JPA가 등장한 이유

1. 구현제 교체의 용이성 : Hibernate 외에 다른 구현체(Eclipse Link 등)로 쉽게 교체 가능
2. 저장소 교체의 용이성 : 관계형 데이터베이스 외에 다른 저장소 (MongoDB 등)로 쉽게 교체 가능
   • Spring Data의 하위 프로젝트들의 기본적인 CRUD 인터페이스가 같아서 의존성만 교체하면 됨

🌸프로젝트에 Spring Data JPA 적용하기

• build.gradle 의존성 등록
  spring-boot-starter-data-jpa
  • 스프링 부트용 Spring Data JPA 추상화 라이브러리.
    스프링 부트 버전에 맞춰 자동으로 JPA 관련 라이브러리 버전 관리
  • h2
  • 인메모리 관계형 데이터베이스. 별도의 설치 없이 프로젝트 의존성만으로 관리 가능.
    메모리에서만 실행돼서 애플리케이션 재시작마다 초기화. → 테스트 용도로 많이 사용.
• domain 패키지 생성.
  • 도메인: 게시글, 댓글, 회원, 정산, 결제 등 소프트웨어에 대한 요구사항 혹은 문제 영역
• domain 패키지에 posts 패키지와 Posts 클래스 생성
  • Posts 클래스: 실제 DB의 테이블과 매칭될 클래스. Entity 클래스라고도 함.
• 더 중요한 (주요) 어노테이션을 클래스에 가깝게 두는 배치
  • → 코틀린 등의 새 언어 전환으로 필요 없어지면 덜 중요한 어노테이션이 상위에 있으니까 쉽게 삭제 가능
• 롬복 어노테이션은 서비스 초기 구축 단계에서 테이블 설계 (여기에선 Entity 설계)가 빈번하게 변경될 때 코드 변경량 최소화
• PK값은 Long type의 Auto_increment 추천.
  • 유니크 키(주민등록번호 등)나 복합키(여러 키 조합)로 PK 잡으면
    • FK 맺을 때 다른 테이블에서 복합키 전부를 갖고 있거나 중간 테이블 하나 더 둬야하는 상황 발생
    • 인덱스에 좋은 영향X
    • 유니크한 조건 변경 시 PK 전체 수정해야 할 수도
  • → 주민등록번호, 복합키 등은 유니크 키로 별도 추가 추천
• Entity 클래스에서는 절대 Setter 메소드를 사용 X.
  해당 클래스의 인스턴스 값들이 언제 어디서 변해야 하는지 코드상 명확 구분 어렵... 차후 기능 변경 시 복잡해짐.
  → 필드값 변경 필요하면 목적과 의도를 나타낼 수 있는 메소드를 사용
  • Setter 대신 생성자를 통해 최종값을 채우고 DB에 삽입하거나 해당 이벤트에 맞는 public 메소드를 호출해 값 변경
    • 여기선 생성자 대신 @Builder를 통해 제공되는 빌더 클래스 사용
      (생성자 공통점: 생성 시점에 값을 채워주는 역할.
      생성자와 차이점: 생산자는 어느 필드에 어떤 값 채워야할지 명확 지정 불가)
• JpaRepository 인터페이스 생성 : Posts 클래스로 DB에 접근하게 해줄 인터페이스. DB 레이어 접근자임.
  • 인터페이스 만드는 게 없어서 헤맸는데 new class 생성하면 interface 선택할 수 있다..!!
  • JpaRepository 인터페이스 이름은 PostRepository로 지정함
  • JpaRepository<Entity 클래스, PK 타입> 상속 → 기본적 CRUD 메소드 자동 생성
  • Entity 클래스와 기본 Entity Repository는 함께 위치해야 하므로 도메인 패키지에서 함께 관리
    (기본 Repository 없으면 Entity 클래스는 제역할 불가)

🌸Spring Data JPA 테스트 코드 작성하기

• Test의 domain 패키지에 posts 패키지, PostsRepositoryTest 클래스 생성
• 테스트 실행해보면 통과함.
• 실제로 실행된 쿼리를 로그로 보려면?
  실제로 실행된 쿼리를 MySQL 버전 로그로 보려면?

    // application.properties
    spring.jpa.show_sql=true
    spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect

🌸등록/수정/조회 API 만들기

• API를 만들기 위해 총 3개의 클래스가 필요
  1. Request 데이터를 받을 Dto
  2. API 요청을 받을 Controller
  3. 트랜잭션, 도메인 기능 간의 순서를 보장하는 Service
     • 비지니스 로직 처리는 Service의 역할이 X
• Spring 웹 계층
  

  

  
  
  • Web Layer
    • 컨트롤러(@Controller)와 JSP/Freemarker 등의 뷰 템플릿 영역
    • 필터(@Filter), 인터셉터, 컨트롤러 어드바이스(@ControllerAdvice) 등 외부 요청과 응답에 대한 전반적인 영역
  • Service Layer
    • @Service에 사용되는 서비스 영역
    • 일반적으로 Controller와 Dao의 중간 영역에서 사용
    • @Transactional이 사용돼야 하는 영역
  • Repository Layer
    • Database와 같이 데이터 저장소에 접근하는 영역
    • Dao (Data Access Object) 영역
  • Dtos
    • Dto (Data Transfer Object)는 계층 간의 데이터 교환을 위한 객체. Dtos는 이들의 영역
    • ex) 뷰 템플릿 엔진에서 사용될 객체나 Repository Layer에서 결과로 넘겨준 객체 등
  • Domain Model
    • 도메인이라 불리는 개발 대상을 모든 사람이 동일한 관점에서 이해할 수 있고 공유할 수 있도록 단순화시킨 것
    • ex) 택시 앱) 배차, 탑승, 요금 등이 모두 도메인
    • @Entity가 사용된 영역
    • VO처럼 값 객체도 도메인 모델에 해당하기에 무조건 DB 테이블과 관계 있어야 하는 건 아님.
    • Web, Service, Repository, Dto, Domain의 5가지 레이어에서 비즈니스 처리는 Domain이 담당
• service : 트랜잭션, 도메인 간의 순서를 보장하는 영역
• 등록
  • web/PostsApicontroller.java
  • service/PostsService.java
    @RequiredArgsConstructor
    : 롬복 어노테이션. final이 선언된 모든 필드를 인자값으로 하는 생성자 생성.
    생성자를 직접 안 쓴 이유: 해당 클래스의 의존성 관계가 변경될 때마다 생성자 코드를 계속 수정해야 하는 번거로움 해결 위해
  • web/dto/PostsSaveRequestDto.java
  • Entity 클래스
    • DB와 맞닿은 핵심 클래스.
    • Entity 클래스를 기준으로 테이블 생성, 스키마 변경.
    • 변경되면 여러 클래스에 영향 끼침.
    • 절대 Request/Response 클래스로 사용하면 안 됨.
      → Request/Response용 Dto는 View를 위한 클래스라 정말 자주 변경 필요.
      View Layer와 DB Layer의 역할 분리 철저하게 하는 게 좋음.
      Controller에서 결괏값으로 여러 테이블을 조인해서 줘야 할 경우가 빈번하므로 Entity 클래스만으로 표현하기 어려운 경우가 많음.
      Entity 클래스와 Controller에서 쓸 Dto는 분리 필수.
  • 테스트 - web/PostsApiControllerTest.java

    • 

• 수정
  • web/PostsApiController
  • web/dto/PostResponseDto
  • service/posts/PostService

• 테스트 코드 실행 → update된 거 확인 가능

• 조회
  • resources/application.properties
    main에서 Application.java 코드 실행 후 콘솔에서 tomcat 8080 실행된 거 확인 후
    http://localhost:8080/h2-console로 이동

❓🔫Trouble Shooting!

tomcate 8080 포트 열린 거 확인됐는데 페이지 접속이 안 되는 문제
→ resources/application.properties를 test 안에 뒀는데 main 안의 resources/application.properties에 h2 관련 속성 적어줘야함

JDBC URL에 jdbc:h2:mem:testdb입력 후 CONNECT 누르기

 

posts 테이블 있는 거 확인하고 쿼리 실행해보기

 

insert into posts (author, content, title) values ('author', 'content', 'title');

 

http://localhost:8080/api/v1/posts/1 로 이동하면 볼 수 있음

 

🌸JPA Auditing으로 생성시간/수정시간 자동화하기

• entity에는 해당 데이터의 생성시간, 수정시간이 보통 포함되는데 모든 테이블과 서비스 메소드에 단순하고 반복적인 이 코드가 포함되는 걸 해결하고자 JPA Auditing 사용
• domain/BaseTimeEntity.java
  이 BaseTimeEntity 클래스는 모든 Entity의 상위 클래스가 되어 Entity들의 createdDate, modifiedDate를 자동 관리
• Posts 클래스가 BaseTimeEntity를 상속받도록 extends 작성
  • public class Posts extends BaseTimeEntity
• JPA Auditing 어노테이션들을 모두 활성화 가능하게 Application 클래스에 활성화 어노테이션 하나 추가
  • @EnableJpaAuditing // JPA Auditing 활성화
• 테스트 코드 작성 후 실행
  

  

  결과 볼 수 있음

• BaseTimeEntity만 상속받으면 Entity의 등록일, 수정일 이슈는 자동 해결