[인프런 강의 복습]스프링 MVC 1편 - 서블릿

■ 서블릿

@ServletComponentScan 
- 스프링 부트는 서블릿을 직접 등록해서 사용할 수 있도록 @ServletComponentScan 어노테이션을 지원

@WebServlet
- 서블릿 어노테이션
- name : 서블릿 이름
- urlPatterns : URL 매핑

[서블릿 컨테이너 동작 방식]
- 스프링 부트에서 내장 톰켓 서버를 지원
- 톰캣(웹 애플리케이션 서버)은 서블릿 코드를 클래스 파일로 빌드해서 올린다.
- 톰캣 서버를 실행하고 HTTP 요청 메시지를 날리게 되면 request, response 객체를 생성해서 서블릿으로 전달
- 서블릿은 service() 메서드 호출을 통해 비지니스 로직을 수행 후
- 응답 결과를 response 객체를 통해 웹 브라우저로 보내게 된다.

 

■ 서블릿 등록 테스트

HTTP 요청을 통해 매핑된 URL이 호출되면 서블릿 컨테이너는 service(HttpServletRequest request, HttpServletResponse 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;

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

 

■ HttpServletRequest

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

1) HTTP 요청 메시지를 편리하게 조회할 수 있다.
- START LINE : HTTP 메서드, URL, 쿼리 스트링, 스키마, 프로토콜
- 헤더
- 바디 : form 파라미터 형식 조회, message body 데이터 직접 조회

2) 임시 저장소 기능
- 해당 HTTP 요청이 시작부터 끝날 때까지 임시 저장소 기능이 유지
- 저장 : request.setAttribute(name, value)
- 조회 : request.getAttribute(nave)

3) 세션 관리 기능 
- request.getSession(create:true)

 

■ HttpServletRequest 기본 사용법 

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

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

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

        printStartLine(request);
        printHeader(request);
        printHeaderUtil(request);
        printEtc(request);
    }

    private void printStartLine(HttpServletRequest request) {
        System.out.println("--- REQUEST START LINE ---");

        System.out.println("request.getMethod() = " + request.getMethod()); //GET
        System.out.println("request.getProtocal() = " + 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-test
        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();
    }

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

    private void printHeaderUtil(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 편의 조회]");
        Enumeration<Locale> locales = request.getLocales();
        while (locales.hasMoreElements()) {
            Locale locale = locales.nextElement();
            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 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달

1) GET - 쿼리 파라미터
- URL의 쿼리 파라미터에 데이터를 포함해서 전달
- 검색, 필터, 페이징 등에서 많이 사용
- url?username=yoo&age=20
- 서버에서는 HttpServletRequest가 제공하는 getParameter() 메서드를 통해 클라이언트로부터 전달된 데이터를 쉽게 조회할 수 있다.

2) POST - HTML FORM
- content-type : application/x-www-form-urlencoded
- 메시지 바디에 쿼리 파라미터 형식으로 데이터 전달
- 회원가입, 상품 주문, HTML Form 사용

3) HTTP message body
- HTTP message body에 데이터를 직접 담아서 요청
- HTTP API에서 주로 사용
- 데이터 형식은 주로 JSON

[참고]
content-type : HTTP 메시지 바디의 데이터 형식을 지정
- GET URL 쿼리 파라미터 형식으로 클라이언트에서 서버로 데이터 전달 시, HTTP 메시지 바디를 사용하지 않기 때문에 content-type X
- POST HTML Form 형식으로 데이터 전달 시, HTTP 메시지 바디에 데이터를 포함해서 보내기 때문에 content-type을 지정 O

 

■ GET방식을 통한 데이터 전송

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;

@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");
        Enumeration<String> parameterNames = request.getParameterNames();
        while (parameterNames.hasMoreElements()) {
            String paramName = parameterNames.nextElement();
            System.out.println(paramName + " = " + request.getParameter(paramName));
        }
        System.out.println("[전체 파라미터 조회] - end");
        System.out.println();
        System.out.println("[단일 파라미터 조회] - start");
        String username = request.getParameter("username");
        String age = request.getParameter("age");
        System.out.println("username = " + username);
        System.out.println("age = " + age);
        System.out.println("[단일 파라미터 조회] - end");
        System.out.println();
        System.out.println("[이름이 같은 복수 파라미터 조회] - start");
        String[] usernames = request.getParameterValues("username");
        for (String name : usernames) {
            System.out.println("username = " + name);
        }
        System.out.println("[이름이 같은 복수 파라미터 조회] - end");

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

 

■ HTTP 바디에 JSON 형식의 데이터 전송

JSON 결과를 파싱해서 사용할 수 있는 자바 객체로 변환하기 위해서는 Jackson, Gson 같은 JSON 변환 라이브러리가 필요
스트링 부트로 Spring MVC를 선택하면 Jackson 라이브러리 기본으로 제공
ObjectMapper 클래스 이용

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 = "requestBodyJonServlet", urlPatterns = "/request-body-json")
public class RequestBodyJonServlet extends HttpServlet {

    private ObjectMapper objectMapper = new ObjectMapper();

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

        ServletInputStream inputStream = request.getInputStream();
        String message = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
        HelloData helloData = objectMapper.readValue(message, HelloData.class);

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

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

 

■ HttpServletResponse

1. HttpServletResponse  역할
- HTTP 응답코드 생성
- 헤더 생성
- 바디 생성
- Content-Type
- 쿠키
- redirect

2. HttpServletResponse 응답 데이터
- 단순 텍스트
- HTML 응답 : HTML을 반환할 때는 Content-type을 "text/html"으로 지정

- HTML API - Message Body JSON 응답

 

■ HttpServletResponse 기본 기능

import javax.servlet.ServletException;
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;
import java.io.IOException;

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

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

        content(response);
        cookie(response);
        redirect(response);

        //[message body]
        response.getWriter().write("ok");
    }

    private void content(HttpServletResponse response) {
        response.setStatus(HttpServletResponse.SC_OK);
        response.setContentType("text/plain");
        response.setCharacterEncoding("utf-8");
        response.setHeader("Cache-Control", "no-cache, no-store, must-revalidate");
        response.setHeader("Pragma", "no-cache");
        response.setHeader("my-header", "hello");
    }

    private void cookie(HttpServletResponse response) {
        Cookie cookie = new Cookie("myCookie", "good");
        cookie.setMaxAge(600);
        response.addCookie(cookie);
    }

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

 

■ HTTP 응답 데이터 - API JSON

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

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 {
        HelloData helloData = new HelloData();
        helloData.setUsername("yoo");
        helloData.setAge(33);

        //Content-Type : application/json
        response.setContentType("application/json");
        response.setCharacterEncoding("utf-8");

        String message = objectMapper.writeValueAsString(helloData);
        response.getWriter().write(message);
    }
}

 

[출처 : 인프런 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술]