[Spring] 2.서블릿

1. 프로젝트 생성

메뉴얼 보고 따라하기

2. Hello 서블릿

[ServletApplication.class]

ㄴ hello.servlet

@ServletComponentScan

@ServletComponentScan //서블릿 자동 등록 @SpringBootApplication
public class ServletApplication {
  public static void main(String[] args) {
    SpringApplication.run(ServletApplication.class, args);
  }
}

- 스프링이 자동으로 내 패키지 포함 하위 패키지 서블릿 찾아서 자동으로 등록해서 찾아서 실행하도록 설정해줌

[HelloServlet.class]

ㄴ hello.servlet.basic

@WebServlet

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

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

protected void service(HttpServletRequest request, HttpServletResponse response)

- 서블릿은 쿼리 파라미터를 쉡게 읽을 수 있도록 지원

-> request.getParameter

- http 메시지 바디에 데이터 넣기

-> reponse.getWriter().write("hello" + username);

* 편리하게 http 요청 메시지 다 보는법

-> src - main - resources - application.properties => 여기에

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

추가

* 운영서버에는 모든 요청 정보 다 남기면 성능저하

* 개발할 때만 사용하기

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

- 스프링 부트가 내장 톰캣 서버 띄워줌

톰캣 서버는 내부에 서블릿 컨테이너 기능 가지고있음

- 서블릿 컨테이너 통해 서블릿 생성 (helloServlet)

HTTP요청, HTTP 응답 메시지

- 웹브라우저가 요청 메시지 만들어서 서버에 던져줌

그러면

-> request, response 객체 만들고

-> 싱글톤으로 떠있는 헬로서블릿 호출

-> 서비스 메서드 호출

-> request, response 넘겨줌

-> 필요한 작업하고 response에 데이터 넣어줌

-> 종료되고 나가면서 WAS 서버가 HTTP 응답 메시지 만들어서 반환해줌

-> 웹브라우저에서 확인가능

* 참고) HTTP 응답에서 Content-Length는 웹어플리케이션 서버가 자동으로 생성해줌

welcome 페이지 추가

ㄴmain - webapp - index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <title>Title</title>
  </head>
  
  <body> 
    <ul>
      <li><a href="basic.html">서블릿 basic</a></li> 
    </ul>
  </body>
</html>

basic 페이지 추가

ㄴ main - webapp - basic.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <title>Title</title>
  </head>
  <body> 
    <ul>
      <li>hello 서블릿
        <ul>
          <li><a href="/hello?username=servlet">hello 서블릿 호출</a></li>
        </ul> 
      </li>
      <li>HttpServletRequest
        <ul>
          <li>
            <a href="/request-header">기본 사용법, Header 조회</a>
          </li> 
          <li>HTTP 요청 메시지 바디 조회
            <ul>
              <li><a href="/request-param?username=hello&age=20">GET -쿼리 파라미터</a>
            </li> li>
<li><a href="/basic/hello-form.html">POST - HTML Form</a></
<li>HTTP API - MessageBody -> Postman 테스트</li> </ul>
</li> </ul>
      </li>
      <li>HttpServletResponse
<ul>
<li><a href="/response-header">기본 사용법, Header 조회</a></li> <li>HTTP 응답 메시지 바디 조회
<ul>
<li><a href="/response-html">HTML 응답</a></li>
<li><a href="/response-json">HTTP API JSON 응답</a></li>
</ul> </li>
</ul> </li>
  </ul>
  </body>
  </html>

3. HttpServletRequest 개요

HttpServletRequest 역할- 서블릿이 개발자 대신에 요청메시지 파싱- 그 결과를 HSR 객체에 담아서 제공

- 임시 저장소 기능

> 저장 : request.setAttribute(name, value)

> 조회 : request.getAttribute(name)

세션 관리 기능

> request.getSession(create: true)

중요)

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

* 메시지 바디에 JSON이 들어가고 / JSON 파싱하려면 라이브러리 사용해야함

4. HttpServletRequest 기본 사용법

HttpServletRequest가 제공하는 기본 기능들

RequestHeaderServlet.class

ㄴhello.servlet.basic.request

//http://localhost:8080/request-header?username=hello
@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 편리한 조회

//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 = " +
System.out.println("request.getLocale() = " + request.getLocale());
locale));
    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();
  }

locale (언어)

5. HTTP 요청 데이터 - 개요

HTTP 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달하는 방법

3가지

1) GET (쿼리 파라미터)
/url?username=hello&age=20
- 메시지 바디 없이 URL 쿼리 파라미터에 데이터를 포함해서 전달
- ex) 검색, 필터, 페이징

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

3) HTTP message body (바디에 데이터 직접 담아서 요청)
- HTTP API에서 주로 사용, JSON, XML, TEXT
- 데이터 형식은 주로 JSON 사용
- POST, PUT, PATCH

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

데이터를 클라이언트에서 서버로 전송

