4 분 소요

인프런 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술편을 학습하고 정리한 내용 입니다.

HTTP 요청 메시지 - 단순 텍스트

HTTP message body에 데이터를 직접 담아서 요청하는 경우

  • HTTP API에서 주로 사용, JSON, XML, TEXT
  • 데이터 형식은 주로 JSON 사용
  • POST, PUT, PATCH

요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 넘어오는 경우는 @RequestParam, @ModelAttribute를 사용할 수 없다. (물론 HTML Form 형식으로 전달되는 경우는 요청 파라미터로 인정된다.)

  • 먼저 가장 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송하고, 읽어 보자.
  • HTTP 메시지 바디의 데이터를 InputStream을 사용해서 직접 읽을 수 있다.

RequestBodyStringController

1
2
3
4
5
6
7
8
9
10
11
12
13

@Slf4j  
@Controller  
public class RequestBodyStringController {  
    @PostMapping("/request-body-string-v1")  
    public void requestBodyString(HttpServletRequest request, HttpServletResponse response) throws IOException {  
        ServletInputStream inputStream = request.getInputStream();  
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);  
  
        log.info("messageBody = {}", messageBody);  
  
        response.getWriter().write("ok");  
    }  
}

먼저 다음과 같이 기본적인 body 를 가져오는 코드를 작성했고, Postman으로 테스트 해봤다. 스프링MVC에서는 여러 파라미터를 지원한다.

Input, Output 스트림, Reader - requestBodyStringV2

1
2
3
4
5
6

@PostMapping("/request-body-string-v2")  
public void requestBodyStringV2(InputStream inputStream, Writer responseWriter) throws IOException {  
    String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);  
    log.info("messageBody = {}", messageBody);  
    responseWriter.write("ok");  
}
  • InputStream(Reader): HTTP 요청 메시지 바디의 내용을 직접 조회
  • OutputStream(Writer): HTTP 응답 메시지의 바디에 직접 결과 출력

HttpEntity - requestBodyStringV3

1
2
3
4
5
6
7
8

@PostMapping("/request-body-string-v3")  
public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) {  
    String messageBody = httpEntity.getBody();  
  
    log.info("messageBody = {}", messageBody);  
  
    return new HttpEntity<>("ok");  
}
  • HttpEntity: HTTP header, body 정보를 편리하게 조회
    • 메시지 바디 정보를 직접 조회
    • 요청 파라미터를 조회하는 기능과 관계 X @Requestparam X, @ModelAttribute X
  • HTTPEntity는 응답에서도 사용 가능
    • 메시지 바디 정보 직접 반환
    • 헤더 정보 포함 가능
    • view 조회 X

HttpEntity 를 상속 받은 다음 객체들도 같은 기능을 제공한다.

  • RequestEntity
    • HttpMethod, url 정보가 추가, 요청에서 사용
  • ResponseEntity
    • HTTP 상태 코드 설정 가능, 응답에서 사용
    • return new ResponseEntity("Hello World", responseHeaders, HttpStatus.CREATED)

참고
스프링 MVC 내부에서 HTTP 메시지 바디를 읽어서 문자나 객체로 변환해서 전달해주는데, 이때 HTTP 지 컨버터(HttpMessageConverter)라는 기능을 사용한다. 이것은 조금 뒤에 HTTP 메시지 컨버터에서 자세히 설명함.

@RequestBody - requestBodyStringV4

1
2
3
4
5
6

@ResponseBody  
@PostMapping("/request-body-string-v4")  
public String requestBodyStringV4(@RequestBody String messageBody) {  
    log.info("messageBody = {}", messageBody);  
    return "ok";  
}

@RequestBody @RequestBody를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다. 참고로 헤더 정보가 필요하다면 HttpEntity를 사용하거나, @RequestHeader를 사용하면 된다.

이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam, @ModelAttribute 와 는 전혀 관계가 없다.

요청 파라미터 vs HTTP 메시지 바디

  • 요청 파라미터를 조회하는 기능: @RequestParam , @ModelAttribute
  • HTTP 메시지 바디를 직접 조회하는 기능: @RequestBody

@ResponseBody

