목차
응답 데이터 반환의 종류
스프링(서버)에서 HTTP 응답 데이터를 만드는 방법은 다음과 같이 크게 3가지입니다.
- 정적 리소스 : 정적 HTML, CSS, JS
- 뷰 템플릿 사용 : 동적인 HTML
- HTTP Message Body에 직접 입력 (단순 텍스트 / JSON)
전체 구조
HTTP 응답 - 정적 리소스, 뷰 템플릿
정적 리소스
- 스프링 부트의 src/main/resources 는 리소스를 보관하는 곳이고, 클래스패스의 시작 경로입니다.
- 스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공합니다.
- /static, /public, /resources, /META-INF/resources
- 따라서, 해당 디렉토리에 리소스를 넣어두면, 스프링 부트가 정적 리소스로 서비스를 제공합니다.
예제)
- 정적 리소스 경로 : src/main/resources/static
- 파일 경로 : src/main/resources/static/basic/hello-form.html
- 실행 : http://localhost:8080/basic/hello-form.html
뷰 템플릿
- 뷰 템플릿을 거치면 동적 HTML 이 생성이 됩니다.
- 일반적으로 HTML을 동적으로 생성하는 용도로 사용하지만, 뷰 템플릿이 만들 수 있는 것이라면 다른 어떠한 것도 가능합니다.
뷰 템플릿 경로
스프링 부트는 기본 뷰 템플릿 경로를 제공합니다.
src/main/resources/templates
뷰 템플릿 생성 (Thymeleaf 사용)
src/main/resources/templates/response/hello.html
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<p th:text="${data}">empty</p>
</body>
</html>참고 Thymeleaf 스프링 부트 설정
build.gradle에 다음 라이브러리를 추가합니다.
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
그러면 스프링 부트가 자동으로 ThymeleafViewResolver와 같이 필요한 스프링 빈들을 다음 설정을 사용하여 등록합니다. 이 설정은 기본 값이기 때문에 필요한 경우에만 설정하면 됩니다.
application.properties
spring.thymeleaf.prefix=classpath:/templates/ spring.thymeleaf.suffix=.html
참고) 스프링부트 타임리프 관련 추가 설정은 다음 공식 사이트를 참고하실 수 있습니다.
(페이지 안에 thymeleaf 검색)
https://docs.spring.io/spring-boot/docs/2.4.3/reference/html/appendix-application-properties.html#common-application-properties-templating
뷰 템플릿 호출 컨트롤러
@Controller
public class ResponseViewController {
//1. ModelAndView 반환
@RequestMapping("/response-view-v1")
public ModelAndView responseViewV1() {
ModelAndView mav = new ModelAndView("response/hello").addObject("data", "hello");
return mav;
}
//2. String 반환
@RequestMapping("/response-view-v2")
public String responseViewV2(Model model) {
model.addAttribute("data", "hello!");
return "response/hello";
}
}
String을 반환하는 경우: View or HTTP 메시지
해당 메서드에 @ResponseBody가 있는지 없는지에 따라 View인지, HTTP 메시지인지로 나뉩니다.
- @ResponseBody (X) → response/hello로 뷰 리졸버가 실행되어 뷰를 찾고 렌더링합니다.
- @ResponseBody (O) → 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello 라는 문자를 입력합니다.
참고 Void를 반환하는 경우 - 요청 URL을 논리 뷰 이름으로 사용
@Controller 를 사용하고, HttpServletResponse, OutputStream(Writer)와 같은 HTTP 메시지 바디를 처리하는 파라미터가 없다면, 요청 URL을 참고하여 논리 뷰 이름으로 사용합니다.
예제)
- 요청 URL : /response/hello
- 실행 : templates/response/hello.html
하지만 이 방식은 명시성이 너무 떨어지고, 이렇게 정확히 이름이 일치하는 경우가 많이 없어서 권장하지 않습니다.
HTTP 응답 - Message 바디에 직접 입력
HTTP API를 제공하는 경우에는 HTML이 아니라, 데이터를 전달해야 하므로 HTTP 메시지 바디에 JSON 같은 형식의 데이터를 전달합니다.
참고 모두 HTTP Message Body
정적 HTML이나 뷰 템플릿을 이용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달됩니다.
여기서 설명하는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 담아 전달하는 경우를 말합니다.
@Slf4j
@Controller
//@RestController
public class ResponseBodyController {
/**
* String
*/
//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";
}
/**
* JSON
*/
//v1: ResponseEntity 사용
@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);
}
//v2: @ResponseBody 사용
//보통 개발할 때 가장 많이 사용한다. (+@RestController)
@ResponseStatus(HttpStatus.OK)
@ResponseBody
@GetMapping("/response-body-json-v2")
public HelloData responseBodyJsonV2() {
HelloData helloData = new HelloData();
helloData.setUsername("userA");
helloData.setAge(20);
return helloData;
}
}
String v2: ResponseEntity
@GetMapping("/response-body-string-v2")
public ResponseEntity<String> responseBodyV2() {
return new ResponseEntity<>("ok", HttpStatus.OK);
}- ResponseEntity 엔티티는 HttpEntity를 상속받습니다.
- HttpEntity는 HTTP 메시지 헤더, 바디 정보를 가지고 있습니다.
- ResponseEntity는 여기에 더해서 HTTP 응답 코드를 설정할 수 있습니다.
- ex) HttpStatus.CREATED 로 변경하면 201 응답이 나가는 것을 확인할 수 있습니다.
String v3: @ResponseBody
@ResponseBody
@GetMapping("/response-body-string-v3")
public String responseBodyV3() {
return "ok";
}- @ResponseBody를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해 HTTP 메시지를 직접 입력할 수 있습니다.
- ResponseEntity도 같은 방식으로 HTTP 메시지 컨버터를 사용하여 동작합니다.
JSON v1:ResponseEntity
@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);
}- ResponseEntity를 반환합니다.
- HTTP 메시지 컨버터를 통해 JSON 형식으로 변환되어 반환됩니다.
JSON v2: @ResonseBody
//보통 개발할 때 가장 많이 사용한다. (+@RestController)
@ResponseStatus(HttpStatus.OK)
@ResponseBody
@GetMapping("/response-body-json-v2")
public HelloData responseBodyJsonV2() {
HelloData helloData = new HelloData();
helloData.setUsername("userA");
helloData.setAge(20);
return helloData;
}- @RestController + 객체 반환 조합을 보통 개발할 때 가장 많이 사용합니다.
- @ResponseBody는 @ResponseStatus 애노테이션을 사용하여 HTTP 응답 코드를 설정할 수 있습니다.
@RestController
@RestController
public class MappingController {
private Logger log = LoggerFactory.getLogger(getClass());
@RequestMapping("/hello-basic")
public String helloBasic() {
log.info("helloBasic");
return "ok";
}
}- @Contoller 애노테이션과 @ResponseBody 애노테이션이 들어있습니다.
- @Controller는 반환 값이 String이라면 뷰 이름으로 인식되어 뷰를 찾습니다. 하지만, @ResponsBody가 있다면 뷰를 찾는 것이 아니라 직접 HTTP 메시지 바디에 해당 값을 입력합니다.
- @RestController는 해당 컨트롤러 메서드 모두에 @ResponseBody 가 적용되는 효과가 있습니다.
- 이름 그대로, REST API(HTTP API)를 만들 때 사용하는 컨트롤러입니다.
참고 @ResponseBody 클래스 레벨
@ResponseBody를 클래스 레벨에 둬도 전체 메서드에 적용됩니다.
출처
https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1/dashboard
스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의
웹 애플리케이션을 개발할 때 필요한 모든 웹 기술을 기초부터 이해하고, 완성할 수 있습니다. 스프링 MVC의 핵심 원리와 구조를 이해하고, 더 깊이있는 백엔드 개발자로 성장할 수 있습니다., 원
www.inflearn.com
'Backend > Spring | SpringBoot' 카테고리의 다른 글
| [SpringBoot] HTTP 메시지 컨버터 (+ArugumentResolver, ReturnValueHandler) (0) | 2023.09.01 |
|---|---|
| [SpringBoot] 로깅 간단히 알아보기 (0) | 2023.08.31 |
| [SpringBoot] HTTP 요청 조회 애노테이션 (0) | 2023.08.25 |
| [SpringBoot] 스프링 MVC 기본 애노테이션(@Controller, @RequestMapping, @PathVariable) (0) | 2023.08.25 |
| [Servlet] 회원 관리 웹 애플리케이션 만들기3 (어댑터 패턴) (0) | 2023.08.18 |