- 메시지 바디 없이 URL의 [쿼리 파라미터]를 사용해서 데이터 전달

ex) 검색, 필터, 페이징등에서 많이 사용하는 방식

- 쿼리 파라미터는 URL에 다음과 같이 '?'를 시작으로 보냄

- 추가 파라미터는 '&'로 구분

http://localhost:8080/request-param?username=hello&age=20

서버에서는 'HttpServletRequest'가 제공하는 다음 메서드를 통해 쿼리 파라미터를 편리하게 조회 가능

[쿼리 파라미터 조회 메서드]

String username = request.getParameter("username"); //단일 파라미터 조회 
Enumeration<String> parameterNames = request.getParameterNames(); //파라미터 이름들 모두 조회
Map<String, String[]> parameterMap = request.getParameterMap(); //파라미터를 Map 으로 조회
String[] usernames = request.getParameterValues("username"); //복수 파라미터 조회

[RequestParamServlet]

/**
* 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 resp) 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);
    }
    
    resp.getWriter().write("ok");
    }
}

* 하나의 파라미터에 값 중복해서 넣을 수 있음

* 복수 파라미터의 경우 배열에 넣어서 활용

7. HTTP 요청 데이터 - POST HTML Form

HTML Form 태그를 사용해서 클라이언트에서 서버로 데이터 전송

주로 회원가입 / 상품 주문 등에서 사용하는 방식

[특징]

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

HTTP 메시지 바디의 데이터 형식을 지정하는 것

- 메시지 바디에 쿼리 파라미터 형식으로 데이터 전달

username=hello&age=20

<html>
<head>
  <meta charset="UTF-8">
  <title>Title</title>
</head>
<body>
  <form action="/request-param" method="post">
    username: <input type="text" name="username" /> 
    age: <input type="text" name="age" /> 
    <button type="submit">전송</button>
  </form>
</body>
</html>

- 서버 입장에서는 둘의 형식이 동일하므로 'request.getParameter()'로 편리하게 구분없이 조회가능

* GET URL 쿼리파라미터 형식으로 클라이언트에서 서버로 데이터 전달할 땐 HTTP 메시지 바디를 사용하지 않기 때문에 content-type이 없다.

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

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

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

- HTTP API에서 주로 사용 (JSON, XML, TEXT)

- 데이터 형식은 주로 JSON

- POST, PUT, PATCH

@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 코드를 반환한다. byte 코드를 우리가 읽을 수 있는 문자(String)로 보려면 문자표
(Charset)를 지정해주어야 한다. 여기서는 UTF_8 Charset을 지정해주었다.

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

HTTP 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 }'

JSON 형식 파싱 추가

lombok.Getter; lombok.Setter;ㄴ import해서 getter setter 자동 생성

@Getter @Setter
public class HelloData {
  private String username;
  private int age;
}

서블릿

/**
* 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);
    System.out.println("messageBody = " + 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");
  }
}

참고)

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

참고)

HTML form 데이터도 메시지 바디를 통해 전송되므로 직접 읽을 수 있다. 하지만 편리한 파리미터 조회
기능( request.getParameter(...) )을 이미 제공하기 때문에 파라미터 조회 기능을 사용하면 된다.

10. HttpServletResponse - 기본 사용법

HttpServletResponse 역할

HTTP 응답 메시지 생성

- HTTP 응답코드 지정

- 헤더 생성

- 바디 생성

편의 기능 제공

- Content-Type, 쿠키, Redirect

HttpServletResponse - 기본 사용법

@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, must-revalidate");
    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");
}

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

HTTP 응답 메시지는 주로 다음 내용을 담아서 전달

- 단순 텍스트 응답

'writer.println("ok");'

- HTML 응답

- HTTP API - MessageBody JSON 응답

HttpServletResponse - 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로 지정해야함

실행

- http://localhost:8080/response-html

12. HTTP 응답 데이터 - 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 형식을 사용하도록 정의되어 있다.
그래서 스펙에서 charset=utf-8과 같은 추가 파라미터를 지원하지 않는다.
따라서 application/json 이라고만 사용해야지
> application/json;charset=utf-8 이라고 전달하는 것은 의미 없는 파라미터를 추가한 것이 된다.
> response.getWriter()를 사용하면 추가 파라미터를 자동으로 추가해버린다.
이때는 response.getOutputStream()으로 출력하면 그런 문제가 없다.

저작자표시

'👨‍💻 Web Development > Spirng - MVC 패턴 l' 카테고리의 다른 글

[Spring] 6.스프링 MVC - 기본 기능 (0)	2023.03.15
[Spring] 5.스프링 MVC - 구조 이해 (0)	2023.03.14
[Spring] 4.MVC 프레임워크 만들기 (0)	2023.03.13
[Spring] 3.서블릿, JSP, MVC 패턴 (0)	2023.03.13
[Spring] 1.웹 애플리케이션 이해 (0)	2023.03.11

[Spring] 2.서블릿