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

6om1n · 2024-05-10T05:18:58Z

6om1n
May 10, 2024
Maintainer

✏️ 프로젝트 생성

프로젝트 선택
- Project: Gradle-Groovy Project
- Language : Java
- Spring Boot : 3.x.x
Project Metadata
- Group : hello
- Artifact : servlet
- Name : servlet
- Package name : hello.servlet
- Packaging : War (JSP를 실행하기 위해서 필요하다.)
- Java : 17
Dependencies : Spring Web, Lombok

롬복 적용

File -> Setting -> Plugins -> Lombok 검색 실행 (재시작)
FIle -> Setting -> Annotation Processors -> Enable annotation processing 체크 (재시작)

Postman 설치
Postman이란 API의 개발을 빠르고 쉽게, 개발된 API를 테스트할 수 있고, 팀원들 간의 공유를 할 수 있게 해주는 플랫폼

✏️ Hello 서블릿

🔍 스프링 부트 서블릿 환경 구성

스프링 부트는 서블릿을 직접 등록해서 사용할 수 있도록 @ServletComponentScan 을 지원한다.
hello.servlet.ServletApplication

package hello.servlet;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@ServletComponentScan // 서블릿 자동 등록
@SpringBootApplication
public class ServletApplication {

	public static void main(String[] args) {
		SpringApplication.run(ServletApplication.class, args);
	}

}

서블릿 등록하기
hello.servlet.basic.HelloServlet

package hello.servlet.basic;

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;

// /hello 로 오면 이 코드가 실행이 된다.
@WebServlet(name = "helloServlet", urlPatterns = "/hello")
public class HelloServlet extends HttpServlet {

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        System.out.println("HelloServlet.service");
        System.out.println("request = " + request);
        System.out.println("response = " + response);

        String username = request.getParameter("username");
        System.out.println("username = " + username);

        response.setContentType("text/plain");
        response.setCharacterEncoding("utf-8");
        response.getWriter().write("hello " + username);

    }
}

@WebServlet 서블릿 애노테이션

name : 서블릿 이름

urlPatterns : URL 매핑

서블릿이름이랑, URL매핑은 겹치면 안된다.
HTTP 요청을 통해 매핑된 URL이 호출되면 서블릿 컨테이너는 다음 메서드를 실행한다.
protected void service (HttpServletRequest request, HttpServletResponse response)
웹 브라우저 실행
- http://localhost:8080/hello?username=world
- 결과 : hello world
콘솔 실행 결과

서블릿 컨테이너는 URL 에서 "/hello" 에 해당하는 서블릿을 찾는다.

해당 서블릿 (HelloServlet)의 service() 메서드가 호출이 된다.

HttpServletRequest 객체에는 브라우저에 전달된 요청 정보가 담겨있다. "username=world" 같은 쿼리 문자열이 포함된다.

HttpServletRequest.getParameter("username")을 통해서 world 의 값을 가져온다.

HttpServletResponse 객체를 사용하여 클라이언트에게 응답을 생성한다.

🔍 HTTP 요청 메시지 로그로 확인하기

application.properties 에서 logging.level.org.apache.coyote.http11=trace 추가하기
서버를 다시 시작하고, 요청해보면 서버가 받은 HTTP 요청 메시지를 출력하는 것을 확인할 수 있음

📍 참고!

운영 서버에 이렇게 모든 요청 정보를 다 남기면 성능 저하가 발생할 수 있다. 개발 단계에서만 적용해야 한다.

🔍 서블릿 컨테이너 동작 방식 설명

내장 톰켓 서버 생성

스프링 부트가 내장 톰켓 서버를 띄워준다.

톰켓 서버는 내부에 서블릿 컨테이너 기능을 가지고 있다.

컨테이너를 통해서 서블릿을 생성해준다. 서블릿 안에 helloServlet이 생성된다.

웹 브라우저에 http://localhost:8080/hello?username=world 라고 입력을 하면, http 메시지를 만들어서 전달해준다.

서버는 request, response 객체를 만들어서 싱글톤인 helloServlet을 호출해준다.

거기에 service 메소드를 호출하면서 request,response 를 넘겨준다.

예시는 hello world 메시지를 넣게 되면 종료되고 나가면서 WAS 서버가 response 정보를 가지고 HTTP 응답 메시지를 만들어서 반환해준다.

참고 ) HTTP 응답에서 Content-Length 는 웹 애플리케이션 서버가 자동으로 생성해준다.

🔍 welcome 페이지 추가

