[Spring] 6.스프링 MVC - 기본 기능

1. 프로젝트 생성

파일참고

주의)

> Packaging는 War가 아니라 Jar를 선택
JSP를 사용하지 않기 때문에 Jar를 사용하는 것이 좋음
앞으로 스프링 부트를 사용하면 이 방식을 주로 사용하게 됨

> Jar를 사용하면 항상 내장 서버(톰캣등)를 사용하고, webapp 경로도 사용하지 않음
내장 서버 사용에 최적화 되어 있는 기능입니다. 최근에는 주로 이 방식을 사용

> War를 사용하면 내장 서버도 사용가능 하지만, 주로 외부 서버에 배포하는 목적으로 사용

build.gradle 설정 -> 파일참고

annotaion processors -> enable annotation processing체크 (롬복때매)

동작확인 -> hello - springmvc - SpringmvcApplication 실행

WelcomPage 만들기

스프링부트에 'Jar' 사용하면 /resources/static/ 위치에 index.html 파일 두면 웰컴페이지로 처리해줌

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <title>Title</title>
</head>
<body> <ul>
<li>로그 출력 <ul>
<li><a href="/log-test">로그 테스트</a></li> </ul>
</li>
<!-- --> <li>요청 매핑
          <ul>
              <li><a href="/hello-basic">hello-basic</a></li>
              <li><a href="/mapping-get-v1">HTTP 메서드 매핑</a></li>
<li><a href="/mapping-get-v2">HTTP 메서드 매핑 축약</a></li>
<li><a href="/mapping/userA">경로 변수</a></li>
<li><a href="/mapping/users/userA/orders/100">경로 변수 다중</a></li> <li><a href="/mapping-param?mode=debug">특정 파라미터 조건 매핑</a></li> <li><a href="/mapping-header">특정 헤더 조건 매핑(POST MAN 필요)</a></
<li><a href="/mapping-consume">미디어 타입 조건 매핑 Content-Type(POST MAN 필요)</a></li>
<li><a href="/mapping-produce">미디어 타입 조건 매핑 Accept(POST MAN 필요)</a></li>
</ul> </li>
<li>요청 매핑 - API 예시 <ul>
<li>POST MAN 필요</li> </ul>
</li>
<li>HTTP 요청 기본
<ul>
<li><a href="/headers">기본, 헤더 조회</a></li>
</ul> </li>
<li>HTTP 요청 파라미터 <ul>
<li><a href="/request-param-v1?username=hello&age=20">요청 파라미터v1</a></li>
<li><a href="/request-param-v1?username=hello&age=20">요청 파라미터v2</a></li>
<li><a href="/request-param-v1?username=hello&age=20">요청 파라미터v3</a></li>
<li><a href="/request-param-v1?username=hello&age=20">요청 파라미터v4</a></li>
<li><a href="/request-param-required?username=hello&age=20">요청 파라미터 필수</a></li>
<li><a href="/request-param-default?username=hello&age=20">요청 파라미터 기본 값</a></li>
<li><a href="/request-param-map?username=hello&age=20">요청 파라미터</a></li>
 <li><a href="/model-attribute-v1?username=hello&age=20">요청 파라미터 @ModelAttribute v1</a></li>
<li><a href="/model-attribute-v2?username=hello&age=20">요청 파라미터 @ModelAttribute v2</a></li>
</ul> </li>
<li>HTTP 요청 메시지 <ul>
                <li>POST MAN</li>
            </ul>
</li>
<li>HTTP 응답 - 정적 리소스, 뷰 템플릿
<ul>
<li><a href="/basic/hello-form.html">정적 리소스</a></li> <li><a href="/response-view-v1">뷰 템플릿 v1</a></li> <li><a href="/response-view-v2">뷰 템플릿 v2</a></li>
</ul> </li>
<li>HTTP 응답 - HTTP API, 메시지 바디에 직접 입력 <ul>
                <li><a href="/response-body-string-v1">HTTP API String v1</a></li>
                <li><a href="/response-body-string-v2">HTTP API String v2</a></li>
                <li><a href="/response-body-string-v3">HTTP API String v3</a></li>
                <li><a href="/response-body-json-v1">HTTP API Json v1</a></li>
                <li><a href="/response-body-json-v2">HTTP API Json v2</a></li>
