[개발] - Spring/MVC 1

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

완벽한 장면 2023. 9. 20. 00:13

API 메시지 바디 - JSON

JSON 형식 전송

 

JSON 형식 파싱 추가

HelloData

@Getter @Setter
public class HelloData {

  private String username;
  private int age;

}

 

Jackson 라이브러리 사용 ObjectMapper

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

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

 

RequestBodyJsonServlet

@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 {
        // HTTP 요청의 입력 스트림을 얻어온다.
        ServletInputStream inputStream = request.getInputStream();

        // 입력 스트림에서 본문(body) 내용을 문자열로 읽어온다..
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

        // 읽어온 JSON 문자열을 출력.
        System.out.println("messageBody = " + messageBody);

        // ObjectMapper를 사용하여 JSON 문자열을 Java 객체로 변환.
        HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);

        // 변환된 객체의 내용을 출력.
        System.out.println("helloData.username = " + helloData.getUsername());
        System.out.println("helloData.age = " + helloData.getAge());

        // HTTP 응답에 "ok"라는 메시지를 작성하여 클라이언트에게 응답을 보낸다.
        response.getWriter().write("ok");
    }
}



- @WebServlet 어노테이션을 사용하여 /request-body-json 경로로 들어오는 HTTP 요청을 처리하는 서블릿을 정의.
- ObjectMapper 객체를 생성하여 JSON 데이터를 Java 객체로 변환하는데 사용.

  (Jackson 라이브러리의 ObjectMapper 클래스는 JSON과 Java 객체 간의 변환을 지원.)

- service 메서드에서는 HTTP 요청 (HttpServletRequest)과 HTTP 응답 (HttpServletResponse)을 처리.

- request.getInputStream()을 사용하여 HTTP 요청의 입력 스트림을 얻어온다.

- 이 입력 스트림은 HTTP 요청의 본문(body)을 읽어오는 데 사용된다.

- StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8)를 호출하여 입력 스트림에서 본문 내용을 문자열로 읽는다.

(StandardCharsets.UTF_8은 문자열 인코딩을 의미.)

- 읽어온 JSON 문자열을 ObjectMapper를 사용하여 HelloData 클래스로 변환.

  (이 클래스는 JSON 데이터의 구조를 반영하는 Java 객체여야 합니다.)

- 변환된 HelloData 객체의 내용을 출력하고.
- 마지막으로 HTTP 응답에 "ok"라는 메시지를 작성하여 클라이언트에게 응답을 보낸다.

 

정리하자면
- 이 서블릿은 클라이언트가 POST 방식으로 JSON 데이터를 전송할 때, 그 데이터를 읽어와서 Java 객체로 변환하고 해당 객체의 내용을 출력하는 코드.

 

cf. 스프링 MVC가 제공하는 극한의 기능들을 활용하려면

@Override
    protected void service(HelloData helloData) throws ServletException, IOException { } 

이렇게 쓸 수도 있다.

 


 

Postman에서 데이터 보내기

실행 결과 콘솔에서 확인해보면

023-08-29 15:48:20.672 DEBUG 14692 --- [nio-8080-exec-1] o.a.coyote.http11.Http11InputBuffer      : Before fill(): parsingHeader: [true], parsingRequestLine: [true], parsingRequestLinePhase: [0], parsingRequestLineStart: [0], byteBuffer.position(): [0], byteBuffer.limit(): [0], end: [271]
2023-08-29 15:48:20.672 DEBUG 14692 --- [nio-8080-exec-1] o.a.coyote.http11.Http11InputBuffer      : Received []
2023-08-29 15:48:20.672 DEBUG 14692 --- [nio-8080-exec-1] o.apache.coyote.http11.Http11Processor   : Socket: [org.apache.tomcat.util.net.NioEndpoint$NioSocketWrapper@657c7b0e:org.apache.tomcat.util.net.NioChannel@46a28d0c:java.nio.channels.SocketChannel[connected local=/0:0:0:0:0:0:0:1:8080 remote=/0:0:0:0:0:0:0:1:51189]], Status in: [OPEN_READ], State out: [OPEN]
2023-08-29 15:48:28.916 DEBUG 14692 --- [nio-8080-exec-2] o.a.coyote.http11.Http11InputBuffer      : Before fill(): parsingHeader: [true], parsingRequestLine: [true], parsingRequestLinePhase: [0], parsingRequestLineStart: [0], byteBuffer.position(): [0], byteBuffer.limit(): [0], end: [271]
2023-08-29 15:48:28.916 DEBUG 14692 --- [nio-8080-exec-2] o.a.coyote.http11.Http11InputBuffer      : Received [POST /request-body-json HTTP/1.1
Content-Type: application/json
User-Agent: PostmanRuntime/7.32.3
Accept: */*
Postman-Token: 3b854157-11e8-45a0-9783-e4de0403a4c6
Host: localhost:8080
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 47

{
    "username" : "hello",
    "age" : 20
}]
messageBody = {
    "username" : "hello",
    "age" : 20
}
helloData.username = hello
helloData.age = 20
2023-08-29 15:48:28.918 DEBUG 14692 --- [nio-8080-exec-2] o.a.coyote.http11.Http11InputBuffer      : Before fill(): parsingHeader: [true], parsingRequestLine: [true], parsingRequestLinePhase: [0], parsingRequestLineStart: [0], byteBuffer.position(): [0], byteBuffer.limit(): [0], end: [271]
2023-08-29 15:48:28.918 DEBUG 14692 --- [nio-8080-exec-2] o.a.coyote.http11.Http11InputBuffer      : Received []
2023-08-29 15:48:28.918 DEBUG 14692 --- [nio-8080-exec-2] o.apache.coyote.http11.Http11Processor   : Socket: [org.apache.tomcat.util.net.NioEndpoint$NioSocketWrapper@657c7b0e:org.apache.tomcat.util.net.NioChannel@46a28d0c:java.nio.channels.SocketChannel[connected local=/0:0:0:0:0:0:0:1:8080 remote=/0:0:0:0:0:0:0:1:51189]], Status in: [OPEN_READ], State out: [OPEN]

messageBody = {
    "username" : "hello",
    "age" : 20
}

이걸 확인할 수 있음.

 

 

- JSON 형식은 아니므로 파싱이 안 되기 때문에 오류는 난다.

 

 

 

728x90
반응형