🐯 03장. 스프링 부트에서 JPA로 데이터베이스 다뤄보자 🐯

1. JPA 소개
2. 프로젝트에 Spring Data Jpa 적용하기
3. Spring Data Jpa 테스트 코드 작성하기
4. JPA Auditing으로 생성시간/수정시간 자동화하기

웹 서비스를 개발하고 운영하다 보면 데이터베이스를 다룬다. 관계형 데이터베이스를 이용하는 프로젝트에서 객체지향 프로그래밍을 할수 있게 해준 해결책이 JPA라는 자바 표준 ORM 기술이다.

---

1. JPA 소개

현대의 웹 애플리케이션에서 관계형 데이터베이스(RDB)는 빠질 수 없는 요소이다. 그러다 보니 객체를 관계형 데이터베이스에서 관리하는 것이 무엇보다 중요하다.

관계형 데이터베이스가 SQL만 인식할 수 있기 때문에 현업 프로젝트 대부분이 애플리케이션 코드보다 SQL로 가득차게 되었다. 그래서, 각 테이블마다 기본적인 CRUD SQL을 매번 생성해야 했다. 개발자가 아무리 노력해도 SQL을 통해야만 데이터베이스에 저장하고 조회할 수 있다. --> SQL은 피할 수 없다.

또한, 관계형 데이터베이스와 객체지향 프로그래밍 언어의 패러다임이 서로 다르므로 객체를 데이터베이스에 저장하려고 하면 여러 문제가 발생한다. 이를 패러다임 불일치라고 한다.

위와 같은 여러 문제를 해결하기 위해 JPA가 등장한다. 서로 지향하는 바가 다른 2개영역을 중간에서 패러다임 일치를 시켜주기 위한 기술이라고 할 수 있다.

즉, 개발자는 객체지향적으로 프로그래밍을 하고 JPA가 이를 관계형 데이터베이스에 맞게 SQL을 대신 생성해서 실행한다. 개발자는 더는 SQL에 종속적인 개발을 하지 않아도 된다.

Spring Data JAP

JPA는 인터페이스로서 자바 표준명세서이다. 인터페이스인 JPA를 사용하기 위해서는 구현체가 필요하다. 대표적으로 Hiberante,EclipseLink 등이 있지만 Spring에서 JPA를 사용할 때는 이 구현체들을 직접 다루진 않는다.

구현체들을 좀 더 쉽게 사용하고자 추상화시킨 Spring Data JPA라는 모듈을 이용하여 JPA기술을 다룬다.

JPA <- Hibernate <- Spring Data JPA

이렇게 한 단계 더 감싸놓은 Spring Data JPA가 등장한 이유는 구현체 교체의 용이성과 저장소 교체의 용이성 때문이다. 먼저 구현체 교체의 용이성은 Hibernate외에 다른 구현체로 쉽게 교체하기 위함이다. 저장소 교체의 용이성이란 관계형 데이터베이스 외에 다른 저장소로 쉽게 교체하기 위함이다. ( 예로, MongoDB로 교체가 필요하다면 개발자는 Spring Data JPA에서 Spring Data MongoDB로 의존성만 교체하면 된다. )

요구사항 분석

하나의 게시판을 만들어 보고 이 서비스를 AWS에 무중단 배포하는 것까지 진행할 것이다.

이 게시판의 요구사항은

게시판 기능

• 게시글 조회, 등록,수정,삭제

회원 기능

• 구글/네이버 로그인
• 로그인한 사용자 글 작성 권한
• 본인 작성 글에 대한 권한 관리

---

2. 프로젝트에 Spring Data Jpa 적용

먼저 build.gradle에 다음과 같이 org.springframework.boot:spring-boot-stater-data-jpa와 com.h2database:h2의존성들을 등록한다.

spring-boot-stater-data-jpa : 스프링 부트용 Spring data Jpa 추상화 라이브러리이다.
H2 : 인메모리형 관계형 데이터베이스이다. 별도의 설치필요없음, 메모리 실행 --> 재시작마다 초기화 , JPA테스트, 로컬환경에서의 구동에서 사용