</ul> </li>
    </ul>
    </body>
    </html>

2. 로깅 간단히 알아보기

로깅 라이브러리

스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리( spring-boot-starter-logging )가 함께 포함된다.
스프링 부트 로깅 라이브러리는 기본으로 다음 로깅 라이브러리를 사용한다.

로그 라이브러리는 Logback, Log4J, Log4J2 등 수많은 라이브러리가 있는데 그것을 통합해서 인터페이스로 제공하는 것이 바로 SLF4J

실무에서는 SLF4J의 인터페이스의 구현체 Logback 많이 씀

로그 선언 및 호출

로그 컨트롤러

//@Slf4j
@RestController
public class LogTestController {
  
  private final Logger log = LoggerFactory.getLogger(getClass());
  
  @RequestMapping("/log-test")
  public String logTest() {
    String name = "Spring";
    log.trace("trace log={}", name);
    log.debug("debug log={}", name);
    log.info(" info log={}", name);
    log.warn(" warn log={}", name);
    log.error("error log={}", name);

    //로그를 사용하지 않아도 a+b 계산 로직이 먼저 실행됨, 이런 방식으로 사용하면 X log.debug("String concat log=" + name);
    return "ok";
  } 
}

@RestController

@Controller 는 반환 값이 String 이면 뷰 이름으로 인식된다.
그래서 뷰를 찾고 뷰가 랜더링 된다. @RestController 는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다.
따라서 실행 결과로 ok 메세지를 받을 수 있다.
@ResponseBody 와 관련이 있는데, 뒤에서 더 자세히 설명한다.

테스트 결과

로그가 출력되는 포멧 확인
시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지

로그 레벨 설정을 변경해서 출력 결과를 다르게 확인 가능
LEVEL: TRACE > DEBUG > INFO > WARN > ERROR

개발 서버는 debug 출력
운영 서버는 info 출력

@Slf4j 로 변경

로그 레벨 설정

application.properties

#전체 로그 레벨 설정(기본 info)
logging.level.root=info

#hello.springmvc 패키지와그 하위 로그 레벨 설정
logging.level.hello.springmvc=debug

@SLf4j 롬복 사용하면 선언없이 바로 log 사용가능

올바른 로그 사용법

log.debug("data="+data)
로그 출력 레벨을 info로 설정해도 해당 코드에 있는 "data="+data가 실제 실행이 되어 버린다.
결과적으로 문자 더하기 연산이 발생한다.

log.debug("data={}", data)
로그 출력 레벨을 info로 설정하면 아무일도 발생하지 않는다.
따라서 앞과 같은 의미없는 연산이 발생하지 않는다.

로그 사용시 장점

쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.
로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.
시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다.
특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.
성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등등)
그래서 실무에서는 꼭 로그를 사용해야 한다.

3. 요청 맵핑

요청 왔을 때 어떤 컨트롤러가 호출이 되는지

(단순 URL 뿐만 아니라 여러 요소 조합)

MappingController.class

ㄴhello - springmvc - basic - requestmapping

@RestController
public class MappingController {
  
  private Logger log = LoggerFactory.getLogger(getClass());
  
  /**
  * 기본 요청
  * 둘다 허용 /hello-basic, /hello-basic/
  * HTTP 메서드 모두 허용 GET, HEAD, POST, PUT, PATCH, DELETE */
  
