서버 개발자가 HTTP 요청을 어떻게 받고, 응답을 어떻게 내려 줄건지, 이걸 어떻게 서블릿을 이용해서 서버에서 편하게 구현할지에 대해 생각해보자.
Servlet
자바 서블릿(Java Servlet)은 웹 서버에서 실행되는 자바 프로그램으로, 클라이언트로부터 HTTP 요청을 받아서 처리하고, 그 결과를 응답으로 되돌려준다.
자바 서블릿은 주로 동적인 웹 페이지를 생성하는 데 사용되며, 자바 기반의 웹 애플리케이션을 개발하는 중요한 구성 요소 중 하나입니다.
@ServletComponentScan // 서블릿 자동 등록
@SpringBootApplication
public class ServletApplication {
public static void main(String[] args) {
SpringApplication.run(ServletApplication.class, args);
}
}스프링 부트는 서블릿을 직접 등록해서 사용할 수 있도록 @ServletComponentScan 을 지원한다.
-> Spring이 @ServletComponentScan이 붙은 패키지를 포함한 하위 패키지들을 전부 뒤져서, 서블릿을 찾아서 자동으로 등록해준다.
package hello.servlet.basic;
@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");
}
}- /hello로 가면, service 로직이 실행된다.
- HTTP 요청이 오면, WAS가(서블릿 컨테이너가) request, response 객체를 만들어서 서블릿에 던져준다.
과정을 그림으로 자세히 살펴보자.
- 스프링 부트를 실행하면서 내장 톰캣 서버가 띄워진다.
- 톰캣 서버는 내부에 서블릿 컨테이너를 갖고있다.
- 여기에 서블릿을 모두 싱글톤으로 등록해준다.
- HTTP 요청 메시지를 기반으로 request, response 객체를 만들어서 helloServlet을 호출해준다.
- 필요한 작업을 하고 response에 정보, 데이터를 추가한다.
- WAS 서버가 response를 가지고 HTTP 응답을 반환해준다.
HttpRequestServlet
HTTP 요청 메시지를 개발자가 직접 파싱해서 사용해도 되지만, 매우 불편할 것이다.
서블릿은 개발자가 HTTP 요청 메시지를 편리하게 사용할 수 있도록 개발자 대신에 HTTP 요청 메시지를 파싱한다. 그리고 그 결과를 HttpServletRequest 객체에 담아서 제공한다.
한마디로, HttpServletRequest를 이용하면, HTTP 요청 메시지를 편리하게 파악할 수 있다.
HTTP request 종류
우선 클라이언트에서 서버로 HTTP 요청을 보내는 방법 3가지를 알아보자.
- GET - 쿼리 파라미터
- 메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
- /url?username=hello&age=20
- POST - HTML Form을 전송
- 메시지 바디에 쿼리 파리미터 형식으로 전달 username=hello&age=20
- content-type이 application/x-www-form-urlencoded
- HTTP Message Body에 직접 데이터를 담아서 전송
- HTTP API(rest api)에서 주로 사용
- 데이터 형식은 주로 JSON
이 방식을 하나씩 살펴보자.
HTTP 요청 데이터 - GET 쿼리 파라미터
@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("[전체 파라미터 조회]");
request.getParameterNames().asIterator()
.forEachRemaining(paramName -> System.out.println(paramName + " = " + request.getParameter(paramName)));
System.out.println("[단일 파라미터 조회]");
String username = request.getParameter("username");
String age = request.getParameter("age");
System.out.println("username = " + username);
System.out.println("age = " + age);
response.getWriter().write("okay");
}
}- http://localhost:8080/request-param?username=kim&age=20 으로 들어가면 아래와 같은 결과를 확인할 수 있다.
[전체 파라미터 조회]
username = hello
age = 20
[단일 파라미터 조회]
username = hello
age = 20- http://localhost:8080/request-param?username=hello&age=20&username=hello2 이런식으로 username에 대한 값이 중복된 경우는 어떻게 할까?
→request.getParameterValues(”usrename”)으로 모든 value를 얻을 수 있다.
HTTP 요청 데이터 - POST HTML Form
- 쿼리 파라미터와 형식이 똑같기 때문에, GET에서 사용한 쿼리 파라미터와 똑같이
request.getParameter()를 통해 데이터를 꺼낼 수 있다. - 폼으로 데이터를 전송하는 형식을 application/x-www-form-urlencoded라 한다.
HTTP 요청 데이터 - API 메시지 바디 - JSON
JSON 형식 파싱 추가
- 보통 JSON을 그대로 쓰지 않고, 객체로 바꿔서 사용한다.
- JSON 형식으로 파싱할 수 있게 객체를 하나 생성하자
import lombok.Getter;
import lombok.Setter;
@Getter
@Setter
public class HelloData {
private String username;
private int age;
}- lombok 라이브러리를 통해 getter, setter을 셋팅할 수 있다.
@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을 얻어와서 ObjectMapper을 이용해 HelloData 객체로 만들어준다.
HttpResponseServlet
이제 HTTP 응답에 대해 알아보자.
HTTP response 종류
- 단순 텍스트 응답
- 위의 코드에서도 나오는, response.getWriter().write("~~")을 통해 구현할 수 있다.
- HTML 응답
- HTTP API - MessageBody JSON 응답
HTTP 응답 데이터 - HTML
@WebServlet(name = "responseHtmlServlet", urlPatterns = "/response-html")
public class ResponseHtmlServlet extends HttpServlet {
@Override
protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
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 응답 데이터 - API 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 {
response.setContentType("application/json");
response.setCharacterEncoding("utf-8");
HelloData helloData = new HelloData();
helloData.setUsername("kim");
helloData.setAge(20);
String result = objectMapper.writeValueAsString(helloData);
response.getWriter().write(result);
}
}- HTTP 응답으로 JSON을 반환할 때는 content-type을 application/json로 지정해야 한다.
- Jackson 라이브러리가 제공하는
objectMapper.writeValueAsString()를 사용하면 객체를 JSON 문자로 변경할 수 있다.
