🎯 목표 : Spring MVC에서의 HTTP 요청 / 응답 데이터를 주고 받는 방법에 대한 학습내용 정리

📒 쿼리 파라미터에 대한 데이터 조회

---

📌 HttpServletRequest & @RequestParam & @ModelAttribute

• 데이터를 전송 받아 조회하는 여러가지 방법.

# GET 쿼리 파라미터 전송
http://localhost:8080/request-param?username=lee&age=20

# POST HTML Form 형식으로 전송
POST /request-param ...
content-type: application/x-www-form-urlencoded
username=lee&age=20

• 위와 같이 데이터를 전송 받는다 가정하고 조회하는 방법을 정리했다.

// 동일한 맵핑으로 log를 확인하기 위해서는 하나씩 주석 처리하고 해야한다.
@Slf4j
@Controller
public class RequestParamController {
    @RquestMapping("/request-param")
    public void requestParamServlet(HttpServletRequest request, HttpServletResponse response) throws IOException {
        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));

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

    @ResponseBody /* View 조회를 무시하고 HTTP message Body에 String 데이터를 직접 전송한다 */
    @RequestMapping("/request-param")
    public String requestParamAnnotation(
            @RequestParam String username,
            @RequestParam int age
    ) {
        log.info("username={}, age={}", username, age);
        return "ok";
    }

    @ResponseBody
    @RequestMapping("/request-param")
    public String requestParamBasic(String username, int age) {
        log.info("username={}, age={}", username, age);
        return "ok";
    }

    @ResponseBody
    @RequestMapping("/request-param")
    public String requestParamMap(@RequestParam Map<String, Object> paramMap) {
        log.info("username={}, age={}",
          paramMap.get("username"),
          paramMap.get("age"));
        return "ok";
    }

    @ResponseBody
    @RequestMapping("/request-param")
    private String modelAttributeV1(@ModelAttribute HelloData helloData) {
        /* HelloData 모델 객체가 생성되고 파라미터의 값을 바인딩해준다.*/
        log.info("HelloData = {}",helloData);
        return "ok";
    }

    @ResponseBody
    @RequestMapping("/request-param")
    private String modelAttributeV2(HelloData helloData) {
        /* HelloData 모델 객체가 생성되고 파라미터의 값을 바인딩해준다.*/

        log.info("HelloData = {}",helloData);
        return "ok";
    }
}

• request.getParameter는 단순히 HttpServletRequest가 제공하는 방식으로 요청 파라미터를 조회할 수 있다.
• @RequestParam 어노테이션은 요청 파라미터를 편리하게 조회 할수 있게 한다.
  • 요청 파라미터를 매개 변수에 자동으로 할당해준다.
  • @RequestParam("username") String memberName과 같이 key 값을 지정해주면 매개 변수의 네이밍은 직접 지정할수 있다.
  • @RequestParam(required = true, defaultValue = "guest") String username
  • @RequestParam(required = true, defaultValue = "-1") int age
  • 위 예시와 같이 required 값으로 필수 파라미터를 지정할수 있으며, null과 비어있는 데이터 파라미터를 방지하기 위해 기본 값을 지정 할수 있다.
• 파라미터가 String, int 등 기본형 이라면, @RequestParam을 생략하고 key 값과 같은 매개 변수명으로 데이터를 받을 수 있다.
• @RequestParam 어노테이션은 Map 형식으로도 데이터를 받을수 있다.
• @ModelAttribute 어노테이션은 객체에 파라미터 값을 바인딩 해준다.
  • HelloData 클래스는 username과 age를 필드 맴버로 가지고 있다고 가정하고 setter, getter와 필요한 생성자가 있다고 가정한다.
  • @ModelAttribute는 생략 가능하다. 요청 파라미터와 매칭되는 필드 맴버가 있다면 자동으로 바인딩 해준다.
    1. HelloData 객체를 생성한다.
    2. 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 바인딩 한다.
    3. ex) username -> steUsername()
• @ModelAttribute과 @RequestParam 둘다 생략 가능하다. 어떤 기능이 우선 순위가 될까?
  • String, int, Integer와 같은 단순 기본형 타입일때는 @RequestParam이 우선으로 적용된다.
  • 나머지, 객체등 @ModelAttribute가 적용된다.