  @RequestMapping("/hello-basic")
  public String helloBasic() {
    log.info("helloBasic");
    return "ok";
  }

[스프링 부트 3.0 이전]
다음 두가지 요청은 다른 URL이지만, 스프링은 다음 URL 요청들을 같은 요청으로 매핑한다.
매핑: /hello-basic
URL 요청: /hello-basic , /hello-basic/

[스프링 부트 3.0 이후]
스프링 부트 3.0 부터는 /hello-basic , /hello-basic/ 는 서로 다른 URL 요청을 사용해야 한다.
기존에는 마지막에 있는 / (slash)를 제거했지만, 스프링 부트 3.0 부터는 마지막의 / (slash)를 유지한다.

> 따라서 다음과 같이 다르게 매핑해서 사용해야 한다.
매핑: /hello-basic URL 요청: /hello-basic
매핑: /hello-basic/ URL 요청: /hello-basic/

HTTP 메서드

@RequestMapping 에 method 속성으로 HTTP 메서드를 지정하지 않으면 HTTP 메서드와 무관하게 호출된다.
모두 허용 GET, HEAD, POST, PUT, PATCH, DELETE

HTTP 메서드 맵핑

/**
* method 특정 HTTP 메서드 요청만 허용
* GET, HEAD, POST, PUT, PATCH, DELETE
*/

@RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET)
public String mappingGetV1() {
      log.info("mappingGetV1");
      return "ok";
}

HTTP 메서드 맵핑 축약

/**
* 편리한 축약 애노테이션 (코드보기) 
* @GetMapping
* @PostMapping
* @PutMapping
* @DeleteMapping
* @PatchMapping
*/
@GetMapping(value = "/mapping-get-v2")
public String mappingGetV2() {
      log.info("mapping-get-v2");
      return "ok";
}

PathVariable(경로 변수) 사용

(자주사용)

/**
* PathVariable 사용
* 변수명이 같으면 생략 가능
* @PathVariable("userId") String userId -> @PathVariable userId
*/
@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable("userId") String data) {
      log.info("mappingPath userId={}", data);
      return "ok";
}

최근 HTTP API는 다음과 같이 리소스 경로에 식별자 넣는 스타일 선호

/mapping/userA

/users/1

@RequestMapping은 URL 경로를 템플릿화 할 수 있는데 @PathVariable을 사용하면 매칭되는 부분을 편리하게 조회할 수 있음

@PathVariable의 이름과 파라미터 이름이 같으면 생략 가능

PathVariable 다중 맵핑

(자주사용)

/**
* PathVariable 사용 다중
*/
@GetMapping("/mapping/users/{userId}/orders/{orderId}")
public String mappingPath(@PathVariable String userId, @PathVariable Long orderId) {
      log.info("mappingPath userId={}, orderId={}", userId, orderId);
      return "ok";
}

특정 파라미터 조건 맵핑

(자주 사용 X)

 /**
 * 파라미터로 추가 매핑
   * params="mode",
   * params="!mode"
   * params="mode=debug"
   * params="mode!=debug" (! = )
   * params = {"mode=debug","data=good"}
   */
  @GetMapping(value = "/mapping-param", params = "mode=debug")
  public String mappingParam() {
      log.info("mappingParam");
      return "ok";
  }

특정 헤더 조건 맵핑

/**
*특정 헤더로 추가 매핑
   * headers="mode",
   * headers="!mode"
   * headers="mode=debug"
   * headers="mode!=debug" (! = )
   */
  @GetMapping(value = "/mapping-header", headers = "mode=debug")
  public String mappingHeader() {
      log.info("mappingHeader");
      return "ok";
  }

미디어 타입 조건 맵핑 - HTTP 요청 Content-Type, consume

/**
* Content-Type 헤더 기반 추가 매핑 Media Type
   * consumes="application/json"
   * consumes="!application/json"
   * consumes="application/*"
   * consumes="*\/*"
   * MediaType.APPLICATION_JSON_VALUE
   */
  @PostMapping(value = "/mapping-consume", consumes = "application/json")
  public String mappingConsumes() {
      log.info("mappingConsumes");
      return "ok";
  }

Content-Type에 따라 호출하는게 달라질 경우

consume : 서버(컨트롤러)입장에서 소비

produce : 서버입장에서 생산해내는 타입 (HTTP요청이 Accept와 맞아야함)

미디어 타입 조건 맵핑 - HTTP 요청 Content-Type, produce

