[스프링 MVC 1편] #6. 스프링 MVC - 기본 기능 (3) #274

YuDeokRin · 2024-07-02T13:30:38Z

YuDeokRin
Jul 2, 2024
Maintainer

1️⃣ 1️⃣ 응답 - 정적 리소스, 뷰 템플릿

스프링(서버)에서 응답 데이터를 만드는 방법은 크게 3가지이다.
- 정적 리소스
  - 예) 웹 브라우저에 정적인 HTML, css, js를 제공할 때는, 정적 리소스를 사용한다.
- 뷰 템플릿 사용
  - 예) 웹 브라우저에 동적인 HTML을 제공할 때는 뷰 템플릿을 사용한다.
- HTTP 메시지 사용
  - HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.

✅정적 리소스

스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공한다.
- /static
- /public
- /resources
- /META-INF/resources
scr/main/resources 는 리소스를 보관하는 곳이고, 또 클래스패스의 시작 경로이다.

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

✅ 뷰 템플릿

뷰 템플릿을 거쳐서 HTML이 생성되고, 뷰가 응답을 만들어서 전달한다.
일반적으로 HTML을 동적으로 생성하는 용도로 사용하지만, 다른 것들도 가능하다. 뷰 템플릿이 만들 수 있는 것이라면 뭐든 가능하다.
스프링 부트는 기본 뷰 템플릿 경로를 제공한다.

➡️뷰 템플릿 경로

scr/main/resources/templates

➡️ 뷰 템플릿 생성

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>

➡️ ResponseViewController - 뷰 템플릿을 호출하는 컨트롤러

@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!!");
	   }
 
}

String을 반환하는 경우 - View or HTTP 메시지
- @responsebody 가 없으면 response/hello 로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 한다.
- @responsebody 가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello 라는 문자가 입력된다
void를 반환하는 경우
- @controller 를 사용하고, HttpServletResponse , OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용
- 요청 URL: /response/hello
- 실행: templates/response/hello.html

참고.
void 방식은 명시성이 떨어지고 이렇게 딱 맞는 경우도 많이 없어서 권장하지 않는다.

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

✅Thymelead 스프링 부트 설정

생략

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

HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.
HTTP 요청에서 응답까지 대부분 다루었으므로 이번시간에는 정리를 해보자.

참고
HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달된다. 여기서 설명하 는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 전달하는 경우를 말한다.

ResponseBodyController

package hello.springmvc.basic.response;

import hello.springmvc.basic.HelloData;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;

import java.io.IOException;

@Slf4j
@Controller
public class ResponseBodyController {
    /**
     * 서블릿 직접 다룰 때처럼
     * HttpServletResponse 객체를 통해서 HTTP 메시지 바디에 직접 `ok` 응답 메시지를 전달한다.
     * response.getWriter().write("ok")
     * @param response
     * @throws IOException
     */
    @GetMapping("/response-body-string-v1")
    public void responseBodyStringV1(HttpServletResponse response) throws IOException {
        response.getWriter().write("ok");
    }

    /**
     * HttpEntity, ResponseEntity(Http Status 추가)
     * ResponseEntity 엔티티는 HttpEntity 를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다.
     * ResponseEntity 는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다.
     * HttpStatus.CREATED 로 변경하면 201 응답이 나가는 것을 확인할 수 있다.
     * @return
     */
    @GetMapping("/response-body-string-v2")
    public ResponseEntity<String> responseBodyV2() {
        return new ResponseEntity<>("ok", HttpStatus.OK);
    }

    /**
     * @ResponseBody 를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있다.
     * ResponseEntity 도 동일한 방식으로 동작한다.
     * @return
     */
    @ResponseBody
    @GetMapping("/response-body-string-v3")
    public String responseBodyV3() {
        return "ok";
    }

    /**
     * ResponseEntity 를 반환한다. HTTP 메시지 컨버터를 통해서 JSON 형식으로 변환되어서 반환된다.
     * @return
     */
    @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 응답 코드를 설정할 수 있는데, @ResponseBody 를 사용하면 이런 것을 설정하기 까다롭다.
     * @ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다.
     * 물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다.
     * 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity 를 사용하면 된다.
     * @return
     */
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    @GetMapping("/response-body-json-v2")
    public HelloData responeBodyJsonV2() {
        HelloData helloData = new HelloData();
        helloData.setUsername("userA");
        helloData.setAge(20);

        return helloData;
    }

}

✅@RestController

@controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @responsebody 가 적용되는 효과가 있다.
따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다.이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러이다.

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

1️⃣ 3️⃣ HTTP 메시지 컨버터

