[스프링 MVC 1편] #2. 서블릿 (2) #221

6om1n · 2024-05-10T14:38:57Z

6om1n
May 10, 2024
Maintainer

✏️ HTTP 요청 데이터 - GET 쿼리 파라미터

전달 데이터
- username=hello
- age=20
메시지 바디 없이, URL의 쿼리 파라미터를 사용해서 데이터를 전달한다. -> 검색, 필터, 페이징 등에서 많이 사용하는 방식
쿼리 파라미터는 URL에 ?를 시작으로 보낼 수 있다. 추가 파라미터는 &로 구분한다.
http://localhost:8080/request-param?username=hello&age=20
서버에서 HttpServletRequest 가 제공하는 다음 메서드를 통해서 쿼리 파라미터를 편리하게 조회할 수 있다.

String username = request.getParameter("username"); //단일 파라미터 조회

Enumeration parameterNames = request.getParameterNames(); //파라미터 이름들 모두 조회

Map<String, String[]> parameterMap = request.getParameterMap(); //파라미터를 Map으로 조회

String[] usernames = request.getParameterValues("username"); / /복수 파라미터 조회

RequestParamServlet

package hello.servlet.basic.request;

import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;
import java.util.Enumeration;

/**
 * 1. 파라미터 전송 기능
 * http://localhost:8080/request-param?username=hello&age=20
 * 
 * 2. 동일한 파라미터 전송 가능
 * http://localhost:8080/request-param?username=hello&username=kim&age=20
 *
 */

@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("[전체 파라미터 조회] - start");

        //paramName은 이름을 꺼내는 것 (username, age), request.getParameter(paramName) 은 그 값인 hello, age를 꺼내는 것
        request.getParameterNames().asIterator()
                        .forEachRemaining(paramName -> System.out.println(paramName + "=" + request.getParameter(paramName)));

        System.out.println("[전체 파라미터 조회] - end");
        System.out.println();

        System.out.println("[단일 파라미터 조회]");
        String username = request.getParameter("username");
        String age = request.getParameter("age");

        System.out.println("username = " + username);
        System.out.println("age = " + age);
        System.out.println();

        System.out.println("[이름이 같은 복수 파라미터 조회]");
        String[] usernames = request.getParameterValues("username");
        for (String name : usernames) {
            System.out.println("username = " + name);
        }

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

    }
}

실행 - 파라미터 전송
http://localhost:8080/request-param?username=hello&age=20
결과
실행 - 동일 파라미터 전송
http://localhost:8080/request-param?username=hello&username=kim&age=20
결과

📍 복수 파라미터에서 단일 파라미터 조회

username=hello&username=kim 과 같이 파라미터 이름은 하나인데, 값이 중복일 경우

request.getParameter() 는 하나의 파라미터 이름에 대해서 단 하나의 값만 있을 때 사용한다.

중복일 경우에는 request.getParameterValues() 를 사용한다.

중복인데, request.getParameter() 를 사용하는 경우는 첫 번째 값을 반환한다.

✏️ HTTP 요청 데이터 - POST HTML Form

HTML의 Form을 사용하여 클라이언트에서 서버로 데이터를 전송하자.

특징
- content-type : application/x-www-form-urlencoded
- 메시지 바디에 쿼리 파라미터 형식으로 데이터를 전달한다. username=hello&age=20
src/main/webapp/basic/hello-form.html

 <!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 메시지를 만든다.
- 요청 URL : http://localhost:8080/request-param
- content-type : application/x-www-form-urlencoded
- message body : username=hello&age=20
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 을 사용하여 테스트를 할 수 있다.

POST 전송 시

Body -> x-www-form-urlencoded 선택

Headers 에서 content-type : application/x-www-form-urlencoded 로 지정된 부분을 확인해야한다.

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

HTTP message body 에 데이터를 직접 담아서 요청한다.
HTTP API 에서 주로 사용한다. JSON, XML, TEXT
데이터 형식은 주로 JSON 을 사용한다.
POST, PUT, PATCH 에서 사용

