스프링 MVC 기본 기능, HTTP 요청 메시지 - 단순 텍스트, JSON

인프런 김영한 님의 스프링 강의이며, 섹션 6 - 스프링 MVC 기본 기능을 정리하는 시간이다.

자세한 설명이 궁금하면 수강을 권장한다.

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의

---

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

이전 시간에 했던 요청 파라미터와 다르게 HTTP 메시지 바디를 통해 데이터 넘어오는 경우

@RequestParam, @ModelAttribute를 사용할 수 없다.

단, HTML Form 형식은 요청 파라미터로 인정된다. 

 

HTTP 메시지 바디의 데이터는 InputStream을 사용해서 직접 읽을 수 있다.

@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);// 바이트코드를 UTF-8 변환

        log.info("messageBody={}", messageBody);
        
        response.getWriter().write("ok");
    }
}

확인은 postman으로 한다.

HttpServletRequest 에서 받아와서 처리하는 과정이 너무 길다.

 

스프링 MVC는 다음 파라미터를 지원한다.

InputStream(Reader) : HTTP 요청 메시지 바디의 내용을 직접 조회

OutputStream(Writer) : HTTP 응답 메시지의 바디에 직접 결과 출력

    @PostMapping("/request-body-string-v2")
    public void requestBodyStringV2(InputStream inputStream, Writer responseWriter) throws IOException {
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);// 바이트코드를 UTF-8 변환

        log.info("messageBody={}", messageBody);

        responseWriter.write("ok");
    }

이것도 처음에 비하면 과정이 간단히 생략되었을 뿐 사용방법은 흡사해서 계속 반복되는 불편함이 있다.

 

스프링 MVC는 더 나아가 메시지 컨퍼버라는 기능을 제공한다. (자세한 내용은 다음에 언급된다.)

    @PostMapping("/request-body-string-v3")
    public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) throws IOException {
        String body = httpEntity.getBody();
        log.info("messageBody={}", body);

        return new HttpEntity<>("ok");
    }

HTTP 메시지처럼 주고 받는다. 

 

HttpEntity

- HTTP header, body 정보를 편리하게 조회

- 요청 파라미터를 조회하는 기능과 관계없음 (@RequestParam, @ModelAttribute)

- 응답에도 사용 가능

- 메시지 바디 정보 직접 반환

- 헤더 정보 포함 가능

- view 조회X

 

HttpEntity를 상속받은 객체도 존재한다

RequestEntity

- HttpMethod, url 정보가 추가, 요청에 사용

 

ResponseEntity

- HTTP 상태 코드 설정 가능, 응답에서 사용

- return new ResponseEntity<String>("hello world", responseHeaders, HttpStatus.CREATED)

    @PostMapping("/request-body-string-v4")
    public HttpEntity<String> requestBodyStringV4(RequestEntity<String> httpEntity) throws IOException {
        String body = httpEntity.getBody();
        log.info("messageBody={}", body);

        return new ResponseEntity<>("ok", HttpStatus.CREATED);
    }

 

스프링MVC 내부에서 HTTP 메시지 바디를 읽어서 문자나 객체로 변환하여 전달한다. 이때 HTTP 메시지 컨버터(HttpMessageConverter) 기능을 사용한다. (자세한 내용은 다음에)

 

@RequestBody

@RequestBody를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다. 헤더 정보가 필요하면 HttpEntity나 @RequestHeader를 사용한다. 메시지 바디를 조회하는 기능은 @RequestParam, @ModelAttribute와는 관계없다. 

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

        return "ok";
    }

 

정리

- 요청 파라미터를 조회하는 기능 : @RequestParam, @ModelAttirubte

- HTTP 메시지 바디를 직접 조회하는 기능 : @RequestBody

 

@ResponseBody

- 응답 결과를 HTTP 메시지 바디에 직접 담아서 전달 가능 (뷰를 사용하지 않는다.)

---

HTTP 요청 메시지 - JSON

JSON 형식 데이터 조회 방법이다.

 

서블릿 방식

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

 

@RequestBody 방식 - String

    @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 방식 - JSON -> 객체 자동 변환

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

        return "ok";
    }

 

 

@RequestBody 객체 파라미터

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

 

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

JSON도 객체로 변환시켜주는데 V2 에서 했던 objectMapper.readValue(값, 객체)를 대신 처리해준다. (자세한 내용은 다음에)

 

@RequestBody는 생략 불가능하다. 생략하면 @RequestParam 이나 @ModelAttribute로 적용되어

HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다. (요청 파라미터 처리 기능은 메시지 바디 데이터를 인식 못한다)

 

명심할 것은 HTTP 요청 시에 content-type : application/json 인지 확인해야 한다. 그래야 HTTP 메시지 컨버터가 실행된다.

 

 

HttpEntity 방식

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

        return "ok";
    }

 

@RequestBody - 응답 방식

- 해당 객체를 HTTP 메시지 바디에 직접 넣을 수 있다

- 이 경우에도 HttpEntity 사용이 가능하다.

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

        return data;
    }

 

정리

@RequestBody 요청

- JSON 요청 -> HTTP 메시지 컨버터 -> 객체

 

@RequestBody 응답

- 객체 -> HTTP 메시지 컨버터 -> JSON 응답