HTTP API 처럼 JSON 데이터를 HTTP 메세지 바디에서 직접 읽거나 쓰는 경우 HTTP 메세지 컨버터를 사용하면 편리하다.
@responsebody 사용 원리
- HTTP의 Body에 문자 내용을 직접 반환
- viewResolver 대신에 HttpMessageConverter가 동작
- 기본 문자처리 : StringHttpMessageConverter
- 기본 객체처리 : MappingJackson2HttpMessageConverter
- byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있다.

참고 : 응답의 경우 클라이언트의 HTTP Accept 헤더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해서 HttpMessageConverter가 선택된다.

스프링 MVC가 적용하는 HTTP MessageConverter
- HTTP 요청 : @RequestBody, HttpEntity(RequestEntity)
- HTTP 응답 : @responsebody, HttpEntity(ResponseEntity)
HTTP 메시지 컨버터 인터페이스

public interface HttpMessageConverter<T> {
    boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);

    boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);

    List<MediaType> getSupportedMediaTypes();

    default List<MediaType> getSupportedMediaTypes(Class<?> clazz) {
        return !this.canRead(clazz, (MediaType)null) && !this.canWrite(clazz, (MediaType)null) ? Collections.emptyList() : this.getSupportedMediaTypes();
    }

    T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;

    void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;
}

HTTP 메시지 컨버터는 HTTP 요청, HTTP 응답 둘 다 사용된다.
- canRead(), canWrite() : 메시지 컨버터가 해당 클래스, 미디어타입을 지원하는지 체크
- read(), write() : 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능

✅스프링 부트 기본 메시지 컨버터

스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 둘을 체크해서 사용여부를 결정한다. 만약 만족하지 않으면 다음 메시지 컨버터로 우선순위가 넘어간다.

우선순위 
0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter

주요한 컨버터 몇가지
- ByteArrayHttpMessageConverter
  - byte[] 데이터 를 처리
  - 클래스타입 : byte[]
  - 미디어타입 : */*
  - 요청 예) @RequestBody byte[] data
  - 응답 예) @RequestBody return byte[] 쓰기 미디어타입 application/octet-stream
- StringHttpMessageConverter
  - String 문자로 데이터를 처리
  - 클래스 타입 : String
  - 미디어 타입 : */*
  - 요청 예) @RequestBody String data
  - 응답 예) @responsebody return “ok” 쓰기 미디어타입 text/plain
```
content-type: application/json

 @RequestMapping
 void hello(@RequestBody String data) {}
```
- MappingJackson2HttpMessageConverter
  - application/json 데이터 처리
  - 클래스 타입 : 객체 또는 HashMap
  - 미디어타입 : application/json 관련
  - 요청 예) @RequestBody HelloData data
  - 응답 예) @responsebody return helloData 쓰기 미디어타입 appliction/json 관련
```
content-type: application/json

 @RequestMapping
 void hello(@RequestBody HelloData data) {}
```
에외 케이스

content-type: text/html

 @RequestMapping
 void hello(@RequestBody HelloData data) {}

✅HTTP 요청 데이터 읽기

HTTP 요청이 오고 컨트롤러에서 @RequestBody, HttpEntity 파라미터를 사용한다.
메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead()를 호출한다.
- 대상 클래스 타입을 지원하는가
  - 예) @RequstBody의 대상 클래스(byte[], String, HelloData)
- HTTP 요청의 Content-Type 미디어 타입을 지원하는가
  - 예) text/plain, application/json, */*
canRead() 조건을 만족하면 read()를 호출해서 객체 생성하고 반환한다.

✅HTTP 응답 데이터 생성

컨트롤러에서 @responsebody, HttpEntity 로 값이 반환된다.
메시지 컨버타가 메시지를 쓸 수 있는지 확인하기 위해 canWrite()를 호출한다.
- 대상 클래스 타입을 지원하는가
  - 예) return의 대상 클래스(byte[], String, HelloData)
- HTTP 요청의 Accept 미디어 타입을 지원하는가( 정확히는 @RequestMapping의 produces)
  - 예) text/plain, application/json, */*
canWrite() 조건을 만족하면 write()를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.

1️⃣ 4️⃣ 요청 매핑 헨들러 어뎁터 구조

HTTP 메시지 컨버터는 스프링 MVC 어디쯤에서 사용될까?
- 애노테이션 기반의 컨트롤러, @RequestMapping 을 처리하는 핸들러 어뎁터인 RequestMappingHandlerAdapter(요청 매핑 핸들러 어뎁터)에 있다.

RequestMappingHandlerAdapter 동작 방식

✅ArgumentResolver

애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다.

HttpServletRequest, Model, @RequestParam, @ModelAttribute 같은 애노테이션 그리고 @RequestBody, HttpEntity 같은 HTTP 메시지를 처리 가능하다.