-RequestBodyStringServlet

package hello.servlet.basic.request;

import jakarta.servlet.ServletException;
import jakarta.servlet.ServletInputStream;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.util.StreamUtils;

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(); //메시지 바디의 내용을 byte 코드로 바로 얻을 수 있다.
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8); // byte를 문자로 변환할 때 어떤 인코딩인지 알려줘야한다.

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

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

📍 참고

inputStream 은 byte 코드를 반환한다. byte 코드를 우리가 읽을 수 있는 문자 (String)로 보려면 Charset 을 지정해주어야 한다.

문자 전송
- POST : http://localhost:8080/request-body-string
- content-type : text/plain
- message body : hello
- 결과: messagebody = hello

✏️ 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}`
hello.servlet.basic.HelloData

package hello.servlet.basic;

import lombok.Getter;
import lombok.Setter;

@Getter @Setter
public class HelloData {

    private String username;
    private int age;

}

hello.servlet.basic.request.RequestBodyJsonServlet

package hello.servlet.basic.request;

import com.fasterxml.jackson.databind.ObjectMapper;
import hello.servlet.basic.HelloData;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletInputStream;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.util.StreamUtils;

import java.io.IOException;
import java.lang.runtime.ObjectMethods;
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());

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

Postman 으로 실행
- POST : http://localhost:8080/request-body-json
- content-type : application/json (Body->raw, 가장 오른쪽 JSON 선택)
- message body : {"username" : "hello", "age":20}

📍 참고

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

✏️ HttpServletResponse - 기본 사용법

🔍 HttpServletResponse 역할

HTTP 응답 메시지 생성
- HTTP 응답코드 지정
- 헤더 생성
- 바디 생성
편의 기능 제공
- Content-Type, 쿠키, Redirect

🔍 HttpServletResponse - 기본 사용법

hello.servlet.basic.response.ResponseHeaderServlet

package hello.servlet.basic.response;

import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.Cookie;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;
import java.io.PrintWriter;

@WebServlet(name = "responseHeaderServlet", urlPatterns = "/response-header")
public class ResponseHeaderServlet extends HttpServlet {

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //[status-line]
        response.setStatus(HttpServletResponse.SC_OK);

        //[response-header]
        response.setHeader("Content-Type", "text/plain;charset=utf-8");
        response.setHeader("Cache-Control", "no-cache, no-store, must-revalidate");
        response.setHeader("Pragma", "no-cache");
        response.setHeader("my-header", "hello");

        //[Header 편의 메서드]
        content(response);
        cookie(response);
        redirect(response);

        //[message body]
        PrintWriter writer = response.getWriter();
        writer.println("ok");

    }
}

Content 편의 메서드

private void content(HttpServletResponse response) {
        //Content-Type: text/plain;charset=utf-8
        //Content-Length: 2
        //response.setHeader("Content-Type", "text/plain;charset=utf-8");
        response.setContentType("text/plain");
        response.setCharacterEncoding("utf-8");
        //response.setContentLength(2); //(생략시 자동 생성)
    }

쿠키 편의 메서드

private void cookie(HttpServletResponse response) {
        //Set-Cookie: myCookie=good; Max-Age=600;
        //response.setHeader("Set-Cookie", "myCookie=good; Max-Age=600");
        Cookie cookie = new Cookie("myCookie", "good");
        cookie.setMaxAge(600); //600초
        response.addCookie(cookie);
    }

redirect 편의 메서드

  private void redirect(HttpServletResponse response) throws IOException {
        //Status Code 302
        //Location: /basic/hello-form.html
        //response.setStatus(HttpServletResponse.SC_FOUND); //302
        //response.setHeader("Location", "/basic/hello-form.html");
        response.sendRedirect("/basic/hello-form.html");
    }

✏️ HTTP 응답 데이터 - 단순 텍스트, HTML

HTTP 응답 메시지는 주로 아래의 내용을 담아서 전달한다.
- 단순 텍스트 응답 (writer.println("ok"))
- HTML 응답
- HTTP API - Message-Body JSON 응답
`hello.servlet.basic.response.ResponseHtmlServlet

 package hello.servlet.basic.response;

