[spring] HTTP 요청 데이터

🌳 HTTP 요청 데이터

클라이언트에서 서버로 HTTP 요청 메세지를 통해 데이터를 전달하는 방법은 크게 3가지 방법을 사용한다.

1️⃣ GET- 쿼리 파라미터

/url?username=hello&age=20
메세지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달한다.

2️⃣ POST - HTML Form

content-type : application/x-www-form-urlencoded
메세지 바디에 쿼리 파라미터 형식으로 전달 username=hello&age=20 한다.

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

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

위의 3가지 방법으로 전달 받은 데이터를 서버에서 어떻게 조회하여 사용할 수 있는지 알아보자.

🌿 GET - 쿼리 파라미터

전달 데이터가 아래와 같다고 해보자.
- username=hello
- age=20
메세지 바디 없이 URL 의 쿼리 파라미터를 사용해서 데이터를 전달 할 수 있다.
보통 이러한 방법은 검색, 필터, 페이징 등에서 많이 사용한다.

cf. 쿼리 파라미터는 URL 에 다음과 같이 ?를 시작으로 보낼 수 있다. 추가 파라미터가 있다면 & 로 구분할 수 있다.

예시 ) localhost:8080/search/sale/price?low=10000&high=50000

서버는 HttpServletRequest 가 제공하는 메서드를 통해 쿼리 파라미터를 편리하게 조회할 수 있다.

String username = request.getParameter("username"); //단일 파라미터 조회 
Enumeration<String> parameterNames = request.getParameterNames(); //파라미터 이름들 모두 조회
Map<String, String[]> parameterMap = request.getParameterMap(); //파라미터를 Map 으로 조회
String[] usernames = request.getParameterValues("username"); //복수 파라미터 조회

만약 이름이 같은 복수 파라미터를 조회해야 한다면 아래와 같이 조회할 수 있다.

String[] usernames = request.getParameterValues("userName");

❓ username=hello&username=kim 과 같이 파라미터 이름은 하나인데 값이 중복이면 어떻게 조회해 볼 수 있을까?

request.getParameter()는 하나의 파라미터 이름에 대해서 단 하나의 값만 있을 사용해야하고
지금처럼 중복일 경우 request.getParameterValues()를 사용해야 한다.

🌿 POST - HTML Form

HTML의 Form 을 통하여 데이터를 서버로 전송할 수 있다.

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<form action="/request-param" method="post">
    username: <input type="text" name="username" /> 
    age: <input type="text" name="age" /> 
    <button type="submit">전송</button>
</form>
</body>
</html>

주로 회원 가입, 상품 주문 등에서 사용하는 방식이다.

POST의 HTML Form 을 전송하면 웹 브라우저는 왼쪽 그림과 같이 HTTP 메세지를 만든다.
이때 Content-type 이 application/x-www-form-urlencoded 형식인데
이 형식은 GET에서 살펴본 쿼리 파라미터 형식과 같기 때문에 쿼리 파라미터 조회 메서드를 그대로 사용할 수 있다.
클라이언트의 입장에서는 두 방식에 차이가 존재하지만, 서버에서는 둘의 형식이 동일하기 때문에
request.getParameter() 로 조회가 가능하다.

cf. content-type 은 HTTP 메세지 바디의 데이터 형식을 지정한다.

때문에 body가 존재한다면 바디에 포함된 데이터가 어떤 형식인지 꼭 지정해주어야 한다.
폼으로 데이터를 전송하는 형식을 application/x-www-form-urlencoded 라고 한다.

🌿 API 메세지 바디

HTTP API 에서 주로 사용하는 방식으로 개발자가 HTTP message body 에 직접 데이터를 담아 요청한다.
JSON, XML, TEXT가 주로 사용되는 형식인데, 최근에는 JSON이 많이 사용된다.

💡 단순 텍스트

postman을 사용하여 확인해보자.

content-type = text/plain , message body = row - text 로 설정

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

실행결과

HTTP message body 는 InputStream 을 사용하여 직접 읽을 수 있다.
inputStream 은 byte 코드를 반환하는데 byte 코드는 우리가 읽을 수 없기 때문에 문자(String) 로 보려면
문자표(Charset)를 지정해주어야 한다.

💡 JSON

postman 을 사용하여 확인해보자.

HTTP API에서 주로 사용되는 JSON 형식으로 데이터를 전달할 때
JSON 형식을 사용할 때에는 해당 데이터를 파싱해서 객체화 시켜줄 객체를 만들어야 한다.

@Getter
@Setter
@ToString
public class HelloData {
    private String username;
    private int age;
}

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

        System.out.println("messageBody = " + messageBody);

        HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
        System.out.println("helloData = " + helloData.getUsername());
        System.out.println("helloData = " + helloData.getAge());

        response.getWriter().write("ok");
    }
}