Spring MVC / HttpServletRequest

HttpServletRequest 

HTTP 요청 메시지를 파싱해서 결과를 HttpServletRequest 객체에 담아서 제공합니다.

HttpServletRequest를 사용하면 HTTP 요청 메시지를 편리하게 조회할 수 있습니다.

 

HTTP 요청 메시지 

POST /save HTTP/1.1    // start-line
Host : localhost:8080   // header
Content-Type : application/x-www-unlencoded

username=dongwoong&age=25  // body

추가적으로 임시 저장소 기능, 세션 관리 기능도 제공합니다.

 

1) 임시 저장소 기능은 해당 HTTP 요청이 시작부터 끝날 때 까지 유지되는 임시저장소 기능으로, 

setAttribute(name,value)를 통해 저장

getAttribute(name)을 통한 value 조회가 가능합니다.

 

2) 세션 관리기능은 getSession(create:true)를 통해 세션을 관리하도록 설정할 수 있습니다.

 

HttpServletRequest, HttpServletResponse 를 명확히 이해하려면 HTTP 스펙이 제공하는 request, response 메시지 자체를 이해해야 하기 때문에 이 전 포스팅을 참고.

 

https://rlaehddnd0422.tistory.com/45

HTTP 표현 헤더

https://rlaehddnd0422.tistory.com/42

HTTP 메소드 - GET, POST, PUT, PATCH, DELETE in Start line

---

HttpServletRequest 기본 사용법

package hello.servlet.basic.request;

import javax.servlet.annotation.WebServlet;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@WebServlet(name="requestHeaderServlet", urlPatterns = "/request-header")
public class RequestHeaderServlet extends HttpServlet {

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response)
    {
        printStartLine(request);
        printHeaders(request);
        printHeaderUtils(request);
        printEtc(request);
    }

    private void printStartLine(HttpServletRequest request) {
        System.out.println("--- REQUEST-LINE - start ---");
        System.out.println("request.getMethod() = " + request.getMethod()); //GET
        System.out.println("request.getProtocol() = " + request.getProtocol()); // HTTP 1.1
        System.out.println("request.getScheme() = " + request.getScheme()); //http
        // http://localhost:8080/request-header
        System.out.println("request.getRequestURL() = " + request.getRequestURL());
        // /request-header
        System.out.println("request.getRequestURI() = " + request.getRequestURI());
        //username=hi
        System.out.println("request.getQueryString() = " +
                request.getQueryString());
        System.out.println("request.isSecure() = " + request.isSecure()); //http 사용 유무
        System.out.println("--- REQUEST-LINE - end ---");
        System.out.println();
    }

    private void printHeaders(HttpServletRequest request) {
        System.out.println("--- Headers - start ---");
        /*
         Enumeration<String> headerNames = request.getHeaderNames();
         while (headerNames.hasMoreElements()) {
         String headerName = headerNames.nextElement();
         System.out.println(headerName + ": " + request.getHeader(headerName));
        }
        */

        request.getHeaderNames().asIterator()
                .forEachRemaining(headerName -> System.out.println(headerName + ":" + request.getHeader(headerName)));

        System.out.println("--- Headers - end ---");
        System.out.println();
    }

    private void printHeaderUtils(HttpServletRequest request)
    {
        System.out.println("--- Header 편의 조회 start ---");
        System.out.println("[Host 편의 조회]");
        System.out.println("request.getServerName() = " +  request.getServerName()); //Host 헤더
        System.out.println("request.getServerPort() = " + request.getServerPort()); //Host 헤더
        System.out.println();

        System.out.println("[Accept-Language 편의 조회]"); request.getLocales().asIterator()
                        .forEachRemaining(locale -> System.out.println("locale = " + locale));
        System.out.println("request.getLocale() = " + request.getLocale());
        System.out.println();

        System.out.println("[cookie 편의 조회]");
        if (request.getCookies() != null) {
            for (Cookie cookie : request.getCookies())
            {
                System.out.println(cookie.getName() + ": " + cookie.getValue());
            }
        }
        System.out.println();

        System.out.println("[Content 편의 조회]");
        System.out.println("request.getContentType() = " + request.getContentType());
        System.out.println("request.getContentLength() = " + request.getContentLength());
        System.out.println("request.getCharacterEncoding() = " + request.getCharacterEncoding());


        System.out.println("--- Header 편의 조회 end ---");
        System.out.println();
    }

    private void printEtc(HttpServletRequest request) { System.out.println("--- 기타 조회 start ---");
        System.out.println("[Remote 정보]");
        System.out.println("request.getRemoteHost() = " +
                request.getRemoteHost()); //
        System.out.println("request.getRemoteAddr() = " +
                request.getRemoteAddr()); //
        System.out.println("request.getRemotePort() = " +
                request.getRemotePort()); //
        System.out.println();
        System.out.println("[Local 정보]");
        System.out.println("request.getLocalName() = " +
                request.getLocalName()); //
        System.out.println("request.getLocalAddr() = " +
                request.getLocalAddr()); //
        System.out.println("request.getLocalPort() = " +
                request.getLocalPort()); //
        System.out.println("--- 기타 조회 end ---");
        System.out.println();
    }


}

