[Spring] 서블릿이란? HttpServletRequest, HttpServletResponse

- 김영한 님의 '스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술'을 보고 정리한 글입니다 😊

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의

---

- 지난 포스팅과 이어집니다 :D

[Spring] WAS, 서블릿, 멀티 스레드와 스레드 풀

 

- 지난 포스팅에서는 간단하게 웹 기술에 필요한 핵심 개념들을 알아보았다.

- 이번에는 스프링 부트 환경에서 직접 서블릿을 등록하고 사용해보자.

 

| 서블릿 (Servlet)

- 기본적으로 스프링 부트의 경우 톰캣 서버를 내장하고 있기 때문에, 서블릿에 대한 편리한 기능들을 몇 가지 제공한다.

[SpringStudyApplication.java] - 가장 기본이 되는 파일

@ServletComponentScan
@SpringBootApplication
public class SpringStudyApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringStudyApplication.class, args);
    }

}

- 다음과 같이 @ServletComponentScan을 추가해준다.

 

[HelloServlet.java]

@WebServlet(name="helloServlet", urlPatterns = "/hello")
public class HelloServlet extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("HelloServlet.service");
        System.out.println("request = " + req);
        System.out.println("response = " + resp);

        // paramter 설정
        String username = req.getParameter("username");
        System.out.println("username = " + username);

        // Response
        resp.setContentType("text/plain");
        resp.setCharacterEncoding("utf-8");
        resp.getWriter().write("hello " + username);
    }
}

- @WebServlet을 통해 서블릿 이름을 붙이고, urlPattern을 통해 url 매핑을 해준다.

- 위 예제에서는 /hello라는 경로로 들어왔을 때 실행된다.

http://localhost:8080/hello?username=hi

 

getParameter를 통해서, 쿼리 파라미터로 들어온 값을 파싱할 수 있다.

위 경로로 요청하게 되면, 다음과 같이 화면에 출력된다.

- 이는, response.getWriter().write를 통해서 화면에 출력해준 부분이라고 볼 수 있다. (HttpMessageBody에 값이 들어가는 거) 

콘솔은 다음과 같이 찍히는 것을 볼 수 있다.

지난 포스팅에서 언급하였던 connector를 통해 HttpServletRequest와 HttpServletResponse가 생성된 것을 볼 수 있다.

참고로, RequestFacade, ResponseFacade의 경우 org.apache.catalina.connector.Request/Response의 구현체이다. (인터페이스 구현체)

Facade는 디자인 패턴에서도 쓰이는데, 내부의 구조를 숨길 때 사용한다. 즉, 간략화된 인터페이스를 제공하는 것.

내부적으로 생성자를 통해 주입받은 실제 Request/Response의 메서드를 호출하는 것으로 구현되어 있다.

 

🚩 즉, 스프링 부트가 내장 톰캣 서버를 가동하면 서블릿 컨테이너를 가지고 있게 되고,

현재 서블릿 컨테이너를 통해 helloServlet 객체가 생성된 상태라고 볼 수 있다.

이후, HTTP 요청 메시지 (GET /hello?username=hi)를 바탕으로 HttpServletRequest/Response를 생성하고,

helloServlet을 실행해준 다음 (service()) 등록된 HttpServletResponse 정보를 바탕으로 HTTP 응답을 생성해준다.

 

---

| HttpServletRequest 

- 서블릿은 HTTP 요청 메시지를 편리하게 사용할 수 있도록 대신 HTTP 요청 메시지를 파싱해준다.

    - 그래서 get() 메서드를 통해서 원하는 내용 (헤더, 바디 등...)을 편리하게 조회할 수 있다.

- 또한, HTTP 요청이 끝날 때까지 유지되는 임시 저장소 기능도 할 수 있다.

    - (저장) request.setAttribute(name, value) <-> (조회) request.getAttribute(name)

- 혹은, 세션 관리 기능도 제공해준다.

    - request.getSession(create: true) --> 채팅방 같은 기능에서 세션을 가져올 때 쓴다...!

 

[많이 사용할 것 같은 start-line 정보 파싱]

http://localhost:8080/request-header?username=hi