/**
* Accept 헤더 기반 Media Type * produces = "text/html"
* produces = "!text/html"
    * produces = "text/*"
   * produces = "*\/*"
   */
  @PostMapping(value = "/mapping-produce", produces = "text/html")
  public String mappingProduces() {
      log.info("mappingProduces");
      return "ok";
  }

4. 요청 맵핑 - API 예시

회원 관리 API 예시

회원 목록 조회 : GET '/users'

회원 등록 : POST '/users'

회원 조회 : GET '/users/{userId}'

회원 수정 : PATCH '/users/{userId}'

회원 삭제 : DELETE '/users/{userId}'

MappingClassController

@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {
    /**
     * GET /mapping/users
     */
    @GetMapping
    public String users() {
        return "get users";
    }
    /**
     * POST /mapping/users
     */
    @PostMapping
    public String addUser() {
        return "post user";
    }
    /**
     * GET /mapping/users/{userId}
     */
    @GetMapping("/{userId}")
    public String findUser(@PathVariable String userId) {
        return "get userId=" + userId;
    }
    /**
     * PATCH /mapping/users/{userId}
     */
    @PatchMapping("/{userId}")
    public String updateUser(@PathVariable String userId) {
        return "update userId=" + userId;
    }
    
    @DeleteMapping("/{userId}")
      public String deleteUser(@PathVariable String userId) {
          return "delete userId=" + userId;
      }
}

5. HTTP 요청 - 기본, 헤더 조회

@Annotation 기반 스프링 컨트롤러는 다양한 파라미터 지원

HTTP 헤더정보 조회

RequestHeaderController

@Slf4j
@RestController
public class RequestHeaderController {
    @RequestMapping("/headers")
    public String headers(HttpServletRequest request, HttpServletResponse response, 
                          HttpMethod httpMethod,
                          Locale locale, 
                          @RequestHeader MultiValueMap<String, String> headerMap, 
                          @RequestHeader("host") String host, 
                          @CookieValue(value = "myCookie", required = false) String cookie){
        log.info("request={}", request);
        log.info("response={}", response);
        log.info("httpMethod={}", httpMethod);
        log.info("locale={}", locale);
        log.info("headerMap={}", headerMap);
        log.info("header host={}", host);
        log.info("myCookie={}", cookie);
        return "ok";
    }
}

HttpServletResponse

HttpMethod : HTTP 메서드를 조회한다. org.springframework.http.HttpMethod

Locale : Locale 정보를 조회한다.

@RequestHeader MultiValueMap<String, String> headerMap
모든 HTTP 헤더를 MultiValueMap 형식으로 조회한다.

@RequestHeader("host") String host

특정 HTTP 헤더를 조회한다.
속성
      필수 값 여부: required
      기본 값 속성: defaultValue

@CookieValue(value = "myCookie", required = false) String cookie
  특정 쿠키를 조회한다.
  속성
      필수 값 여부: required
      기본 값: defaultValue

MultiValueMap

  MAP과 유사한데, 하나의 키에 여러 값을 받을 수 있다.
  HTTP header, HTTP 쿼리 파라미터와 같이 하나의 키에 여러 값을 받을 때 사용한다.
  keyA=value1&keyA=value2

6. HTTP 요청 - 쿼리 파라미터, HTML Form

클라이언트에서 서버로 HTTP 요청 메시지 보내는 방법 딱 세가지 뿐(GET / POST / HTTP message body)

요청 파라미터(request parameter) 조회

RequestParamController

@Slf4j
@Controller
public class RequestParamController {

/**
* 반환 타입이 없으면서 이렇게 응답에 값을 직접 집어넣으면, view 조회X
*/

  @RequestMapping("/request-param-v1")
  public void requestParamV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
          String username = request.getParameter("username");
          int age = Integer.parseInt(request.getParameter("age"));
          log.info("username={}, age={}", username, age);
          response.getWriter().write("ok");
  }
}

7. HTTP 요청 파라미터 - @RequestParam

requestParamV2

/**
* @RequestParam 사용
* - 파라미터 이름으로 바인딩
* @ResponseBody 추가
* - View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력 */

