[Spring] 서블릿

Hello 서블릿

서블릿은 원래 톰캣같은 웹 애플리케이션 서버를 직접 설치하고, 그 위에 서블릿 코드를 클래스 파일로 빌드해서 올린다음 톰캣서버를 실행해야하는데, 스프링부트는 톰캣서버를 내장하고있어서 편리하게 서블릿 코드를 실행할 수 있다.

 

스프링부트에서 서블릿을 직접 등록해서 사용하려면

package hello.servlet;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.web.servlet.ServletComponentScan;
 
 
@ServletComponentScan //서블릿 자동 등록 
@SpringBootApplication
public class ServletApplication {
     public static void main(String[] args) {
         SpringApplication.run(ServletApplication.class, args);
    }
    
}

@ServletComponentScan어노테이션을 추가해야한다.

 

package hello.servlet.basic;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

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

이건 실제로 동작하는 서블릿 코드이다.

@WabServlet 어노테이션을 사용해서 이름과 url 패턴을 등록한다.

또한 HTTP 요청을 통해 매핑된 url이 호출되면

service 메서드를 실행한다.

 

만약 http 요청 메세지를 전부 보고싶다면

application.properties에서 

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

를 추가하면 된다.

 

그럼 콘솔에서 이런 화면을 볼 수 있다. 하지만, 운영서버에서 이렇게 하면 성능저하가 발생할 수 있으니 개발할 때만 쓰도록 한다

 

위 과정의 원리는 이렇다

먼저 내장 톰캣 서버가 서블릿 컨테이너에 helloServlet 객체를 생성한다.

 

만약 http 요청이 온다면 톰캣 서버가 request, response 객체를 생성해서 helloServlet 객체로 넘긴다. 

 

HttpServletRequest- 개요

http 요청 메세지를 개발자가 직접 파싱해서 사용하면 불편함 -> 서블릿은 http 메세지를 편리하게 사용할 수 있도록 http 요청 메세지를 파싱함

-> 그 결과를 httpServletRequest 객체에 담아서 제공함

 

다음과 같이 요청 메세지가 오면

start line(메소드, url, 쿼리...), 헤더, 바디를 조회한다.

 

HttpServletRequest는 추가로 여러가지 부가 기능을 제공하는데, 

 

임시저장소 기능

request.setAttribute(name, value)- 저장

request.getAttribute(name) - 조회

 

세션 관리 기능

request.getSession(create : true)

 

HttpServletRequset - 기본 사용법

이 부분에서 받은 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.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()); // 전체 URL
    System.out.println("request.getRequestURI() = " + request.getRequestURI()); // /request-header

    // username=hi
    System.out.println("request.getQueryString() = " + request.getQueryString());

    System.out.println("request.isSecure() = " + request.isSecure()); // https 사용 여부

    System.out.println();
}

위와 같은 방식으로 요청 메세지의 startLine 정보를 얻을 수 있고,

 

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

이렇게 하면 모든 헤더의 정보를 출력할 수 있다.

각각 얻는 방식도 있는데 일단 생략한다..ㅎㅎ

 

// 기타 정보
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();

    System.out.println("[Local 정보]");
    System.out.println("request.getLocalName() = " + request.getLocalName());
    System.out.println("request.getLocalAddr() = " + request.getLocalAddr());
    System.out.println("request.getLocalPort() = " + request.getLocalPort());

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

이렇게 하면 요청을 한 서버 정보와 로컬 정보도 알 수 있다.

 

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

/url?username = hello &age = 20

메세지, 바디 없이 url의 쿼리 파라미터에 데이터를 포함해서 전달한다.

검색필터, 페이징에서 많이 사용한다.

 

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

이건 쿼리파라미터 조회 메서드이다. 

 

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

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

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

쿼리파라미터는 위와 같이 조회할 수 있다.

request.getParameter("필드명")을 하면 해당 필드의 값을 얻을 수 있다.

 

만약 복수 파라미터(같은 파라미터명이 있는 것 존재)가 있다면

getParameterValues를 사용하여 모든 값을 출력해야한다.

 

HTTP 요청 데이터 - POST HTML Form

HTML의 Form을 사용해서 클라 -> 서버로 데이터를 전송하는 방식이다.

 

 

