스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 24

인프런 강의 38일차.

 - 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 1 (김영한 강사님)

 - 서블릿, JSP, MVC 패턴

 - 서블릿으로 1차 구현

   -> 서블릿으로 구현했을 때 불편한 점 개선을 위해 JSP로 2차 구현

   -> JSP로도 불편한 점을 개선하기 위해 MVC 패턴으로 3차 구현

 - 스프링 프로젝트 시작

   -> 스프링 기본기능 이해

   -> 스프링 MVC 웹페이지 만들기

 

4. 스프링 MVC - 기본 기능

 4.8 HTTP 요청 메시지 - 단순 텍스트

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

   - 요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 데이터가 넘어오는 경우는 @RequestParam , @ModelAttribute 를 사용할 수 없다.

   - 물론 HTML Form 형식으로 전달되는 경우는 요청 파라미터로 인정된다.

package hello.springmvc.basic.request;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.util.StreamUtils;
import org.springframework.web.bind.annotation.PostMapping;

import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

@Slf4j
@Controller
public class RequestBodyStringController {
    @PostMapping("/request-body-string-v1")
    public void requestBodyString(HttpServletRequest request,
                                  HttpServletResponse response) throws IOException {
        ServletInputStream inputStream = request.getInputStream();
        String messageBody = StreamUtils.copyToString(inputStream,
                StandardCharsets.UTF_8);
        log.info("messageBody={}", messageBody);
        response.getWriter().write("ok");
    }
}

   - RequestBodyStringController.java

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

   - Postman을 사용해서 테스트 해보자 : POST, http://localhost:8080/request-body-string-v1, Body : row, Text 선택

 

/**
 * InputStream(Reader): HTTP 요청 메시지 바디의 내용을 직접 조회
 * OutputStream(Writer): HTTP 응답 메시지의 바디에 직접 결과 출력
 */
@PostMapping("/request-body-string-v2")
public void requestBodyStringV2(InputStream inputStream, Writer responseWriter)
        throws IOException {
    String messageBody = StreamUtils.copyToString(inputStream,
            StandardCharsets.UTF_8);
    log.info("messageBody={}", messageBody);
    responseWriter.write("ok");
}

   - requestBodyStringV2 (Input, Output 스트림, Reader)

   - 스프링 MVC는 다음 파라미터를 지원한다.

   - InputStream(Reader) : HTTP 요청 메시지 바디의 내용을 직접 조회

   - OutputStream(Writer) : HTTP 응답 메시지의 바디에 직접 결과 출력

 

/**
 * HttpEntity: HTTP header, body 정보를 편라하게 조회
 * - 메시지 바디 정보를 직접 조회(@RequestParam X, @ModelAttribute X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 *
 * 응답에서도 HttpEntity 사용 가능
 * - 메시지 바디 정보 직접 반환(view 조회X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 */
@PostMapping("/request-body-string-v3")
public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) {
    String messageBody = httpEntity.getBody();  //inputStream으로부터 읽어오는 로직 및 Writer를 간단하게 적용 가능하다. (Converter가 동작함)
    log.info("messageBody={}", messageBody);
    return new HttpEntity<>("ok");
}

   - requestBodyStringV3 (HttpEntity)

   - 스프링 MVC는 다음 파라미터를 지원한다.

   - HttpEntity : HTTP header, body 정보를 편리하게 조회 (메시지 바디 정보를 직접 조회)

   - 파라미터, 리턴타입을 HttpEntity로 선언해야한다.

   - 요청 파라미터를 조회하는 기능과 관계 없음

   - @RequestParam X, @ModelAttribute X

   - HttpEntity는 응답에도 사용 가능

   - 메시지 바디 정보 직접 반환

   - 헤더 정보 포함 가능, view 조회X

 

  * HttpEntity 를 상속받은 다음 객체들도 같은 기능을 제공한다.

   - RequestEntity : HttpMethod, url 정보가 추가, 요청에서 사용

   - ResponseEntity : HTTP 상태 코드 설정 가능, 응답에서 사용

   - return new ResponseEntity("Hello World", responseHeaders, HttpStatus.CREATED)

  > 스프링MVC 내부에서 HTTP 메시지 바디를 읽어서 문자나 객체로 변환해서 전달해주는데, 이때 HTTP 메시지 컨버터( HttpMessageConverter )라는 기능을 사용한다.

 

