서블릿2

LeeKyoungChang·2022년 1월 7일

spring, jpa 강의를 보고 정리한 내용입니다.

목록 보기

24/107

'스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술' 수업을 듣고 정리한 내용입니다.

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

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

HTTP API에서 주로 사용

JSON, XML, TEXT에서 사용되는 방식

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

POST, PUT, PATCH

main.java.hello.servlet.basic.request.RequestBodyStringServlet

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

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


package hello.servlet.basic.request;

import org.springframework.util.StreamUtils;

import javax.servlet.ServletException;
import javax.servlet.ServletInputStream;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;

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

📝 참고
inputStream은 byte 코드를 반환한다. byte 코드를 우리가 읽을 수 있는 문자(String)로 보려면 문자표(Charset)를 지정해주어야 한다.
여기서는 UTF_8_Charset을 지정해주었다.

Postman을 사용해서 테스트

문자 전송

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

content-type: text/plain

message body: hello

결과: messageBody = hello

Body를 Text로 주었기 때문에
Header 에서는 Content-Type이 text/plain 이다.

결과

Content-Type: text/plain
User-Agent: PostmanRuntime/7.28.4
Accept: */*
Postman-Token: 17e2915b-d0b6-4a6c-88c0-7afcf15e9fb9
Host: localhost:8080
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 6

hello!]
messageBody = hello!
2022-01-06 17:05:56.880 DEBUG 3018 --- [nio-8080-exec-6] o.a.coyote.http11.Http11InputBuffer      : Before fill(): parsingHeader: [true], parsingRequestLine: [true], parsingRequestLinePhase: [0], parsingRequestLineStart: [0], byteBuffer.position(): [0], byteBuffer.limit(): [0], end: [266]
2022-01-06 17:05:56.882 DEBUG 3018 --- [nio-8080-exec-6] o.a.coyote.http11.Http11InputBuffer      : Received []
2022-01-06 17:05:56.883 DEBUG 3018 --- [nio-8080-exec-6] o.apache.coyote.http11.Http11Processor   : Socket: [org.apache.tomcat.util.net.NioEndpoint$NioSocketWrapper@3c567e0e:org.apache.tomcat.util.net.NioChannel@5a95f425:java.nio.channels.SocketChannel[connected local=/0:0:0:0:0:0:0:1:8080 remote=/0:0:0:0:0:0:0:1:56632]], Status in: [OPEN_READ], State out: [OPEN]

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

이번에는 HTTP API에서 주로 사용하는 JSON 형식으로 데이터를 전달해보자.

JSON 형식 전송

POST http://localhost:8080/request-body-string
content-type: applicaiton/json
message body: {"username": "hello", "age": 20}
결과: messageBody = {"username": "hello", "age": 20}

📖 A. JSON 형식 파싱 추가

JSON 형식으로 파싱할 수 있게 객체를 하나 생성하자!
username 과 age를 담을 수 있는 JSON 객체가 만들어진다.

main.java.hello.servlet.basic.HelloData

package hello.servlet.basic;

import lombok.Getter;
import lombok.Setter;

// Lombok 사용
@Getter @Setter
public class HelloData {
    private String username;
    private int age;


}

lombok이 제공하는 @Getter, @Setter 덕분에 다음 코드가 자동으로 추가된다.

package hello.servlet.basic;

public class HelloData {
    private String username;
    private int age;
//==== lombok 생성 코드 ====// public String getUsername() {
          return username;
}

    public void setUsername(String username) {
        this.username = username;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

main.java.hello.servlet.basic.request.RequestBodyJsonServlet
JSON 방식의 API와 매핑해줄 서블릿

package hello.servlet.basic.request;

import com.fasterxml.jackson.databind.ObjectMapper;
import hello.servlet.basic.HelloData;
import org.springframework.util.StreamUtils;

import javax.servlet.ServletException;
import javax.servlet.ServletInputStream;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;


/*
* http://localhost:8080/request-body-json
*
* JSON 형식 전송
* content-type: application/json
* message-body: {"username": "hello", "age": 20}
*
* */

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

Postman을 이용한 실행 결과

Content-Type: application/json


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

📝 참고
JSON 결과를 파싱해서 사용할 수 있는 자바 객체로 변환하려면 Jackson, Gson 같은 JSON 변한 라이브러리를 추가해서 사용해야 한다.
스프링 부트로 Spring MVC를 선택하면 기본으로 Jackson 라이브러리 (ObjectMapper)를 함께 제공한다.

📝 참고
HTML form 데이터도 메시지 바디를 통해 전송되므로 직접 읽을 수 있다. 하지만 편리한 파라미터 조회 기능 (request.getParameter(...))을 이미 제공하기 때문에 파라미터 조회 기능을 사용하면 된다.

📚 3. HttpServletResponse - 기본 사용법

📖 1. `HttpServletResponse` 역할

HTTP response 메시지를 편리하게 만들 수 있도록 제공되는 객체
HTTP 응답 메시지 생성

HTTP 응답코드 지정

