✅ 목표
- 스프링 부트에서 서블릿 환경을 구성해서 Servlet에 대한 동작 방식을 이해하기
✅ Spring Boot 서블릿 환경 구성
- 서블릿은 스프링 부트가 필요없이 구성 및 실행이 가능하지만, 실행하기 위해서는 톰캣 같은 WAS를 설치하고 그위에 서블릿 코드를 클래스 파일로 빌드해서 올리고 톰캣 서버를 실행하는 복잡하고 번거롭다.
- 스프링 부트는 톰캣 서버를 내장하고 있으므로, 편리하게 서블릿 코드를 실습하기 위해서 스프링 부트에서 서블릿 환경 구성 후 진행한다.
@SpringBootApplication
@ServletComponentScan // 서블릿 자동 등록
public class ServletApplication {
public static void main(String[] args) {
SpringApplication.run(ServletApplication.class, args);
}
}- 스프링 부트는 서블릿을 직접 등록해서 사용할 수 있도록
@ServletComponentScan을 지원한다.
서블릿 코드 등록
@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 매핑
- HTTP 요청을 통해 매핑된 URL이 호출되면 서블릿 컨테이너는 아래 메소드를 호출한다.
protected void service(HttpServletRequest request, HttpServletResponse response)
HTTP 요청 메시지 로그로 확인
- application.yaml 파일에 아래와 같이 설정 추가
logging:
level:
org:
apache:
coyote:
http11: debug- 해당 설정 후, HTTP 요청이 들어오면 HTTP 요청 메시지 정보들을 출력해준다.
- 그러나 위와 같이 모든 요청 정보를 다 넘기면 성능 저하가 발생할 수 있으므로 개발 단계에서만 사용한다.
✅ 서블릿 컨테이너 동작 방식
내장 톰캣 서버 생성
✅ HttpServletRequest
- Servlet은 개발자 대신 HTTP 요청 메시지를 파싱해서 그 결과를 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 기본 사용법
@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);
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();
}
//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());
System.out.println("request.getServerPort() = " + request.getServerPort());
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();
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-unlencoded
- 메시지 바디에 쿼리 파라미터 형식으로 전달
- 예) 회원 가입, 상품 주문, HTML Form 사용
3. HTTP message body에 데이터를 직접 담아서 요청
- HTTP API에서 주로 사용, JSON, XML, TEXT
- 데이터 형식은 주로 JSON 사용
- POST, PUT, PATCH
✔️ GET - 쿼리 파라미터
- 서버에서 HttpServletRequest가 제공하는 아래 메소드들을 통해 쿼리 파라미터를 편리하게 조회할 수 있다.
String username = request.getParameter("username"); //단일 파라미터 조회
Enumeration<String> parameterNames = request.getParameterNames(); //파라미터 이름들 모두 조회
Map<String, String[]> parameterMap = request.getParameterMap(); //파라미터를 Map으로 조회
String[] usernames = request.getParameterValues("username"); //복수 파라미터 조회예제 코드
/**
* 1. 파라미터 전송 기능
* http://localhost:8080/request-param?username=hello&age=20
* <p>
* 2. 동일한 파라미터 전송 가능
* http://localhost:8080/request-param?username=hello&username=kim&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");
/*
Enumeration<String> parameterNames = request.getParameterNames();
while (parameterNames.hasMoreElements()) {
String paramName = parameterNames.nextElement();
System.out.println(paramName + "=" + request.getParameter(paramName));
}
*/
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");
System.out.println("request.getParameter(username) = " + username);
String age = request.getParameter("age");
System.out.println("request.getParameter(age) = " + age);
System.out.println();
System.out.println("[이름이 같은 복수 파라미터 조회]");
System.out.println("request.getParameterValues(username)");
String[] usernames = request.getParameterValues("username");
for (String name : usernames) {
System.out.println("username=" + name);
}
response.getWriter().write("ok");
}
}- 같은 파라미터를 가진 값이 두 개 이상 있는 경우(중복),
request.getParamterValues()메소드를 통해 조회할 수 있다. request.getParameter()를 사용하면 중복된 첫 번째 값을 반환한다.
✔️ POST - HTML Form
- POST의 HTML Form으로 전송하면 아래와 같은 형식으로 HTTP 메시지를 만든다.
- 요청 URL :
http://localhost:8080/request-param - content-type :
appication/x-www-form-urlencoded - message body :
username=hello&age=20
- 요청 URL :
- GET 방식과 동일하게 쿼리 파라미터를 사용하고 서버 입장에서는 GET 방식과 형식이 동일하므로
request.getParameter()조회할 수 있다. - 즉,
request.getParameter()는 GET 형식과 POST HTML Form 형식 둘 다 지원한다. - 다만, 둘의 차이점은 GET 형식은 URL을 통해서 보내므로 content-type이 없고 POST HTML Form은 HTTP 메시지 바디에 데이터를 포함하기 때문에 content-type이 존재하고
application/x-www-form-urlencoded을 사용한다.
✔️ HTTP API Message Body - 단순 텍스트
- HTTP 메시지 바디의 데이터를
InputStream을 사용해서 직접 읽을 수 있다.
예제 코드
@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");
}
}- inputStream은 byte 코드로 변환하기 때문에 String으로 보려면 문자표(Charset)을 지정해주어야 한다.
✔️ HTTP API Message Body - JSON
/**
* http://localhost:8080/request-body-json
*
* JSON 형식 전송
* content-type: application/json
* message body: {"username": "hello", "age": 20}
*
*/
@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);
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");
}
}- JSON 결과를 파싱해서 사용할 수 있는 자바 객체로 변환하려면 jackson, Gson 같은 JSON 변환 라이브러리가 필요하다.
- 스프링 부트에서 Spring MVC를 선택하면 기본으로 jackson 라이브러리를 함께 제공하므로 ObjectMapper를 사용해서 JSON 데이터를 객체로 파싱해서 사용할 수 있다.
- HTML Form도 메시지 바디를 통해 전송되므로 직접 읽을 수 있으나
request.getParameter()를 통해 쉽게 조회할 수 있으므로 굳이 사용하지 않는다.
✅ HttpServletResponse
✔️ HttpServletResponse 의 역할
- HTTP 응답 메시지 생성
- HTTP 응답코드 지정
- 헤더 생성
- 바디 생성
- 편의 기능 제공
- Content-Type, 쿠키, Redirect
✔️ HttpServletResponse 기본 사용방법
/**
* http://localhost:8080/response-header
*
*/
@WebServlet(name = "responseHeaderServlet", urlPatterns = "/response-header")
public class ResponseHeaderServlet extends HttpServlet {
@Override
protected void service(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
//[status-line]
response.setStatus(HttpServletResponse.SC_OK); //200
//[response-headers]
response.setHeader("Content-Type", "text/plain;charset=utf-8");
response.setHeader("Cache-Control", "no-cache, no-store, mustrevalidate");
response.setHeader("Pragma", "no-cache");
response.setHeader("my-header","hello");
//[Header 편의 메서드]
content(response);
cookie(response);
redirect(response);
//[message body]
PrintWriter writer = response.getWriter();
writer.println("ok");
}
}- Content 편의 메소드
private 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); //(생략시 자동 생성)
}- 쿠키 편의 메소드
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 응답 데이터
- HTTP 응답 메시지는 아래와 같은 데이터를 담아서 전달한다.
- 단순 텍스트 응답
ex) writer.println("ok") - HTML 응답
- HTML API - MessageBody JSON 응답
- 단순 텍스트 응답
✔️ HTML 응답
@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로 지정해야 한다.
✔️ API JSON
/**
* http://localhost:8080/response-json
*
*/
@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 {
//Content-Type: application/json
response.setHeader("content-type", "application/json");
response.setCharacterEncoding("utf-8");
HelloData data = new HelloData();
data.setUsername("kim");
data.setAge(20);
//{"username":"kim","age":20}
String result = objectMapper.writeValueAsString(data);
response.getWriter().write(result);
}
}- HTTP 응답으로 JSON을 반환할 때는 content-type을
application/json으로 지정해야 한다. - Jackson 라이브러리가 제공하는
objectMapper.writeValueAsString()를 사용하면 객체를 JSON 문자로 변환할 수 있다.
❗ 참고
application/json은 utf-8 형식을 사용하도록 정의되어 있으므로application/json;charset=utf-8와 같이 설정하는 것은 의미없는 파라미터를 추가하는 것이다.- response.getWriter()를 사용하면 해당 파라미터를 자동으로 추가해버린다. 이 때는 response.getOutputStream()으로 출력하면 문제가 없다.
참고 Reference
- 인프런 강의
하루하루 꾸준히 포기하지 말고