[Spring] 스프링MVC HTTP 응답

이번 글에서는 얼마 전에 포스팅한 HttpServlerResponse 객체의 응답 데이터 보내는 방법 이후에 스프링(Spring)에서 제공하는 응답 관련 편리한 기능들을 소개하도록 하겠다.

 

이미 공부해서 알고있으신분들은 상관없겠다만, 서블릿과 HtterServletResponse 혹은 HttpServletRequest에 대한 사전 지식이 부족하신 분들은 아래 링크를 참고하시는 것을 추천드립니다.

 

서블릿이란?

 

HttpServletRequest?

 

HttpServletResponse?

 

---

 

HTTP 응답 - 정적 리소스, 뷰 템플릿

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

• 정적 리소스
  • 예) 웹 브라우저에 정적인 HTML, css, js를 제공할 때는 정적 리소스를 사용합니다.
• 뷰 템플릿 사용
  • 예) 웹 브라우저에 동적인 HTML을 제공할 때는 뷰 템플릿을 사용합니다.
• HTTP 메시지 사용
  • HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보냅니다

 

정적 리소스

스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공합니다.

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

 

src/main/resources는 리소스를 보관하는 곳이고, 또 클래스패스의 시작 경로입니다.

따라서 다음 디렉토리에 리소스를 넣어두면 스프링 부트가 정적 리소스로 서비스를 제공합니다.

 

스프링 부트에는 내장 웹 서버(Tomcat)가 있어서 정적 리소스를 그대로 서비스해 줍니다.

 

 

정적 리소스 경로는 src/main/resources/static 인데

만약 다음 경로 src/main/resources/static/basic/hello-form.html 에 파일이 있다고 하였을때

웹브라우저에서 다음과 같이 실행하면 해당 html 파일이 렌더링 되어 나타납니다.

• http://localhost:8080/basic/hello-form.html

 

정적 리소스는 해당 파일을 변경 없이 그대로 서비스하는 것을 말합니다.

 

 

정리하면, 해당 정적 리소스 경로는 스프링 부트에서 기본적으로 제공하고 그 이하 경로에 존재하는 파일에 접근하고 싶다면 기본 경로를 제외한 추가 경로(위 예시 기준 basic/hello-form.html)만 작성하여 주시면 됩니다.

 

 

뷰 템플릿

뷰 템플릿을 거쳐서 HTML이 생성되고, 뷰가 응답을 만들어서 전달합니다.

일반적으로 HTML을 동적으로 생성하는 용도로 사용하지만, 다른 것들도 가능합니다.

뷰 템플릿이 만들 수 있는 것이라면 뭐든지 가능하다.

 

스프링 부트는 기본 뷰 템플릿 경로를 제공합니다.

• src/main/resources/templates

 

다음 두 개의 예제 코드는 src/main/resources/templates/response/hello.html 경로의 존재하는 

파일(뷰 템플릿)을 호출하는 컨트롤러이다. (해당 경로에 HTML 파일이 있다고 가정)

 

 

 

String을 반환하는 경우 - View or HTTP 메시지

//String을 반환하는 경우 - View or HTTP 메시지
@RequestMapping("/response-view-v2")
public String responseViewV2(Model model) {
    model.addAttribute("data", "hello!");
    return "response/hello";
}

 

@ResponseBody가 없으면 response/hello로 뷰 리졸버가 실행되어서 뷰를 찾고 렌더링 합니다.

@ResponseBody가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello 라는 문자가 입력됩니다.

 

여기서는 뷰의 논리 이름인 response/hello 를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는 것을 확인할 수 있습니다.

 

 

 

void를 반환하는 경우

//권장하지 않는 방법이라고 한다. (명시성이 너무 떨어지고, 이렇게 딱 맞는 경우도 많이 없다고 합니다.)
@RequestMapping("/response/hello")
public void responseViewV3(Model model) {
    model.addAttribute("data", "hello!");
}

 

@Controller를 사용하고, HttpServletResponse, OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용한다.

 

예를 들어 우리가 요청 URL에 매핑하여 컨트롤러를 실행할 때, 요청 URL에 해당하는 논리 뷰 이름을 사용하여 템플릿을 렌더링 한다.

 

즉, '/response/hello' URL 요청이 들어오면 src/main/resources/templates/response/hello.html 파일이 렌더링 된다. ( .html 은 제외 )

 

참고로 이 방식은(void 반환) 명시성이 너무 떨어지고 이렇게 딱 맞는 경우도 적기 때문에 권장하지 않는다.

 

 

HTTP 메시지

@ResponseBody, HttpEntity 를 사용하면, 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 응답 데이터를 출력할 수 있습니다.

 

---

 

HTTP 응답 - HTTP API, 메시지 바디에 직접 입력

HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보냅니다.

 

 

 

참고!

위에서 배웠듯이 HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달됩니다.

여기서 설명하는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 전달하는 경우를 말합니다.

 

 

서블릿 방식

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

 

서블릿을 직접 다룰 때처럼 HttppServletResponse 객체를 통해서 HTTP 메시지 바디에 직접 "ok" 응답 메시지를 전달합니다.

 

 

@ResponseBody

@ResponseBody를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있습니다.

ResponseEntity도 동일한 방식으로 동작합니다.

// ResponseEntity 사용 -> 메세지와 상태코드 반환
@GetMapping("/response-body-string-v2")
public ResponseEntity<String> responseBodyV2() {
    return new ResponseEntity<>("ok", HttpStatus.OK);
}

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

 

 

 

ResponseEntity(JSON)

ResponseEntity를 반환합니다.

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

@GetMapping("/response-body-json-v1")
public ResponseEntity<HelloData> responseBodyJsonV1() {
    HelloData helloData = new HelloData();
    helloData.setUsername("userA");
    helloData.setAge(20);;
    return new ResponseEntity<>(helloData, HttpStatus.OK);
}

 

 

 

@ResponseBody + @ResponseStatus

위의 방식 중 ResponseEntity는 HTTP 응답 코드를 설정할 수 있는 반면에, @ResponseBody를 사용하면 이런 것을 설정하기 까다롭습니다.

 

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

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

물론 어노테이션으로 설정한 것이기 때문에 응답 코드를 동적으로 변경할 수 없습니다.

프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity를 사용하면 되겠습니다.

 

 

@RestController

@Controller 대신에 @RestController 어노테이션을 사용하면, 해당 컨트롤에 모두 @ResponseBody가 적용되는 효과가 있습니다. 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력합니다.

이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러입니다.

 

실제로 이런 것이 가능한 이유는

@RestController 어노테이션에 @Controller + @ResponseBody 어노테이션이 같이 설정되어 있기 때문입니다.

 

아래 예제 코드처럼 클래스 레벨에 두면 해당 컨트롤러 전체 메서드에 적용됩니다.

@RestController  //@ResponseBody + @Controller
public class ResControllerTestClass {
    
    // 해당 메서드에 @ResponseBody 적용
    @RequestMapping("/test1")
    public void test1() {
        return "ok";
    }
    
    // 해당 메서드에 @ResponseBody 적용    
    @RequestMapping("/test2")
    public void test2() {
        return "ok";
    }
}

 

---

 

참고(출처)

https://rebugs.tistory.com/606

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1/dashboard

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 | 김영한 - 인프런