[Spring MVC] 스프링 MVC - 기본 기능 ②

HTTP 요청 메시지 - JSON

---

HTTP 요청 메시지 바디에는 JSON이 주로 사용된다. JSON은 아래와 같은 구조인데, 이를 객체로 변환화는 과정에 대해서 학습해 보자.

JSON

{
    "username":"catsbi",
    "age":20
}

Object

@Data
public class HelloData {
    private String username;
    private int age;
}

RequestBodyJsonController.requestBodyJsonV1 - 예전 방식

HttpServletRequest, HttpServletResponse 객체에서 메시지 바디를 읽어와 ObjectMapper로 객체 바인딩 하는 코드

@PostMapping("/request-body-json-v1")
public void requestBodyJsonV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
    ServletInputStream inputStream = request.getInputStream();
    String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

    log.info("messageBody={}", messageBody);
    HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
    log.info("helloDate = {}", helloData.toString());

    response.getWriter().write("ok");
}

• HttpServletRequest를 사용해서 직접 HTTP 메시지 바디에서 데이터를 읽어와, 문자로 변환한다.

• 문자로 된 JSON 데이터를 Jackson 라이브러리인 ObjectMapper를 사용해 객체 변환을 한다.

예전 방식으로 JSON을 받아서 처리하려니 처리해야 할 기본 로직이 상당히 많다. StreamUtil부터 ObjectMapper까지 꺼내서 사용을 해야 하는데 JSON을 받아서 사용해야 할 컨트롤러가 많을수록 코드 중복이 많아질 수밖에 없다.

RequestBodyJsonController.requestBodyJsonV2

@PostMapping("/request-body-json-v2")
@ResponseBody
public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {
    log.info("messageBody={}", messageBody);
    HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
    log.info("helloDate = {}", helloData.toString());

    return "ok";
}

저번 포스팅에서 다룬 @RequestBody 어노테이션을 이용해 메시지 바디를 사용하면 InputStream을 꺼내 StreamUtili로 변환해 줄 필요 없이 바로 ObjectMapper로 객체 변환을 해줄 수 있다.

RequestBodyJsonController.requestBodyJsonV3

• @RequestBody를 사용하면 객체를 직접 지정해서 매핑해 줄 수 있다.

@PostMapping("/request-body-json-v3")
@ResponseBody
public String requestBodyJsonV3(@RequestBody HelloData helloData){
    log.info("helloDate = {}", helloData.toString());
    return "ok";
}

• HttpEntity, @RequestBody를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디 내용을 우리가 원하는 문자나 객체 등으로 변환해 준다.

• HTTP 메시지 컨버터는 문자뿐 아니라 JSON도 변환해 주며 우리가 위에서 수동으로 진행했던 과정을 대신 처리해 준다.

• @RequestBody는 생략이 불가능하다.
  • 기본 타입과, 나머지는 모두 RequestParam, ModelAttribute가 매핑하기 때문
  • 그래서 위 코드에서 해당 어노테이션을 제거하면 @ModelAttribute가 적용되어 버린다.

✅ 참고 - Content-type은 application/json이어야 한다.

HTTP 요청 시 content-type이 application/json 인지 확인해야 한다.

RequestBodyJsonController.requestBodyJsonV4 ~ V5

@PostMapping("/request-body-json-v4")
@ResponseBody
public String requestBodyJsonV4(HttpEntity<HelloData> httpEntity){
    HelloData helloData = httpEntity.getBody();
    log.info("helloDate = {}", helloData.toString());
    return "ok";
}

@PostMapping("/request-body-json-v5")
@ResponseBody
public HelloData requestBodyJsonV5(@RequestBody HelloData helloData){
    log.info("helloDate = {}", helloData.toString());
    return helloData;
}

• HttpEntity를 이용해서 제네릭 타입으로 객체 매핑도 가능하다.
• V5를 보면 어노테이션을 최대한 활용해서 V1보다 훨씬 간결해진 코드가 완성된다.

@RequestBody 요청

• JSON 요청 → HTTP 메시지 컨버터 → 객체

@ResponseBody 응답

• 객체 → HTTP 메시지 컨버터 → JSON 응답

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

---

스프링(서버)에서 응답 데이터를 반드는 방식은 크게 세 가지가 있다.

리소스

• 웹 브라우저에 정적인 HTML, css, js를 제공할 때 정적 리소스 사용

뷰 템플릿 사용

• 웹 브라우저에 동적인 HTML을 제공할 때 뷰 템플릿 사용

HTTP 메시지 사용

• HTTP API를 제공하는 경우 HTTP 메시지 바디에 JSON 형식으로 데이터를 실어 보낸다.

정적 리소스

/static
/public
/resources
/META-INF/resources
src/main/resources는 리소스를 보관하는 곳이고, 또 클래스 패스의 시작 경로다.

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

예를 들어, 정적 리소스 경로 src/main/resources/static/baisc/hello-form.html에 해당 파일이 있다면 웹 브라우저에서는 컨트롤러를 통하지 않고 정적 리소스 경로 뒤의 경로를 입력해 바로 가져올 수 있다.

뷰 템플릿

뷰 템플릿을 거쳐 HTML이 생성되고 뷰가 응답을 만들어 전달하는데, 일반적으로 HTML을 동적으로 생성하는 용도로 사용한다.

Thymeleaf 스프링 부트 설정

build.gradle에 아래 코드를 추가한다.

build.gralde

implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'

스프링 부트는 자동으로 ThymeleafViewResolver와 필요한 스프링 빈들을 등록하는데, 스프링 설정을 통해 해당 뷰 리졸버에서 뷰 템플릿의 물리적 경로를 완성할 때 접두사나 접미사를 변경할 수도 있다.

