[스프링 with AWS] CRU 기능 - RestTemplate으로 API 테스트

🏃 CH.03 🏃

3장부터는 하나의 게시판 페이지를 만들어보고,

7장에서 10장까지는 이 서비스를 AWS 무중단 배포하는 것까지 진행한다.

---

📌 Role #1

기본적으로 Builder 패턴을 사용한다.

 

📌 Role #2

Setter를 사용하지 않고, 

기본적으로 생성자를 통해 값을 채우고,

값 변경이 필요한 경우엔 명확하게 그 목적과 의도를 나타낼 수 있는 메소드를 추가한다.

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Entity
public class Posts {

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

 

📌 생성자 대신 빌더 클래스를 사용하는 이유는,

어느 필드에 어떤 값을 채워야할지 명확하게 인지할 수 있기 때문이다.

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

 

JpaRepository도 생성해주었는데,

이때 Entity 클래스는 기본 Repository와 함께 위치해야한다는 점이 새로웠다.

이때까진 repository만 한 곳에 모아뒀었는데, 나중에 프로젝트가 커져서 도메인별로 프로젝트를 분리하는 상황이 온다면 함께 움직여야하므로 같이 도메인 패키지에서 관리한다고한다.

 

📌 JPA 기본 테스트 코드

@RunWith(SpringRunner.class)
@SpringBootTest
public class PostsRepositoryTest {

    @Autowired
    PostsRepository postsRepository;

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

    @Test
    public void 게시글저장_불러오기() throws Exception{
        //given
        String title="게시글 제목";
        String content="게시글 본문";

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

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

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

    }

}

H2 쿼리 대신 SQL 쿼리 로그로 남기기 위해 아래 추가

spring.jpa.properties.hibernate.format_sql=true

---

🏃 등록,수정,조회 API 만들기 🏃

- Request 데이터 받을 DTO

- API 요청을 받을 Controller

- 트랜잭션,도메인 기능 간의 순서를 보장하는 Service

 

 

Service는 비즈니스로직을 처리하는 곳이 아니다.
트랜잭션, 도메인 간 순서를 보장하는 역할만 한다.

 

비즈니스 로직을 처리해야하는 곳은 바로 Domain이다.

 

 

* 도메인 모델 패턴 *

엔티티가 비즈니스 로직을 가지고, 객체지향의 특성을 적극 활용하는 패턴
↔ 트랜잭션 스크립트 (Service에서 대부분의 비즈니스 로직을 처리하는 것

---

📌 등록 Controller

@RequiredArgsConstructor
@RestController
public class PostApiController {
    private final PostsService postsService;

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

}

📌 등록 Service

@RequiredArgsConstructor
@Service
public class PostsService {

    private final PostsRepository postsRepository;

    @Transactional
    public Long save(PostSaveRequestDto requestDto) {
        return postsRepository.save(requestDto.toEntity()).getId();
    }
}

📌 등록 RequestDto

@Getter
@NoArgsConstructor
public class PostSaveRequestDto {

    private String title;
    private String content;
    private String author;

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

    //DTO -> Posts Entity로
    public Posts toEntity()
    {
        return Posts.builder()
                .title(title)
                .content(content)
                .author(author)
                .build();
    }
}

📌 등록 테스트

 

JPA 기능까지 한번에 테스트할 때에는 @SpringBootTest 와 @TestRestTemplate를 사용하면 된다고한다.

Random port를 생성하여 내장 톰캣을 사용하여 테스트를 진행

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class PostApiControllerTest {

    @LocalServerPort
    private int port;

    @Autowired
    private TestRestTemplate testRestTemplate;

    @Autowired
    private PostsRepository postsRepository;

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

    @Test
    public void Posts_등록된다() throws Exception{
        //given
        String title ="title";
        String content ="content";
        PostSaveRequestDto postSaveRequestDto= PostSaveRequestDto.builder()
                .title(title)
                .content(content)
                .author("author")
                .build();

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

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

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

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

🔗 @SpringBootTest(webEnvironment=SpringBootTest.webEnvironment.RANDOM_PORT)

 

🔗 @LocalServerPort

 

🔗 @TestRestTemplate

 

🔗 restTemplate.postForEntity( 요청 보낼 url, 보낼 객체, 받아올 타입의 class)

 

🔗 responseEntity.getBody()

 

---

수정과 조회에 대한 부분은

update 부분 테스트 코드 작성한 부분에서 보고 넘어가야 할 부분이 있어서 그 부분만 정리해두려고한다.

 

📌수정 테스트 코드

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

        Long updateId=posts.getId();
        PostsUpdateRequestDto requestDto =PostsUpdateRequestDto.builder()
                .title("fixed_title")
                .content("fixed_content")
                .build();


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

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

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


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

        List<Posts> postsList = postsRepository.findAll();
        assertThat(postsList.get(0).getTitle()).isEqualTo(requestDto.getTitle());
        assertThat(postsList.get(0).getContent()).isEqualTo(requestDto.getContent());
       
    }

🔗 new HttpEntity<>( )

 

🔗 restTemplate.exchange(url, HttpMethod.PUT, HttpEntity로 감싸진 객체, 반환타입)