Spring boot 에 Spring Data JPA 적용하기

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

build.gradle 수정

Spring Data JPA 와 H2 를 사용하기 위해 아래처럼 build.gradle 파일을 수정한다. Spring Data JPA 가 무엇이고 SQL Mapper와는 어떻게 다른지 궁금하다면... 👉 SQL Mapper vs ORM (feat. Hibernate vs Spring Data JPA) H2는 인메모리 RDBMS로 Spring boot 에 내장되어 있다. 별도의 설치가 필요 없고 메모리에서 실행되므로 애플리케이션 실행 시 초기화돼서 테스트 용도로 자주 쓰이는 DB 이다. 수정해주고 gradle 반영 버튼을 꼭 누르자.

dependencies {
	...

    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    runtimeOnly 'com.h2database:h2'
}

 

domain 생성

domain 은 요구 사항 및 문제 영역이다. 블로그로 따지면 게시글, 회원, 방명록, 댓글 등등에 해당된다. 그리고 도메인에서 도출된 객체들을 domain object 라고 한다. 데이터 객체인 Entity, 데이터의 영속성을 위한 Repository 등 모두 domain object 에 포함된다. 데이터 전달을 위해 사용되는 DTO 와는 목적이 다르기 때문에, DTO 에 쿼리 결과값만 담았다면 domain object 에는 문제 해결을 위한 비즈니스 로직도 포함된다.(지금은 이렇게만 이해하고... 나중에 도메인 패턴을 제대로 공부해봐야겠다)

 

src/main/java/com.study.springbootsaws/domain/posts/Posts

Posts 클래스는 Spring Data JPA 을 통해 실제 DB 테이블과 매핑되는 객체다. Entity 라고 하며, @Entity 어노테이션을 붙여주면 된다. 참고로 이 책에서는 이후 리팩토링, 다른 툴로 변환 등을 쉽게 하기 위해 주요 어노테이션을 클래스와 가까이 둔다고 한다. lombok 은 코드를 단순화 시켜주지만 필수 어노테이션은 아니라 위쪽에 두었다. 각 어노테이션 설명은 주석으로 달아두었다.

 

참고로 Entity 클래스는 Setter 메소드 작성을 지양한다. setter 사용으로 데이터가 여기저기서 변경되어 일관성이 없어지고, 왜 변경하는지 그 목적이 불분명하기 때문이다. 그래서 초기 필드 값을 넣기 위해서 생성자를 이용한다. 만약 필드값이 변경되어야 하는 경우 setter 가 아닌, 왜 변경하는지 목적과 의도가 분명하게 들어가 있는 별도의 메소드를 추가한다.

 

여기서는 생성자 대신 빌더 클래스를 이용했다. 생성자는 필드의 순서를 바꾸어도 오류가 나지 않지만, 빌더 패턴의 경우 builder().filed1(value).filed2(value) 이런 식으로 작성하기 때문에 어떤 필드에 어떤 값을 넣었는지 명확하게 인지할 수 있기 때문이다.

 

package com.study.springbootaws.domain.posts;

import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;

import javax.persistence.*;

@Getter
@NoArgsConstructor	//lombok. 기본 생성자 생성
@Entity	//JPA. 테이블과 링크될 클래스임을 나타냄
public class Posts {
    @Id	//PK
    @GeneratedValue(strategy = GenerationType.IDENTITY)	//auto_increment
    private Long id;

    @Column(length = 500, nullable = false)	//table 의 column 설정. 굳이 어노테이션 안 달아도 나머지 필드들 자동으로 coloumn 됨. 별도의 설정 있을 경우 선언
    private String title;

    @Column(columnDefinition = "TEXT", nullable = false)
    private String content;

    private String author;

    @Builder	//lombok. 빌더 패턴 클래스 생성. 이렇게 생성자쪽에 붙여주면 생성자 필드만 빌더에 포함됨
    public Posts(String title, String content, String author) {
        this.title = title;
        this.content = content;
        this.author = author;
    }
}

 

src/main/java/com.study.springbootsaws/domain/posts/PostsRepository

Repository 는 MyBatis 에서 DAO 와 같은 DB Layer 접근 클래스다. JPA에서는 어노테이션 달 필요 없이, 밑에처럼 JpaRepository 를 상속받는 interface 를 생성하면 기본적인 CRUD 메소드가 자동으로 생성된다. 단, Entity 와 Repository 클래스는 밀접하게 관계있으므로 같은 위치에 있어야 한다. 이후 패키지 수정 시 같이 움직인다...

package com.study.springbootaws.domain.posts;

import org.springframework.data.jpa.repository.JpaRepository;

public interface PostsRepository extends JpaRepository<Posts, Long> {
}

 

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

src/test/java/com.study.springbootaws/domain/posts/PostsRepositoryTest

위 경로에 테스트 코드를 작성해준다. JPA 의 save, findAll 등의 기능을 테스트할 수 있다. save 는 insert/update 에 해당하는 메소드고 findAll 은 select 에 해당하는 메소드다. 참고로 책에서는 @After 어노테이션을 사용했으나, 버전이 달라지며 @AfterEach 를 붙여준다.

package com.study.springbootaws.domain.posts;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import static org.assertj.core.api.AssertionsForClassTypes.assertThat;


import java.util.List;

@SpringBootTest
public class PostRepositoryTest {
    @Autowired
    PostsRepository postsRepository;

    @AfterEach	//@Test 어노테이션이 붙은 메소드가 각각 실행된 후 자동으로 실행됨
    public void cleanup() {
        postsRepository.deleteAll();
    }

    @Test
    public void saveAndReadPosts() {
        String title = "테스트 게시글";
        String content = "테스트 본문";

        postsRepository.save(Posts.builder().title(title).content(content).author("dev@gmail.com").build());

        List<Posts> postsList = postsRepository.findAll();

        Posts posts = postsList.get(0);

        assertThat(posts.getTitle()).isEqualTo(title);
        assertThat(posts.getContent()).isEqualTo(content);
    }
}

 

src/main/resources/application.properties

위 경로에 properties 파일을 만들어주고 아래 내용을 넣는다. 버전이 달라지며 코드도 살짝 달라졌다. 이렇게 하면 JPA 가 실행되며 생성된 쿼리문을 터미널에서 출력해준다. 또 지금 사용하는 DB 는 H2 DB 라 H2 문법으로 보일텐데, 아래처럼 옵션을 넣으면 MySql 문법으로 변환돼서 보여준다.

spring.jpa.show_sql=true
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL57Dialect
spring.jpa.properties.hibernate.dialect.storage_engine=innodb
spring.datasource.hikari.jdbc-url=jdbc:h2:mem://localhost/~/testdb;MODE=MYSQL

아래처럼 뜬다!!