Spring Data JPA 로 등록/조회/수정 API 만들기

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

각 코드 상세 설명은 주석으로 달았다. 또 Entity 클래스와 Repository 클래스는 👉  Spring boot 에 Spring Data JPA 적용하기 에서 작성했다.

 

DTO 만들기

DTO는 데이터를 View Layer 와 주고받을 때(request, response) 감싸는 객체이다. 외부에 노출되는 객체이므로 안에 비즈니스 로직을 담지 않는다. 여기서는 Entity 와 유사하나, 이렇게 View 와 주고받는 데이터들은 자주 수정이 일어난다. Entity 는 DB와 밀접한 객체고 비즈니스 로직도 담고 있으므로 자주 수정하게 되면 관련된 여러 클래스들에 영향을 끼치기 때문에 Entity 를 dto 용도로 쓰지 않는다. 즉, Entity 클래스와 Controller 에서 쓸 DTO 는 분리해야 한다.

 

src/main/java/com.study.springbootaws/web/dto/PostsResponseDto

package com.study.springbootaws.web.dto;

import com.study.springbootaws.domain.posts.Posts;
import lombok.Getter;

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

	//repository 를 통해 조회한 entity 를 dto 로 변환 용도 
    public PostsResponseDto(Posts entity) {
        this.id = entity.getId();
        this.title = entity.getTitle();
        this.content = entity.getContent();
        this.author = entity.getAuthor();
    }
}

 

src/main/java/com.study.springbootaws/web/dto/PostsSaveRequestDto

package com.study.springbootaws.web.dto;

import com.study.springbootaws.domain.posts.Posts;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;

@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.content = content;
        this.author = author;
    }

	//resquest dto 로 받은 Posts 객체를 entity 화하여 저장하는 용도
    public Posts toEntity() {
        return Posts.builder().title(title).content(content).author(author).build();
    }
}

 

src/main/java/com.study.springbootaws/web/dto/PostsUpdateRequestDto

package com.study.springbootaws.web.dto;

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

@Getter
@NoArgsConstructor
public class PostsUpdateRequestDto {
    private String title;
    private String content;

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

 

Entity 코드 수정

Spring Data Jpa 는 기본적으로 JPA 영속성 컨텍스트 유지를 제공한다. 이 상태에서 해당 데이터의 값을 변경하면 자동으로 변경사항이 DB에 반영한다. 즉, 별도로 Update 쿼리를 날리지 않아도, 데이터만 변경하면 알아서 변경되므로 수정기능은 아래처럼 Entity 에 update 메소드를 만들어줘 구현한다. 

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

...

public class Posts {

...

    public void update(String title, String content) {
        this.title = title;
        this.content = content;
    }
}

 

Service 만들기

보통은 Service 에 비즈니스 로직을 구현한다. 그것을 트랜잭션 스크립트라고 하는데, 그러다보니 서비스 계층이 무의미해진다. 서비스 계층에서는 트랜잭션과 도메인 간 순서만을 보장해줘야 한다. 비즈니스 로직은 도메인 에서 처리한다.

src/main/java/com.study.springbootaws/service/PostsService

package com.study.springbootaws.service;

import com.study.springbootaws.domain.posts.Posts;
import com.study.springbootaws.domain.posts.PostsRepository;
import com.study.springbootaws.web.dto.PostsResponseDto;
import com.study.springbootaws.web.dto.PostsSaveRequestDto;
import com.study.springbootaws.web.dto.PostsUpdateRequestDto;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

import javax.transaction.Transactional;

@RequiredArgsConstructor    //final or NonNull 옵션 필드를 전부 포함한 생성자 만들어줌
@Service
public class PostsService {
    //@Autowired 사용 지양됨 -> @RequiredArgsConstructor 로 생성되는 생성자로 주입받기 위해 final 붙임.
    private final PostsRepository postsRepository;

    @Transactional  //db 트랜잭션 자동으로 commit 해줌
    public Long save(PostsSaveRequestDto requestDto) {
        //dto 를 entity 화 해서 repository 의 save 메소드를 통해 db 에 저장.
        //저장 후 생성한 id 반환해줌
        return postsRepository.save(requestDto.toEntity()).getId();
    }

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

        //JPA 의 영속성 컨텍스트 덕분에 entity 객체의 값만 변경하면 자동으로 변경사항 반영함!
        //따라서 repository.update 를 쓰지 않아도 됨.
        posts.update(requestDto.getTitle(), requestDto.getContent());

        return id;
    }

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

        return new PostsResponseDto(entity);
    }
}

 

Controller 만들기

src/main/java/com.study.springbootaws/web/PostsApiController

package com.study.springbootaws.web;

import com.study.springbootaws.service.PostsService;
import com.study.springbootaws.web.dto.PostsResponseDto;
import com.study.springbootaws.web.dto.PostsSaveRequestDto;
import com.study.springbootaws.web.dto.PostsUpdateRequestDto;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;