domain 패키지

도메인을 담을 패키지로 도메인이란 게시글,댓글,회원,정산,결제 등 소프트웨어에 대한 요구사항 혹은 문제영역이다. domain패키지에 posts패키지와 Posts클래스를 만든다.

@Getter
@NoArgsConstructor
@Entity
public class Posts {
    @Id
    @GeneratedValue(strategy =  GenerationType.IDENTITY)
    private Long id;

    @Column(length = 500,nullable = false)
    private String title;

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

    private String author;

    @Builder
    public Posts(String title,String content,String author){
        this.title = title;
        this.author = author;
        this.content = content;
    }
}

• @Entity : 테이블과 링크될 클래스임을 나타냄. 기본값으로 클래스의 카멜케이스 이름을 언더스코어 네이밍(_)으로 테이블 이름을 매칭 ( ex. SalesManager.java -> sales_manager table )

• @Id : 해당 테이블의 PK필드를 나타낸다.

• @GeneratedValue : PK의 생성규칙을 나타낸다. 스프링 부트 2.0에서는 GenerationType.IDENTITY옵션을 추가해야만 auto_increment가 된다.

• @Column : 테이블의 칼럼을 나타내며 굳이 선언하지 않아도 해당 클래스의 필드는 모두 칼럼이 된다. 기본값외에 추가로 변경이 필요한 경우 사용한다. (ex.사이즈 늘리기, 타입 변경 등 )

• @Builder : 해당 클래스의 빌더 패턴 클래스를 생성, 생성자 상단에 선언 시 생성자에 포함된 필드만 빌더에 포함

위의 Posts클래스에는 Setter메소드가 없다. 차후 기능 변경시 복잡해지는 것을 막기 위해 Entity클래스에서는 절대 Setter메소드를 만들지 않는다. 대신, 해당 필드의 값 변경이 필요하면 명확히 그 목적과 의도를 나타낼 수 있는 메소드를 추가해야만 한다.

그러면 Setter가 업는 상황에서 어떻게 값을 채워 DB에 삽입 할까? 기본적인 구조는 생성자를 통해 최종값을 채운 후 DB에 삽입하는 ㄱ서이며, 값 변경이 필요한 경우 해당 이벤트에 맞는 public 메소드를 호출 하여 변경하는 것을 전제로 한다. (여기선 @Builder를 통해 제공되는 빌더클래스를 사용한다. )

생성자와 빌더 : 둘다 생성 시점에 값을 채워주는 역할은 똑같다. 다만, 생성자의 경우 지금 채워야 할 필드가 무엇인지 명확히 지정할 수 가 없다. 빌더를 사용하는 경우 어느 필드에 어떤 값을 채워야 할지 명확하게 인지 할 수 있다.

Example.builder()
	.a(a)
    .b(b)
    .build();

PostsRepository 인터페이스

Posts클래스로 Database 접근을 위한 인터페이스이다. DB Layer접근자로서 JPA에서 Repository라고 부르며 인터페이스로 생성한다. 단순히 인터페이스를 생성한후 JpaRepository<Entity 클래스, PK 타입> 을 상속하면 기본적인 CRUD메소드가 자동으로 생성된다.

@Repository를 추가할 필요도 없다. 여기서 주의해야할 점은 Entity클래스와 기본 Entity Repository는 함께 위치해야 하는 점이다. Entity클래스는 기본 Repository없이는 제대로 역할을 할 수 가 없다.

---

3. Spring Data JPA 테스트 코드 작성

PostsRepositroyTest 클래스

해당 클래스에서 save,findAll 기능을 테스트한다.

@RunWith(SpringRunner.class)
@SpringBootTest
public class PostsRepositoryTest extends TestCase {
    @Autowired
    PostsRepository postsRepository;

    @After
    public void cleanup(){
        postsRepository.deleteAll();
    }