aplication/x-www-form-urlencoded 형식은 get에서 본 쿼리파라미터 형식과 같다. 

따라서 쿼리파라미터 조회 메서드를 그대로 사용하면 된다.

request.getParameter()로 편리하게 구분없이 조회할 수 있다.

 

여기서 주의할 점은 GET의 경우 body에 아무런 데이터가 들어가지 않아서 content-type이 없지만

POST HTML Form 형식은 body에 데이터를 보내기 때문에 꼭 content-type을 지정해야한다.

 

이를 테스트하기 위해서는 postman 테스트 시 Body에서 aplication/x-www-form-urlencoded를 선택하면 된다.

 

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

HTTP message body에 데이터를 직접 담아서 요청하는 방식이 있다.

JSON, XML, TEXT를 지원하고,

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

 

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

api의 바디 텍스트는 위와 같다.

request.getInputStream()을 사용하면 해당 메세지의 byte 코드를 얻을 수 있다

이를 변환하고 출력하면 우리가 원하는 정보를 얻을 수 있다

 

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

json 메세지를 보낼 때는

content-type:application/json

body : {"user":"helllo","age":30}

이런식으로 보내게 된다.

 

import lombok.Getter;
 import lombok.Setter;
 @Getter @Setter
 public class HelloData {
     private String username;
     private int age;
 }
```

이러한 객체가 있고, 이 객체에 대한 데이터를 json으로 보낸다고 할 때

 

@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 {

        // JSON 데이터를 문자열로 읽기
        ServletInputStream inputStream = request.getInputStream();
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

        System.out.println("messageBody = " + messageBody);

        // JSON -> 자바 객체 변환
        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내의 readValue 메서드로 객체로 변환한다.

 

원래 json결과를 파싱해서 자바 객체로 변환하려면 json변환 라이브러리를 추가해야하지만, spring MVC는 objectMapper를 함께 제공한다

 

HTML form도 메세지 바디를 통해 전송되므로 직접 읽을 수 있지만, 편리한 파라미터 기능이 이미 존재하기 때문에 그걸 쓰면 된다

 

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

response.setHeader("필드명","값")으로 헤더값을 설정할 수 있다.

 

private void content(HttpServletResponse response) {
    // Content-Type: text/plain;charset=utf-8
    // Content-Length: 2

    // 아래와 같이 편의 메서드를 사용하면 Content-Type 헤더를 자동 설정해줌
    response.setContentType("text/plain");
    response.setCharacterEncoding("utf-8");

    // Content-Length는 생략하면 자동으로 계산됨
    // response.setContentLength(2);
}

위와 같은 편의 메서드로 contentType, CaracterEncoding을 설정할 수 있다.

 

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

 

addCookie로 쿠키도 설정하고

 

// redirect 편의 메서드
private void redirect(HttpServletResponse response) throws IOException {
    // Status Code 302
    // Location: /basic/hello-form.html

    // 아래처럼 직접 상태 코드와 Location 헤더를 설정할 수도 있지만,
    // sendRedirect()가 이를 자동으로 처리해줌
    // response.setStatus(HttpServletResponse.SC_FOUND); // 302
    // response.setHeader("Location", "/basic/hello-form.html");

    response.sendRedirect("/basic/hello-form.html");
}

sendRedirect로 status 코드와 header 부분의 location에 들어갈 리다이렉트 url을 한번에 넣을 수 있다.

참고로 리다이렉트 http 코드에는 300번대 코드와 Location필드에 리다이렉트 url이 들어가야한다

 

HttpServletResponse - HTML 응답

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

HTML응답을 할때는 content타입을 html로 지정하고, 인코딩도 지정한 후 

writer을 선언해서 html 코드를 보내면 된다.

 

그러면 브라우저에 안녕이라는 글자가 출력됨을 확인할 수 있다.

 

HTTP 응답 데이터 - API JSON

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

    // 객체 -> JSON 문자열 변환
    String result = objectMapper.writeValueAsString(data);

    // 응답 출력
    response.getWriter().write(result);
}

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

인코딩 타입도 지정한 후 응답할 객체를 만든다.

객체를 json 형태의 문자열로 만드려면 objectMapper.writeValueAsString() 메서드로 사용하면 된다

 

출처 

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1/dashboard

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