[스프링 MVC 1편] 서블릿 개요 (기본정보)

스프링 MVC 1편 서블릿

프로젝트를 시작하기 전에, 스프링 부트 스타터 사이트에서 스프링 프로젝트를 생성한다.

프로젝트 선택 및 설정

Project: Gradle - Groovy Project
Language: Java
Spring Boot: 2.4.x
Group: hello
Artifact: servlet
Name: servlet
Package name: hello.servlet
Packaging: War (주의!)
Java: 11
Dependencies: Spring Web, Lombok

🔥 스프링 3.0 이상을 선택하는 경우, Java 17 이상을 사용해야 한다. javax 패키지 이름을 jakarta 로 변경해야한다.

 

build.gradle 설정

plugins {
id 'org.springframework.boot' version '2.4.3'
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
id 'java'
id 'war'
}
group = 'hello'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'
configurations {
compileOnly {
extendsFrom annotationProcessor
}
}
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
test {
useJUnitPlatform()
}

 

인텔리 제이 실행을 자바 직접 실행으로 변경해주는데, 나처럼 인텔리제이 무료 버전을 사용하는 사람이라면 실행 주체를 Gradle 로 설정해야한다. 

롬복 까지 검색 및 체크해서 설치한 뒤에 API 테스트를 간단하게 하기 위해 Postman 로 설치한다.

---

Hello 서블릿

서블릿은 톰캣 같은 웹 애플리케이션 서버를 직접 설치하고, 그 위에 서블릿 코드를 클래스 파일로 빌드해서 올린 다음, 톰캣 서버를 실행하면 된다. 매우 복잡한 과정이다. 

💫 스프링 부트는 톰캣 서버를 내장하고 있으므로, 톰캣 서버 설치 없이 편리하게 서블릿 코드를 실행할 수 있다!

 

스프링 부트 서블릿 환경 설정

@ServletComponentScan 애노테이션으로 서블릿을 직접 등록해서 사용할 수 있다.

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

}

 

HelloServlet 첫 실행

HttpServlet 을 상속 받고, @WebServlet 애노테이션을 설정해주어 서블릿을 동작시킬 수 있다.

name : 서블릿 이름 , urlPatterns : URL 매핑 정보이다.

package hello.servlet.basic;

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;

@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"); //이왕이면 utf-8을 쓰자.
        response.getWriter().write("hello! " + username);


    }
}

 

HTTP 요청을 통해 매핑된 URL 이 호출되면, 서블릿 컨테이너는 service 메서드를 실행한다.

 

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

application.properties 에 다음을 추가하면 HTTP 요청 메시지를 로그로 확인할 수 있다.

logging.level.org.apache.coyote.http11=debug

 

---

HttpServletRequest - 개요

역할 : HTTP 요청 메시지를 개발자가 직접 파싱해서 사용해도 되지만, 이는 매우 불편하다! 그래서 서블릿은 개발자가 HTTP 요청 메시지를 편리하게 사용할 수 있도록 개발자 대신에 HTTP 요청 메시지를 파싱한다. 그리고 그 결과를 HttpServletRequest 객체에 담아서 제공한다.

 

💫 HttpServletRequest 객체는 임시 저장소 기능, 세션 관리 기능 등 추가로 여러가지 부가 기능도 함께 제공한다.

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

 

HttpServletRequest - 기본 사용법

start-line 정보, 헤더 정보 등 요청 메시지의 다양한 정보를 조회할 수 있다. 

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;

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

    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

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

    }

    //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 요청 데이터 - 개요 

HTTP 요청 메시지는 주로 다음과 같은 3가지 방식을 사용한다.

 

GET - 쿼리 파라미터
메시지 바디 없이 url 의 쿼리 파라미터에 데이터를 포함해 전달한다.
검색, 필터, 페이징 등에서 많이 사용하는 방식이다.

POST - HTML Form
메시지 바디에 쿼리 파라미터 형식으로 전달한다. 

HTTP message body
HTTP API에서 주로 사용! JSON, XML, TEXT
데이터 형식은 주로 JSON 을 사용한다. 
POST, PUT, PATCH 사용 가능!!

 

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

