postman에 해당되는 글 1건

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 5

Spring 정리 2021. 9. 27. 13:17

인프런 강의 23일차.

 - 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 1 (김영한 강사님)

 

1. Http요청 데이터 - 개요

 - HTTP 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달하는 방법

 - 주로 3가지의 방법으로 사용

 

1.1 GET - 쿼리 파라미터

 - /url=?username=hello&age=20

 - 메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 표현해서 전달

 - 예) 검색, 필터, 페이징등에서 많이 사용하는 방식

 

1.2. POST - HTML form

 - content-type : application/x-www-form-urlencoded

 - 메시지 바디에 쿼리 파라미터 형식으로 전달, username=hello&age=20

 - 예) 회원가입, 상품주문, HTML Form 사용

 

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

 - HTTP API에서 주로 사용, JSON, XML, TEXT

 - 데이터 형식은 주로 JSON 사용

 - POST, PUT, PATCH

 

2. HTTP 요청 데이터 - GET 쿼리 파라미터

 - 전달 데이터

   : username=hello

   : age=20

 - 메시지 바디 없이, URL의 '쿼리 파라미터'를 사용해서 데이터를 전달하다

  ex) 검색, 필터, 페이징등에서 많이 사용하는 방식

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

 - http://localhost:8080/request-param?username=hello&age=20

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

 

protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        System.out.println("[전체 파라미터 조회] - start");
        request.getParameterNames().asIterator()
                .forEachRemaining(paramName -> System.out.println(paramName + "=" + request.getParameter(paramName)));
        Enumeration<String> parameterNames = request.getParameterNames();
        System.out.println("[전체 파라미터 조회] - end");

        System.out.println("[단일 파라미터 조회] - start");
        //username=hello&age=20
        String username = request.getParameter("username");
        String age = request.getParameter("age");
        System.out.println("username = " + username);
        System.out.println("age = "+ age);
        System.out.println("[단일 파라미터 조회] - end");

        //username=hello&age=20&username=hello2
        System.out.println("[이름이 같은 복수 파라미터 조회] - start");
        String[] usernames = request.getParameterValues("username");
        for (String name : usernames) {
            System.out.println("username = "+name);
        }
        //아래와 같은 형태로 출력된다.
        //username = hello
        //username = hello2
        //만약 username에 2개 이상의 값이 할당된 상태에서 getParameter를 할 시 내부 우선순위에 의해 1개만 선택되어 표시된다.
        //다만, 중복으로 보내는 경우는 거의 없다.
        System.out.println("[이름이 같은 복수 파라미터 조회] - start");

    }

 

3. HTTP 요청 데이터 - POST HTML Form

 - 이번에는 HTML Form을 사용해서 클라이언트에서 서버로 데이터를 전송해보자.

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

 - content-type: 'application/x-www-form-urlencoded'

 - 메시지 바디에 쿼리 파라미터 형식으로 데이터를 전달한다. 'username=hello&age=20'

<!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>

 - 해당 form에서 submit 시 GET방식에서 사용한 메소드를 호출하는 것을 볼 수 있다.

 - POST의 HTML form을 전송하면 웹 브라우저는 다음 형식으로 HTTP 메시지를 만든다. (개발자 모드 확인)

 - 요청 URL : http://localhost:8080/request-param

 - content-type : application/x-www-form-urlencoded

 - message body : username=hello&age=20

 - application/x-www-form-urlencoded 형식은 앞서 GET에서 살펴본 쿼리 파라미터 형식과 같다. 따라서 '쿼리 파라미터 조회 메소드를 그대로 사용'하면 된다.

 - 클라이언트 입장에서는 두 방식에 차이가 있지만, 서버 입장에서는 둘의 형식이 동일하므로 request.getParameter()로 편리하게 구분 없이 조회할 수 있다.

 - 정리하면 request.getParameter()는 GET URL 쿼리 파라미터 형식도 지원하고, POST HTML Form 형식도 둘 다 지원한다.

 

 * 참고

 - content-type은 HTTP 메시지 바디의 데이터 형식을 지원한다.

 - GET URL 쿼리 파라미터 형식으로 클라이언트에서 서버로 데이터를 전달할 때는 HTTP 메시지 바디를 사용하지 않기 때문에 content-type이 없다.

 - POST HTML Form 형식으로 데이터를 전달하면 HTTP 메시지 바디에 해당 데이터를 포함해서 보내기 때문에 바디에 포함된 데이터가 어떤 형식인지 content-type을 꼭 지정해야 한다. 이렇게 폼으로 데이터를 전송하는 형식을 application/x-www-form-urlencoded라 한다.

 

 * postman을 사용한 테스트

 - 간단한 테스트에 html form을 만들기는 귀찮으므로 postman을 사용하여 테스트 수행.

 - POST 전송 시 body 및 Header가 x-www-form-urlencoded로 선택되었는지 확인!

 