/**
 * @RequestBody
 * - 메시지 바디 정보를 직접 조회(@RequestParam X, @ModelAttribute X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 *
 * @ResponseBody
 * - 메시지 바디 정보 직접 반환(view 조회X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 */
@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody) {
    log.info("messageBody={}", messageBody);
    return "ok";
}

   - requestBodyStringV4 (@RequestBody)

   - @RequestBody 를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다.

   - 헤더 정보가 필요하다면 HttpEntity 를 사용하거나 @RequestHeader 를 사용하면 된다.

   - 이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam , @ModelAttribute 와는 전혀 관계가 없다.

   - @ResponseBody 를 사용하면 응답 결과를 HTTP 메시지 바디에 직접 담아서 전달할 수 있다. 물론 이 경우에도 view를 사용하지 않는다.

   - RequestBodyStringController.java에서 수동으로 파싱, 형변환 하던 작업을 스프링에서 자동으로 해준다(Converter)

 

  * 요청 파라미터 vs HTTP 메시지 바디

   - 요청 파라미터를 조회하는 기능: @RequestParam , @ModelAttribute

   - HTTP 메시지 바디를 직접 조회하는 기능: @RequestBody

 

 4.9 HTTP 요청 메시지 - JSON

  > HTTP API에서 주로 사용하는 JSON 데이터 형식을 조회해보자

package hello.springmvc.basic.request;
import com.fasterxml.jackson.databind.ObjectMapper;
import hello.springmvc.basic.HelloData;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.util.StreamUtils;
import org.springframework.web.bind.annotation.PostMapping;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
/**
 * {"username":"hello", "age":20}
 * content-type: application/json
 */
@Slf4j
@Controller
public class RequestBodyJsonController {

    private ObjectMapper objectMapper = new ObjectMapper();

    @PostMapping("/request-body-json-v1")
    public void requestBodyJsonV1(HttpServletRequest request,
                                  HttpServletResponse response) throws IOException {
        ServletInputStream inputStream = request.getInputStream();
        String messageBody = StreamUtils.copyToString(inputStream,
                StandardCharsets.UTF_8);
        log.info("messageBody={}", messageBody);
        HelloData data = objectMapper.readValue(messageBody, HelloData.class);
        log.info("username={}, age={}", data.getUsername(), data.getAge());
        response.getWriter().write("ok");
    }
}

   - RequestBodyJsonController.requestBodyJsonV1

   - HttpServletRequest를 사용해서 직접 HTTP 메시지 바디에서 데이터를 읽어와서, 문자로 변환한다.

   - 문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper 를 사용해서 자바 객체로 변환한다

   - Postman으로 테스트 : POST, http://localhost:8080/request-body-json-v1 raw, JSON, content-type: application/json {"username":"hello", "age":20}

 

/**
 * @RequestBody
 * HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 *
 * @ResponseBody
 * - 모든 메서드에 @ResponseBody 적용
 * - 메시지 바디 정보 직접 반환(view 조회X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 */
@ResponseBody
@PostMapping("/request-body-json-v2")
public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {
    HelloData data = objectMapper.readValue(messageBody, HelloData.class);
    log.info("username={}, age={}", data.getUsername(), data.getAge());
    
    return "ok";
}

   - requestBodyJsonV2 (@RequestBody 문자 변환)

   - 이전에 학습했던 @RequestBody 를 사용해서 HTTP 메시지에서 데이터를 꺼내고 messageBody에 저장한다.

   - 문자로 된 JSON 데이터인 messageBody 를 objectMapper 를 통해서 자바 객체로 변환한다.

   - 문자로 변환하고 다시 json으로 변환하는 과정... @ModelAttribute처럼 한번에 객체로 변환할 수는 없을까?

 

/**
 * @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
 * HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (contenttype: application/json)
 *
 */
