Spring 서블릿 [HttpServletRequest/HttpServletResponse]

spring mvc강의를 듣기 시작했다!

mvc를 배우기 전에 서블릿부터 간단히 살펴보는데 잘 이해한 건지는 모르겠다...!

이번에는 서블릿을 이용해서 살펴본 요청과 응답 메시지를 확인해보고 작동 원리를 정리해보려고 한다.

 

---

🌠 스프링 부트에서 서블릿을 직접 등록해서 쓰려면 어노테이션을 하나 추가해야 한다.

@ServletComponentScan //서블릿 자동 등록

 

 

 

[ 서블릿 등록하기 ]

@WebServlet(name="", urlPatterns = "/")

• name : 서블릿 이름
• urlPatterns : URL 매핑

 

 

 

[ HttpServletRequest ]

 

먼저 http 요청 메시지를 살펴보자면.

POST /save HTTP/1.1
Host: localhost:8080
Content-Type: application/x-www-form-urlencoded

username=kin&age=20

👉 HttpServletRequest를 사용하면 위에 있는 HTTP 요청 메시지를 편하게 조회할 수 있다.

 

◾ START LINE

• HTTP 메서드
• URL
• 쿼리 스트링
• 스키마, 프로토콜

 

◾ 헤더

 

◾ 바디

• form 파라미터 형식 조회
• message body 데이터 직접 조회

➕ 부가 기능

 

◾ 임시 저장소 기능

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); // START LINE 출력
        printHeader(request); // 헤더 정보 출력
        printHeaderUtils(request); // 편리한 조회
        printEtc(request); //기타 정보
    }

이 클래스 안에서 요청 조회 클래스를 만들어서 요청 메시지를 조회한다.

 

🌠 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.getProtocal() = " + 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()); // null
        System.out.println("request.isSecure() = " + request.isSecure()); //https 사용 유무
        System.out.println("--- REQUEST-LINE - end ---");
    }

 

• request.getMethod() : http 메서드 조회 ( GET, POST, PATCH, PUT, DELETE...)
• request.getProtocol() : http프로토콜 조회
• request.getScheme() : http 스키마 조회 (http, https)
• request.getRequestURL() : http 주소 조회
• request.getRequestURI() : http uri 조회
• request.getQueryString() : http 쿼리 파라미터 조회 ( ex)? username=hello 여기에 있는 쿼리 파라미터)
• request.isSecure() : https인지 아닌지

실행하고 localhost:8080/request-header로 이동하면 START LINE 정보가 출력된다.

 

🌠 헤더 정보

private void printHeader(HttpServletRequest request) {
        System.out.println("--- Header - start ---");

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

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

모든 헤더 정보를 출력해준다.

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

위와 같은 주소로 조회했을 경우에 아래와 같은 정보가 출력된다.

 

 

🌠 Header 편리한 조회

📁 header (host, port) , Accept-Language, cookie, Content 조회하기

 

◾ header (host, port) 조회

System.out.println("[Host 편의 조회]");
System.out.println("request.getServerName() = " +
	request.getServerName()); //Host 헤더
System.out.println("request.getServerPort() = " +
	request.getServerPort()); //Host 헤더

 

◾ Accept-Language 조회

request.getLocales().asIterator()
		.forEachRemaining(locale -> System.out.println("locale = " + locale));
System.out.println("request.getLocale() = " + request.getLocale());

 

◾ Cookie 조회

if (request.getCookies() != null) {
		for (Cookie cookie : request.getCookies()) {
			System.out.println(cookie.getName() + ": " + cookie.getValue());
		}
}

 

◾ Content 조회

System.out.println("request.getContentType() = " + request.getContentType());
System.out.println("request.getContentLength() = " + request.getContentLength());
System.out.println("request.getCharacterEncoding() = " + request.getCharacterEncoding());

 

🌠 기타 정보

📁 Remote 정보, Local 정보

 

◾ Remote 정보

System.out.println("request.getRemoteHost() = " + request.getRemoteHost()); 
System.out.println("request.getRemoteAddr() = " + request.getRemoteAddr()); 
System.out.println("request.getRemotePort() = " + request.getRemotePort());

◾ Local 정보

System.out.println("request.getLocalName() = " + request.getLocalName());
System.out.println("request.getLocalAddr() = " + request.getLocalAddr());
System.out.println("request.getLocalPort() = " + request.getLocalPort());

 

 

[ HTTP 요청 데이터 ]

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

 

◾ GET - 쿼리 파라미터

• /url? username=hello&age=20
• 메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
• Ex) 검색, 필터, 페이징에서 많이 사용