    @Test
    public void 게시글저장_불러오기(){
        String title = "테스트 게시글";
        String content = "테스트 본문";

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

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

        Posts posts = postsList.get(0);
        assertThat(posts.getTitle()).isEqualTo(title);
        assertThat(posts.getContent()).isEqualTo(content);
    }
}

• @After : Junit에서 단위 테스트가 끝날 때마다 수행되는 메소드를 지정. 보통은 배포 전 전체 테스트를 수행할 때 테스트간 데이터 침범 막기 위해 사용. 여러 테스트가 동시 수행시 테스트용 데이터베이스인 H2에 데이터가 그대로 남아 있어 다음 테스트 실행 시 테스트 실패 가능
• postsRepository.save : 테이블 posts에 insert/update쿼리를 실행. id값이 있다면 update가 없다면 insert 쿼리가 실행
• postsRepostiroy.findAll : 테이블 posts에 있는 모든 데이터를 조회하는 메소드

별다른 설정 없이 @SpringBootTest를 사용할 경우 H2 데이터베이스를 자동으로 실행해준다.

실제 실행 쿼리 로그 보기 : application.properties 혹은 application.yml 등의 파일에 한줄의 코드로 설정 가능 --> src/main/resources 디렉토리 아래 application.properties파일 생성한 후 spring.jpa.show_sql=true 작성

출력되는 쿼리 로그를 MySQL 버전으로 변경 : application.properties에 spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect를 추가

---

4. 등록/수정/조회 API 만들기

API를 만들기 위해 총 3개의 클래스가 필요하다.

• Request 데이터를 받을 Dto
• API 요청을 받을 Controller
• 트랜잭션,도메인 기능 간의 순서를 보장하는 Service

Spring 웹 계층

• Web Layer : 컨트롤러와 JSP/Freemarker 등의 뷰 템플릿 영역. 이외에도 필터, 인터셉터, 컨트롤러 어드바이스 등 외부 요청과 응답에 대한 전반적인 영역을 이야기 한다.
• Service Layer : @Service에 사용되는 서비스 영역으로 일반적으로 Controller와 Dao의 중간 영역에서 사용. @Transactional이 사용되어야 하는 영역이기도 하다.
• Repostiroy Layer: Database오 같이 데이터 저장소에 접근하는 여역(Dao영역)
• Dtos : Dto는 계층 간에 데이터 교환을 위한 객체를 이야기 하며 Dtos는 이들의 영역
• Domain Model : 도메인이라 불리는 개발 대상을 모든 사람이 동일한 관점에서 이해할 수 있고 공유할 수 있도록 단순화 시킨 것을 도메인 모델이라고 한다.

PostApiController 클래스

@RestController
@RequiredArgsConstructor
public class PostsApiController {

    private final PostsService postsService;

    @PostMapping("/api/v1/posts")
    public Long save(@RequestBody PostsSaveRequestDto requestDto){
        return postsService.save(requestDto);
    }


    @PutMapping("/api/v1/posts/{id}")
    public Long update(@PathVariable Long id,@RequestBody PostsUpdateRequestDto requestDto){
        return postsService.update(id,requestDto);
    }


    @GetMapping("/api/v1/posts/{id}")
    public PostsResponseDto findById(@PathVariable Long id){
        return postsService.findById(id);
    }

}

PostsService

@Service
@RequiredArgsConstructor
public class PostsService {
    private final PostsRepository postsRepository;

    @Transactional
    public Long save(PostsSaveRequestDto requestDto){
        return postsRepository.save(requestDto.toEntity()).getId();
    }
    
	@Transactional
    public Long update(Long id, PostsUpdateRequestDto requestDto) {
        Posts posts = postsRepository.findById(id).orElseThrow(()-> new IllegalArgumentException("해당 게시글이 없습니다. id = " + id));

        posts.update(requestDto.getTitle(),requestDto.getContent());

        return id;
    }