@ResponseBody 를 사용하면 응답 결과를 HTTP 메시지 바디에 직접 담아서 전달할 수 있다. 물론 이 경우에도 view를 사용하지 않는다.

HTTP 요청 메시지 - JSON

이번에는 HTTP API에 주로 사용하는 JSON 데이터 형식을 조회해 보자.

RequestBodyJsonController

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

@Slf4j  
@Controller  
public class RequestBodyJsonController {  
  
    private ObjectMapper objectMapper = new 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("username={}, age={}", helloData.getUsername(), helloData.getAge());  
  
        response.getWriter().write("ok");  
  
    }  
  
}

이것도 기존에 Sevlet 에서 한 ServletInputStream을 사용해서 json으로 변환한 기초적인 방법이다.

  • HttpServletRequest를 사용해서 직접 HTTP 메시지 바디에서 데이터를 읽어와서, 문자로 변환한다.
  • 문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper 를 사용해서 자바 객체로 변환한다.

이제 스프링 기능을 이용해서 코드를 개선해 보자.

requestBodyJsonV2 - @RequestBody 문자 변환

1
2
3
4
5
6
7
8
9
10

@ResponseBody  
@PostMapping("/request-body-json-v2")  
public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {  
  
    log.info("messageBody: {}", messageBody);  
    HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);  
    log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());  
  
    return "ok";  
}
  • 이전에 학습했던 @RequestBody 를 사용해서 HTTP 메시지에서 데이터를 꺼내고 messageBody에 저장한다.
  • 문자로 된 JSON 데이터인 messageBody를 objectMapper를 통해서 자바 객체로 변환한다.

문자로 변환하고 다시 json으로 변환하는 과정이 불편하다. @ModelAttribute처럼 한번에 객체로 변환할 수는 없을까?

requestBodyJsonV3 - @RequestBody 객체 변환

1
2
3
4
5
6
7

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

@RequestBody 객체 파라미터

  • @RequestBody HelloData helloData
  • @RequestBody 에 직접 만든 객체를 지정할 수 있다.

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

HTTP 메시지 컨버터는 문자 뿐만이 아니라 JSON도 객체로 변환해주는데, 우리가 방금 V2에서 했던 작업을 대신 처리 해준다.

자세한 내용은 뒤에 HTTP 메시지 컨버터에서 다룬다.

@RequestBody 는 생략 불가능!!

@ModelAttribute 를 떠올려 보자.

스프링은 파라미터 에노테이션을 생략하면 다음과 같은 순서라고 했다.

  • String, int, Integer 같은 단순 타입 = @RequestParam
  • 나머지 = @ModelAttribute(argument resolver로 지정해둔 타입 외)

따라서 이렇게 생략 해버리면 @ModelAttribute가 적용되버린다.

따라서 생략하면 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.

주의
HTTP 요청 시에 content-type이 application/json인지 꼭 확인해야 한다. 그래야 JSON을 처리할 수 있는 HTTP 메시지 컨버터가 실행된다.

requestBodyJsonV4 - HttpEntity

1
2
3
4
5
6
7

@ResponseBody  
@PostMapping("/request-body-json-v4")  
public String requestBodyJsonV4(HttpEntity<HelloData> httpEntity) {  
    HelloData data = httpEntity.getBody();  
    log.info("username={}, age={}", data.getUsername(), data.getAge());  
    return "ok";  
}

뭐 이런 식으로 쓸 수도 있다.

requestBodyJsonV5

이번엔 반환에 대해 알아보자. 지금까진 @ResponsBody를 사용해서 String을 반환했지만, 이번엔 HelloData객체를 반환해 보자.

1
2
3
4
5
6
7

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

@ResponseBody 응답의 경우에도 @ResponseBody를 사용하면 해당 객체를 HTTP 메시지 바디에 직접 넣어줄 수 있다. 물론 이 경우에도 HttpEntity를 사용해도 된다.

  • @RequestBody 요청
    • JSON 요청 → HTTP 메시지 컨버터 → 객체
  • @ResponseBody 응답
    • 객체 → HTTP 메시지 컨버터 → JSON 응답

태그:

카테고리:

업데이트:

댓글남기기

참고