@ResponseBody
@RequestMapping("/request-param-v2")
public String requestParamV2(
  @RequestParam("username") String memberName, @RequestParam("age") int memberAge) {
  log.info("username={}, age={}", memberName, memberAge);
  return "ok";
}

@RequestParam : 파라미터 이름으로 바인딩
@ResponseBody : View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력
@RequestParam의 name(value) 속성이 파라미터 이름으로 사용 @RequestParam("username") String memberName
= request.getParameter("username")

개선

/**
* @RequestParam 사용
* HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx") 생략 가능 */
  @ResponseBody
  @RequestMapping("/request-param-v3")
  public String requestParamV3(
          @RequestParam String username,
          @RequestParam int age) {
      log.info("username={}, age={}", username, age);
      return "ok";
}

개선

/**
* @RequestParam 사용
* String, int 등의 단순 타입이면 @RequestParam 도 생략 가능 */
  @ResponseBody
  @RequestMapping("/request-param-v4")
  public String requestParamV4(String username, int age) {
           log.info("username={}, age={}", username, age);
        return "ok";
    }

참고)

@RequestParam이 없는건 오바..

파라미터 필수 여부

/**
     * @RequestParam.required
* /request-param-required -> username이 없으므로 예외 *
* 주의!
* /request-param-required?username= -> 빈문자로 통과 *
* 주의!
* /request-param-required
* int age -> null을 int에 입력하는 것은 불가능, 따라서 Integer 변경해야 함(또는 다음에 나오는
defaultValue 사용) */

@ResponseBody
    @RequestMapping("/request-param-required")
    public String requestParamRequired(
            @RequestParam(required = true) String username,
            @RequestParam(required = false) Integer age) {
             log.info("username={}, age={}", username, age);
                    return "ok";
  }

- required true / false

- true인데 없으면 400 예외

주의)

파라미터만 있고 값이 없는 경우 통과됨!!!

주의)

int에 null 넣을 수 없음 -> Integer형으로 선언

기본값 적용 가능

/**
   * @RequestParam
* - defaultValue 사용 *
* 참고: defaultValue는 빈 문자의 경우에도 적용 * /request-param-default?username=
*/
  @ResponseBody
  @RequestMapping("/request-param-default")
  public String requestParamDefault(
          @RequestParam(required = true, defaultValue = "guest") String username,
          @RequestParam(required = false, defaultValue = "-1") int age) {
           log.info("username={}, age={}", username, age);
                  return "ok";
  }

- 기본값이 있기 때문에 required 의미 없고 Integer사용할 필요 없다

파라미터를 Map으로 조회하기 - requestParamMap

/**
   * @RequestParam Map, MultiValueMap
   * Map(key=value)
   * MultiValueMap(key=[value1, value2, ...]) ex) (key=userIds, value=[id1, id2])
   */
  @ResponseBody
  @RequestMapping("/request-param-map")
  public String requestParamMap(@RequestParam Map<String, Object> paramMap) {
      log.info("username={}, age={}", paramMap.get("username"),
  paramMap.get("age"));
      return "ok";
  }

@RequestParam Map : Map(key=value)
@RequestParam MultiValueMap
MultiValueMap(key=[value1, value2, ...] ex) (key=userIds, value=[id1, id2])

* 파라미터의 값이 1개가 확실하다면 Map 을 사용해도 되지만, 그렇지 않다면 MultiValueMap 을 사용

8. HTTP 요청 파라미터 - @ModelAttribute

실제 개발하면 요청 파라미터 받아 필요한 객체 만들고 그 객체에 값 넣어주는데,

스프링은 이 과정을 자동화해줌

요청 파라미터를 바인딩 받을 객체

  @Data
  public class HelloData {
      private String username;
      private int age;
  }

롬복 @Data

@Getter , @Setter , @ToString , @EqualsAndHashCode , @RequiredArgsConstructor 를 자동으로 적용

ModelAttribute 적용

