[Spring] HttpServletResponse / 응답 데이터 전달하는 방법

728x90

HttpServletResponse

🔍 HttpServletResponse 역할

HTTP 응답 메시지를 생성해준다.
- HTTP 응답코드를 지정해준다.
- 헤더를 생성해준다.
- 바디를 생성해준다.
편의 기능 제공
- Content-Type 지정 방법 지원
- 쿠키
- Redirect

🔍 Http response message 정보 조회 및 설정

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

@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);  // HTTP 응답 코드 지정

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

    private void content(HttpServletResponse response) {
        
        // response.set필드명() 메서드를 통해서  하나씩 지정해주는 방법
        response.setContentType("text/plain");
        response.setCharacterEncoding("utf-8");
//        response.setContentLength(2);  // 생략시 자동 생성된다.
    }

    private void cookie(HttpServletResponse response) {

        // 방법 1
//        response.setHeader("Set-Cookie", "myCookie=good Max-Age=600");

        // 방법2
        Cookie cookie = new Cookie("myCookie", "good");
        cookie.setMaxAge(600);  // 해당 쿠키는 600초 동안 유효하다.
        response.addCookie(cookie);
    }

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

        // 방법1
//        response.setStatus(HttpServletResponse.SC_FOUND);  // HTTP 응답코드 302
//        response.setHeader("Location", "/basic/hello-form.html");

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

HTTP 응답코드를 적을 때 200, 300 이런식으로 숫자로 적는것보다 HttpServletResponse.SC_OK 이런식으로 가시적으로 적는게 좋다.
status-line
- statusCode 지정
response-headers
- 데이터 타입 지정
header 편의 메서드
- response.setHeader() 메서드로 파리미터를 텍스트로 작성하는 것이 아닌 각각의 setter 메서드로 넣는 것이다.

🔍 HTTP 응답 데이터를 전달하는 3가지 방법.

단순 텍스트로 응답
HTML 응답
HTML API
- MessageBody에 JSON 형식의 데이터를 넣어서 응답

💡 단순 텍스트로 응답

response.getWriter().writer.println("ok");

💡 HTML 응답

📌 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 {
        // Context-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을 반환할 때는 context-type을 text/html로 지정해야한다.

💡 HTML 응답 데이터 - API JSON

📌 HelloData 클래스

package hello.servlet.basic;

import lombok.Getter;
import lombok.Setter;

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

}

HelloData 클래스는 필드 값을 JSON 객체로 만들기 위한 데이터 저장소 역할이다.

📌 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("kim");
        helloData.setAge(20);

        // {"username":"kim", "age":20}
        String result = objectMapper.writeValueAsString(helloData);  // 객체의 필드 값을 Json 문자로 변환
        response.getWriter().write(result);
    }
}

HTTP 응답으로 JSON을 반환할 때는 content-type을 application/json으로 지정해야 한다.
Jackson 라이브러리가 제공하는 objectMapper.writerValueAsString() 메서드를 사용해서 객체를 JSON 문자로 변경할 수 있다.

✔ 참고사항

application/json은 스펙상 utf-8 형식을 사용하도록 정의되어 있다.
그래서 굳이 utf-8 형식을 추가하지 않아도 된다.

👀 참고 자료

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

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

웹 애플리케이션을 개발할 때 필요한 모든 웹 기술을 기초부터 이해하고, 완성할 수 있습니다. 스프링 MVC의 핵심 원리와 구조를 이해하고, 더 깊이있는 백엔드 개발자로 성장할 수 있습니다., -

www.inflearn.com