HTTP 응답(정적 리소스, 뷰 템플릿, HTTP 메시지) 처리

  스프링(서버)에서 응답 데이터를 만드는 방법은 크게 3가지가 있다.

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

하나씩 자세히 알아보자.

 

1. 정적 리소스 🥪

  정적 리소스란 해당 파일을 변경 없이 그대로 서비스하는 것을 말한다. 스프링 부트는 클래스패스에 아래의 디렉토리에 있는 정적 리소스를 제공한다.

/static
/public
/resources
/META-INF/resources

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

  예를 들어 src/main/resources/static/basic/hello-form.html이 있다고 하면 웹 브라우저에서 http://localhost:8080/basic/hello-form.html로 접근할 수 있다.

 

2. 뷰 템플릿 🌮

  뷰 템플릿을 거쳐서 HTML이 생성되고, 뷰가 응답을 만들어서 전달한다. 일반적으로 HTML을 동적으로 생성하는 용도로 사용된다.

  스프링 부트의 기본 뷰 템플릿 경로는 src/main/resources/templates이다. 그래서  src/main/resources/templates/response/hello.html이 있다고 한다면 아래와 같이 응답을 할 수 있다.

V1. ModelAndView

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

    return mav;
}

V2. Model

@RequestMapping("/response-view-v2")
public String responseViewV2(Model model) {
    model.addAttribute("name", "amenable");

    return "response/hello";
}

  V1(ModelAndView)과 V2(Model) 방식의 경우 response/hello를 이용하여 뷰 리졸버가 실행되어서 뷰를 찾고 렌더링 한다. (만약 @ResponseBody가 있다면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello라는 문자가 입력되게 된다.)

V3. Model + Void반환

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

  void를 반환하게 되면 요청 URL을 참고해서 논리 뷰 이름으로 사용한다. 여기서는 요청 URL이 /response/hello이므로 이를 참고하여 templates/response/hello.html이 실행된다.

  이 방식은 명시성이 너무 떨어지므로 권장하지는 않는다.

 

3. HTTP 메시지 - 단순 텍스트 🥙

V1. HttpServletResponse

@GetMapping("/response-body-string-v1")
public void responseBodyV1(HttpServletResponse response) throws IOException {
    response.getWriter().write("ok");
}

V2. ResponseEntity

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

V3. @ResponseBody

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

  @ResponseBody 또는 HttpEntity를 사용하면 뷰 템플릿을 실행하지 않고 HTTP 메시지 바디에 직접 응답 데이터를 출력할 수 있다. (V2, V3 코드 참고)(ResponseEntity는 HttpEntity를 상속받은 것이다.)

 

4. HTTP 메시지 - JSON 🌯

V1. ResponseEntity

@GetMapping("/response-body-json-v1")
public ResponseEntity<Person> responseBodyJsonV1() {
    Person person = new Person();
    person.setName("amenable");
    person.setAge(20);

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

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

V2. @ResponseBody

@ResponseStatus(HttpStatus.OK)
@ResponseBody
@GetMapping("/response-body-json-v2")
public Person responseBodyJsonV2(){
    Person person = new Person();
    person.setName("amenable");
    person.setAge(20);

    return person;
}

  @ResponseBody를 사용한 것인데, 이렇게 사용하면 응답 코드와 같은 것들을 설정하기 어렵다는 문제가 있다. 그래서 프로그램 조건에 따라서 동적으로 응답 코드 등을 변경하려면 V1과 같이 ResponseEntity를 사용해야 한다.

+α. @RestController

@RestController
public class ResponseViewController {
    
    @GetMapping("/response-body")
    public String responseBodyByRestController() {
        return "ok";
    }
}

  @Controller 대신에 @RestController를 사용하면 해당 컨트롤러에 모두 @ResponseBody가 적용된다. (@RestController 안에 @ResponseBody가 있기 때문이다.) 이렇게 하면 뷰 템플릿을 사용하는 게 아니라 HTTP 메시지 바디에 직접 데이터를 입력하게 된다.

 

해당 글은 김영한 님의 '스프링 MVC 1편 - 백엔드 웹 핵심 기술'을 참고하였습니다.