import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;
import java.io.PrintWriter;

@WebServlet(name = "responseHtmmlServlet", urlPatterns = "/response-html")
public class ResponseHtmlServlet extends HttpServlet {

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //Content-Type : text/html;charset=utf-8
        response.setContentType("text/html");
        response.setCharacterEncoding("utf-8");

        PrintWriter writer = response.getWriter();
        writer.println("<html>");
        writer.println("<body>");
        writer.println("<div>안녕?</div>");
        writer.println("</body>");
        writer.println("</html>");
    }
}

HTTP 응답으로 HTML을 반환할 때는 content-type 을 text/html 로 지정해야 한다.
실행
- http://localhost:8080/response-html
- 페이지 소스보기 F12 를 사용하면 결과 HTML을 확인할 수 있다.

✏️ HTTP 응답 데이터 - API JSON

hello.servlet.basic.response.ResponseJsonServlet

package hello.servlet.basic.response;

import com.fasterxml.jackson.databind.ObjectMapper;
import hello.servlet.basic.HelloData;
import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.w3c.dom.html.HTMLHeadElement;

import java.awt.*;
import java.io.IOException;

@WebServlet(name ="responseJsonServlet", urlPatterns = "/response-json")
public class ResponseJsonServlet extends HttpServlet {

    private ObjectMapper objectMapper = new ObjectMapper();
    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //Content-Type : application/json
        response.setContentType("application/json");
        response.setCharacterEncoding("utf-8");

        HelloData helloData = new HelloData();
        helloData.setUsername("kim");
        helloData.setAge(20);

        //{"username":"kim", "age":20}
        String result = objectMapper.writeValueAsString(helloData);
        response.getWriter().write(result);
    }
}

HTTP 응답으로 JSON을 반환할 때는 content-type을 application/json 으로 지정해야 한다.
Jackson 라이브러리가 제공하는 objectMapper.writeValueAsString() 을 사용하면 객체를 JSON 문자로 변경할 수 있다.

실행
- http://localhost:8080/response-json

📍 참고

application/json 은 스펙상 utf-8 형식을 사용하도록 정의되어 있다.
따라서 application/json 이라고 해야지 application/json;charset=utf-8 이라고 전달하는 것은 의미 없는 파라미터를 추가한 것이다.
response.getWriter() 를 사용하면 추가 파라미터를 자동으로 추가한다.
이럴 경우에는 response.getOutputStream() 으로 출력하면 문제가 되지 않는다.

🔗출처

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

YuDeokRin · 2024-05-11T05:58:10Z

YuDeokRin
May 11, 2024
Maintainer

오 ? 보민님 굳입니다.

0 replies

Navigation Menu

Uh oh!

[스프링 MVC 1편] #2. 서블릿 (2) #221

Uh oh!

{{title}}

Uh oh!

Replies: 1 comment

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Uh oh!

[스프링 MVC 1편] #2. 서블릿 (2) #221

Uh oh!

6om1n May 10, 2024 Maintainer

✏️ HTTP 요청 데이터 - GET 쿼리 파라미터

📍 복수 파라미터에서 단일 파라미터 조회

✏️ HTTP 요청 데이터 - POST HTML Form

HTML의 Form을 사용하여 클라이언트에서 서버로 데이터를 전송하자.

📍 참고

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

📍 참고

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

📍 참고

✏️ HttpServletResponse - 기본 사용법

🔍 HttpServletResponse 역할

🔍 HttpServletResponse - 기본 사용법

✏️ HTTP 응답 데이터 - 단순 텍스트, HTML

✏️ HTTP 응답 데이터 - API JSON

📍 참고

🔗출처

Replies: 1 comment

Uh oh!

YuDeokRin May 11, 2024 Maintainer

6om1n
May 10, 2024
Maintainer

YuDeokRin
May 11, 2024
Maintainer