[Spring MVC] HTTP 응답

응답 데이터 만드는 방법

• 정적 리소스
  • Ex) 웹 브라우저에서 정적인 HTML, css, js를 제공할 때 사용.
• 뷰 템플릿 사용
  • Ex) 웹 브라우저에서 동적인 HTML을 제공할 때 사용.
• HTTP 메시지 사용
  • HTTP API를 제공하는 경우에는 HTML이 아닌 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON같은 형식으로 데이터를 보낸다.

정적 리소스

스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공한다.
/static, /public, /resources, /META-INF/resources

src/main/resources는 리소스를 보관하는 곳이고, 클래스패스의 시작 경로이다.

정적 리소스 경로
src/main/resources/static

뷰 템플릿

뷰 템플릿을 거쳐서 HTML이 생성되고, 뷰가 응답을 만들어서 전달한다.

뷰 템플릿 경로
src/main/resources/templates

ResponseViewController

뷰 템플릿을 호출하는 컨트롤러

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

    @RequestMapping("/response/hello")
    public void responseViewV3(Model model) {
        model.addAttribute("data", "hello!!");
    }
}

Void를 반환하는 경우
@Controller를 사용하고, HttpServletResponse, OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용.(권장X)

Thymeleaf 설정

build.gradle

implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'

application.properties

spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html

변경이 필요하면 바꿀 수 있다.

HTTP API, 메시지 바디

ResponseBodyController

@Slf4j
@Controller
//@RestController
public class ResponseBodyController {

    @GetMapping("/response-body-string-v1")
    public void responseBodyV1(HttpServletResponse response) throws IOException {
        response.getWriter().write("ok");
    }
    
    @GetMapping("/response-body-string-v2")
    public ResponseEntity<String> responseBodyV2() {
        return new ResponseEntity<>("ok", HttpStatus.OK);
    }

    @ResponseBody
    @GetMapping("/response-body-string-v3")
    public String responseBodyV3() {
        return "ok";
    }

    @GetMapping("/response-body-json-v1")
    public ResponseEntity<HelloData> responseBodyJsonV1() {

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

        return new ResponseEntity<>(helloData, HttpStatus.OK);
    }

    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    @GetMapping("/response-body-json-v2")
    public HelloData responseBodyJsonV2() {

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

        return helloData;
    }
}

responseBodyJsonV1
HTTP 메시지 컨버터를 통해서 JSON 형식으로 변환되서 반환한다.

responseBodyJsonV2
ResponseEntity는 HTTP 응답 코드를 설정할 수 있다.
@ResponseBody를 사용하면 설정하기 까다롭지만 @ResponseStatus를 사용하면 설정할 수 있다.

@RestController
@RestController애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody가 적용되는 효과가 있다.
따라서, 뷰 템플릿을 사용하는 것이 아닌, HTTP 메시지 바디에 직접 데이터를 입력할 때 사용한다.

Rest API(HTTP API)를 만들 때 사용하는 컨트롤러 이다.

<출처 : 인프런 - 스프링 MVC 1편 : 백엔드 웹 개발 핵심 기술(김영한)>