# 아래 설정은 기본값이기에 변경이 필요할 때만 사용한다. 
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html

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

---

HTTP API를 제공하는 경우 응답 메시지로 HTML이 아니라 데이터를 전달해야 한다. 그리고 이때 HTTP 메시지 바디에는 JSON 같은 형식으로 데이터를 실어서 보낸다.

✅ 참고

이번 섹션에서 말하는 내용은 정적 리소스나, 뷰 템플릿이 아니라 직접 HTTP 응답 메시지를 전달하는 경우를 말한다.

ReponseBodyController

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

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


    @GetMapping("/response-body-json-v1")
    public ResponseEntity<HelloData> responseBodyJsonV1() {
        HelloData helloData = new HelloData();
        helloData.setUsername("catsbi");
        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("catsbi");
        helloData.setAge(20);

        return helloData;
    }

}

responseBodyV1

• 서블릿을 직접 다룰 때와 같이 코드가 구현돼있다.
  HttpServletResponse 객체를 통해 HTTP 메시지 바디에 직접 OK 응답 메시지를 전달한다.

• response.getWriter().write("ok")

responseBodyV2

• ResponseEntity 엔티티는 HttpEntity를 상속받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다면 ResponseEntity는 HTTP 응답 코드가 추가되었다고 생각하면 된다.

• return new ResponseEntity<>(helloData, HttpStatus.OK);

responseBodyV3

• @ResponseBody 어노테이션을 사용하면 view를 사용하지 않고 HTTP 메시지 컨버터를 통해 HTTP 메시지를 직접 입력할 수 있다 ResponseEntity도 동일한 방식으로 동작한다.

responseBodyJsonV1

• ResponseEntity를 반환한다. HTTP 메시지 컨버터를 통해서 객체는 JSON으로 변환되어 반환된다.

responseBodyJsonV2

• ResponseEntity는 HTTP 응답 코드를 설정할 수 있는데 @ResponseBody를 사용하면 설정하기가 까다롭다. 그래서 이런 경우에는 @ResponseStatus을 이용하여 상태 코드를 설정할 수 있다.

• 정적으로 상태 코드를 작성한 것이기에 유연하지는 못하다. 그렇기에 동적으로 상태 코드가 변경돼야 하는 상황이라면 ResponseEntity를 사용하면 된다.

HTTP 메시지 컨버터

---

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

@ResponseBody 사용 원리

• @ResponseBody를 사용
  • HTTP의 BODY에 문자 내용을 직접 반환
  • viewResolver 대신에 HttpMessageConverter가 동작
  • 기본 문자 처리 : StringHttpMessageConverter
  • 기본 객체 처리 : MappingJackson2HttpMessageConverter
  • byte 처리 등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

✅ 참고

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

스프링 MVC는 다음의 경우에 HTTP 메시지 컨버터를 적용한다.

• HTTP 요청 : @RequestBody, HttpEntity(RequestEntity)
• HTTP 응답 : @ResponseBody, HttpEntity(ResponseEntity)

HTTP 메시지 컨버터 인터페이스

org.springframework.http.converter.HttpMessageConverter

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

  List<MediaType> 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
  • 응답, @ResponseBody return byte[] 쓰기 미디어 타입 application/octet-stream

• StringHttpMessageConverter : String 문자로 데이터를 처리한다.
  • 클래스 타입 : String, 미디어 타입 : */*
  • 요청, @RequestBody String data
  • 응답, @ResponseBody return "ok" 쓰기 미디어 타입 text/plain

• MappingJackson2HttpMessageConverter : application/json
  • 클래스 타입 : 객체 또는 HashMap, 미디어 타입 : application/json 관련
  • 요청, @RequestBody HelloData data
  • 응답, @ResponseBody return helloData 쓰기 미디어 타입 application/json 관련

HTTP (요청/응답) 데이터 (읽기/쓰기)

HTTP 요청 데이터 읽기

• HTTP 요청이 오고, 컨트롤러에서 @RequestBody, HttpEntity 파라미터를 사용한다.

• 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead()를 호출한다.

  • 대상 클래스 타입을 지원하는가.
    • 예) @RequestBody의 대상 클래스 (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 응답 메시지 바디에 데이터를 생성한다.

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

---

Spring MVC 구조

모든 비밀은 @RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter (요청 매핑 핸들러 어댑터)에 있다.

RequestMappingHandlerAdapter 동작 방식

ArgumentResolver

어노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다.
HttpServletRequest, Model은 물론이고, @RequestParam, @ModelAttribute 같은 어노테이션 그리고 @RequestBody, HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다. 이렇게 파라미터를 유연하게 처리할 수 있는 이유가 바로 ArgumentResolver 덕분이다.

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

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

정확히는 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()를 호출해서 해당 파라미터를 지원하는지 체크하고, 지원하면 resolveArgument()를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출 시 넘어가는 것이다.

ReturnValueHandler

HandlerMethodReturnValueHandler를 줄여서 ReturnValueHandler라 부른다.
ArgumentResolver와 비슷한데, 이것은 응답 값을 변환하고 처리한다.

컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler 덕분이다.

HTTP 메시지 컨버터 위치

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

요청의 경우 @RequestBody를 처리하는 ArgumentResolver가 있고, HttpEntity를 처리하는 ArgumentResolver가 있다. 이 ArgumentResolver들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.

응답의 경우 @ResponseBody와 HttpEntity를 처리하는 ReturnValueHandler가 있다. 그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.

확장

스프링은 다음 모두를 인터페이스로 제공한다.

• HandlerMethodArgumentResolver
• HandlerMethodReturnValueHandler
• HttpMessageConverter