    public PostsResponseDto findById(Long id) {
        Posts posts = postsRepository.findById(id).orElseThrow(()->new IllegalArgumentException("해당 게시글이 없습니다. id = " + id));
        PostsResponseDto responseDto = new PostsResponseDto(posts);
        
        return responseDto;
    }
}

update기능에서 데이터베이스에 쿼리를 날리는 부분이 없다. 이게 가능한 이유는 JPA의 영속성 컨텍스트 때문이다. 영속성 컨텍스트란, 엔티티를 영구 저장하는 환경 이다. JPA의 핵심 내용은 엔티티가 영속성 컨텍스트에 포함되어 있냐 아니냐로 갈린다. JPA의 엔티티 매니저가 활성화된 상태로 트랜잭션 안에서 데이터베이스에서 데이터를 가져오면 이 데이터는 영속성 컨텍스트가 유지된 상태이다. 이 상태에서 해당 값을 변경하면 트랜잭션이 끝나는 시점에 해당 테이블에 변경분을 반영한다. 즉 Entity 객체의 값만 변경하면 별도로 update쿼리를 날릴 필요가 없다는 것이다. 이 개념을 더티 체킹 이라고 한다.

PostsSaveRequestDto

@Getter
@NoArgsConstructor
public class PostsSaveRequestDto {
    private String title;
    private String content;
    private String author;

    @Builder
    public PostsSaveRequestDto(String title,String content, String author){
        this.title = title;
        this.author = author;
        this.content = content;
    }

    public Posts toEntity(){
        return Posts.builder()
                .author(this.author)
                .title(this.title)
                .content(this.content)
                .build();
    }
}

dto클래스는 Entity클래스와 거의 유사한 형태이다. 절대로 Entity클래스를 Request/Response 클래스로 사용해서는 안된다. Entity클래스는 데이터베이스와 맞닿은 핵심 클래스이다. Entity 클래스를 기준으로 테이블이 생성되고, 스키마가 변경된다. Entity 클래스가 변경되면 여러 클래스에 영향을 끼치지만, Request와 Respose용 Dto는 View를 위한 클래스라 정말 자주 변경이 필요하다.

View Layer와 DB Layer의 역할 분리를 철저하게 하는게 좋다. 실제로 Controller에서 결과값으로 여러 테이블을 조인해서 줘야 할 경우가 빈번하므로 Entity클래스만으로 표현하기가 어려운 경우가 많다.

테스트 - PostsControllerTest

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class PostsApiControllerTest extends TestCase {

    @LocalServerPort
    private int port;

    @Autowired
    private TestRestTemplate restTemplate;

    @Autowired
    private PostsRepository postsRepository;


    @After
    public void tearDown() throws Exception{
        postsRepository.deleteAll();
    }

    @Test
    public void Posts_등록된다() throws Exception{

        String title = "title";
        String content = "content";

        PostsSaveRequestDto postsSaveRequestDto = new PostsSaveRequestDto().builder()
                .title(title)
                .content(content)
                .author("author")
                .build();

        String url = "http://localhost:" + port  + "/api/v1/posts";


        ResponseEntity<Long> responseEntity = restTemplate.postForEntity(url,postsSaveRequestDto,Long.class);

        assertThat(responseEntity.getStatusCode()).isEqualTo(HttpStatus.OK);
        assertThat(responseEntity.getBody()).isGreaterThan(0L);


        List<Posts> all = postsRepository.findAll();
        assertThat(all.get(0).getTitle()).isEqualTo(title);
        assertThat(all.get(0).getContent()).isEqualTo(content);
        
    }

}

    @Test
    public void Posts_수정된다() throws Exception{
        Posts savedPosts = postsRepository.save(Posts.builder().
                title("title")
                .content("content")
                .author("author").build());

        Long updatedId = savedPosts.getId();
        String expectedTitle = "title2";
        String expectedContent = "content2";


        PostsUpdateRequestDto requestDto = PostsUpdateRequestDto.builder()
                .title(expectedTitle)
                .content(expectedContent).build();

        String url = "http://localhost:" + port + "/api/v1/posts/"+updatedId;

        HttpEntity<PostsUpdateRequestDto> requestEntity = new HttpEntity<>(requestDto);


        ResponseEntity<Long> responseEntity = restTemplate.exchange(url, HttpMethod.PUT,requestEntity,Long.class);


        assertThat(responseEntity.getStatusCode()).isEqualTo(HttpStatus.OK);
        assertThat(responseEntity.getBody()).isGreaterThan(0L);

        List<Posts> all = postsRepository.findAll();
        assertThat(all.get(0).getTitle()).isEqualTo(expectedTitle);
        assertThat(all.get(0).getContent()).isEqualTo(expectedContent);
    }