/**
* @ModelAttribute 사용
* 참고: model.addAttribute(helloData) 코드도 함께 자동 적용됨, 뒤에 model을 설명할 때 자세히 설명
*/
  @ResponseBody
  @RequestMapping("/model-attribute-v1")
  public String modelAttributeV1(@ModelAttribute HelloData helloData) {
      log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
      return "ok";
  }

- 바인딩 is magic

개선 (생략)

/*
* @ModelAttribute 생략 가능
* String, int 같은 단순 타입 = @RequestParam
* argument resolver 로 지정해둔 타입 외 = @ModelAttribute */
    @ResponseBody
    @RequestMapping("/model-attribute-v2")
    public String modelAttributeV2(HelloData helloData) {
        log.info("username={}, age={}", helloData.getUsername(),
    helloData.getAge());
        return "ok";
    }

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

- argument resolver로 지정해둔 타입 외 @ModelAttribute

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

HTTP message body에 데이터 직접 담아서 요청하는 경우

- HTTP API에서 주로 사용 (JSON)

- POST, PUT, PATCH

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

HTTP 메시지 바디의 데이터를 InputStream을 통해 직접 읽기

RequestBodyStringController

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

개선

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

스프링 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();
      log.info("messageBody={}", messageBody);
      return new HttpEntity<>("ok");
  }

스프링 MVC는 다음 파라미터 지원

HttpEntity: HTTP header, body 정보를 편리하게 조회
- 메시지 바디 정보를 직접 조회
- 요청 파라미터를 조회하는 기능과 관계 없음

@RequestParam X, @ModelAttribute X HttpEntity는 응답에도 사용 가능
- 메시지 바디 정보 직접 반환 헤더 정보 포함 가능
- view 조회X

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

RequestEntity
- HttpMethod, url 정보가 추가, 요청에서 사용
ResponseEntity
- HTTP 상태 코드 설정 가능, 응답에서 사용
- return new ResponseEntity<String>("Hello World", responseHeaders, HttpStatus.CREATED)

더 개선

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

@Requestbody

@RequestBody 를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다.
참고로 헤더 정보가 필요하다면 HttpEntity 를 사용하거나 @RequestHeader 를 사용하면 된다.

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

@Responsebody

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

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

요청 파라미터를 조회하는 기능: @RequestParam , @ModelAttribute
HTTP 메시지 바디를 직접 조회하는 기능: @RequestBody

10. HTTP 요청 메시지 - JSON

HTTP API에서 주로 사용하는 JSON 데이터 형식 조회

RequestBodyJsonController

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

HttpServletRequest를 사용해서 직접 HTTP 메시지 바디에서 데이터를 읽어와서, 문자로 변환한다.
문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper 를 사용해서 자바 객체로 변환한다.

개선

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

더 개선

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

@RequestBody

@RequestBody HelloData data
@RequestBody 에 직접 만든 객체를 지정할 수 있다.
HttpEntity , @RequestBody 를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환해준다.
HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해주는데, 우리가 방금 V2에서 했던 작업을 대신 처리해준다.
자세한 내용은 뒤에 HTTP 메시지 컨버터에서 다룬다.

주의) HTTP 요청시에 content-type이 application/json인지 꼭! 확인해야 한다

@RequestBody 요청 : JSON 요청 HTTP 메시지 컨버터 객체
@ResponseBody 응답 : 객체 HTTP 메시지 컨버터 JSON 응답

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

스프링 서버에서 응답 데이터를 만드는 방법 3가지

1) 정적 리소스

- ex) 웹 브라우저에 정적인 HTML, CSS, JS 제공할 땐 정적 리소스 사용

2) 뷰 템플릿 사용

- ex) 웹 브라우저에 동적인 HTML을 제공할 땐 뷰 템플릿 사용

3) HTTP 메시지 사용

- ex) HTTP API를 제공하는 경우 HTML이 아니라 데이터를 전달해야하므로,

HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보냄

1) 정적 리소스

[경로]

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>

컨트롤러

 @Controller
  public class ResponseViewController {
      @RequestMapping("/response-view-v1")
      public ModelAndView responseViewV1() {
         ModelAndView mav = new ModelAndView("response/hello")
                  .addObject("data", "hello!");
         return mav; 
      }
      
      // view의 논리적이름
      @RequestMapping("/response-view-v2")
      public String responseViewV2(Model model) {
          model.addAttribute("data", "hello!!");
          return "response/hello";
      }
}

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