→ 이렇게 파라미터를 유연하게 처리할 수 있는 이유가 ArgumentResolver 의 역할이다.

동작 순서

애노테이션 기반 컨트롤러를 처리 RequestMappingHandlerAdapter
ArgumentResolver를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성
파라미터 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.

스프링은 30개 넘는 ArgumentResolver를 기본으로 제공한다.

참고
가능한 파라미터 목록은 공식 메뉴엘에서 확인가능
https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-methods/arguments.html

정확히는 HandlerMethodArgumentResolver인데 줄여서 ArgumentResolver라고 부른다.

public interface HandlerMethodArgumentResolver {
    boolean supportsParameter(MethodParameter parameter);

    @Nullable
    Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception;
}

✅동작 방식

ArgumentResolver의 supportsParameter()를 호출해서 해당 파라미터를 지원하는지 체크하고 지원하면 resolverArgument()를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다.

추가로 이 인터페이스를 확장해서 원하는 ArgumentResolver를 만들 수 있다.

✅ReturnValueHandler

HandlerMethodReturnValueHandler 를 줄여서 ReturnValueHandler 라고 부른다.
ArgumentResolver 와 비슷한데, 이것은 응답 값을 변환하고 처리한다.
컨트롤러에서 String으로 뷰 이름을 반환해도 동작하는 이유가 ReturnValueHandler 에 역할 때문이다.
스프링은 10여개가 넘는 ReturnValueHandler 를 지원한다.
- 예) ModelAndView, @responsebody, HttpEntity, String
코드 확인

public interface HandlerMethodReturnValueHandler {
    boolean supportsReturnType(MethodParameter returnType);

    void handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception;
}

참고
가능한 응답 값 목록은 다음 공식 메뉴얼에서 확인할 수 있다.
https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-methods/return-types.html

✅메시지 컨버터

HTTP 메시지 컨버터 위치
- HTTP 메시지 컨버터를 사용하는 @RequestBody도 컨트롤러가 필요로 하는 파라미터의 값에 사용된다. @responsebody의 경우도 컨트롤러의 반환 값을 이용한다.

요청의 경우
- @RequestBody를 처리하는 ArgumentResolver가 있고, HttpEntity를 처리하는 ArgumentResolver가 있다.
- 이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.( 모임에서 만나서 코드 살펴보기)
응답의 경우
- @responsebody와 HttpEntity를 처리하는 ReturnValueHandler가 있다. 그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.
스프링 MVC는 @RequestBody @ResponseBody 가 있으면 RequestResponseBodyMethodProcessor(ArgumentResolver, ReturnValueHandler 둘다 구현) HttpEntity 가 있으면 HttpEntityMethodProcessor(ArgumentResolver, ReturnValueHandler 둘다 구현) 를사용한다.

참고
HttpMessageConverter를 구현한 클래스를 한번 확인해보자.

✅확장

스프링은 다음 인터페이스를 제공한다. 따라서 필요하면 언제든지 기능을 확장할 수 있다.
- HandlerMethodArgumentResolver
- HandlerMethodReturnValueHandler
- HttpMessageConverter

참고
스프링이 필요한 부분을 제공하고 있어서 확장할 일이 얼마 없다.

기능 확장은 WebMvcConfigurer 를 상속 받아서 스프링 빈으로 등록하면 된다.
WebMvcConfigurer 확장

	@Bean
	public WebMvcConfigurer webMvcConfigurer() {
     
     return new WebMvcConfigurer() {
         @Override
         public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
					
					//...
		 }
			   @Override
         public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
				
				 //...
		 } 
	
	};
}

Navigation Menu

Uh oh!

[스프링 MVC 1편] #6. 스프링 MVC - 기본 기능 (3) #274

Uh oh!

{{title}}

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

Uh oh!

[스프링 MVC 1편] #6. 스프링 MVC - 기본 기능 (3) #274

Uh oh!

YuDeokRin Jul 2, 2024 Maintainer

1️⃣ 1️⃣ 응답 - 정적 리소스, 뷰 템플릿

✅정적 리소스

✅ 뷰 템플릿

✅Thymelead 스프링 부트 설정

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

✅**@RestController**

1️⃣ 3️⃣ HTTP 메시지 컨버터

✅스프링 부트 기본 메시지 컨버터

✅HTTP 요청 데이터 읽기

✅HTTP 응답 데이터 생성

1️⃣ 4️⃣ 요청 매핑 헨들러 어뎁터 구조

✅ArgumentResolver

✅동작 방식

✅ReturnValueHandler

✅메시지 컨버터

✅확장

Replies: 0 comments

YuDeokRin
Jul 2, 2024
Maintainer

✅@RestController