request.getMethod()	GET
request.getProtocol()	HTTP/1.1
request.getScheme()	http
request.getRequestURL();	http://localhost:8080/request-header
request.getRequestURI();	/request-header
request.getQueryString()	username=hi
request.isSecure()	false (https 여부)

 

⭐ Http 요청 메시지를 통해 클라이언트 -> 서버로 데이터 전달하기

✔ GET - 쿼리 파라미터

- /hello?username=hi&age=22

- 메시지 바디를 사용하지 않고, URL의 쿼리 파라미터에 데이터를 포함해서 전달하는 방법

ex) 검색, 필터, 페이징에서 많이 사용

 

- HttpServletRequest를 통해서 쿼리 파라미터 조회하기

형식	리턴 타입	설명
request.getParameter("username")	String	단일 파라미터 조회
request.getParameterNames()	Enumeration<String>	파라미터 네임 모두 조회
request.getParameterMap()	Map<String, String[]>	Map 형식으로 파라미터 조회
request.getParameterValues("username")	String[]	동일 이름의 복수 파라미터 조회

- 참고로, 동일한 이름의 파라미터가 존재했을 때 getParameter를 사용하면 첫 번째 값을 반환한다.

 

 

✔ POST - HTML Form 

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

- 메시지 바디에 쿼리 파라미터 형식으로 전달하는 방법 (username=hi&age=22)

ex) 회원 가입, 상품 주문, HTML form 사용 (form action="" method="post")

 

- 참고로, GET 방식이랑 형식이 동일하기 때문에 request.getParamter()로 동일하게 조회가 가능하다.

- 단, GET 방식의 경우 메시지 바디를 사용하지 않기 때문에 content-type이 없고, 

POST HTML form 방식은 메시지 바디에 데이터를 넣어서 전송하는 방법이기 때문에 content-type을 지정해주는 것이다.

 

 

✔ HTTP message body에 직접 담기

- HTTP API에서 주로 사용하는 방법.

ex) JSON, XML, TEXT

- 주로 JSON을 많이 사용한다. 

- POST, PUT, PATCH 방식

@WebServlet(name = "requestHeaderServlet", urlPatterns = "/request-header")
public class RequestHeaderServlet extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        ServletInputStream inputStream = req.getInputStream();
        String messageBody = StreamUtils.copyToString(inputStream,
                StandardCharsets.UTF_8);
        System.out.println("messageBody = " + messageBody);
        resp.getWriter().write("ok");
    }
}

- 가장 단순한 text 타입을 이용해서 테스트 하는 방법이다. Postman에서 타입을 raw->text 타입으로 하고 전송하면 된다.

- inputStream을 통해서 메시지 바디의 데이터를 바이트 코드로 바로 얻을 수 있다. 

- 바이트 코드를 string으로 바꾸기 위해서 StreamUtils.copyToString을 사용하였다. 인코딩 타입은 UTF_8이다.

 

- 다음으로, 가장 많이 사용하는 방법인 JSON 형식을 알아보자.

- content-type을 raw -> application/json으로 바꿔줘야 한다.

- messageBody에는 {"username:" "hi", "age": 22} 으로 작성해준다.

- 파싱을 위한 객체 하나를 생성하자.

 

[HelloData.java]

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

- Setter는 꼭 열어줘야 한다. (그래서 웬만하면 실제 개발에서는 DTO를 사용한다)

 

🚩 이번에 찾아보면서 알게 되었는데, ObjectMapper를 사용하면 setter가 없어도 필드에 접근할 수 있다!

- 찾아봤는데, 기본적으로 @Getter나 @Setter 중에 하나만 있어도 동작한다.

    - objectMapper는 동일한 이름의 필드명으로 매칭하는 게 아니라, getter와 setter를 통해서 매칭해준다!!

- @Setter가 필요없는 이유는, BeanDeserializer -> deserializeAndSet 메서드에서 reflection을 통해 값을 주입해주기 때문이다...!)

    - 리플랙션은 런타임에서 객체를 생성해주니까, 굳이 @Setter를 통해 미리 할 필요가 없다는 거.

(참고: 아래 블로그 링크! :D)