Start-Line 정보

• getMethod() : 메소드 정보를 리턴 ( GET, POST .. )
• getProtocol() : 프로토콜 정보를 리턴 ( HTTP/1.1 ) 
• getScheme() : 프로토콜 정보를 리턴 ( http, https .. )
• getRequestURL() : 요청 URL 리턴 ( http://localhost:8080/request-header )
• getRequestURI() : URI만 리턴 ( request-header )
• getQueryString() : query 파라미터 리턴 ( 없으면 null 리턴 )
• isSecure() : https 사용 유무 리턴 

Header 정보

• getServerName() : 서버 이름 조회 
• getServerPort() : 서버 포트번호 조회
• getHeaderNames() : 헤더 조회
• asIterator().forEachRemaining()을 통해 모든 헤더이름과 헤더 정보를 확인할 수 있습니다.
• getLocale() : 우선순위 가장 높은 Accept-Language 조회
• asIterator().forEachRemaining()을 통해 모든 Language 조회가 가능합니다. 
• getCookies() : 쿠키 조회 
• getContentType() : 콘텐트타입 조회
• getContentLength() : 콘텐트 길이 조회
• getCharacterEncoding : 인코딩 방식 조회

request.getLocales().asIterator()
                        .forEachRemaining(locale -> System.out.println("locale = " + locale));

 

그 외 기타 정보 ( 포트번호, 호스트주소 등등 ) 조회 가능.

 

출력 결과

--- REQUEST-LINE - start ---
request.getMethod() = GET
request.getProtocol() = HTTP/1.1
request.getScheme() = http
request.getRequestURL() = http://localhost:8080/request-header
request.getRequestURI() = /request-header
request.getQueryString() = null
request.isSecure() = false
--- REQUEST-LINE - end ---

--- Headers - start ---
host:localhost:8080
connection:keep-alive
cache-control:max-age=0
sec-ch-ua:"Chromium";v="110", "Not A(Brand";v="24", "Google Chrome";v="110"
sec-ch-ua-mobile:?0
sec-ch-ua-platform:"macOS"
upgrade-insecure-requests:1
user-agent:Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36
accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7
sec-fetch-site:none
sec-fetch-mode:navigate
sec-fetch-user:?1
sec-fetch-dest:document
accept-encoding:gzip, deflate, br
accept-language:ko-KR,ko;q=0.9,en-US;q=0.8,en;q=0.7
--- Headers - end ---

--- Header 편의 조회 start ---
[Host 편의 조회]
request.getServerName() = localhost
request.getServerPort() = 8080

[Accept-Language 편의 조회]
locale = ko_KR
locale = ko
locale = en_US
locale = en
request.getLocale() = ko_KR

[cookie 편의 조회]

[Content 편의 조회]
request.getContentType() = null
request.getContentLength() = -1
request.getCharacterEncoding() = UTF-8
--- Header 편의 조회 end ---

--- 기타 조회 start ---
[Remote 정보]
request.getRemoteHost() = 0:0:0:0:0:0:0:1
request.getRemoteAddr() = 0:0:0:0:0:0:0:1
request.getRemotePort() = 60763

[Local 정보]
request.getLocalName() = localhost
request.getLocalAddr() = 0:0:0:0:0:0:0:1
request.getLocalPort() = 8080
--- 기타 조회 end ---

---

HTTP 요청 데이터

HTTP 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달하는 방법에는 주로 3가지 방법을 사용합니다.

1. GET - 쿼리 파라미터 사용 

• 메시지 바디 없이, URL의 쿼리파라미터에 데이터를 포함해서 전달하는 방식입니다.
• ex) 검색, 필터, 페이징에서 많이 사용하는 방식 
• 사용 예시 : url?name=kim&age=25