---

📒 HTTP 요청 메세지에 대한 데이터 조회

---

📌 HTTP Message Body

• HTTP API에서 주로 사용된다. 주로 사용되는 데이터 방식은 JSON으로 JSON 데이터를 받는 경우만 정리 하였다.
• POST, PUT, PATCH에 적용된다.
• 요청 파라미터와 다르게 HTTP 메세지 바디로 데이터가 넘어오는 경우 @RequestParam과 @ModelAttribute를 사용할 수 없다.(HTML Form 형식으로 전달되는 경우 제외)
• raw, JSON, content-type: application/json
{"username":"Lee", "age":20} 와 같이 JSON 타입의 데이터가 요청 메세지로 들어 온다고 가정한다

@Controller
@Slf4j
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 data = objectMapper.readValue(messageBody, HelloData.class);
        log.info("username={}, age={}", data.getUsername(), data.getAge());
        response.getWriter().write("ok");
    }

    @ResponseBody
    @PostMapping("/request-body-json-v2")
    public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {

        log.info("messageBody = {}", messageBody);
        HelloData data = objectMapper.readValue(messageBody, HelloData.class);
        log.info("username={}, age={}", data.getUsername(), data.getAge());
        return "ok";
    }

    @ResponseBody
    @PostMapping("/request-body-json-v3")
    public String requestBodyJsonV3(@RequestBody HelloData helloData) {

        log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
        return "ok";
    }

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

• InputStream, OutputStream을 활용하여 String타입의 단순 메세지 바디의 내용을 조회하고 결과를 출력 할수도 있으며 HttpServletRequest request, HttpServletResponse response를 활용하여 데이터를 받아 ObjectMapper로 맵핑하여 JSON 타입의 데이터를 객체에 적용 할 수 있다.
• @RequestBody를 사용하여 HTTP 메세지에서 데이터를 꺼내고 ObjectMapper를 사용하여 자바 객체로 맵핑 한다.
• @RequestBody를 사용하여 직접 객체에 매개 변수로 지정하면, 별도의 맵핑이 필요 없이 데이터를 담을수 있다.(HelloData)
• HttpEntity를 활용하여 HTTP Header,Body를 조회할 수 있다.
  • HttpEntity를 상속 받은 RequestEntity와 ResponseEntity도 사용 가능하다.
• HttpEntity와 @RequestBody는 HTTP 메세지 컨버터가 HTTP 메세지 바디의 내용을 원하는 문자나 객체로 변환 해 준다. 문자 뿐만 아니라 JSON 타입의 객체로 변환도 지원한다.

---

📒 HTTP API 메세지 바디에 직접 응답

---

📌 HTTP Response Body

• HTTP API를 제공하는 경우 데이터를 전달 해야 하므로, HTTP 메세지 바디에 JSON 데이터와 같은 형식으로 데이터를 응답한다. 단순 String 타입의 데이터도 응답 가능하다.

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

• HttpServletResponse객체를 통해 HTTP 메세지 바디에 직접 응답 메세지를 전달 할수 있다.
• ResponseEntity는 HttpEntity를 상속 받아 HTTP 메세지의 헤더와 바디 정보를 가지고 있으며, HTTP 응답 코드를 설정하여 반환 할수 있다.
• @ResponseBody를 사용하면 HTTP 메세지 컴버터를 통해 HTTP 메세지를 직접 입력 할수 있으며, ResponseEntity와 동일한 방식으로 동작 한다.
  • ResponseBody에는 응답 코드를 사용 할수 없는데 @ResponseStatus(HttpStatus.OK)와 같은 어노테이션을 이용하여 응답 코드를 설정 할수 있다.
• ResponseEntity를 반환하게 되면 HTTP 메세지 컨버터를 통하여 JSON 형식으로 변환되어 반환한다.

---

HTTP 요청 바디에 대한 처리 과정 정리

• HTTP 메세지 컨버터의 동작과 처리 과정
  
  

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 미디어 타입을 지원하는지 확인.(@RequestMapping 의 produces 값)
    • ex) text/plain , application/json , */*
• canWrite 메소드 조건을 만족하면 write() 를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.