webapp경로에 index.html 을 두면 http://localhost:8080 호출 시, index.html 페이지가 열린다.
main/webapp/index.html

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<ul>
    <li><a href="basic.html">서블릿 basic</a></li>
</ul>
</body>
</html>

main/webapp/basic.html

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<ul>
    <li>hello 서블릿
        <ul>
            <li><a href="/hello?username=servlet">hello 서블릿 호출</a></li>
        </ul>
    </li>
    <li>HttpServletRequest
        <ul>
            <li><a href="/request-header">기본 사용법, Header 조회</a></li>
            <li>HTTP 요청 메시지 바디 조회
                <ul>
                    <li><a href="/request-param?username=hello&age=20">GET - 쿼리
                        파라미터</a></li>
                    <li><a href="/basic/hello-form.html">POST - HTML Form</a></li>
                    <li>HTTP API - MessageBody -> Postman 테스트</li>
                </ul>
            </li>
        </ul>
    </li>
    <li>HttpServletResponse
        <ul>
            <li><a href="/response-header">기본 사용법, Header 조회</a></li>
            <li>HTTP 응답 메시지 바디 조회
                <ul>
                    <li><a href="/response-html">HTML 응답</a></li>
                    <li><a href="/response-json">HTTP API JSON 응답</a></li>
                </ul>
            </li>
        </ul>
    </li>
</ul>
</body>
</html>

✏️ HttpServletRequest - 개요

🔍 HttpServletRequest 역할

서블릿은 개발자가 HTTP 요청 메시지를 편리하게 사용할 수 있도록 개발자 대신에 HTTP 요청 메시지를 파싱한다. 그리고 그 결과를 HttpServletRequest 객체에 담아서 제공한다.

HTTP 요청 메시지

START LINE

HTTP 메소드, URL, 쿼리 스트링, 스키마, 프로토콜

헤더

헤더 조회

바디

form 파라미터 형식 조회, message body 데이터 직접 조회

임시 저장소 기능 (해당 HTTP 요청이 시작부터 끝날 때까지 유지되는 임시 저장소 기능)
- 저장 : request.setAttribute(name, value)
- 조회 : request.getAttribute(name)
세션 관리 기능
- `request.getSession(create: true)

⭐ 중요

HttpServletRequest, HttpServletResponse를 사용할 때, 이 객체들이 HTTP 요청 메시지, 응답 메시지를 편리하게 사용하도록 도와주는 객체이다. 따라서 이 기능들에 대한 깊이 있는 이해를 하려면 HTTP 스펙이 제공하는 요청, 응답 메시지 자체를 이해해야 한다

✏️ HttpServletRequest - 기본 사용법

hello.servlet.basic.request.RequestHeaderServlet

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

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

start-line 정보

 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()); //https 사용 유무
        System.out.println("--- REQUEST-LINE - end ---");
        System.out.println();
    }

웹 브라우저에 http://localhost:8080/request-header?username=hello 라고 입력했을 때
헤더정보

 private void printHeaders(HttpServletRequest request) {
        System.out.println("--- Headers - start ---");

        //Http에 있는 모든 헤더정보를 꺼내서 출력한다. (예전 스타일의 코딩 방식)
//        Enumeration<String> headerNames = request.getHeaderNames();
//        while (headerNames.hasMoreElements()) {
//            String headerName = headerNames.nextElement();
//            System.out.println(headerName + ": " + headerName);
//        }

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


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

Header 편리한 조회

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

결과

✏️ 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
- 예) 회원 가입, 상품 주문, HTML Form 사용
3️⃣ HTTP message body 에 데이터를 직접 담아서 요청
- HTTP API 에서 주로 사용, JSON, XML, TEXT
데이터 형식은 주로 JSON 사용
- POST, PUT, PATCH
POST- HTML Form 예시

content-Type은 바디에 대한 정보를 가지고 있다.

위의 사진은 html 폼을 통해서 전달된 정보임을 알 수 있다.

🔗출처

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

Navigation Menu

Uh oh!

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

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

6om1n May 10, 2024 Maintainer

✏️ 프로젝트 생성

✏️ Hello 서블릿

🔍 스프링 부트 서블릿 환경 구성

🔍 HTTP 요청 메시지 로그로 확인하기

🔍 서블릿 컨테이너 동작 방식 설명

🔍 welcome 페이지 추가

✏️ HttpServletRequest - 개요

🔍 HttpServletRequest 역할

⭐ 중요

✏️ HttpServletRequest - 기본 사용법

✏️ HTTP 요청 데이터 - 개요

🔗출처

Replies: 0 comments

6om1n
May 10, 2024
Maintainer