메시지 바디 없이, URL 의 쿼리 파라미터를 사용해서 데이터를 전달한다.

쿼리 파라미터는 URL 에 ?을 시작으로 보내고, 추가 파라미터는 & 로 구분한다.

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("단일 파라미터 조회 - ");
        String username = request.getParameter("username");

        String age = request.getParameter("age");

        System.out.println(age);
        System.out.println(username);
        System.out.println();

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

        for ( String n : usernames )
        {
            System.out.println("names = " + n);
        }

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

    }
}

 

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

이름이 하나고 값이 중복으로 있는 경우, request.getParameterValues() 를 사용한다.

 

HTTP 요청 데이터 - POST HTML Form

특징 

content-type: application/x-www-form-urlencoded

메시지 바디에 쿼리 파리미터 형식으로 데이터를 전달한다. username=hello&age=20

POST 의 HTML Form 을 전송하면 웹 브라우저는 HTTP 메시지를 만들어 서버로 요청을 보낸다. 

 

application/x-www-form-urlencoded 형식은 앞서 GET에서 살펴본 쿼리 파라미터 형식과 같다.

따라서 쿼리 파라미터 조회 메서드를 그대로 사용하면 된다.

 

참고

content-type은 HTTP 메시지 바디의 데이터 형식을 지정한다.

POST HTML Form 형식으로 데이터를 전달하면 HTTP 메시지 바디에 해당 데이터를 포함해서 보내기 때문에 ✨바디에 포함된 데이터가 어떤 형식인지 content-type을 꼭 지정해야 한다. 이렇게 폼으로 데이터를 전송하는 형식을 application/x-www-form-urlencoded 라 한다.

 

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

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

HTTP API 에서 주로 사용하며, JSON, XML, TEXT 타입이 있고 주로 JSON 형식을 많이 사용한다. 

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

    }
}

 

HTTP 메시지 바디의 데이터는 InputStream 을 사용해서 직접 읽을 수 있다!!!

참고로 InputStream 은 byte 코드를 반환한다. 반환된 byte 코드를 우리가 읽을 수 있는 문자로 보려면, 문자표를 지정해줘야한다. 여기서는 utf-8 을 지정해줬다.

 

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

API 에서 주로 사용하는 JSON 형식으로 데이터를 전송한다. 

JSON 형식 전송

POST http://localhost:8080/request-body-json

content-type: application/json

message body: {"username": "hello", "age": 20}

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

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 = " + helloData.getUsername());
        System.out.println("helloData = " + helloData.getAge());

    }
}

 

참고

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

 

---

HttpServletResponse - 기본 사용법

HTTP 응답 메시지를 생성한다. (응답 코드, 헤더, 바디를 생성한다.)

Content-Type, 쿠키, Redirect 기능과 같은 편의 기능도 제공한다.

package hello.servlet.basic.response;

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.io.PrintWriter;

@WebServlet(name = "responseHeaderServlet", urlPatterns = "/response-header")
public class ResponseHeaderServlet extends HttpServlet {
    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setStatus(HttpServletResponse.SC_OK);

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

        PrintWriter p = response.getWriter();
        p.println("ok");

    }
}

 

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

단순 텍스트 응답을 보낼 수 있다.

package hello.servlet.basic.response;

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.io.PrintWriter;

@WebServlet(name = "responseHtmlServlet", 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 응답 데이터 - API JSON

HTTP 응답으로 JSON 을 반환할 때는 content-type 을 application/json 으로 지정해줘야한다. 

Jackson 라이브러리가 제공하는 objectMapper.writeValueAsString() 를 사용하면 객체를 JSON 문자로 변경할 수 있다.

package hello.servlet.basic.response;

import com.fasterxml.jackson.databind.ObjectMapper;
import hello.servlet.basic.HelloData;

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;

@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 {
        response.setContentType("application/json");
        response.setCharacterEncoding("utf-8");

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

        //{"username":"mi"} 이 형식으로
        String result = objectMapper.writeValueAsString(helloData);
        response.getWriter().write(result);

    }
}