[SPRING] 기존 Controller 코드를 롬복으로 전환

🧨롬복

롬복: 자바 개발 시 자주 사용하는 코드 Getter, Setter, 기본 생성자, toString 등을 어노테이션으로 자동 생성해주는 자바 개발자들의 필수 라이브러리

build.gradle에 미리 넣어둔 compile('org.projectlombok:lombok')로 수행됨.

 

 

🧨hello controller 코드를 롬복으로 전환

기존 코드를 롬복으로 리팩토링하는 과정!

1. Dto 생성
🔽main/패키지/web/dto/HelloResponseDto

import lombok.Getter;
import lombok.RequiredArgsConstructor;

@Getter
@RequiredArgsConstructor
public class HelloResponseDto {
    private final String name;
    private final int amount;
}

@Getter : 선언된 모든 필드의 get 메소드 생성

 

@RequiredArgsConstructor

선언된 모든 final 필드가 포함된 생성자를 생성

final이 없는 필드는 생성자에 미포함

 

 

2. Dto 테스트 코드
🔽test/패키지/dto/HelloResponseDtoTest

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

public class HelloResponseDtoTest {
    @Test
    public void 롬복_기능_테스트() {
        //given
        String name = "test";
        int amount = 1000;

        //when
        HelloResponseDto dto = new HelloResponseDto(name, amount);

        //then
        assertThat(dto.getName()).isEqualTo(name);
        assertThat(dto.getAmount()).isEqualTo(amount);
    }
}

assertThat

assertj라는 테스트 검증 라이브러리의 검증 메소드

검증 원하는 대상을 메소드 인자로 받음

 

isEqualTo

assertj의 동등 비교 메소드

assertThat에 있는 값과 isEqualTo의 값이 같을 때만 성공

 

 

실행하면 정상적으로 기능 수행 (롬복의 @Getter로 get 메소드, @RequiredArgsConstructor로 생성자가 자동으로 생성) 확인 가능

 

 

3. HelloController에도 새로 만든 ResponseDto 사용
🔽main/패키지/web/HelloController

import com.jojoldu.book.springboot.web.dto.HelloResponseDto;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello() {
        return "hello";
    }
//여기까지 기존 코드----------------------------------다음부터 추가

    @GetMapping("/hello/dto")
        //외부에서 name (@RequestParam("name"))이란 이름으로 넘긴 파라미터를 메소드 파라미터 name(String name)에 저장
    public HelloResponseDto helloDto(@RequestParam("name") String name,
                                     @RequestParam("amount") int amount) {
        return new HelloResponseDto(name, amount);
    }
}

@RequestParam

외부에서 API로 넘긴 파라미터를 가져오는 어노테이션

추가된 API 테스트하는 코드 추가

🔽test/패키지/dto/HelloResponseDtoTest

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;

import static org.hamcrest.Matchers.is;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

@RunWith(SpringRunner.class)
@WebMvcTest
public class HelloControllerTest {
    @Autowired
    private MockMvc mvc;

    @Test
    public void hello가_리턴된다() throws Exception {
        String hello = "hello";
        mvc.perform(get("/hello"))
                .andExpect(status().isOk())
                .andExpect(content().string(hello));
    }
//여기까지 기존 코드----------------------------------다음부터 추가

    @Test
    public void helloDto가_리턴된다() throws Exception {
        String name = "hello";
        int amount = 1000;
        mvc.perform(
                get("/hello/dto")
                        .param("name", name)
                        .param("amount", String.valueOf(amount)))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.name", is(name)))
                .andExpect(jsonPath("$.amount", is(amount)));
    }
}

param

API 테스트 시 사용될 요청 파라미터 설정 (값은 String만 허용)

 

jsonPath

json 응답값을 필드별로 검증 가능한 메소드.

$ 기준으로 필드명 명시

 

 

JSON이 리턴되는 API도 정상적으로 테스트 통과하는 거 확인 가능