본문 바로가기
Spring Tutorial

[스프링MVC 기본 기능 9] HTTP 응답 데이터

by 미소5 2023. 8. 24.
  • 스프링(서버)에서 응답 데이터를 만드는 방법 ( 3가지 )
    1. 정적 리소스
      • 예) 웹 브라우저에 정적인 HTML, css, js를 제공할 때는, 정적 리소스를 사용한다.
    2.  뷰 템플릿 
      • 예) 웹 브라우저에 동적인 HTML을 제공할 때는 뷰 템플릿을 사용한다.
    3. HTTP 메시지 
      • HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.

 

1. 정적 리소스는 해당 파일을 변경 없이 그대로 서비스하는 것이다.

  • 스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공한다.
    • /static , /public , /resources , /META-INF/resources
    •  src/main/resources는 리소스를 보관하는 곳이고, 클래스패스의 시작 경로 → 이 디렉토리에 리소스를 넣어두면 스프링 부트가 정적 리소스로 서비스를 제공

 

  • 정적 리소스 경로 src/main/resources/static
    • src/main/resources/static/basic/hello-form.html 이 경로에 파일이 들어있으면 
    • 웹 브라우저에서 http://localhost:8080/basic/hello-form.html 와 같이 실행하면 된다. 

 

2. 뷰 템플릿을 거쳐서 HTML이 생성되고, 뷰가 응답을 만들어서 전달한다. (일반적으로 HTML을 동적으로 생성하는 용도로 사용하지만, 다른 것들도 뷰 템플릿이 만들 수 있는 것이라면 뭐든지 가능)

  • 스프링 부트는 기본 뷰 템플릿 경로를 제공 src/main/resources/templates

 

  • 뷰 템플릿 생성
    • src/main/resources/templates/response/hello.html
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<p th:text="${data}">empty</p>
</body>
</html>

 

  • String을 반환하는 경우 - View or HTTP 메시지
    • @ResponseBody가 없으면, response/hello로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 
    • @ResponseBody가 있으면, 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 "response/hello"라는 문자가 입력
      • @ResponseBody , HttpEntity 를 사용하면, 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 응답 데이터를 출력할 수 있다.
/**뷰 템플릿을 호출하는 컨트롤러*/

@Controller
public class ResponseViewController {

    @RequestMapping("/response-view-v1")
    public ModelAndView responseViewV1() {
        ModelAndView mav = new ModelAndView("response/hello")
                .addObject("data", "hello!");
        return mav;
    }

    @RequestMapping("/response-view-v2")
    public String responseViewV2(Model model) {
        model.addAttribute("data", "hello!!");
        return "response/hello";
    }

}
  • 뷰의 논리 이름인 response/hello를 반환하면 templates/response/hello.html 경로의 뷰 템플릿이 렌더링되는 것을 확인할 수 있다. 

 

  • Void를 반환하는 경우 (권장X, 명시성이 떨어짐)
    • @Controller를 사용하고, HttpServletResponse , OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용
      • 요청 URL: /response/hello
      • 실행: templates/response/hello.html
@RequestMapping("/response/hello")
public void responseViewV3(Model model) {
    model.addAttribute("data", "hello!!");
}

 

  • 스프링 부트의 타임리프 관련 설정
    • build.gradle에 다음 라이브러리를 추가 (Thymeleaf 설정)
      • 스프링 부트가 자동으로 ThymeleafViewResolver 와 필요한 스프링 빈들을 등록
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf

 

  • application.properties
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html

이 설정은 기본 값 이기 때문에 변경이 필요할 때만 설정하면 된다.

 

 

 

3. HTTP API를 제공하는 경우, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.

  • HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달된다. 여기서 설명하는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 전달하는 경우를 말한다.

 

@Slf4j
@Controller
public class ResponseBodyController {

    @GetMapping("/response-body-string-v1")
    public void responseBodyV1(HttpServletResponse response) throws IOException {
        
        response.getWriter().write("ok");
        //서블릿을 직접 다룰 때처럼 HttpServletResponse객체를 통해 HTTP 메시지 바디에 직접 ok 응답 메시지를 전달
    
    }
  • ResponseEntity 는 HttpEntity를 상속 받았다.
    • HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있고
    • ResponseEntity는 여기에 더해 HTTP 응답 코드도 설정할 수 있다.
@GetMapping("/response-body-string-v2")
public ResponseEntity<String> responseBodyV2() {

    return new ResponseEntity<>("ok", HttpStatus.OK);   
    //HttpStatus.CREATED로 변경하면 201 응답
    
}
@ResponseBody   //view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력 
@GetMapping("/response-body-string-v3")
public String responseBodyV3() {
    return "ok";
}
@GetMapping("/response-body-json-v1")
public ResponseEntity<HelloData> responseBodyJsonV1() { //ResponseEntity를 반환
    HelloData helloData = new HelloData();
    helloData.setUsername("userA");
    helloData.setAge(20);

    return new ResponseEntity<>(helloData, HttpStatus.OK);
    //HTTP 메시지 컨버터를 통해서 JSON 형식으로 변환되어서 반환
}

@ResponseBody   //@ResponseBody를 사용하는데, HTTP 응답 코드 설정하려면?
@ResponseStatus(HttpStatus.OK)  //응답 코드 설정   //동적으로 변경하려면 ResponseEntity를 사용하면 된다.
@GetMapping("/response-body-json-v2")
public HelloData responseBodyJsonV2() {
    HelloData helloData = new HelloData();
    helloData.setUsername("userA");
    helloData.setAge(20);

    return helloData;
}
  • @RestController
    • @Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러의 모든 메서드에 @ResponseBody 가 적용되는 효과가 있다. 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다. 이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러이다.
      • @RestController 에노테이션 안에 @ResponseBody와 @Controller가 적용되어 있고, @ResponseBody 는 클래스 레벨에 두면 전체 메서드에 적용된다.

 

 

[스프링 MVC 15] 서블릿: HTTP 응답 데이터 (tistory.com)

 

[스프링 MVC 15] 서블릿: HTTP 응답 데이터

HTTP 응답 메시지는 주로 다음 내용을 담아서 전달한다. (3가지) 단순 텍스트 응답 writer.println("ok"); HTML 응답 HTTP API - MessageBody JSON 응답 HttpServletResponse - HTML 응답 HTTP 응답으로 HTML을 반환할 때는 con

joly156.tistory.com

[스프링 MVC 13] 서블릿: HTTP 요청 데이터 - API 메시지 바디 (tistory.com)

 

[스프링 MVC 13] 서블릿: HTTP 요청 데이터 - API 메시지 바디

HTTP message body에 데이터를 직접 담아서 담아서 요청 먼저 가장 단순한 텍스트 메시지를 담아 전송하고, 읽어보자 HTTP 메시지 바디의 데이터를 InputStream을 사용해서 직접 읽을 수 있다 @WebServlet(name

joly156.tistory.com

 

728x90
반응형

'Spring Tutorial' 카테고리의 다른 글

[스프링MVC 기본 기능 11] 요청 매핑 핸들러 어댑터 구조  (1) 2023.08.27
[스프링MVC 기본 기능 10] HTTP 메시지 컨버터  (0) 2023.08.26
[스프링MVC 기본 기능 8] HTTP 요청 메시지 - JSON  (0) 2023.08.23
[스프링MVC 기본 기능 7] HTTP 요청 메시지 - 단순 텍스트  (0) 2023.08.23
[스프링MVC 기본 기능 6] HTTP 요청 파라미터 - @ModelAttribute  (0) 2023.08.22

관련글

티스토리툴바