@ResponseBody
@PostMapping("/request-body-json-v3")
public String requestBodyJsonV3(@RequestBody HelloData data) {
    log.info("username={}, age={}", data.getUsername(), data.getAge());
    return "ok";
}

   - requestBodyJsonV3 (@RequestBody 객체 변환)

   - @RequestBody 객체 파라미터 : @RequestBody HelloData data 사용 시 @RequestBody에 직접 만든 객체를 지정할 수 있다.

   - HttpEntity , @RequestBody 를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환해준다.

   - HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해주는데, 우리가 방금 V2에서 했던 작업을 대신 처리해준다. 

   - 리턴타입을 String으로 지정하였음.

 

 * @RequestBody는 생략 불가능하다.

   - 스프링은 @ModelAttribute, @RequestParam 해당 생략시 다음과 같은 규칙을 적용한다.

   - String , int , Integer 같은 단순 타입 = @RequestParam

   - 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)

   - 따라서 이 경우 HelloData에 @RequestBody 를 생략하면 @ModelAttribute 가 적용되어버린다.

   - HelloData data -> @ModelAttribute HelloData data

   - 즉 생략하면 HTTP 메시지 바디가 아니라 ModelAttribute를 사용해 요청 파라미터를 처리하게 된다.

 

  * HTTP 요청시에 content-type이 application/json으로 되어있어야 JSON을 처리할 수 있는 HTTP 메시지 컨버터가 실행된다.

 

@ResponseBody
@PostMapping("/request-body-json-v4")
public String requestBodyJsonV4(HttpEntity<HelloData> httpEntity) {
    HelloData data = httpEntity.getBody();
    log.info("username={}, age={}", data.getUsername(), data.getAge());
    return "ok";
}

   - requestBodyJsonV4 (HttpEntity)

   - 앞서 배운 것과 같이 HttpEntity를 사용해서 HelloData를 처리해도 된다.

 

/**
 * @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
 * HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (contenttype: application/json)
 *
 * @ResponseBody 적용
 * - 메시지 바디 정보 직접 반환(view 조회X)
 * - HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter 적용
(Accept: application/json)
 */
@ResponseBody
@PostMapping("/request-body-json-v5")
public HelloData requestBodyJsonV5(@RequestBody HelloData data) {
    //@RequestBody-HttpMessageConverter가 MappingJackson2HttpMessageConverter를 적용함으로써 helloData를 바로 사용 가능하다
    //@RequestBody는 아래 코드를 처리해준다.
    //HelloData data = objectMapper.readValue(messageBody, HelloData.class);
    log.info("username={}, age={}", data.getUsername(), data.getAge());
    return data;
}

   - requestBodyJsonV5

   - @ResponseBody 응답의 경우에도 @ResponseBody 를 사용하면 해당 객체를 HTTP 메시지 바디에 직접 넣어줄 수 있다. (물론 이 경우에도 HttpEntity 를 사용해도 된다)

   - 리턴타입을 HelloData로 지정할 시 컨버터가 변환한 json 메시지가 Http 응답 메시지에 박혀서 리턴된다. (즉 응답도 json으로 리턴된다)

 

  * @RequestBody 요청

   - JSON 요청 -> HTTP 메시지 컨버터 -> 객체

  * @ResponseBody 응답

   - 객체 -> HTTP 메시지 컨버터 -> JSON 응답

 

 4.10 HTTP 응답 - 정적 리소스, 뷰 템플릿

  > 응답 부분에 초점을 맞추어서 정리해보자. 스프링(서버)에서 응답 데이터를 만드는 방법은 크게 3가지이다.

   - 정적 리소스 : 웹 브라우저에 정적인 HTML, css, js을 제공할 때는, 정적 리소스를 사용한다.

   - 뷰 템플릿 : 웹 브라우저에 동적인 HTML을 제공할 때는 뷰 템플릿을 사용한다.

   - HTTP 메시지 : HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.

 

  > 정적 리소스

   - 스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공한다.

   - /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

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

 

  > 뷰 템플릿

   - 뷰 템플릿을 거쳐서 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>

   - hello.html

 

