스프링 스터디 ; 서블릿

강의 링크

프로젝트 생성

: 스프링부트 사이트에서 프로젝트 만들 때
: JSP를 사용하기 위해 War을 설정해주어야하고
: WAS 서버가 내장되어있는 Spring Web을 Dependencies로 추가해주어야한다.

Hello 서블릿

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

: 스프링 부트 서블릿 환경을 구성하기 위해 hello.servlet.ServletApplication을 수정합니다.
: @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);
	}

}

: 실제로 서블릿을 등록해봅시다. 코드는 다음과 같습니다.

package hello.servlet.basic;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebFilter;
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 {
    // 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");
        // 바디에 들어가는 내용
        response.getWriter().write("hello " +username);//http 메세지 바디에 들어가는 내용

    }
}

: 여기서 중요한 부분은 @WebServlet 애노테이션입니다. name은 서블릿 이름이되고 urlPatterns은 URL 매핑 정보를 담고 있스빈다.
: HTTP 요청을 통해 매핑된 URL이 호출되면 서블릿 컨테이너는 다음 메서드를 실행합니다.
protected void service(HttpServletRequest request, HttpServletResponse response)

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

: 로그로 확인을 하기 위해선 application.properties에 다음과 같은 설정을 해둬야합니다.
logging.level.org.apache.coyote.http11=debug
: 하지만 운영 서버에 이렇게 모~든 정보를 다 남긴다면 성능 저하가 발생할 수 있습니다. 개발 단계에서만 적용해야합니다.

Welcome 페이지 추가

webapp 경로에 index.html을 두면 웰컴페이지를 만들 수 있게 됩니다.

HttpServletRequest 개요

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 데이터 직접 조회

: 또한 HttpServletRequest 객체는 해당 HTTP 요청이 시작 부터 끝날 때까지 유지되는 임시 저장소 기능을 제공합니다.
-> 저장 = request.setAttribute(name, value)
-> 조회 = request.getAttribute(name)
: 그리고 세션 관리 기능 도 제공합니다
-> request.getSession(create:true)

HttpServletRequest-기본 사용법

: Start line 정보를 조회할 수 있습니다.

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

        System.out.println("request.getMethod() = "+ request.getMethod());
        System.out.println("request.getProtocal() = " + request.getProtocol());
        System.out.println("request.getScheme() = "+ request.getScheme());
        // 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());
        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 = " + headerName);
//        }
        // 이게 위의 방식보다 요즘 방식.
        request.getHeaderNames().asIterator()
                        .forEachRemaining(headerName -> System.out.println(headerName + ":"+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 편의 조회]");
        // .getLocales로 로케일 정보를 다 꺼낼 수 있다. ex ko-kr, en=0.8 ...어쩌구
        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 메시지의 정보는 아님) 또한 조회할 수 있습니다.

 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 - 쿼리 파라미터
: ?username=kim&age=20
: 메시지 바디 없이 URL의 쿼리 파라미터에 데이터를 포함해서 전달합니다.
2) POST - HTML Form
: content-type : application/x-www-form-urlencoded의 설정이 필요합니다
: 메시지 바디에 쿼리 파라미터 형식으로 전달합니다. usernmae=kim&age=20
3) HTTP message body에 데이터를 직접 담아서 요청합니다.
: HTTP API에서 주로 사용합니다.
: 데이터 형식은 주로 JSON을 사용합니다.(POST, PUT, PATCH)

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

: HttpServletRequest가 제공하는 메서드를 통해 쿼리 파라미터를 편하게 조회할 수 있습니다.

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");
        // 전체 파라미터
        // getParameter로 값을 꺼낼 수 있다.
        request.getParameterNames().asIterator()
                .forEachRemaining(paramName -> System.out.println(paramName +"=" + request.getParameter(paramName)));
        System.out.println("[전체 파라미터 조회] - end");
        System.out.println();

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

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

        // 하나의 파라미터 이름에 여러 값을 넘긴 경우(중복)
        System.out.println("[이름이 같은 복수 파라미터 조회]");
        String[] usernames = request.getParameterValues("username");
        for (String name : usernames) {
            System.out.println("name = " + name);
        }
    }
}

HTTP 요청데이터 - POST HTML Form

: GET과는 달리 Content-type을 꼭 지정해야합니다. (메시지 바디에 데이터가 있기 때문에)
: POST의 HTML Form을 전송하면 웹 브라우저는 다음 형식으로 HTTP 메시지를 만듭니다.
: 요청 URL
: content-type : application/x-www-form-urlencoded
: message bodt : username=hello&age=20
: 클라이언트 입장에서는 GET 방식과 Form 방식은 차이가 있지만, 백에서는 쿼리 파라미터 조회 메서드를 그대로 사용하므로 request.getParameter()로 편리하게 구분없이 조회할 수 있습니다.

: 즉, request.getParameter()는 GET URL 쿼리 파라미터 형식도 지원하고, POST HTML Form 형식도 지원합니다.

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

: HTTP 메시지 바디에 데이터를 직접 담아서 요청ㅎ반다.
: HTTP API에서 주로 사용하며
: 데이터 형식은 주로 JSON을 사용합니다.

