[JPA] 등록, 수정, 조회 API

API 만들기 위한 클래스

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

 

Spring 웹 계층

Web Layer	DTOs
Service Layer
	Domain Model
Repository Layer

• Web Layer
  • 컨트롤러(@Controller), JSP/Freemarker 등의 뷰 템플릿 영역
  • 필터(@Filter), 인터셉터, 컨트롤러 어드바이스(@ControllerAdvice) 등 외부 요청과 응답에 대한 전반적인 영역
• Service Layer
  • @Service에 사용되는 서비스 영역
  • Controller와 Dao 중간 영역에서 사용됨
  • @Transactional이 사용되어야 하는 영역
• Repository Layer
  • 데이터 저장소에 접근하는 영역
  • Dao 영역 (Data Access Object)
• Dtos
  • Dto(Data Transfer Object): 계층 간 데이터 교환을 위한 객체
  • Dtos: Dto들의 영역
  • 뷰 템플릿 엔진에서 사용될 객체, Repository Layer에서 결과로 넘겨준 객체 등
• Domain Model
  • 도메인이라고 불리는 개발 대상을 모든 사람이 이해, 공유 가능하게 단순화 시킨 것
  • @Entity가 사용된 영역
  • 데이터베이스의 테이블과만 관련있어야 하는건 아님
  • 값 객체(VO)들도 이 영역에 해당됨
  • ex) 택시 앱에서 배차, 탑승, 요금 등
  • 비지니스 처리를 담당함

 

PostApiController

package com.springAWS.web;

import com.springAWS.service.posts.PostsService;
import com.springAWS.web.dto.PostsResponseDto;
import com.springAWS.web.dto.PostsSaveRequestDto;
import com.springAWS.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);
    }
}

등록, 수정, 조회 기능

 

Posts

package com.springAWS.domain.posts;

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

import javax.persistence.*;

@Getter
@NoArgsConstructor
@Entity
public class Posts { //실제 DB 테이블과 매칭될 클래스, 보통 Entity 클래스라고 함

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY) //PK의 생성 규칙, GenerationType.IDENTITY 를 해야 auto_increment 됨
    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.content = content;
        this.author = author;
    }

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

 

PostsService

package com.springAWS.service.posts;

import com.springAWS.domain.posts.Posts;
import com.springAWS.domain.posts.PostsRepository;
import com.springAWS.web.dto.PostsResponseDto;
import com.springAWS.web.dto.PostsSaveRequestDto;
import com.springAWS.web.dto.PostsUpdateRequestDto;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@RequiredArgsConstructor //final이 선언된 모든 필드를 인자값으로 하는 생성자 생성해줌
@Service
public class PostsService {

    private final PostsRepository postsRepository;

    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 entity = postsRepository.findById(id)
                .orElseThrow(() -> new IllegalArgumentException("해당 게시글이 없습니다. id=" + id));

        return new PostsResponseDto(entity);
    }
}

 

스프링 Bean 주입 방법

• @Autowired (권장하지 않음)
• setter
• 생성자

앞의 코드에서는 롬복의 @RequiredArgsConstructor가 final이 선언된 모든 필드를 인자값으로 하는 생성자를 생성해줌

 

DTO 클래스

PostsSaveRequestDto

package com.springAWS.web.dto;

import com.springAWS.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;
    }

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

 

PostsResponseDto

package com.springAWS.web.dto;

import com.springAWS.domain.posts.Posts;

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

package com.springAWS.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;
    }
}

 

JPA 영속성 컨텍스트

• update 기능에서 쿼리 날리는 부분 없음
• 엔티티 영구 저장하는 환경
• 더티 체킹 (Dirty Checking) - 상태 변경 검사
  • 영속성 컨텍스트 유지된 상태에서 해당 데이터 값 변경하면 트랜젝션 끝나는 시점에 해당 테이블에 반영함
  • Entitiy 객체의 값만 변경하면 Update 쿼리 날릴 필요가 없음

 

Entity 클래스를 Request/Response 클래스로 사용하면 절대 안됨!

 

Entity 클래스

• DB와 맞닿는 핵심 클래스
• 이 클래스를 기준으로 테이블 생성되고 스키마 변경됨
• 화면 변경은 아주 사소하고 자주 변경돼서 분리해야 함

Request, Response Dto는 View를 위한 클래스 -> 자주 변경됨

View Layer와 DB Layer 분리해야함

Controller에서 결괏값으로 여러 테이블 조인해야 하는 경우 많아서 Entity, Controller에서 쓰는 Dto는 분리 사용해야함

 

PostsApiControllerTest

package com.springAWS.web;

import com.springAWS.domain.posts.Posts;
import com.springAWS.domain.posts.PostsRepository;
import com.springAWS.web.dto.PostsSaveRequestDto;
import com.springAWS.web.dto.PostsUpdateRequestDto;
import junit.framework.TestCase;
import org.assertj.core.api.Assertions;
import org.junit.After;
import org.junit.Test;
import org.junit.runner.RunWith;
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.junit4.SpringRunner;

import java.util.List;
import java.util.logging.Logger;

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

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

    private final static Logger LOG = Logger.getGlobal();
    @LocalServerPort
    private int port;
    @Autowired
    private TestRestTemplate restTemplate;
    @Autowired
    private PostsRepository postsRepository;
    
    @After
    public void tearDown() throws Exception {
        postsRepository.deleteAll();
    }

    @Test
    public void PostsRegister() throws Exception {

        //given
        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";

        //when
        ResponseEntity<Long> responseEntity = restTemplate.postForEntity(url, requestDto, Long.class);

        //then
        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 PostsUpdate() throws Exception {

        //given
        Posts savePosts = postsRepository.save(Posts.builder()
                                            .title("title")
                                            .content("content")
                                            .author("author")
                                            .build());

        Long updateId = savePosts.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);

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

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

• @WebMvcTest를 사용하면 JPA 기능이 작동하지 않음
  (Controller, ControllerAdvice 등 외부 연동과 관련된 부분만 활성화됨)
• JPA까지 한번에 테스트할 때는 @SpringBootTest, TestRestTemplate 사용하기

 

H2 웹 콘솔 사용하는 방법

application.properties에 spring.h2.console.enabled=true 추가

http://localhost:8080/h2-console 접속 후 JDBC URL을 jdbc:h2:mem:testdb로 작성 후 connect