HTML이 아니라 데이터를 전달 -> 메시지 바디에 JSON 담아 보냄

ResponseBodyController

@Slf4j
@Controller
//@RestController
public class ResponseBodyController {
    @GetMapping("/response-body-string-v1")
    public void responseBodyV1(HttpServletResponse response) throws IOException
{
        response.getWriter().write("ok");
    }
/**
* HttpEntity, ResponseEntity(Http Status 추가)
* @return
*/
    @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;
      }
}

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

responseBodyV2
ResponseEntity 엔티티는 HttpEntity 를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다. ResponseEntity 는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다.
HttpStatus.CREATED 로 변경하면 201 응답이 나가는 것을 확인할 수 있다.

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

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

responseBodyJsonV2
ResponseEntity 는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody 를 사용하면 이런 것을 설정하기 까다롭다.
@ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다.

물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다. 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity 를 사용하면 된다.

@RestController
@Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody 가 적용되는 효과가 있다. 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다. 이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러이다.

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

13. HTTP 메시지 컨버터

HTTP API (JSON) 데이터를 HTTP 메시지 바디에 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용

@ResponseBody

- HTTP body에 문자 내용 직접 반환

- viewResolver대신 HttpMessageConverter 동작

- 기본 문자 처리 : StringHttpMessageConverter

- 기본 객체 처리 : MappingJackson2HttpMessageConverter

참고) 응답의 경우 클라이언트의 HTTP Accept 헤더와 서버의 컨트롤러 반환 타입 정보 조합해서 HttpMessageConverter 선택됨

스프링 MVC는 다음의 경우 HTTP 메시지 컨버터 적용

HTTP 요청: @RequestBody , HttpEntity(RequestEntity)
HTTP 응답: @ResponseBody , HttpEntity(ResponseEntity)

HTTP 메시지 컨버터 인터페이스

public interface HttpMessageConverter<T> {
      boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
      boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);
      List<MediaType> getSupportedMediaTypes();
      T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
              throws IOException, HttpMessageNotReadableException;
      void write(T t, @Nullable MediaType contentType, HttpOutputMessage
    outputMessage)
              throws IOException, HttpMessageNotWritableException;
}

HTTP 메세지 컨버터는 요청 응답 모두 사용됨

- canRead(), canWrite() : 메시지 컨버터가 해당 클래스, 미디어타입 지원하는지 체크

- read(), write() : 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능

스프링부트 기본 메시지 컨버터 -> 대상 클래스 타입과 미디어 타입 체크해서 사용여부 결정

몇가지 주요한 메시지 컨버터

ByteArrayHttpMessageConverter : byte[] 데이터를 처리한다.
>클래스 타입: byte[] , 미디어타입: */* ,
>요청 예) @RequestBody byte[] data
>응답 예) @ResponseBody return byte[] 쓰기 미디어타입 application/octet-stream

StringHttpMessageConverter : String 문자로 데이터를 처리한다. 클래스 타입: String , 미디어타입: */*
>요청 예) @RequestBody String data
>응답 예) @ResponseBody return "ok" 쓰기 미디어타입 text/plain

MappingJackson2HttpMessageConverter : application/json
>클래스 타입: 객체 또는 HashMap , 미디어타입 application/json 관련
>요청 예) @RequestBody HelloData data
>응답 예) @ResponseBody return helloData 쓰기 미디어타입 application/json 관련

StringHttpMessageConverter

content-type: application/json

@RequestMapping
void hello(@RequestBody String data) {}

MappingJackson2HttpMessageConverter

content-type: application/json

@RequestMapping
void hello(@RequestBody HelloData data) {}

안되는 케이스

content-type: text/html

@RequestMapping
void hello(@RequestBody HelloData data) {}