@RequestBody에 왜 기본 생성자는 필요하고, Setter는 필요 없을까? #3

- 그렇기 때문에 objectMapper를 사용하는 @RequestBody에서도 기본적으로 DTO에 @Setter를 안 붙여줘도 된다...!

- @Getter를 통해 사용한다면 public, @Setter를 사용한다면 private~public 모든 접근지정자가 가능하다고 한다.

 

@WebServlet(name = "requestHeaderServlet", urlPatterns = "/request-header")
public class RequestHeaderServlet extends HttpServlet {
    private final ObjectMapper objectMapper = new ObjectMapper();

    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        ServletInputStream inputStream = req.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.getUsername() = " + helloData.getUsername());
        System.out.println("helloData.getAge() = " + helloData.getAge());

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

- 아무튼, 다시 본론으로 돌아와서...

- Jackson의 ObjectMapper를 추가해주었다. 보통은 Bean으로 등록해서 사용하지만, 여기는 테스트니까 그냥 바로 객체를 생성해주었다.

- messageBody에 담긴 데이터를 HelloData라는 자바 객체로 변환해준다. 

- 실행해보면 getUsername, getAge를 통해 데이터가 잘 받아진 걸 확인해볼 수 있다 :)

 

---

| HttpServletResponse

- HttpServletResponse의 경우 HTTP 응답 메시지를 생성해준다.

- HTTP response Code, Header, Body를 생성해줄 수 있다.

- 혹은, Content-type을 지정하거나 쿠키 생성, Redirect 같은 기능도 제공한다!

 

[응답 코드 지정]

response.setStatus(HttpServletResponse.SC_OK); // 200

 

[헤더 지정]

response.setHeader("Content-Type", "text/plain;charset=utf-8")

 

[바디 지정]

response.getWriter().println("ok")

 

[content-type 편의 기능] - 헤더에서 지정한 Content-Type을 조금 더 쉽게 지정

response.setContentType("text/plain");

response.setCharacterEncoding("utf-8");

response.setContentLength(2)" // default로 2.

 

[쿠키 편의 기능] - Set-Cookie : myCookie=hello; Max-Age=600

Cookie cookie = new Cookie("myCookie", "hello");

cookie.setMaxAge(600);

response.addCookie(cookie);

 

[redirect 편의 기능] response.setStatus(HttpServletResponse.SC_FOUND); // 302

- redirectresponse.setHeader("Location", "/hello.html"); 

// 위의 두 코드를 하나로 합쳐준 기능

response.sendRedirect("/hello.html");

 

 

⭐ HTML 응답 데이터

✔ 텍스트로 응답하기

writer.println("hi");

 

✔ HTML로 응답하기

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

    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setContentType("text/html");
        resp.setCharacterEncoding("utf-8");

        PrintWriter writer = resp.getWriter();
        writer.println("<html>");
        writer.println("<body>");
        writer.println(" <div>안녕?</div>");
        writer.println("</body>");
        writer.println("</html>");
        resp.getWriter().write("ok");
    }
}

- 상당한 하드코딩이지만 이런 식으로 정적 html 응답도 가능하다. (하지만 이걸 쓰는 일은 없을 것 같다...)

 

 

✔ JSON으로 응답하기 

@WebServlet(name = "responseHeaderServlet", urlPatterns = "/response-header")
public class ResponseHeaderServlet extends HttpServlet {
    private final ObjectMapper objectMapper = new ObjectMapper();
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setHeader("content-type", "application/json");
        resp.setCharacterEncoding("utf-8");

        HelloData data = new HelloData();
        data.setUsername("hi");
        data.setAge(22);

        String result = objectMapper.writeValueAsString(data);
        resp.getWriter().write(result);
    }
}

- content-type을 json으로 설정해주었다. 객체에 setter를 통해 넣어주고, objectMapper를 통해서 JSON으로 변환해준다.

 

- 이렇게 기본적인 httpServletRequest, httpServletResponse에 대해서 알아보았다.

- 다음 포스팅에서는 본격적인 회원 관리 시스템을 정의하여 JSP, MVC 패턴을 본격적으로 다루어보겠다.