Application 코드와 테스트 코드 작성하기

Application 코드 작성하기

Application 클래스는 springboot 프로젝트의 메인 클래스가 된다. src/main/java 에 com.study.springbootaws 패키지를 생성한다. 패키지명은 보통 회사 도메인의 역순으로 만든다. 그 아래에 Application class 를 생성하고 아래처럼 내용을 작성한다.

 

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

package com.study.springbootaws;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

//프로젝트의 시작점. 스프링부트, Bean 읽기/생성 등 자동으로 설정해주는 어노테이션
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        //내장 WAS 실행
        SpringApplication.run(Application.class, args);
    }
}

 

@SpringbootApplicaiton 어노테이션 덕분에 스프링부트의 자동설정, Bean 읽기/생성을 모두 자동으로 설정된다. 또 이 어노테이션이 있는 위치부터 프로젝트를 읽어가므로, Application 클래스는 항상 최상단에 위치해야만 한다.

 

SpringApplication.run 메소드는 내장 WAS 를 실행한다. 이렇게 되면 서버에 톰캣을 설치할 필요 없이 스프링 부트로 만들어진 실행파일(Jar) 로 실행하면 된다. 내장 WAS 를 쓰지 않아도 되지만, 언제 어디서나 같은 환경에서 스프링 부트를 배포할 수 있기 때문에 사용이 권장된다.

 

 

테스트 코드 작성하기

테스트 코드가 무엇이고 왜 필요한지는 👉  TDD (Test Driven Development), 테스트 주도 개발이란? 을 참고해주세요.

 

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

먼저 테스트할 컨트롤러를 위 경로를 따라 만든다. 참고로 @RestController 는 컨트롤러를 JSON 을 반환하는 컨트롤러로 만들어준다. 예전엔 JSON을 반환하려면 @ResponseBody 를 각 메소드마다 선언해야 했다. @GetMapping 도 최신 문법이다. 대신 @GetMapping은 메소드 단위에서만 쓸 수 있고 이전의 @RequestMapping 은 클래스 단위까지 쓸 수 있다.

package com.study.springbootaws.web;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

//JSON 을 반환하는 컨트롤러로 만들어줌
@RestController
public class HelloController {
    @GetMapping("/hello")   // = @RequestMapping(method = RequestMethod.GET)
    public String hello() {
        return "hello";
    }
}

 

build.gradle

JUnit 은 Java 테스트 코드 작성을 도와주는 프레임워크다. 책에서는 JUnit4로 진행하지만 나는 JUnit5로 진행할 것이다. 만약 JUnit4를 이용하고 싶다면 build.gradle 에 아래 코드를 추가해주고 테스트코드를 책과 같이 쓰면 된다.

dependencies {
	...
    implementation 'junit:junit:4.13.1'
    ...
}

JUnit5 는 Springboot 2.2.x 버전에 내장되어 있어서 추가할 필요가 없다.

 

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

이제 위 경로에 컨트롤러를 테스트할 테스트코드를 작성하자. 참고로 @RunWith 은 JUnit4 의 문법으로, JUnit 테스트를 스프링 부트 테스트로 확장시켜주는 역할을 한다. JUnit5 로 넘어오며 @ExtendWith 라는 어노테이션으로 바뀌었으나 @SrpringbootTest, @WebMvcTest 같은 어노테이션에 이미 내장되어 있으므로 생략할 수 있다.

package com.study.springbootaws.web;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.web.servlet.MockMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

//Springboot의 모든 빈을 로드하지 않고 controller 관련 코드만 테스트할 때 사용. 단, Service, Component, Repository는 사용x
@WebMvcTest(HelloController.class)
public class HelloControllerTest {
    @Autowired  //Bean 자동 주입
    private MockMvc mvc;    //웹 API 테스트(GET, POST 등)시 사용. 스프링 MVC 테스트의 시작점

    @Test
    public void returnHello() throws Exception {
        String hello = "hello";

        mvc.perform(get("/hello"))      // /hello 주소로 get 요청
                .andExpect(status().isOk())         //결과 중 HTTP Header 의 status code 검증.
                .andExpect(content().string(hello));    //결과 중 본문 검증.
    }
}

 

테스트 실행