◾ POST -  HTML Form

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

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

• HTTP  API에서 주로 사용, JSON, XML, TEXT
• 데이터 형식은 주로 JSON 사용 (POST, PUT, PATCH)

✍ GET과 POST는 쿼리 파라미터 형식으로 전달하기 때문에 request.getParameter()로 조회 가능

 

 

🌠  Get

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

위와 같이 username을 2개 넣고, age를 넣는 쿼리 파라미터 주소에 넣었다. get방식은 주소에 쿼리 파라미터 형식으로 조회하기 때문에 url에 넣어서 조회해야 한다.

@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("[전체 파라미터 조회] - end");
        System.out.println();

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

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

>> 실행화면

 

🌠 POST

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

<!DOCTYPE html>
<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-param으로 작동하도록 했기 때문에 위에 GET으로 조회했던 것과 결과가 똑같이 나온다.

위에서 설명했듯이 GET과 POST는 모두 쿼리 파라미터로 데이터를 전송하기 때문에 똑같이 조회할 수 있다.

 

🌠 HTTP 요청 데이터 - JSON

@Getter @Setter //getter setter를 lombok으로 자동 세팅
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 = " + messageBody);

        HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);

        System.out.println("helloData.username = " + helloData.getUsername());
        System.out.println("helloData.age = " + helloData.getAge());

    }
}

>> 조회 화면

POST MAN을 이용해서 조회해보았다. 그럼 이렇게 JSON 형식으로 조회가 가능하다. 

JSON 방법이 읽기 편해서 가장 많이 쓴다고 한다!

 

 

[ HttpServletResponse ]

 

📁 HttpServletResponse 역할

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

    //content 편의 메서드
    private void content(HttpServletResponse response) {
        response.setContentType("text/plain");
        response.setCharacterEncoding("utf-8");
    }

    //cookie 편의 메서드
    private void cookie(HttpServletResponse response) {
        Cookie cookie = new Cookie("myCookie", "good");
        cookie.setMaxAge(600); //600초
        response.addCookie(cookie);
    }

    //redirect 편의 메서드
    private void redirect(HttpServletResponse response) throws IOException {
        response.sendRedirect("/basic/hello-form.html");
    }
}

 

✍ response.setStatus(HttpServletResponse.SC_OK); 이걸 쓰는 이유는 200 ok를 지정해주는 것이다.

response.setStatus(200); 이렇게 써도 된다! 

개발자 도구에서 확인해볼 수 있다. 다른 숫자로 바꾸면 다른 숫자로 나온다!

 

redirect에 관한 내용은 이전 포스팅에서 확인할 수 있다! 👇

HTTP 상태코드 정리

 

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

HTTP 응답 메시지는 HTML로 담아서 전달하는 경우와 JSON으로 나눠서 전달하는 경우가 있다.

먼저 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"); //HTML로 반환할때는 꼭 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>");
        
        // servlet으로 html렌더링할때는 이렇게 적어야됨
    }
}

>> 실행 화면

이렇게 안녕?이라고 나오지만 개발자 도구에서 소스파일을 살펴보면 응답으로 보낸 html가 들어있는 걸 확인할 수 있다!!

 

 

🌠 HTTP 응답 데이터 - 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"); //Content-Type: application/json 로 지정해줘야됨
        response.setCharacterEncoding("utf-8");

        HelloData helloData = new HelloData();
        helloData.setUsername("kim");
        helloData.setAge(20);

        //{"username":"kim", "age":20}
        String result = objectMapper.writeValueAsString(helloData); //객체를 JSON문자로 변경
        response.getWriter().write(result);
    }
}

 

>> 실행화면

소스코드를 봐도 json 형식으로 응답되었다!!

 

 

✍ json은 이미 초기 설정이 utf-8이기 때문에 굳이 추가해줄 필요가 없다.

 

 

---

서블릿은 이름만 들었을 때 되게 어려울 것이라고 생각했는데 이렇게 실습으로 해보니까 어느 정도 이해가 간 것 같다.

블로그로 정리하니까 한번 더 정리하는 느낌이어서 좋은 것 같다!! 😊

mvc를 사용하면 이것보다 훨씬 코드가 많이 줄어든다던데 벌써 신기하다,,

웹페이지가 뒤에서 되게 복잡하게 동작하고 있다는 것을 다시 한번 느끼게 되었다( ɵ̥̥ ˑ̫ ɵ̥̥) 앞으로 더 파이팅!

 

이 포스팅은 인프런 김영한 님의 스프링 MVC1편을 듣고 작성된 복습 정리 포스팅입니다.