package hello.servlet.basic.request;

import javax.servlet.ServletException;
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.util.Enumeration;

/*
* 1. 파라미터 전송기능
* http://localhost:8080/request-param?username=hello&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");
        request.getParameterNames().asIterator()
            .forEachRemaining(paramName -> System.out.println(paramName + "=" + request.getParameter(paramName)));
        System.out.println("[전체 파라미터 조회]-end");
        System.out.println();

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


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

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

1. localhost:8080/request-param에 쿼리 파라미터를 추가한 URI인 localhost:8080/request-param?name=kim&age=20를 서버에 요청합니다.
2.  HttpServletRequest 객체인 request에 요청 정보(파라미터)를 담아서 서버에 전송합니다.
3.  서버는 HTTP 응답 메시지를 HttpServletResponse 객체에 담아 클라이언트에 전송합니다.

 

request.getParameter("파라미터 이름") 을 통해 요청할 때 서버에 보낸 파라미터 이름에 대한 값을 조회할 수 있습니다.

중복된 파라미터의 경우 request.getParameterValues()를 사용하면 중복 파라미터에 대한 값들을 모두 조회할 수 있습니다.

Postman을 이용한 GET

2. POST - HTML FORM 사용

• content-type : application/x-www-form-urlencoded 를 사용합니다.
• 메시지 바디에 쿼리 파라미터 형식으로 전달하는 방식입니다.
• ex) 회원 가입, 상품 주문

html-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="name" /> age: <input type="text" name="age" /> <button type="submit">전송</button>
</form>
</body>
</html>

html-form.html

여기서 작성한 폼은 /request-param에 POST 방식으로 전달됩니다.

 

 

이렇게 작성한 뒤에 전송을 누르면 request message body에 쿼리 파라미터 형식으로 데이터를 전달합니다.

name=kdo6301&age=11 이 메시지 바디에 담겨 /request-param으로 전달됩니다.

 

Postman을 이용한 POST

GET URL 쿼리 파라미터 형식으로 클라이언트에서 서버로 데이터를 전달할 때는 HTTP 바디를 사용하지 않기 때문에 Content-type이 없지만, POST HTML Form 형식으로 데이터를 전달하면 HTTP 메시지 바디에 해당 데이터를 포함해서 보내기 때문에 바디에 포함된 데이터가 어떤 형식인지 Content-type을 꼭 지정해야 합니다.

이렇게 폼으로 데이터를 전송하는 형식은 Content-type : application/x-www-form-urlencoded을 사용합니다.

 

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

• 주로 HTTP API에서 주로 사용합니다. (json, xml, text)
• 데이터 형식은 주로 json 사용 ( POST, PUT, PATCH )

3-1. TEXT

 

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

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.");

    }
}

inputStream은 바이트 코드를 반환합니다.

즉, request의 message body를 바이트코드로 반환하여 inputStream에 저장이 되는데, 우리가 읽을 수 있는 스트링으로 보려면 Charset을 UTF-8로 지정해야 합니다.

여기에서 StreamUtils를 사용해 inputStream에 저장된 스트링을 messagebody에 utf-8로 변환하여 저장해줍니다.

Postman을 이용한 message body 전송

단순 텍스트 Content-type : text/plain

message body를 이용해 단순 TEXT를 전송하기 위해서는 content-type을 text/plain로 지정해 주어야합니다.

 

 

Send 결과

결과

 

3-2. JSON

JSON 형식 전송.

JSON Content-type : application/json

content-type : application/json

message body : {"name" : "kimjson", "age" : 25}

 

package hello.servlet.basic;

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

@Getter @Setter @ToString
public class HelloData {
    private String name;
    private int 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.getAge() = " + helloData.getAge());
        System.out.println("helloData.getName() = " + helloData.getName());
        System.out.println("helloData = " + helloData);
        response.getWriter().write("OK");
    }
}

 

참고 : JSON 결과를 파싱해서 사용할 수 있는 자바 객체로 변환하려면 Jackson, Gson 같은 JSON 변환 라이브러리를 추가해서 사용해야 합니다. 

스프링 부트로 Spring MVC를 선택하면 기본으로 Jackson 라이브러리 ( ObjectMapper )를 함께 제공해주기 때문에 여기에서는 ObjectMapper를 이용해 json 결과를 객체에 파싱하였습니다.

Postman을 이용한 json 형식 데이터 전송

결과