HelloController와 달리 @WebMvcTest를 사용하지 않았다. @webMvcTest의 경우 JPA 기능이 작동하지 않기 때문인데, Controller와 ControllerAdvice 등 외부 연동과 관련된 부분만 활성화되니 지금 같이 JPA 기능 까지 한번에 테스트 할 때는 @SpringBootTest와 TestRestTemplate을 사용하면 된다.

PostsResponseDto 클래스

@Getter
public class PostsResponseDto {
    private Long id;
    private String title;
    private String content;
    private String author;

    public PostsResponseDto(Posts entity){
        this.id = entity.getId();
        this.title = entity.getTitle();
        this.content = entity.getContent();
        this.author = entity.getAuthor();
    }
}

PostsUpdateRequestDto 클래스

@Getter
@NoArgsConstructor
public class PostsUpdateRequestDto {
    private String title;
    private String content;
    
    @Builder
    public PostsUpdateRequestDto(String title,String content){
        this.title = title;
        this.content = content;
    }
}

---

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

보통 엔티티에는 해당 데이터의 생성시간과 수정시간을 포함한다. 언제 만들어졌는지, 언제 수정되었는지 등은 차후 유지보수에 있어 굉장히 중요한 정보이기 때문이다. 그렇다 보니 매번 DB에 삽입하기전 갱신하기전에 날짜 데이터를 등록/수정하는 코드가 여기저기 들어가게 된다. 이런 단순하고 반복적인 코드가 모든 테이블과 서비스 메소드에 포함되어야 한다면 귀찮고 코드가 지저분해질 수 있다. 이런 문제를 해결하고자 JAP Auditing을 사용한다.

BaseTimeEntity 클래스

@Getter
@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
public class BaseTimeEntity {
    
    @CreatedDate
    private LocalDateTime createdDate;
    
    @LastModifiedDate
    private LocalDateTime modifiedDate;
    
}

• @MappedSuperclass : JPA Entity 클래스들이 BaseTimeEntity를 상속할 경우 필드들도 칼럼으로 인식하도록 한다.
• @EntityListeners(AuditingEntityListener.class) : BaseTimeEntity클래스에 Auditing기능을 포함시킨다.
• @CreatedDate : Entity가 생성되어 저장될때 시간이 자동 저장
  _ @LastModifiedDate : 조회한 Entity값을 변경할 떄 시간이 자동 저장

이후에 Posts클래스가 BaseTimeEntity를 상속받도록 변경한다.

마지막으로 JPA Auditing 어노테이션들을 모두 활성화 할 수 있도록 Application클래스에 활성화 어노테이션 하나를 추가한다. @EnableJpaAuditing !

테스트 코드 작성하기

 @Test
    public void BaseTimeEntity_등록(){

        LocalDateTime now = LocalDateTime.of(2019,6,4,0,0,0);
        postsRepository.save(Posts.builder()
                .title("title")
                .content("content")
                .author("author")
                .build());

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

        Posts posts = postsList.get(0);

        System.out.println(">>>>>>>>>>>>>>> createDate = " + posts.getCreatedDate() + ", modifiedDate = " + posts.getModifiedDate());


        assertThat(posts.getCreatedDate()).isAfter(now);
        assertThat(posts.getModifiedDate()).isAfter(now);

    }