아래 이미지처럼 Run 'returnHello()' 를 클릭하면 터미널에 결과가 나타난다. 만약 Execution failed for task ':test' 에러가 난다면 👉  [🔧 트러블슈팅] IntelliJ JUnit 테스트 중 Execution failed for task ':test' 에러 게시물을 확인하자.

테스트가 통과됐다!

 

롬복으로 변환하고 테스트해보기

지금은 작은 규모지만, 큰 규모의 프로젝트에 롬복을 추가하면 어떤 코드에서 에러가 나는지 안 나는지 확인하기 쉽지 않을 것이다. 그러나 테스트 코드가 우리의 코드를 지켜주므로, 테스트 코드만 돌려보면 문제가 생기는지 알 수 있다. 롬복으로 변환한 후 테스트를 한번 해볼 것이다.

 

롬복 설정

롬복은 자바 개발에 자주 사용하는 getter, setter, construct, toStrign 등을 어노테이션으로 자동 생성해주는 편리한 라이브러리다. 이전에 plugins 에서 설치했던 것처럼 lombok 플러그인을 설치해준다. 나는 이미 설치되어 있어서 과정은 생략하겠다. 단, 롬복 플러그인은 한번만 설치하면 되지만 롬복 사용 설정은 프로젝트마다 해줘야 하므로 아래처럼 설정해준다.

build.gradle

dependencies {
	...
	//gradle 이 버전 4 라면
    implementation 'org.projectlombok:lombok'
    
    //gradle 이 버전 5 라면
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
	...
}

 

 

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

롬복이 사용된 Dto 를 위 경로에 추가해준다.

package com.study.springbootaws.web.dto;


import lombok.Getter;
import lombok.RequiredArgsConstructor;

@Getter     //모든 필드 getter 메소드 생성
@RequiredArgsConstructor    //final 이나 @NonNull 값인 모든 필드를 파라미터로 받는 생성자 생성
public class HelloResponseDto {
    private final String name;
    private final int amount;
}

 

src/test/java/com.study.springbootaws/web/dto/HelloResponseDtoTest

위 경로에 테스트 코드를 추가해주고 실행한다. 만약 not initialized in the default constructor 에러가 난다면 gradle 버전에 맞게 lokmok을 추가했는지 확인하자. assertThat 은 메소드 인자로 받은 value 를 검증해준다. 참고로 Junit 의 기본 assertThat 이 아닌 assertj 를 사용했다. 이유는 assertj 는 Assert 클래스를 반환하므로 메소드 자동완성이 되고 체이닝 메소드 패턴을 사용할 수 있기 때문이다.

package com.study.springbootaws.web.dto;

import org.junit.jupiter.api.Test;

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

public class HelloResponseDtoTest {
    @Test
    public void lombokTest() {
        String name = "test";
        int amount = 1000;

        HelloResponseDto dto = new HelloResponseDto(name, amount);

        //asseartThat 은 메소드 인자로 받은 value 비교 및 검증해줌.
        //isEqualTo 말고도 greaterThan, lessThan 등의 체이닝도 가능.
        assertThat(dto.getName()).isEqualTo(name);
        assertThat(dto.getAmount()).isEqualTo(amount);
    }
}

 

마찬가지로 테스트하면 잘 동작한다.

 

HelloController 에 HelloResponseDto 를 사용하고 테스트해보기

HelloResponseDto 가 문제 없이 동작함을 확인했으니 HelloController 에 적용해보자. 

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

HelloControlelr 클래스에 HelloReponseDto 를 사용하는 새로운 경로를 아래처럼 추가하자.

import org.springframework.web.bind.annotation.RequestParam;

...

@GetMapping("/hello/dto")
public HelloResponseDto helloDto(@RequestParam("name") String name, @RequestParam("amount") int amount) {
	return new HelloResponseDto(name, amount);
}

...

 

 

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

HelloControllerTest 에 추가한 helloDto 를 테스트하는 코드를 작성한다. jsonPath 는 응답값을 json 필드로 검증할 수 있는 메소드다.

import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;

...

@Test
public void returnHelloDto() 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").value(name))      //$ => 루트, .name => ['name'] 하위요소
           .andExpect(jsonPath("$.amount").value(amount));
}

...

 

테스트를 돌리면 무사히 통과한다!