: 가장 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송하고 읽는 방식입니다.
: HTTP 메시지 바디의 데이터를 InputStream을 사용해서 직접 읽을 수 있습니다.

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;

// HTTP 요청 데이터 - API 메시지 바디 - 단순 텍스트
@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으로 변환
        // byte를 문자로 바꿀때는 어떤 인코딩인지 알려주어야해서 UTF_8을 인자로 넣는다.
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
        System.out.println("messageBody = " + messageBody);
        response.getWriter().write("ok");
    }
}

: inputStream은 byte 코드를 반환합니다. 이를 우리가 읽을 수 있는 문자로 변환하려면 charSet을 지정해주어야합ㄴ디ㅏ.
: content-type : text/plain 입니다.

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

: HTTP API에서 주로 사용하는 JSON 형식으로 데이터를 전달하는 것입니다.
: JSON 형식으로 전송할때는 content-type : application/json입니다.
: JSON 형식으로 파싱할 수 있게 hello.servlet.basic.HelloData를 생성합니다.
: 해당 코드에 lombock을 적용하여 getter setter를 만듭니다.

package hello.servlet.basic;

import lombok.Getter;
import lombok.Setter;

// JSON 형식으로 파싱할 수 있게 객체를 하나 생성
@Getter @Setter
public class HelloData {
    private String username;
    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);
        // JSON도 그냥 문자이므로 그냥 파싱하면 된다.
        System.out.println("messageBody = " + messageBody);

        // HelloData 변환하려면 JSON 라이브러리가 필요.
        // messageBody를 객체로 변환해준다.
        HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
        System.out.println("helloData.username = " + helloData.getUsername());
        System.out.println("helloData.age = " + helloData.getAge());

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

ObjectMapper란 ON 형식을 사용할 때, 응답들을 직렬화하고 요청들을 역직렬화 할 때 사용하는 기술입니다.

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

HttpServletResponse - 기본 사용법

: HTTPServletResponse는
: HTTP 응답 메시지를 생성할 수 있고
- HTTP 응답 코드 생성
- 헤더 생성
- 바디 생성
: 편의 기능을 제공합니다.
- content-type, 쿠키, Redirect

package hello.servlet.basic.response;

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

@WebServlet(name="responseHeaderServlet", urlPatterns = "/response-header")
public class ResponseHeaderServlet extends HttpServlet {
    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // 응답 코드 생성
        // 200이런거 직접 적는 것보다 저렇게 하는 것이 좋음.
        // [status line]
        response.setStatus(HttpServletResponse.SC_OK);

        // [response-headers]
        response.setHeader("Content-Type", "text/plain;charset=utf-8");
        response.setHeader("Cache-Control", "no-cache, no-store, must-revalidate"); // 캐시 무효화
        response.setHeader("Pragma", "no-cache"); // + 캐시 무효화
        response.setHeader("my-header", "hello"); // 내가 만든 헤더

        // [Header의 편의 메소드]
        content(response);

        // 쿠키도 넣을 수는 있음 set-cookie로 해서..
        // 근데 그냥 좀 편리하게 하기 위해서
        cookie(response);

        redirect(response);

        // [message Body]
        PrintWriter writer = response.getWriter();
        writer.println("ok");
    }

    // 조금 더 쉽게 header 생성하는 방법.
    public void content(HttpServletResponse response){
        // Content-Type : text/plain; charset=utf-8
        // Content-Length : 2
        // response.setHeader("Content-Type", "text/plain;charset=utf-8")
        response.setContentType("text/plain");
        response.setCharacterEncoding("utf-8");
        //response.setContentLength(2); // 생락시 자동 생성! 내가 직접 적어서 내보낼 수도 있음.
        // OK + \n 이어서 byte 길이 3
   }

   private void cookie(HttpServletResponse response){
        // Set-Cookie : myCookie=good; Max-Age=600;
       // response.setHeader("Set-Cookie", "myCookie=good; Max-Age=600");
       Cookie cookie = new Cookie("myCookie", "good");
       cookie.setMaxAge(600); //600초
       response.addCookie(cookie);
   }

   // redirect 편의 메서드
    private void redirect(HttpServletResponse response) throws IOException{
        //Status Code 302
        //Location: /basic/hello-form.html

        //response.setStatus(HttpServletResponse..SC_FOUND); //302
        //response.setHeader("Location", "/basic/hello-form.html");
        response.sendRedirect("/basic/hello-form.html");
    }

}

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

: HTTP 응답 메시지는 주로 다음 내용을 담아서 전달합니다.
: 단순 텍스트 응답 + HTML 응답 + HTTP API - Message Body JSON응답

: 단순 텍스트 응답은 write.println("OK");로 해결합니다.
: 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>");
    }
}

: 주목할 점은 content-type을 text/html로 지정해야한다는것입니다.

HTTP 응답 데이터 - API 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 org.springframework.beans.factory.ObjectProvider;

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("applicatio/json");
        response.setCharacterEncoding("utf-8");

        HelloData helloData = new HelloData();
        // 이렇게 바꾸려면 Object Mapper가 필요하다.
        helloData.setUsername("kim");
        helloData.setAge(20);

        // String 데이터로 뽑고
        String result = objectMapper.writeValueAsString(helloData);
        response.getWriter().write(result);
    }
}