[Spring] 스프링 MVC 핵심 기술 - 요청, 응답 서블릿

이글은 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 강의를 학습 후 
나중에 다시 복습하기 위해 정리한 글입니다.
문제시 비공개로 처리하겠습니다.

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

 

목차

1. HttpServletRequest
2. HTTP 요청 데이터
3. HttpServletResponse
4. HTTP 응답 데이터

---

1. HttpServletRequest

서블릿은 개발자가 Http 요청 메시지를 편리하게 사용할 수 있도록 개발자 대신에 Http 요청 메시지를 파싱한다.

그리고 이것을 HttpServletRequest 객체에 담아서 제공한다.

 

HttpServletRequest, HttpServletResponse 를 사용할 때 가장 중요한 점은 

이 객체들이 HTTP 요청 메시지, 응답 메시지를 편리하게 사용하도록 도와주는 객체라는 점이다.

따라서 이 기능에 깊이있게 이해하려면 HTTP 스펙이 제공하는 요청,응답 메시지 자체를 이해해야 한다.

임시 저장소 기능

HTTP 요청이 시작부터 끝날 때 까지 유지되는 임시 저장소 기능

• 저장 : request.setAttribute(name, value)
• 조회 : request.getAttribute(name)

세션 관리 기능

request.getSession() , default : true 

• true : 이미 생성된 세션이 있다면 그걸 반환, 없다면 새로운 세션을 반환
• false : 이미 생성된 세션이 있다면 그걸 반환, 없다면 null을 반환

기본 사용법

HttpServletRequest 가 제공하는 기본 기능들을 알아보자.

 

요청 객체의 start-line, header, 기타 정보 등을 출력하는 예시 class 이다.

hello.servlet.basic.request.RequestHeaderServlet

@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
        System.out.println("request.getRequestURL() = " + request.getRequestURL()); // http://localhost:8080/request-header
        System.out.println("request.getRequestURI() = " + request.getRequestURI()); // /request-header
        System.out.println("request.getQueryString() = " + request.getQueryString());// username=hi
        System.out.println("request.isSecure() = " + request.isSecure()); // false - https 사용 유무

        System.out.println("---REQUEST-LINE - end ---");
    }

    // 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);
        }*/

        request.getHeaderNames().asIterator()
                .forEachRemaining(headName -> System.out.println(headName + ": " + request.getHeader(headName)));

        System.out.println("--- Headers - end ---");
    }

    // 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("[Accept-Language 편의 조회]");
        request.getLocales().asIterator()
                .forEachRemaining(locale -> System.out.println("locale = " + locale));
        System.out.println("request.getLocale() = " + request.getLocale());

        System.out.println("[cookie 편의 조회]");
        if(request.getCookies() != null){
            for(Cookie cookie : request.getCookies()) {
                System.out.println(cookie.getName() + ": " + cookie.getValue());
            }
        }

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

    // 기타 정보
    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("[Local 정보]");
        System.out.println("request.getLocalName() = " + request.getLocalName());
        System.out.println("request.getLocalAddr() = " + request.getLocalAddr());
        System.out.println("request.getRemotePort() = " + request.getRemotePort());

        System.out.println("--- 기타 조회 end ---");
    }
}

---

2. HTTP 요청 데이터

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

• GET - 쿼리 파라미터
  • /url?username=hello&age=20
  • 메시지 바디 없이, URL 쿼리 파라미터에 데이터를 포함해서 전달
  • 검색, 필터, 페이징등에 많이 사용하는 방식
• POST - HTML Form
  • content-type: application/x-www-form-urlencoded
  • 메시지 바디에 쿼리 파라미터 형식으로 전달 username=hello&age=20
  • 회원 가입, 상품 주문, HTML Form 사용
• HTTP message body 에 데이터를 직접 담아서 요청
  • HTTP API에서 주로 사용 JSON, XML, TEXT 형태

GET - 쿼리 파라미터

• request.getParameterNames() : 전체 파라미터 조회
• request.getParameter() : 단일 파라미터 조회
• request.getParameterValues() : 중복 파라미터 조회

@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");
        request.getParameterNames().asIterator()
                .forEachRemaining(paramName -> System.out.println(paramName + "=" + request.getParameter(paramName)));

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

        System.out.println("[이름이 같은 복수 파라미터 조회]");
        String[] usernames = request.getParameterValues("username");
        for (String name : usernames) {
            System.out.println("username = " + name);
        }

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

POST - HTML Form

Form (html 파일) 을 만들어서 POST 요청을 보내면 되지만 POSTMAN 을 이용하면 더 편하게 보낼 수 있다.

어차피 API 통신을 할 때도 POSTMAN을 잘 사용한다.

참고 : GET 방식의 쿼리 파라미터를 통한 요청이든 POST 방식의 메시지 바디를 통한 요청이든 클라이언트 입장에선 차이가 있지만 서버 입장에선 둘의 형식이 동일하므로 request.getParameter() 로 동일하게 조회할 수 있다.

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

HTTP API에서 주로 사용한다. 

데이터 형식은 주로 JSON 형식을 사용한다.

- 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송

HTTP 메시지 바디의 데이터를 InputStream을 사용해서 직접 읽을 수 있음

참고 : inpustStream은 byte 코드를 반환한다. 
byte 코드는 우리가 읽을 수 있는 문자(String)로 보려면 문자표(Charset)를 지정해줘야한다. (UTF-8)

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

- JSON 형식으로 HTTP 메시지 바디에 담아서 전송

JSON 결과를 파싱해서 사용할 수 있는 자바 객체로 변환하려면 Jackson, Gson 같은 라이브러리를 추가해야한다.

스프링 부트(Spring MVC) 에선 Jackson 라이브러리 (ObjectMapper)를 함께 제공한다.

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


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

        HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
        System.out.println(helloData.getUsername());
        System.out.println(helloData.getAge());

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

---

3. HttpServletResponse

HTTP 응답 메시지 생성

• HTTP 응답코드 지정
• 헤더 지정
• 바디 생성

편의 기능 제공

• Content-Type
• 쿠키
• Redirect

기본 사용법

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

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

    private void content(HttpServletResponse response){
        // response.setHeader("Content-Type","text/plain;charset=utf-8");
        response.setContentType("text/plain");
        response.setCharacterEncoding("utf-8");
    }

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

    private void redirect(HttpServletResponse response) throws IOException {
        // response.setHeader("Location","/basic/hello-form.html");
        response.sendRedirect("/basic/hello-form.html");
    }
}

---

4. HTTP 응답 데이터

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

• 단순 텍스트 응답 (writer.write("ok"))
• HTML 응답
• HTTP API - JSON 응답

HTML 응답

HTTP 응답으로 HTML 을 반환할 때는 content-type을 text/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 API - JSON 응답

HTTP 응답으로 JSON 을 반환할 때는 content-type을 application/json로 지정해야 한다.

Jackson 라이브러리가 제공하는 objectMapper.writeValueAsString() 을 사용하면 객체를 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);
    }
}