김영한님의 인프런 강의와 PDF를 바탕으로 정리하였습니다.
https://www.inflearn.com/courses?s=%EA%B9%80%EC%98%81%ED%95%9C
응답 메시지도 요청메시지오 같이 주로 3가지의 데이터를 응답합니다.
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/hello.html
ResponseViewController - 뷰 템플릿을 호출하는 컨트롤러
1. ModelAndView에 뷰 정보와 model을 직접 담는 방법
2. 뷰의 논리이름을 String으로 반환하고, model에 값을 넣는 방법.
3. 권장하진 않지만 반환을 하지 않고, 뷰의 경로와 url매핑을 맞추는 방법
String을 반환하는 경우 - View or HTTP 메시지
@ResponseBody 가 없으면 response/hello 로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 합니다.
@ResponseBody 가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello 라는 문자가 입력됩니다.
여기서는 뷰의 논리 이름인 response/hello 를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는 것을 확인할 수 있습니다.
실행: templates/response/hello.html
Void를 반환하는 경우
@Controller 를 사용하고, HttpServletResponse , OutputStream(Writer) 같은 HTTP 메시지
바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용
요청 URL: /response/hello
실행: templates/response/hello.html
참고로 이 방식은 명시성이 너무 떨어지고 이렇게 딱 맞는 경우도 많이 없어서, 권장하지 않는 방법입니다.
!중요!
HTTP 메시지
@ResponseBody, HttpEntity를 사용하면, 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 응답 데이터를 출력합니다.
참고
다음과 같이 타임리프 의존성을 추가하면
`implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
스프링 부트가 자동으로 ThymeleafViewResolver와 필요한 스프링 빈들을 등록합니다. 그리고 다음 설정도 사용합니다. 이 설정은 기본값이기 때문에 변경이 필요할 때만 설정하면 됩니다.
application.prooerties :
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html
HTTP 응답 - HTTP API, 메시지 바디에 직접 입력
HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보냅니다.
참고
HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달됩니다. 여기서
설명하는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 전달하는 경우를 말합니다.
ResponseBodyController
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 가 적용되어 있습니다.
'Spring > spring mvc' 카테고리의 다른 글
HTTP 메시지 컨버터, 요청 매핑 핸들러 어댑터 구조 (0) | 2021.06.29 |
---|---|
(추가 정리) 스프링 요청 응답 정리 (0) | 2021.06.28 |
HTTP 요청 메시지 -단순 텍스트, JSON (0) | 2021.06.28 |
HTTP 요청 파라미터 - 쿼리 파라미터, HTML FORM + @RequestParam, @ModelAttribute (0) | 2021.06.28 |
HTTP 요청 헤더 정보 조회 (0) | 2021.06.28 |