Back-end

2. 서블릿

-운- 2023. 11. 28. 19:04

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

스프링은 톰캣 서버를 내장하고 있어 서블릿 코드 실행에 편리하다.

따라서 Main 함수에 @ServletComponentScan를 추가하여 서블릿의 사용을 지원하도록 하자.

package hello.servlet.basic;

import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;

@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("req = " + req);
        System.out.println("resp = " + resp);
        String username = req.getParameter("username");
        System.out.println("username = " + username);

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

 

@WebServlet 서블릿 애노테이션

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

직접 localhost:8080/hello를 인터넷에 치고 들어가면 페이지를 확인할 수 있다.

 

과정에서 에러가 많았는데, 가장 큰 에러는 실행 자체가 안되는 것이었다.

이는 강의에서 run을 빠른 속도로 하기 위해 인텔리제이에서 이루어지도록 바꿨으나 이때문에 오류가 난다고 하여 다시 gradle로 바꾸었다.

 

application.properties에

logging.level.org.apache.coyote.http11=debug를 추가하여 HTTP 요청 메세지를 출력하도록 할 수 있다.

 

welocme 페이지를 추가하여 개발 내용을 편리하게 참고할 수 있도록 하였다. html 코드를 추가하였다.

<!DOCTYPE html>
<html>
<head>
 <meta charset="UTF-8">
 <title>Title</title>
</head>
<body>
<ul>
 <li><a href="basic.html">서블릿 basic</a></li>
</ul>
</body>
</html>
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<ul>
    <li>hello 서블릿
        <ul>
            <li><a href="/hello?username=servlet">hello 서블릿 호출</a></li>
        </ul>
    </li>
    <li>HttpServletRequest
        <ul>
            <li><a href="/request-header">기본 사용법, Header 조회</a></li>
            <li>HTTP 요청 메시지 바디 조회
                <ul>
                    <li><a href="/request-param?username=hello&age=20">GET -
                        쿼리 파라미터</a></li>
                    <li><a href="/basic/hello-form.html">POST - HTML Form</a></
                    li>
                    <li>HTTP API - MessageBody -> Postman 테스트</li>
                </ul>
            </li>
        </ul>
    </li>
    <li>HttpServletResponse
        <ul>
            <li><a href="/response-header">기본 사용법, Header 조회</a></li>
            <li>HTTP 응답 메시지 바디 조회
                <ul>
                    <li><a href="/response-html">HTML 응답</a></li>
                    <li><a href="/response-json">HTTP API JSON 응답</a></li>
                </ul>
            </li>
        </ul>
    </li>
</ul>
</body>
</html>

 

HttpServletRequest

서블릿은 개발자의 HTTP 요청 메세지를 편리하도록 만들고 이는 요청 메세지 파싱이 이루어지도록 한다.

package hello.servlet.basic.request;

import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.Cookie;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;

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

    }
    
//Start-Line 정보
    private static 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());
        // /request-header
        System.out.println("request.getRequestURI() = " + request.getRequestURI());
        //username=hi
        System.out.println("request.getQueryString() = " +
                request.getQueryString());
        System.out.println("request.isSecure() = " + request.isSecure()); //https 사용 유무
        System.out.println("--- REQUEST-LINE - end ---");
        System.out.println();
    }
    
    
//헤더 정보
    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 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();
        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();
        System.out.println("[cookie 편의 조회]");
        if (request.getCookies() != null) {
            for (Cookie cookie : request.getCookies()) {
                System.out.println(cookie.getName() + ": " + cookie.getValue());
            }
        }
        System.out.println();
        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 ---");
        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 요청 데이터

 

HTTP 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달할 때는 주로 3가지 방법을 이용한다.

 

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

데이터 형식은 주로 JSON 사용

POST, PUT, PATCH

 

 

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

 

쿼리 파라미터는 URL에 다음과 같이 '?' 를 시작으로 보낼 수 있다. 추가 파라미터는 '&' 로 구분하면 된다.

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

 

package hello.servlet.basic.request;

import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;

@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("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.getParameterValues() 를 사용해야 한다.

 

HTTP 요청 데이터 - 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>

실행하고 

http://localhost:8080/basic/hello-form.html에 들어가면

username과 age를 작성해 전송하는 것이 생긴 것을 확인할 수 있다.

 

POST의 HTML Form을 전송하면 웹 브라우저는 다음 형식으로 HTTP 메시지를 만든다.

(웹 브라우저 개발자 모드 확인)

  • 요청 URL: http://localhost:8080/request-param
  • content-type: application/x-www-form-urlencoded
  • message body: username=hello&age=20

request.getParameter() 는 GET URL 쿼리 파라미터 형식도 지원하고, POST HTML Form 형식도 둘 다 지원한다

 

ㅇPostman을 사용해 test해보자.

 

 

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

 

@WebServlet(name = "requestBodyStringServlet", urlPatterns = "/request-bodystring")
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");
 	}
}

먼저 가장 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송하고, 읽어보자.

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

 

문자 전송

POST http://localhost:8080/request-body-string

content-type: text/plain

message body: hello

 

결과: messageBody = hello

 

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

 

JSON 형식 전송

POST http://localhost:8080/request-body-json

content-type: application/json

message body: {"username": "hello", "age": 20}

 

결과: messageBody = {"username": "hello", "age": 20}

 

WebServlet(name = "requestBodyJsonServlet", urlPatterns = "/request-bodyjson")
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");
 	}
}

posrtman 실행

POST http://localhost:8080/request-body-json

content-type: application/json (Body raw, 가장 오른쪽에서 JSON 선택)

message body: {"username": "hello", "age": 20}

 

결과

messageBody={"username": "hello", "age": 20}

data.username=hello

data.age=20

 

 

HttpServletResponse - 기본 사용법

 

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

 

 

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

 

단순 텍스트 응답 앞에서 살펴봄 ( writer.println("ok");

@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 응답으로 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 {
		//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);
	}
}

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

Jackson 라이브러리가 제공하는 objectMapper.writeValueAsString() 를 사용하면 객체를 JSON 문자로 변경할 수 있다

'Back-end' 카테고리의 다른 글

04. MVC 프레임워크 만들기  (0) 2023.12.26
03. 서블릿, JSP, MVC 패턴  (1) 2023.12.17
01. 웹 플리케이션 이해  (0) 2023.11.19
09. 빈 스코프  (1) 2023.11.14
08. 빈 생명주기 콜백  (0) 2023.11.05

'Back-end'의 다른글

  • 현재글2. 서블릿

관련글

티스토리툴바