HTTP 요청 데이터 읽기
HTTP 요청이 오고, 컨트롤러에서 @RequestBody , HttpEntity 파라미터를 사용한다.
메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead() 를 호출한다.
>대상 클래스 타입을 지원하는가.
예) @RequestBody 의 대상 클래스 ( byte[] , String , HelloData )
>HTTP 요청의 Content-Type 미디어 타입을 지원하는가.
예) text/plain , application/json , */*
canRead() 조건을 만족하면 read() 를 호출해서 객체 생성하고, 반환한다.

HTTP 응답 데이터 생성
컨트롤러에서 @ResponseBody , HttpEntity 로 값이 반환된다.
메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite() 를 호출한다.
>대상 클래스 타입을 지원하는가.
예) return의 대상 클래스 ( byte[] , String , HelloData )
>HTTP 요청의 Accept 미디어 타입을 지원하는가.(더 정확히는 @RequestMapping 의 produces )
예) text/plain , application/json , */*
canWrite() 조건을 만족하면 write() 를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.

14. 요청 맵핑 핸들러 어뎁터 구조

HTTP 메시지 컨버터는 스프링 MVC 어디서 사용?

@RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter(요청 맵핑 핸들러 어댑터)

RequestMappingHandlerAdapter 동작방식

ArgumentResolver

생각해보면, 애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다.

HttpServletRequest , Model 은 물론이고, @RequestParam , @ModelAttribute 같은 애노테이션 그리고 @RequestBody , HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다.
이렇게 파라미터를 유연하게 처리할 수 있는 이유가 바로 ArgumentResolver 덕분이다.

애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdapter 는 바로 이 ArgumentResolver 를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다.

그리고 이렇게 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.

public interface HandlerMethodArgumentResolver {
      
      boolean supportsParameter(MethodParameter parameter);
      
      @Nullable
      Object resolveArgument(MethodParameter parameter, @Nullable
    ModelAndViewContainer mavContainer,
    NativeWebRequest webRequest, @Nullable WebDataBinderFactory
    binderFactory) throws Exception;
}

동작방식

ArgumentResolver 의 supportsParameter() 를 호출해서 해당 파라미터를 지원하는지 체크하고,
지원하면 resolveArgument() 를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다.

ReturnValueHandler

->컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유

HTTP 메시지 컨버터 위치

요청의 경우
@RequestBody 를 처리하는 ArgumentResolver 가 있고,
HttpEntity 를 처리하는 ArgumentResolver 가 있다.
이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.

응답의 경우
@ResponseBody 와 HttpEntity 를 처리하는 ReturnValueHandler 가 있다.
그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.

스프링 MVC는 @RequestBody @ResponseBody 가 있으면 RequestResponseBodyMethodProcessor (ArgumentResolver)
HttpEntity 가 있으면 HttpEntityMethodProcessor (ArgumentResolver)를 사용한다.

확장
스프링은 다음을 모두 인터페이스로 제공한다. 따라서 필요하면 언제든지 기능을 확장할 수 있다.
HandlerMethodArgumentResolver
HandlerMethodReturnValueHandler
HttpMessageConverter

확장할 일 많지 않음

확장이 필요할 때 WebMvcConfigurer 검색

@Bean
    public WebMvcConfigurer webMvcConfigurer() {
        return new WebMvcConfigurer() {
            @Override
            public void addArgumentResolvers(List<HandlerMethodArgumentResolver>
    resolvers) {
//...
} @Override
  public void extendMessageConverters(List<HttpMessageConverter<?>>
  converters) {
//...
} };
}

저작자표시

'👨‍💻 Web Development > Spirng - MVC 패턴 l' 카테고리의 다른 글

[Spring] 7.스프링 MVC - 웹 페이지 만들기 (0)	2023.03.18
[Spring] 5.스프링 MVC - 구조 이해 (0)	2023.03.14
[Spring] 4.MVC 프레임워크 만들기 (0)	2023.03.13
[Spring] 3.서블릿, JSP, MVC 패턴 (0)	2023.03.13
[Spring] 2.서블릿 (0)	2023.03.12

[Spring] 6.스프링 MVC - 기본 기능