[MVC] http 응답

스프링에서 응답 데이터를 만드는 방법은 대표적으로 3가지가 존재.

1. 정적 리소스
   • 웹 브라우저에 정적인 HTML, CSS, JS 제공할때는 정적 리소스를 사용.
2. 뷰 템플릿 사용
   • 웹 브라우저에 동적인 HTML을 제공할때는 뷰 템플릿을 사용한다.
3. HTTP 메시지 사용
   • HTTP API를 제공하는 경우 데이터를 전달해야하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어보낸다.

정적 리소스

스프링 부트는 다음과 같은 디렉토리에 있는 정적 리소스를 제공.
/static , /public , /resources , /META-INF/resources

src/main/resources 는 리소스를 보관하는 곳이고, 또 클래스패스의 시작 경로이다.
따라서 다음 디렉토리에 리소스를 넣어두면 스프링 부트가 정적 리소스로 서비스를 제공한다.

해당 파일의 변경 없이 그대로 서비스한다.

뷰 템플릿

뷰 템플릿을 거쳐 HTML을 생성하고, 뷰를 통해 응답을 만들어 전송한다.
일반적으로 HTML을 동적으로 생성하는 용도로 사용하나, 뷰 템플릿이 만들 수 있는것이라면 무엇이든 가능하다.

뷰 템플릿의 기본 경로는 다음과 같다. src/main/resources/templates

@Controller
public class ResponseViewController {

    @RequestMapping("/response-view-v1")
    public ModelAndView responseViewV1() {
        ModelAndView mav = new ModelAndView("response/hello")
                .addObject("data", "hello!");

        return mav;
    }

    @RequestMapping("/response-view-v2")
    public String responseViewV2(Model model) {
        model.addAttribute("data", "hello!");
        return "response/hello";
    }

    @RequestMapping("/response/hello")
    public void responseViewV3(Model model) {
        model.addAttribute("data", "hello!");
    }
}

• ModelAndView를 반환하는 첫번째 버전.
• String를 반환하는 두번째 버전.
  • @ResponseBody가 없다면 reponse/hello라는 뷰의 논리 이름으로 뷰 리졸버가 실행되어 뷰를 찾고 렌더링한다.(해당 경로의 뷰 템플릿 실행)
  • @ResponseBody가 존재하면 HTTP 메시지 바디에 문자열 입력.
• void를 반환하여 요청 url을 참고하여 논리 뷰 이름으로 사용하는 세번째 버전도 있으나 코드를 보면 알수있듯이 명시성이 떨어지고 이렇게 딱 맞아 떨어지는 경우도 적어 권장하지 않는 방법이다.

HTTP 메시지

@Slf4j
@Controller
public class ResponseBodyController {
    @GetMapping("/response-body-string-v1")
    public void responseBodyStringV1(HttpServletResponse response) throws IOException {
        response.getWriter().write("ok");
    }

    @GetMapping("/response-body-string-v2")
    public ResponseEntity<String> responseBodyStringV2() throws IOException {
        return new ResponseEntity<>("ok", HttpStatus.OK);
    }

    @ResponseBody
    @GetMapping("/response-body-string-v3")
    public String responseBodyStringV3() throws IOException {
        return "ok";
    }

    @GetMapping("/response-body-json-v1")
    public ResponseEntity<HelloData> responseBodyJsonV1() {
        HelloData helloData = new HelloData();
        helloData.setUsername("hello");
        helloData.setAge(20);

        return new ResponseEntity<>(helloData, HttpStatus.OK);
    }

    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    @GetMapping("/response-body-json-v2")
    public HelloData responseBodyJsonV2() {
        HelloData helloData = new HelloData();
        helloData.setUsername("hello");
        helloData.setAge(20);

        return helloData;
    }
}

앞서 공부한 내용이기 때문에 간단한 코드를 통해 요약만 할 것이다.

responseBodyV1

서블릿을 직접 다룰 때 처럼 HttpServletResponse 객체를 통해서 HTTP 메시지 바디에 직접 ok 응답 메시지를 전달한다.
response.getWriter().write("ok")

responseBodyV2

ResponseEntity 엔티티는 HttpEntity 를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다. ResponseEntity 는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다.

HttpStatus.CREATED 로 변경하면 201 응답이 나가는 것을 확인할 수 있다.

responseBodyV3

@ResponseBody 를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할수 있다. ResponseEntity 도 동일한 방식으로 동작한다.

responseBodyJsonV1

ResponseEntity 를 반환한다. HTTP 메시지 컨버터를 통해서 JSON 형식으로 변환되어서 반환된다.

responseBodyJsonV2

ResponseEntity 는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody 를 사용하면 이런 것을 설정하기 까다롭다.

@ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다.

물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다. 프로그램 조건에 따라서 동적으로 변경하려면ResponseEntity 를 사용하면 된다.

@RestController

@Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody 가적용되는 효과가 있다.

따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다. 이름그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러이다.

참고로 @ResponseBody 는 클래스 레벨에 두면 전체 메서드에 적용되는데, @RestController 에노테이션 안에@ResponseBody 가 적용되어 있다.