HTTP 요청 파라미터

클라이언트에서 서버로 요청 데이터를 전달할 때는 주로 다음 3가지 방법을 사용

• GET - 쿼리 파라미터
  • /url?username=hello&age=20
  • 메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
  • 예) 검색, 필터, 페이징등에서 많이 사용하는 방식
• POST - HTML Form
  • content-type: application/x-www-form-urlencoded
  • 메시지 바디에 쿼리 파리미터 형식으로 전달 username=hello&age=20
  • 예) 회원 가입, 상품 주문, HTML Form 사용
• HTTP message body에 데이터를 직접 담아서 요청
  • HTTP API에서 주로 사용, JSON, XML, TEXT
  • 데이터 형식은 주로 JSON 사용
  • POST, PUT, PATCH

---

HTTP 요청 파라미터 - @RequestParam

• @RequestParam : 파라미터 이름으로 바인딩
• @ResponseBody : View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력
• @RequestParam의 name(value) 속성이 파라미터 이름으로 사용
  • @RequestParam("username") String memberName
  • request.getParameter("username")
• HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx") 생략 가능
• String, int 등의 단순 타입이면 @RequestParam 도 생략 가능
• @RequestParam 애노테이션을 생략하면 스프링 MVC는 내부에서 required=false 를 적용

@RequestParam.required

• 파라미터 필수 여부
• 기본값이 파라미터 필수( true ) 임

/request-param 요청

• username 이 없으므로 400 예외가 발생함

주의! - 파라미터 이름만 사용

• /request-param?username=
• 파라미터 이름만 있고 값이 없는 경우, 빈문자로 통과

주의! - 기본형(primitive)에 null 입력

• /request-param 요청
• @RequestParam(required = false) int age
• null 을 int 에 입력하는 것은 불가능(500 예외 발생)
• 따라서 null 을 받을 수 있는 Integer 로 변경하거나, defaultValue 사용

파라미터를 Map, MultiValueMap으로 조회가능

• @RequestParam Map ,
  • Map(key=value)
• @RequestParam MultiValueMap
  • MultiValueMap(key=[value1, value2, ...] ex) (key=userIds, value=[id1, id2])
• 파라미터의 값이 1개가 확실하다면 Map 을 사용해도 되지만, 그렇지 않다면 MultiValueMap 을 사용

HTTP 요청 파라미터 - @ModelAttribute

• @ModelAttribute는 객체를 생성하고, 요청 파라미터 이름으로 객체 프로퍼티의 setter를 호출해서 값을 바인딩 함
  • 파라미터가 username이면 setUsername() 메소드를 호출하여 값을 바인딩
• @ModelAttribute 는 생략 가능
  • 그런데 @RequestParam 도 생략할 수 있으니 혼란이 발생할 수 있음
• 스프링은 해당 생략시 다음과 같은 규칙을 적용한다.
  • String , int , Integer 같은 단순 타입 = @RequestParam
  • 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)

    @ModelAttribute HelloData helloData

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

HTTP message body에 데이터를 직접 담아서 요청

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

방법1. HttpServletRequest, HttpServletResponse 사용

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

방법2. InputStream(Reader), OutputStream(Writer) 사용 - Spring MVC에서 지원

public void requestBodyStringV2 (InputStream inputStream, Writer responseWriter) throws IOException 
{
	String messageBody = StreamUtils.copyToString(inputStream,StandardCharsets.UTF_8);
}

방법3. HttpEntity 사용

• HttpEntity: HTTP header, body 정보를 편리하게 조회
  • 메시지 바디 정보를 직접 조회
  • 요청 파라미터를 조회하는 기능과 관계 없음 @RequestParam X, @ModelAttribute X
• HttpEntity는 응답에도 사용 가능
  • 메시지 바디 정보 직접 반환
  • 헤더 정보 포함 가능
  • view 조회X
• HttpEntity 를 상속받은 다음 객체들도 같은 기능을 제공
• RequestEntity
  • HttpMethod, url 정보가 추가, 요청에서 사용
• ResponseEntity
  • HTTP 상태 코드 설정 가능, 응답에서 사용
  • return new ResponseEntity<String>("Hello World", responseHeaders, HttpStatus.CREATED)

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

방법4. @RequestBody, @ResponseBody 사용
@RequestBody

• @RequestBody 를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있음
  • 참고로 헤더 정보가 필요하다면 HttpEntity 를 사용하거나 @RequestHeader 를 사용
• 이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam ,
  @ModelAttribute 와는 전혀 관계가 없다.

@ResponseBody

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

HTTP 요청 메시지 - JSON

방법1. HttpServletRequest를 사용

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

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);
    HelloData data = objectMapper.readValue(messageBody, HelloData.class);
    response.getWriter().write("ok");
}

방법2. @RequestBody 문자 변환

• 문자로 된 JSON 데이터인 messageBody 를 objectMapper 를 통해서 자바 객체로 변환

@ResponseBody
@PostMapping("/request-body-json-v2")
public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {
	HelloData data = objectMapper.readValue(messageBody, HelloData.class);
	return "ok";
}

방법3. @RequestBody 객체 변환

• @RequestBody 에 직접 만든 객체를 지정할 수 있음
• @RequestBody는 생략 불가능, 생략하게 되면 @ModelAttribute로 적용됨

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

방법4. HttpEntity

• 위에 단순 텍스트에서 해본 것 처럼 Json도 HttpEntity로 사용 가능

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

방법5. @ResponseBody를 사용하여 메세지 바디 정보 직접 반환 가능

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