@RequiredArgsConstructor
@RestController
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);
    }
}

 

등록/수정 api 테스트하기

src/test/java/com.study.springbootaws/web/PostsApiControllerTest

이전 컨트롤러 테스트와 달리, Jpa 를 사용하기 때문에 @SpringbootTest 와 TestRestTemplate 을 사용한다.

package com.study.springbootaws.web;

import com.study.springbootaws.domain.posts.Posts;
import com.study.springbootaws.domain.posts.PostsRepository;
import com.study.springbootaws.web.dto.PostsSaveRequestDto;
import com.study.springbootaws.web.dto.PostsUpdateRequestDto;
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 org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.boot.web.server.LocalServerPort;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.web.WebAppConfiguration;

import java.util.List;

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

//webmvctest 는 jpa가 동작하지 않음.
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class PostsApiControllerTest {
    @LocalServerPort
    private int port;

    //mockmvc 와 resttemplate 둘 다 컨트롤러 테스트 라이브러리임. testresttemplate 은 컨테이너를 직접 실행시키므로 클라이언트 입장에서 테스트할 때 사용함.
    //mockmvc 는 컨테이너 직접 실행 안하므로 비즈니스 로직에 문제 없는지를 확인함.
    @Autowired
    private TestRestTemplate restTemplate;

    @Autowired
    private PostsRepository postsRepository;

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

    @Test
    public void insertPosts() throws Exception {
        String title = "title";
        String content = "content";

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

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

        ResponseEntity<Long> responseEntity = restTemplate.postForEntity(url, requestDto, 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 updatePosts() throws Exception {
        Posts savedPosts = postsRepository.save(Posts.builder().title("title").content("content").author("author").build());

        Long updateId = 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/" + updateId;

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

 

save 테스트

 

update 테스트

 

조회 테스트

조회 테스트는 직접 톰캣 서버를 실행해서 확인할 것이다. H2 DB를 쓰기 때문에 웹 콘솔에서 직접 접근해야 한다.

src/main/resources/application.properties

웹 콘솔 옵션을 활성화한다.

...
spring.h2.console.enabled=true
spring.h2.console.path=/h2-console
spring.datasource.url=jdbc:h2:mem:testdb

 

Application 클래스의 main 메소드를 실행하고 http://localhost:8080/h2-console 에 접속한다. 아래처럼 수정해주고 connect 를 클릭한다. JDBC URL 은 이전 mysql 로 쿼리 변환 properties 변경 시 아래처럼 입력했던 url 을 따라 적으면 된다.

...
spring.datasource.hikari.jdbc-url=jdbc:h2:mem://localhost/~/testdb;MODE=MYSQL

 

connect 를 누르면 아래처럼 뜬다. posts 가 생성되어있는지 확인하고 insert into posts (author, content, title) values ('author', 'content', 'title'); 문을 run 시킨다.

 

localhost:8080/api/v1/posts/1 로 들어가 조회해서 나오면 성공!!

 

JPA Auditing 으로 생성/수정시간 자동으로 넣기

생성/수정 시간은 차후 유지보수에 굉장히 중요한 정보다. DB 여기저기에 들어가게 되는데, 모든 Entity 에 하나하나 넣어주는 작업을 JPA Auditing 으로 해결할 수 있다.

 

src/main/java/com.study.springbootaws/domain/BaseTimeEntity

package com.study.springbootaws.domain;

import lombok.Getter;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.LastModifiedDate;
import org.springframework.data.jpa.domain.support.AuditingEntityListener;

import javax.persistence.EntityListeners;
import javax.persistence.MappedSuperclass;
import java.time.LocalDateTime;

@Getter
@MappedSuperclass   //부모 클래스(BaseTimeEntity) 의 필드들도 전부 컬럼으로 인식하게 함.
@EntityListeners(AuditingEntityListener.class)
public abstract class BaseTimeEntity {
    @CreatedDate    //Entity 가 생성될 때 자동으로 생성/수정시간 삽입
    private LocalDateTime createdDate;

    @LastModifiedDate
    private LocalDateTime modifiedDate;
}

 

src/main/java/com.study.springbootaws/domain/posts/Post

post Entity 클래스에 BaseTimeEntity 클래스를 상속시켜준다.

...
public class Posts extends BaseTimeEntity { 
...

 

src/main/java/com.study.springbootaws/Application

Application 코드에 jpa auditing을 활성화하는 어노테이션을 붙여준다.

...
@EnableJpaAuditing  //jpa auditing 활성화
public class Application {
...

 

테스트하기

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

PostsRepositoryTest 에 BaseTimeEntityTest 코드를 추가해주고 실행하면 된다.

...

@SpringBootTest
public class PostRepositoryTest {
 
 	...

    @Test
    public void insertBaseTileEntity() {
        LocalDateTime now = LocalDateTime.now();
        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);
    }
}

 

성공!!