헤더 생성

바디 생성

편의 기능 제공
Content-Type, 쿠키, Redirect

main.java.hello.servlet.basic.response.ResponseHeaderServlet

package hello.servlet.basic.response;

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

/*
* http://localhost:8080/response-header
*
* */

@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); // 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"); // messagebody에 출력된다.

    }

HttpServletResponse.SC_OK : 서블릿에서는 HttpServletResponse에서 상태코드를 의미있는 상수로 작성해 놓았다. (SC_OK : 200)
response.setHeader(...) : 예제 코드에 작성된 헤더 내용은 캐시를 완전히 무효화 하겠다는 내용이다.

Content 편의 메서드

    private void content(HttpServletResponse response){
        //Content-Type: text/plain;charset=utf-8
        // Content-Length: 2
        // response.setHeader("Content-Type", "text/plain;charset=utf-8");
        response.setContentType("text/plain");
        response.setCharacterEncoding("utf-8");
        // response.setContentLength(2); //(생략시 자동 생성)
    }

status-line : statusCode 지정
response-header : 데이터 타입 등을 지정
header 편의 메서드 : setHeader 로 텍스트로 필드를 삽입 하는 것이 아니라 하나하나 각각 setter로 지정

쿠키 편의 메서드

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

쿠키 편의 메소드를 사용하지 않을 시, setHeader메소드에 Set-Cookie 라는 name으로 value를 직접 입력해야 한다.
편의 메서드를 통해 쿠키와 쿠키의 유효시간을 모두 손쉽게 설정할 수 있다.

redirect 편의 메서드

    private void redirect(HttpServletResponse response) throws IOException {
        //Status Code 302
        //Location: /basic/hello-form.html
//        response.setStatus(HttpServletResponse.SC_FOUND); //302
//        response.setHeader("Location", "/basic/hello-form.html");
        response.sendRedirect("/basic/hello-form.html");  // 위 두줄과 같은 결과가 나온다.
    }

리다이렉트 편의 메서드를 사용하지 않고 리다이렉트를 유도하려면 response의 상태코드를 SC_FOUND(302) 로 설정한 뒤 Header에 Location의 값으로 리다이렉션 해야하는 경로를 입력해줘야 한다.
편의 메서드인 sendRedirect에 리다이렉션할 경로만 파라미터로 넣어주면, 자동으로 302 상태코드와 리다이렉션할 경로를 응답메세지에 설정해준다.

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

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

단순 텍스트 응답 : writer.println("ok");

HTML 응답

HTTP API : MessageBody, JSON 응답

📖 A. HttpServletResponse - HTML 응답

main.java.hello.servlet.basic.response.ResponseHtmlServlet


package hello.servlet.basic.response;

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;
import java.io.PrintWriter;

@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로 지정해야 한다.

HTML으로 반환한다는 내용을 setContentType으로 content-type을 지정해줘야 웹 브라우저에서는 정상적으로 해당 응답 결과 message body를 html으로 렌더링하여 사용자에게 보여준다.
서블릿을 통해 html 소스를 작성해주었으며, 동적으로 내용이 추가되거나 분기를 해야하는 경우 해당 메서드에서 작업을 수행하면 된다.
ex) writer.println(" <div>안녕?</div>");

실행
http://localhost:8080/response-html
스크린샷 2022-01-07 오후 12 27 57

페이지 소스 보기
스크린샷 2022-01-07 오후 12 28 20

📚 5. HTTP 응답 데이터 - API JSON

main.java.hello.servlet.basic.response.ResponseJsonServlet

package hello.servlet.basic.response;

import com.fasterxml.jackson.databind.ObjectMapper;
import hello.servlet.basic.HelloData;

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 = "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.setContentType("application/json");
        response.setCharacterEncoding("utf-8");

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

        // {"username":"kim", "age":20}
        String result = objectMapper.writeValueAsString(helloData);
        response.getWriter().write(result);
    }
}

ObjectMapper 를 사용해서 HelloData 객체를 json으로 만들어주고 있다.
application/json 은 기본이 utf-8 이므로 charset 이 설정되어 있기에 setCharacterEncoding 을 해주지 않아도 된다.
HTTP 응답으로 JSON을 반환할 때는 content-type을 application/json 으로 지정해야 한다.
Jackson 라이브러리가 제공하는 objectMapper.writeValueAsString() 을 사용하면 객체를 JSON 문자로 변경할 수 있다.

실행 결과
http://localhost:8080/response-json

📝 참고
application/json 은 스펙상 utf-8 형식을 사용하도록 정의되어 있다.
스펙에서 charset=utf-8과 같은 추가 파라미터를 지원하지 않는다.
따라서 application/json 이라고만 사용해야지 application/json;charset=utf-8 이라고 전달하는 것은 의미 없는 파라미터를 추가한 것이 된다.
response.getWriter()를 사용하면 추가 파라미터를 자동으로 추가해버린다.
이때는 response.getOutputStream()으로 출력하면 그런 문제가 없다.