[Spring] HttpEntity와 x-www-form-urlencoded이란? 폼 전송시 코드 살펴보기.

 

 

ContentType을
x-www-form-urlencoded로
명시했더니,
HttpEntity에 담아 보냈다.
무슨 관계가 있는 걸까?

 

 

 

 

 

 

HttpEntity

• 헤더와 바디로 이뤄진 HTTP request, response 엔티티를 나타낸다.
• 쉽게 설명하자면, HttpEntity는 Http 요청/응답의 헤더+바디를 묶는 상자와 같아서 헤더와 바디를 함께 보내야 할 때 사용한다.
• 형제 타입으로는 RequestEntity<T>(요청전용, HTTP 메서드/URL까지 포함)와 ResponseEntity<T>(응답전용, 상태코드까지 포함)가 있다.
• HttpEntity는 상태 코드가 없으나 HttpStatus의 상태 코드를 더할 수 있다.
• HttpEntity는 요청/응답 양쪽에서 사용 가능하다. 

 

 

 

x-www-form-urlencoded

• html form을 통한 POST 전송 방식 중 가장 기본이 되는 ContentType이다.
• 보내는 데이터를 url 인코딩 후 웹 서버에 보내는 방식이다.
• 모든 브라우저는 application/x-www-form-urlencoded content-type에 대해 body의 데이터를 자동으로 encoding 하도록 구현되어있다.
• 만약 애플리케이션 로직에서 해당타입으로 POST 요청을 보낼 때는 body에 대한 인코딩이 되는지 여부를 확인해야 한다.
• 인코딩이 필요하기 때문에 크기가 큰 데이터에 적합하지 않다.
• x-www-form-urlencoded의 인코딩 규칙은 key=value 형식이며, 여러 개의 key-value 쌍은 '&'로 구분되며 여러 데이터를 한 번에 전송 가능하다.
• 데이터의 특수 문자나 공백과 같은 부분이 url 인코딩 규칙[RFC1738]에 따라 인코딩 된다.

 

 

 

---

 

 

 

 

 

x-www-form-urlencoded와 HttpEntity 코드 예시

HttpHeaders tokenHeaders = new HttpHeaders();
tokenHeaders.setContentType(MediaType.APPLICATION_FORM_URLENCODED);

MultiValueMap<String, String> form = new LinkedMultiValueMap<>();
form.add("grant_type", "authorization_code");
...

HttpEntity<MultiValueMap<String, String>> tokenReq = new HttpEntity<>(form, tokenHeaders);

위의 코드는 카카오 간편 로그인을 하면서 작성한 코드 일부이다.

setContentType(MediaType.APPLICATION_FORM_URLENCODED);를 적어, 여기서 Content-Type을 x-www-form-urlencoded로 명시했다. 그리고 마지막 줄을 보면 HttpEntity로 감싼 걸 확인할 수 있다.

그러면 왜 HttpEntity가 와야 하는 걸까?

application/x-www-form-urlencoded는 폼 형식이라는 이름을 가지고 있다. 이 폼 형식은 바디 안에 들어있는 데이터가 키=값&키=값...으로 URL 인코딩 되어 있다는 뜻이다. 그리고 서버에게 "바디가 이렇게 생겼어요"라는 사실을 알려야 하는데, 알리는 방법이 헤더의 ContentType에 "이 바디는 폼 형식입니다"라고 적어줘야 한다. 그래서 x-www-form-urlencoded는 헤더와 바디를 둘 다 보내는 게 중요한 것이다. (헤더로 형식을 알리고, 바디에 데이터도 보내야 하니까!)

위에서 말했듯이 HttpEntity는 바디와 ContentType 헤더를 하나의 세트처럼 묶어서 보낸다.(보통 폼 전송처럼 헤더와 바디를 함께 담는 게 일반적이긴 하나, 헤더나 바디만 담아도 가능하다) 그래서 HttpEntity를 사용하여 깔끔하게 보내기 위함도 있고, 헤더와 바디를 같이 보내기 위함도 있다. 

+) MultiValueMap도 비슷한 이유로  x-www-form-urlencoded와 함께 쓰인다. 아까 바디 안에 들어있는 데이터는 키=값&키=값... 이런 형태라고 했다. 같은 키에 다중 값이 가능한 형태인데, 이런 형태에는 MutiValueMap이 딱 맞다. 왜냐하면 스프링의 FormHttpMessageConverter가 MultiValueMap<String,Stirng>을 정확히 키=값&키=값... 형식으로 URL 인코딩해 직렬화하기 때문이다.

 

 

 

 

---

 

 

 

아래에 출처를 남겨두겠습니다.
블로그엔 제가 최대한 이해한 내용까지만 적는거라
출처에 들어가시면 더 많은 내용이 있어 공부하시는데 도움되실겁니다.

 

🪽

틀린 내용이 있다면 댓글로 알려주세요

 

 

---

 

 

- HttpEntity

[Spring Boot] HttpEntiy, ResponseEntity 란?

 

 

 

- x-www-form-urlencoded

x-www-form-urlencoded 타입이란 (multipart/form-data와의 차이점)

 

 

 

- x-www-form-urlencoded

[네트워크] application/x-www-form-urlencoded, application/json 무슨 차이가 있는걸까?