HTTP 요청 데이터
지난 번엔 'HttpServletRequest' 객체에 대해 공부하면서 HTTP 메시지의 시작 줄, 헤더 등 기본 정보를 조회하는 방법을 알아봤다.
만약 HTTP 메시지와 해당 객체에 대한 내용이 궁금하다면 아래 글들을 참고하면 되겠다.
https://jnsodevelop.tistory.com/40
[Network] HTTP Message
HTTP Message 'HTTP Message' 는 서버와 클라이언트 간 데이터가 교환되는 방식이다. 메시지 타입엔 두 가지가 있다. 요청 (Request) : 클라이언트가 서버로 데이터를 전달하여 필요한 동작을 요청한다. 응
jnsodevelop.tistory.com
https://jnsodevelop.tistory.com/72
[Servlet] HttpServletRequest
HttpServletRequest 객체를 알아보기 전에 '서블릿(Servlet)' 에 대해 알고 있다면 이해하기 쉬울 것이다. 아래 글을 먼저 읽고 오는 것을 추천한다. https://jnsodevelop.tistory.com/66 [Servlet] 서블릿(Servlet) 1. 서
jnsodevelop.tistory.com
이번엔 단순히 HTTP 메시지에 대한 정보를 조회하는 것을 넘어, 메시지에 담긴 요청 데이터 조회 방법을 공부했다. 클라이언트 측은 HTTP 메시지를 통해 서버 측으로 데이터를 전달할 수 있다. 이렇게 데이터를 전달하는 방법엔 몇 가지가 있는데, 대표적인 3가지 방식을 소개한다.
- GET - 쿼리 파라미터 (Query Parameter)
- POST - HTML Form
- Http Message Body
1️⃣ GET - 쿼리 파라미터 (Query Prameter)
- 검색, 필터, 페이징 등에서 자주 사용하는 방식 (GET)
- HTTP 메시지 바디가 아닌, URL의 '쿼리 파라미터'에 데이터를 포함하여 직접적으로 전달하는 방식
- URL에 '?' 기호를 쿼리 파라미터의 시작점으로, '&' 기호를 각 파라미터의 구분점으로 사용
- http://url/?name1=param1&name2=param2&name3=param3... 형식
- ex) http://localhost8080/query-param?name=gildong&nation=korea
다음은 쿼리 파라미터를 조회할 수 있는 메서드이다. 이는 'HttpServletRequest' 를 통해 사용할 수 있다.
여기서 'request' 는 HttpServletRequest 를 말한다.
// 단일 파라미터 조회
String name = request.getParameter("파라미터 이름");
// 복수 파라미터 조회
String[] names = request.getParameterValues("파라미터 이름");
// 모든 파라미터 이름 조회 - 1
Enumeration<String> parameterNames = request.getParameterNames();
// 모든 파라미터 이름 조회 - 2
request.getParameterNames().asIterator()
.forEachRemaining(paramName -> System.out.println(request.getParameter(paramName)));
// Map으로 조회
Map<String, String[]> parameterMap = request.getParameterMap();
Postman 을 통해 요청 데이터를 확인해보자. 이 때 사용된 자바 코드는 아래와 같다.
@WebServlet(name = "requestParamServlet", urlPatterns = "/request-param")
public class RequestParamServlet extends HttpServlet {
@Override
protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
System.out.println("=========");
System.out.println("name = " + request.getParameter("name"));
System.out.println("nation = " + request.getParameter("nation"));
System.out.println("=========");
response.getWriter().write("ok");
}
}
1. GET
먼저 GET 방식으로 http://localhost:8080?name=junseo&nation=korea 에 요청을 보냈다.
2. POST
다음은 POST 방식으로 같은 주소로 요청을 보냈다.
GET, POST 방식 모두 같은 결과가 나왔다. 여기서 알 수 있는 점은 쿼리 파라미터 방식은 클라이언트가 URL에 데이터를 넣어 서버로 전달한다는 것이다. 따라서 특정 조건을 조회하는 방법, 특정 데이터를 전송하는 방법인 GET, POST 방식 모두 결과가 동일한 것이다. 그럼에도 검색, 필터 등 GET 방식에 많이 사용되기 때문에 'GET 쿼리 파라미터'라고 명칭한 것이다.
2️⃣ POST - HTML Form
- 회원 가입, 상품 주문 등에서 자주 사용하는 방식 (POST)
- 쿼리 파라미터와는 달리 URL이 아닌 '메시지 바디' 에 쿼리 파라미터 형식으로 데이터를 전달하는 방식
- HTML의 Form 을 통해 데이터를 전송
- content-type : application/x-www-form-urlencoded
- 쿼리 파라미터 형식과 같기 때문에 데이터 조회 방법 또한 같음
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<form action="/request-param" method="post">
name: <input type="text" name="name"/>
nation: <input type="text" name="nation"/>
<button type="submit">전송</button>
</form>
</body>
</html>@WebServlet(name = "requestParamServlet", urlPatterns = "/request-param")
public class RequestParamServlet extends HttpServlet {
@Override
protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
System.out.println("=========");
System.out.println("name = " + request.getParameter("name"));
System.out.println("nation = " + request.getParameter("nation"));
System.out.println("=========");
response.getWriter().write("ok");
}
}
자바 코드를 보면 위 쿼리 파라미터 때와 같다. 여기서 알 수 있는 사실은 HTML Form 을 통해 전달된 데이터는 메시지 바디에 쿼리 파라미터 형식으로 들어가기 때문에 조회 방법 역시 같다는 것이다.
하지만 이렇게 HTML 코드를 작성하고 확인하는 것은 귀찮기 때문에 Postman으로 간단하게 테스트할 수 있다.
대신 메시지 바디에 데이터를 넣어야 하기 때문에 꼭 Body에서 'x-www-form-urlencoded'형식을 선택해야 한다. 또한 쿼리 파라미터 방식과 동일하게 key, value를 각각 넣어주면 된다.
3️⃣ 쿼리 파라미터 vs HTML Form
쿼리 파라미터 방식과 HTML Form 방식에서 데이터를 조회하는 방법은 같다고 했다. 그 이유는 쿼리 파라미터의 형식과 HTML Form 방식에서의 content-type인 'application/x-www-form-urlencoded'의 형식이 같기 때문이다. 실제로 클라이언트가 서버에 데이터를 전달할 때 URL을 사용하는지, HTML Form을 사용하는지의 차이는 있지만 결국 서버 입장에서는 같은 형태의 데이터를 받게 된다.
차이점 또한 존재하는데, 아래 사진을 보자. 첫 번째 사진은 쿼리 파라미터로 데이터를 전달했을 때 개발자 도구로 요청 헤더를 확인한 것이다. 두 번째 사진은 HTML Form으로 전달했을 때 요청 헤더를 확인한 것이다.
쿼리 파라미터 방식은 메시지 바디가 아닌 URL로 전달하기 때문에 HTTP 메시지 바디에 대한 내용이 없다. 즉, content-type이 포함되어있지 않다.
HTML Form 방식은 HTTP 메시지 바디에 데이터를 포함해 전송하기 때문에 어떠한 형식인지를 나타내는 content-type, content-length 등이 존재한다.
| GET - 쿼리 파라미터 | POST - HTML Form | |
| 자주 사용되는 HTTP 메서드 | GET | POST |
| 데이터 위치 | URL | HTTP 메시지 바디 |
| 데이터 형식 | ?key1=value1&key2=value2 | application/x-www-form-urlencoded |
| 단일 데이터 조회 | request.getParameter("파라미터 이름"); | |
4️⃣ HTTP Message Body
- HTTP API에서 주로 사용하는 방식
- JSON, XML, TEXT 등 여러 데이터 형식을 지원하지만, 주로 JSON 사용
- POST, PUT, PATCH
- content-type : text/plain, application/json 등
1. TEXT
- POST http://localhost:8080/request-body-string
- content-type : text/plain
텍스트 메시지를 HTTP 메시지 바디에 담아 전송할 수 있다. 그리고 이러한 데이터를 읽기 위해선 'InputStream'을 사용해야 한다. 여기서 InputStream은 byte 코드를 반환하는데, 인코딩 방식을 지정해주어야 한다. 즉, byte 코드를 우리가 읽을 수 있는 문자로 변환하기 위해 문자표(Charset)을 지정해야 한다. 인코딩 방식은 주로 'UTF-8' 방식을 사용한다.
@WebServlet(name = "requestBodyStringServlet", urlPatterns = "/request-body-string")
public class RequestBodyStringServlet extends HttpServlet {
@Override
protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
ServletInputStream inputStream = request.getInputStream();
String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
System.out.println("messageBody = " + messageBody);
response.getWriter().write("ok");
}
}
역시 Postman 을 통해 테스트하자. 여기선 데이터 형식을 'raw-text'로 설정해야 한다.
2. JSON
- POST http://localhost:8080/request-body-json
- content-type : application/json
- 예시) {"name": "junseo", "nation": "korea"}
JSON 데이터를 자바에서 사용하려면 기본적으로 파싱을 해줘야 한다. 이 때 'Jackson', 'Gson' 같은 JSON 변환 라이브러리를 사용할 수 있다. 만약 Spring boot 설정시 'Spring MVC'를 선택하면 Jackson 라이브러리를 기본적으로 사용할 수 있다. 우선 요청 데이터를 받아올 수 있도록 Java14부터 지원하는 'Record'객체를 하나 생성하자.
public record TestData(String name, String nation) {
}
다음으로 JSON 데이터를 'TestData'로 파싱할 수 있도록 코드를 작성하자. 역시 인코딩 형식(UTF-8)을 설정한다.
@WebServlet(name = "requestBodyJsonServlet", urlPatterns = "/request-body-json")
public class RequestBodyJsonServlet extends HttpServlet {
private ObjectMapper objectMapper = new ObjectMapper();
@Override
protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
ServletInputStream inputStream = request.getInputStream();
String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
TestData testData = objectMapper.readValue(messageBody, TestData.class);
System.out.println("testData.name() = " + testData.name());
System.out.println("testData.nation() = " + testData.nation());
response.getWriter().write("ok");
}
}