package hello.springmvc.basic.response;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class ResponseViewController {

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

   - ResponseViewController (뷰 템플릿을 호출하는 컨트롤러)

 

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

   - String을 반환하는 경우 : View or HTTP 메시지

   - @ResponseBody 가 없으면 response/hello 로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 한다.

   - @ResponseBody 가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello 라는 문자가 입력된다.

   - 여기서는 뷰의 논리 이름인 response/hello 를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는 것을 확인할 수 있다.

   - 실행 : templates/response/hello.html

 

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

   - Void를 반환하는 경우

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

   - URL : /response/hello

   - 실행 : templates/response/hello.html

   - 이 방식은 명시성이 너무 떨어지고 이렇게 딱 맞는 경우도 많이 없어서, 권장하지 않는다.

 

   > HTTP 메시지

   - @ResponseBody , HttpEntity 를 사용하면, 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 응답 데이터를 출력할 수 있다

 

#스프링 부트가 자동으로 ThymeleafViewResolver 와 필요한 스프링 빈들을 등록한다. 그리고 다음 설정도 사용한다. 이 설정은 기본 값 이기 때문에 변경이 필요할 때만 설정하면 된다.
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html

    - application.propertie에 thymeleaf에서 사용할 prefix, suffix 디폴트값 설정이 가능하다

 

 4.11 HTTP 응답 - HTTP API, 메시지 바디에 직접 입력

  > HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.

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

 

package hello.springmvc.basic.response;
import hello.springmvc.basic.HelloData;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Slf4j
@Controller
//@ResponseBody       //클래스레벨에 ResponseBody 설정하게되면 클래스 내 메소드에서 선언해주지 않아도 됨
//@RestController : @RestController는 @Controller + @ResponseBody의 역할을 한다.
public class ResponseBodyController {

    @GetMapping("/response-body-string-v1")
    public void responseBodyV1(HttpServletResponse response) throws IOException
    {
        response.getWriter().write("ok");
    }
}

    - ResponseBodyController.responseBodyV1

    - 서블릿을 직접 다룰 때 처럼 HttpServletResponse 객체를 통해서 HTTP 메시지 바디에 직접 ok 응답 메시지를 전달한다.

    - response.getWriter().write("ok")

 

/**
 * HttpEntity, ResponseEntity(Http Status 추가)
 * @return
 */
@GetMapping("/response-body-string-v2")
public ResponseEntity<String> responseBodyV2() {
    return new ResponseEntity<>("ok", HttpStatus.OK);
}

    - responseBodyV2

    - ResponseEntity 엔티티는 HttpEntity 를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다.

    - ResponseEntity 는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다.

    - HttpStatus.CREATED 로 변경하면 201 응답이 나가는 것을 확인할 수 있다.

 

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

    - responseBodyV3

    - @ResponseBody 를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있다. ResponseEntity 도 동일한 방식으로 동작한다.

 

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

    - responseBodyJsonV1

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

 

@ResponseStatus(HttpStatus.OK)      //return new ResponseEntity<>(helloData, HttpStatus.OK); 것 처럼 HTTP 응답코드 세팅 가능
@ResponseBody
@GetMapping("/response-body-json-v2")
public HelloData responseBodyJsonV2() {
    HelloData helloData = new HelloData();
    helloData.setUsername("userA");
    helloData.setAge(20);
    return helloData;
}

    - responseBodyJsonV2

    - responseBodyJsonV1에서 사용하는 것처럼 ResponseEntity 는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody 를 사용하면 이런 것을 설정하기 까다롭다.

    - @ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다.

    - 물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다.

    - 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity 를 사용하면 된다

 

  * @RestController

    - @Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody 가 적용되는 효과가 있다. (@RestController는 @Controller + @ResponseBody의 역할을 하는 애노테이션이다)

    - 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다.

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

    - @ResponseBody 는 클래스 레벨에 두면 전체에 메서드에 적용되는데, @RestController 에노테이션 안에 @ResponseBody 가 적용되어 있다.