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

[seyxxn]

2_서블릿 (1)

프로젝트 생성

• 스프링 부트 스타터에서 스프링 프로젝트 생성
  • https://start.spring.io
• 주의할 점
  • Packaging : War 선택
  • JSP를 실행하기 위해서 Jar가 아닌 War를 선택

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;

@WebServlet(name = "helloServlet", urlPatterns = "/hello")
public class HelloServlet extends HttpServlet {
    // ctrl + o 누른후, 좌물쇠 모양 service
    // 서블릿이 호출되면 이 서비스 메서드가 호출 됨
    @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");
        // 위 2개는 http header 정보에 들어감
        response.getWriter().write("hello " + username);
        // write 함수를 사용하면 http body에 데이터가 들어감
    }
}

• @WebServlet 서블릿 애노테이션
  • name : 서블릿 이름
  • urlPatterns : URL 매핑
• HTTP 요청을 통해 매핑된 URL이 호출되면 서블릿 컨테이너는 다음 메서드를 실행
  • protected void service(HttpServletRequest request, HttpServletResponse response)

HTTP 요청 메세지 로그로 확인하기

• application.properties에 다음 설정을 추가한다
  • logging.level.org.apache.coyote.http11=trace
• 서버를 다시 시작하고 요청해보면 서버가 받은 HTTP 요청 메세지를 출력하는 것을 확인할 수 있음
• 운영서버에 모든 요청 정보를 다 남기면 성능저하가 발생할 수 있기에 개발 단계에서만 적용

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

• 스프링부트가 실행되면서 내장 톰캣 서버를 띄워줌
• 톰캣 서버는 내부에 서블릿 컨테이너 기능을 가지고 있음
• 서블릿 컨테이너를 통해서 서블릿을 모두 생성함
• 이때, helloServlet이 생성이 됨

• 웹 브라우저가 (왼쪽 그림 처럼) http 메세지를 만들어서 서버 쪽에 던짐

• 서버는 http 요청 메세지를 기반으로 request, response 객체를 만들어서 helloServlet의 서비스 메서드를 호출하면서 request, response를 넘겨줌
• 필요한 일을 하고, http 응답 메세지를 만들어서 반환

HttpServletRequest - 개요

HttpServletRequest 역할

• HTTP 요청 메세지를 개발자가 직접 파싱하는 것은 매우 불편
• 서블릿은 개발자가 HTTP 요청 메세지를 편리하게 사용할 수 있도록 HTTP 요청 메세지를 파싱함
• 그 결과를 HttpServletRequest 객체에 담아서 제공
• HttpServletRequest를 사용하면 다음과 같은 HTTP 요청 메세지를 편리하게 조회할 수 있음
  • HTTP 요청 메세지

  POST /save HTTP/1.1
  Host: localhost:8080
  Content-Type: application/x-www-form-urlencoded
  username=kim&age=20
  

  • START LINE
    • HTTP 메소드
    • URL
    • 쿼리 스트링
    • 스키마, 프로토콜
  • 헤더
    • 헤더 조회
  • 바디
    • form 파라미터 형식 조회
    • message body 데이터 직접 조회
• 또한 이 객체는 추가로 여러 부가기능도 함께 제공
  • 임시 저장소 기능 : 해당 HTTP 요청이 시작부터 끝날 때 까지 유지되는 임시 저장소 기능
    • 저장 : request.setAttribute(name, value)
    • 조회 : request.getAttribute(name)
  • 세션 관리 기능
    • request.getSession(create: true)

HttpServletRequest - 기본 사용법

HttpServletRequest가 제공하는 기본 기능들을 알아보자

• start-line 정보

• Header 모든 정보

• Header 편리한 조회

• 기타 정보 (기타정보는 HTTP 메세지의 정보는 아님)

• hello.servlet.basic.request.RequestHeaderServlet

package hello.servlet.basic.request;

import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.*;

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

    }

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

    //Header 모든 정보
    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();
    }

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

    //기타 정보
    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();
    }
}

HTTP 요청 데이터 - 개요

• 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

---

🔗 출처

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