4. HTTP 요청 데이터 - API 메시지 바디 - 단순 텍스트

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

   : HTTP API에서 주로 사용, JSON, XML, TEXT

   : 데이터 형식은 주로 JSON 사용

   : POST, PUT, PATCH

 - 먼저 가장 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송하고, 읽어보자

 - HTTP 메시지 바디의 데이터를 InputStream을 사용해서 직접 읽을 수 있다.

package hello.servlet.basic.request;

import org.springframework.util.StreamUtils;

import javax.servlet.ServletException;
import javax.servlet.ServletInputStream;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

@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을 사용하여 테스트해보자.

 

* 참고

 - inputStrream은 byte를 반환하므로 string으로 변환해줘야한다.

 - POST http://localhost:8080/request-body-string

 - content-type : text/plain

 - message-body : hello

 - 결과 : message-body : hello

 

5. HTTP 요청 데이터 - API 메시지 바디 - JSON

 - HTTP API에서 주로 사용하는 것은 JSON 형식

 

* JSON 형식 전송

 - POST http://localhost:8080/request-body-json

 - content-type : application/json

 - message-body : {"username" : "hello", "age" : 20}

 - 결과 : message-body : {"username" : "hello", "age" : 20}

 

* JSON 형식 파싱 추가

 - JSON형식으로 파싱할 수 있게 객체 생성

 - POST http://localhost:8080/request-body-json

 - content-type : application/json

 - message-body : {"username" : "hello", "age" : 20}

 - 결과 : message-body : {"username" : "hello", "age" : 20}

package hello.servlet.basic;

import lombok.Getter;
import lombok.Setter;

@Getter @Setter
public class HelloData {

    private String username;
    private int age;

    /*
    //프로젝트 세팅 때 Lombok 세팅을 해두었으므로 @Getter, @Setter 선언으로 아래 코드가 자동생성된다.
    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
     */
}

 

package hello.servlet.basic.request;

import com.fasterxml.jackson.databind.ObjectMapper;
import hello.servlet.basic.HelloData;
import org.springframework.util.StreamUtils;

import javax.servlet.ServletException;
import javax.servlet.ServletInputStream;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

@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.username = "+helloData.getUsername());
        System.out.println("helloData.age = "+helloData.getAge());
    }
}

- JSON 결과를 파싱해서 사용할 수 있는 자바 객체로 변환하려면 Jackson, Gson과 같은 JSON 변환 라이브러리를 추가해서 사용해야 한다. 스프링부트로 SpringMVC를 선택하면 기본으로 Jackson 라이브러리(ObjectMapper)를 함께 제공한다.

 - HTML form 데이터도 메시지 바디를 통해 전송되므로 직접 읽을 수 있다. 하지만 편리한 파라미터 조회 기능(request.getParameter...)를 이미 제공하므로 해당 조회 기능을 사용하면 된다.

 

 

 

'Spring 정리' 카테고리의 다른 글

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 7  (0) 2021.10.05
스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 6  (0) 2021.09.30
스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 4  (0) 2021.08.30
스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 3  (0) 2021.08.25
스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 2  (0) 2021.08.19
,
1

티스토리툴바