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

chaelink · 2024-07-02T03:01:13Z

chaelink
Jul 2, 2024

섹션 6. 스프링 MVC - 기본 기능 (3)

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

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

1. 정적 리소스
ex) 웹 브라우저에 정적인 HTML, CSS, JS

스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 변경 없이 그대로 제공한다
/static, /public, /resources, /META-INF/resources

2. 뷰 템플릿
뷰 템플릿을 거쳐서 HTML이 생성되고, 뷰가 응답을 만들어서 프론트로 전달한다
HTML을 동적으로 생성하는 용도로 사용 + 뷰 템플릿이 만들 수 있는 모든 기능

뷰 템플릿 경로
src/main/resources/templates

뷰 템플릿 생성

 <!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 responseView3(Model model) {
        model.addAttribute("data", "hello!");
    }

}

@ResponseBody - String을 반환하는 경우

@ResponseBody가 없으면 response/hello로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 한다
@ResponseBody가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에서 직접 response/hello라는 문자가 입력된다

Void를 반환하는 경우

@Controller를 사용하고 HttpServletResponse , OutputStream(Writer) 같은 HTTP 메시지 바디를 처리한느 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용한다
- 요청 URL: /response/hello
- 실행 : templates/response/hello.html
명시성이 너무 떨어지고, 이렇게 요청 URL과 실행 경로가 맞는 경우가 많이 없으니 권장하지 않음

3. HTTP 메시지
@ResponseBody, HttpEntity를 사용하면 뷰 템플릿을 사용하지 않고 HTTP 메시지 바디에 직접 응답 데이터를 출력함

Thymeleaf 스프링 부트 설정
build.gradle에 라이브러리가 추가되어 있음
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf
스프링부트가 자동으로 ThymeleafViewResolver 와 필요한 스프링 빈을 등록함

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

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

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

ResponseBodyController

@Slf4j
@Controller
public class ResponseBodyController {

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

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

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

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

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

responseBodyV1

서블릿을 직접 다룰 때 처럼 HttpServletResponse 객체를 통해 HTTP 메시지 바디에 직접 메시지 전달
response.getWriter().write("ok")

responseBodyV2

ResponseEntity 는 HttpEntity를 상속 받았다
HTTP 메시지의 헤더, 바디 정보를 가지고 있고 HTTP 응답 코드를 설정할 수 있다
EX) HttpStatus.CREATED 로 설정하면 201 응답이 나간다

responseBodyV3

@ResponseBody를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해 HTTP 메시지를 직접 입력할 수 있다
ResponseEntity와 동작 방식이 같다

responseBodyJsonV1

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

responseBodyJsonV2

@ResponseStatus(HttpStatus.OK) 애노테이션을 사용해서 @ResponseBody 에서 어려운 응답 코드 설정 가능
애노테이션이므로 응답 코드 동적 변경은 불가능하다

@RestController

@Controller + @ResponseBody
이름 그대로 Rest API ( HTTP API) 를 사용함

13. HTTP 메시지 컨버터

뷰 템플릿으로 HTML 을 생성해서 응답하는 것이 아닌, HTTP API처럼 JSON 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터 사용

스프링 입문 강의에서 설명했던 내용

스프링 MVC가 HTTP 메시지 컨버터를 적용하는 경우

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

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

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

주요 메시지 컨버터 알아보기

ByteArrayHttpMessageConverter : byte[ ] 데이터 처리
StringHttpMessageConverter : String 문자로 데이터 처리
MappingJackson2HttpMessageConverter : application/json 처리

HTTP 요청 데이터 읽기

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

HTTP 응답 데이터 생성

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

14. 요청 매핑 핸들러 어댑터 구조

HTTP 메시지 컨버터는 스프링 MVC 어디에서 사용되는 것일까?
아래 그림에서는 보이지 않는다

RequestMappingHandlerAdapter(요청 매핑 헨들러 어뎁터) 에 모든 비밀이 있다

ArgumentResolver

애노테이션 기반의 컨트롤러가 다양한 파라미터를 사용할 수 있게 해준다
RequestMappingHandlerAdapter 는 ArgumentResolver를 호출해서 컨트롤러가 필요로 하는 다양한 파라미터(객체) 값을 생성한다. 그리고 파라미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다
스프링은 30개가 넘는 ArgumentResolver를 기본 제공한다

public interface HandlerMethodArgumentResolver {

   boolean supportsParameter(MethodParameter parameter);

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

ArgumentResolver 동작 방식

ArgumentResolver 의 supportsParameter()를 호출해서 해당 파라미터를 지원하는지 체크하고, 지원하면 resolveArgument()를 호출해서 실제 객체 생성
이렇게 생성한 객체가 컨트롤러 호출 시 넘어가는 것
원하면 직접 ArgumentResolver 를 만들 수 있다

ReturnValueHandler

HandlerMethodReturnValueHandler를 줄여서 ReturnValueHandler라 부른다
응답 값을 변환하고 처리한다

HTTP 메시지 컨버터 위치

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

요청

@RequestBody, HttpEntity 를 처리하는 ArgumentResolver 가 각각 존재한다
이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성한다

응답

@ResponseBody와 HttpEntity 를 처리하는 ReturnValueHandler가 있다
HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다

확장

스프링은 다음을 모두 인터페이스로 제공하여 필요하면 언제든지 기능을 확장할 수 있다.
- HandlerMethodArgumentResolver
- HandlerMethodReturnValueHandler
- HttpMessageConverter

스프링이 이미 필요한 기능 대부분을 제공하기에 실제로 기능을 확장할 일은 거의 없다

Navigation Menu

Uh oh!

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

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

chaelink Jul 2, 2024

섹션 6. 스프링 MVC - 기본 기능 (3)

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

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

13. HTTP 메시지 컨버터

스프링 입문 강의에서 설명했던 내용

14. 요청 매핑 핸들러 어댑터 구조

HTTP 메시지 컨버터 위치

Replies: 0 comments

chaelink
Jul 2, 2024