스프링MVC6_기본 기능

하도야지·2021년 7월 28일

Spring MVC

목록 보기

6/7

(1) 프로젝트 생성

1. 프로젝트 생성

start.spring.io

프로젝트 선택
 Project: Gradle Project
 Language: Java
 Spring Boot: 2.4.x
Project Metadata
 Group: hello
 Artifact: springmvc
 Name: springmvc
 Package name: hello.springmvc
 Packaging: Jar (주의!)
 Java: 11
 Dependencies: Spring Web, Thymeleaf, Lombok

[참고]

Jar : 항상 내장서버 사용(최적화), webapp 경로 사용 x

War : 내장서버 사용 가능, 주로 외부 서버에 배포 목적

2. Welcome 페이지 추가

index.html
: Jar 이용 시 /resources/static/index.hml 위치에 두면 welcome페이지 처리 ( localhost:8080 시 접속 )

<!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>
 <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-v2?username=hello&age=20">요청 파라미터
v2</a></li>
 <li><a href="/request-param-v3?username=hello&age=20">요청 파라미터
v3</a></li>
 <li><a href="/request-param-v4?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">요청 파라미터
MAP</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) 로깅 간단히 알아보기

1. 로깅

운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해서 필요한 정보를 출력하지 않는다.
대신 별도의 로깅 라이브러리를 사용해서 로그를 출력한다.

2. 로깅 라이브러리

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

SLF4J - http://www.slf4j.org
-> 인터페이스
Logback - http://logback.qos.ch
-> 구현체

실무에서는 스프링 부트가 기본으로 제공하는 Logback을 대부분 사용한다.

3. 로그 선언과 로그 호출

로그 선언

- private Logger log = LoggerFactory.getLogger(getClass());
- private static final Logger log = LoggerFactory.getLogger(Xxx.class)
- @Slf4j : 롬복 사용 가능

로그 호출

호출 방법
log.info("hello")
LogTestController.java
매핑정보 (@RestController)
@Controller
: 반환값이 String일때 뷰 이름으로 인식됨
-> 뷰를 찾고 뷰가 랜더링 됨
@RestController
: 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력
-> 실행결과로 ok 메세지를 받을 수 있음
--> @ResponseBody와 관련 있음

테스트

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

로그 레벨 설정

application.properties
#전체 로그 레벨 설정(기본 info)
logging.level.root=info
#hello.springmvc 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=debug
LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
-> 개발 서버는 debug 출력
-> 운영 서버는 info 출력

@Slf4j 로 변경

올바른 로그 사용법

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

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

로그 사용시 장점

쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.

로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.

시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다.
-> 특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.

성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등등) 그래서 실무에서는 꼭 로그를
사용해야 한다

(3) 요청 매핑

기본 @RequestMapping("/hello-basic")

@RequestMapping("/hello-basic")
: /hello-basic URL 호출이 오면 이 메서드가 실행되도록 매핑한다.
: 대부분의 속성을 배열[] 로 제공하므로 다중 설정이 가능하다. {"/hello-basic", "/hello-go"}

둘다 허용
: 다음 두가지 요청은 다른 URL이지만, 스프링은 다음 URL 요청들을 같은 요청으로 매핑한다.
-> 매핑: /hello-basic
-> URL 요청: /hello-basic , /hello-basic/

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

HTTP 메서드 매핑
HTTP 메서드 매핑 축약

-> HTTP 메서드를 축약한 애노테이션을 사용
PathVariable(경로 변수) 사용

최근 선호하는 스타일
-> /mapping/userA
-> /users/1

@RequestMapping은 URL 경로 템플릿화 가능

@PathVariable의 이름과 파리머 이름 같을 시 생략 가능

PathVariable 사용 - 다중
특정 파라미터 조건 매핑
특정 헤더 조건 매핑
미디어 타입 조건 매핑 - HTTP 요청 Content-Type, consume

HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑

미디어 타입 조건 매핑 - HTTP 요청 Accept, produce

HTTP 요청의 Accept 헤더를 기반으로 미디어 타입으로 매핑

(4) 요청 매핑 - API 예시

1. 회원 관리 API

회원 목록 조회: GET /users
회원 등록: POST /users
회원 조회: GET /users/{userId}
회원 수정: PATCH /users/{userId}
회원 삭제: DELETE /users/{userId}

2. API 매핑 코드 예제

MappingClassController.java

package hello.springmvc.basic.requestmapping;

import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {

    /**
     * GET /mapping/users
     */
    @GetMapping
    public String user(){
        return "get users";
    }

    /**
     * POST /mapping/users
     */
    @PostMapping
    public String addUser(){
        return "add 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;
    }

    /**
     * DELETE /mapping/users/{userId}
     */
    @DeleteMapping("/{userId}")
    public String deleteUser(@PathVariable String userId){
        return "delete userId = " + userId;
    }

}

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

애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원한다.
HTTP 헤더 정보를 조회하는 방법을 알아보자

RequestHeaderController.java
지원 파라미터

HttpServletRequest

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=value

@Slf4j
: 다음의 코드를 자동으로 생성하여 로그를 선언해준다
: 개발자는 log라고 적고 사용하면 된다.

private static final org.slf4j.Logger log = 
org.slf4j.LoggerFactory.getLogger(RequestHeaderController.class)

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

1. HTTP 요청 데이터 조회 - 개요

클라이언트에서 서버로 요청 데이터를 전달할 때는 주로 다음 3가지 방법을 사용한다.

GET - 쿼리 파라미터
-> /url?username=hello&age=20
-> 메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
-> 예) 검색, 필터, 페이징등에서 많이 사용하는 방식
POST - HTML Form
-> content-type: application/x-www-form-urlencoded
-> 메시지 바디에 쿼리 파리미터 형식으로 전달 username=hello&age=20
-> 예) 회원 가입, 상품 주문, HTML Form 사용
HTTP message body에 데이터를 직접 담아서 요청
-> HTTP API에서 주로 사용, JSON, XML, TEXT
데이터 형식은 주로 JSON 사용
-> POST, PUT, PATCH

2. 요청 파라미터 - 쿼리파라미터, HTML Form
HttpServletRequest의 request.getParameter()을 사용하면 다음 두 가지 요청 파라미터를 조회할 수 있다.

GET, 쿼리 파라미터 전송

http://localhost:8080/request-param?username=hello&age=20

POST, HTML Form 전송

POST /request-param ...
content-type: application/x-www-form-urlencoded
username=hello&age=20

RequestParamController.java
PostForm 페이지 생성
: main/resources/static/basic/hello-form.html

<!DOCTYPE html>
<html>
<head>
 <meta charset="UTF-8">
 <title>Title</title>
</head>
<body>
 <form action="/request-param-v1" method="post">
 username: <input type="text" name="username" />
 age: <input type="text" name="age" />
 <button type="submit">전송</button>
 </form>
</body>
</html>

(7) HTTP 요청 파라미터 - @RequestParam

@RequestParam 을 사용하면 요청 파라미터를 매우 편리하게 사용

1. requestParamV2

@RequestParam
: 파라미터 이름으로 바인딩

@ResponseBody
: View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력
: @RequestParam의 name(value) 속성이 파라미터 이름으로 사용

@RequestParam("username") String memberName
-> request.getParameter("username")

2. requestParamV3

HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx") 생략 가능

3. requestParamV4

String , int , Integer 등의 단순 타입이면 @RequestParam 도 생략 가능
** @RequestParam 이 있으면 명확하게 요청 파리미터에서 데이터를 읽는 다는 것을 알 수 있다

4. 파라미터 필수 여부 - requestParamRequired

- @RequestParam.required
: 파라미터 필수 여부
: 기본값이 파라미터 필수( true )이다.

주의! - 파라미터 이름만 사용
-> /request-param?username=
--> 파라미터 이름만 있고 값이 없는 경우 빈문자로 통과

주의! - 기본형(primitive)에 null 입력
-> /request-param 요청
--> @RequestParam(required = false) int age
: null 을 int 에 입력하는 것은 불가능(500 예외 발생)
따라서 null 을 받을 수 있는 Integer 로 변경하거나, 또는 다음에 나오는 defaultValue 사용

5. 기본 값 적용 - requestParamDefault

파라미터에 값이 없는 경우 defaultValue 를 사용하면 기본 값을 적용할 수 있다

defaultValue 는 빈 문자의 경우에도 설정한 기본 값이 적용된다

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

파라미터를 Map, MultiValueMap으로 조회할 수 있다.

(8) HTTP 요청 파라미터 - @ModelAttribute

0. @ModelAttribute 이전의 개발

@RequestParam String username;
@RequestParam int age;
HelloData data = new HelloData();
data.setUsername(username);
data.setAge(age);

1. @ModelAttribute 적용 - modelAttributeV1

HelloData.java
modelAttributeV1.java

HelloData 객체가 생성되고, 요청 파라미터의 값도 모두 들어가 있다.

스프링MVC는 @ModelAttribute 가 있으면 다음을 실행한다.
-> HelloData 객체를 생성한다.
--> 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩) 한다.

프로퍼티

객체에 getUsername() , setUsername() 메서드가 있으면, 이 객체는 username 이라는 프로퍼티를 가지고 있다.

username 프로퍼티의 값을 변경하면 setUsername() 이 호출되고, 조회하면 getUsername()이 호출된다.

바인딩 오류

age=abc 처럼 숫자가 들어가야 할 곳에 문자를 넣으면 BindException 이 발생한다.

2. @ModelAttribute 생략 - modelAttributeV2

@ModelAttribute 는 생략할 수 있다.

그런데 @RequestParam 도 생략할 수 있으니 혼란이 발생할 수 있다.

스프링은 해당 생략시 다음과 같은 규칙을 적용한다.
- String , int , Integer 같은 단순 타입 = @RequestParam
- 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)

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

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

HTTP API에서 주로 사용, JSON, XML, TEXT

데이터 형식은 주로 JSON 사용

POST, PUT, PATCH

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

2. HTTP message body 전송하기

RequestBodyStringController.java
Input, Output 스트림, Reader - requestBodyStringV2

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

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

HttpEntity - requestBodyStringV3

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

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

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

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

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

@RequestBody - requestBodyStringV4

@RequestBody
: @RequestBody 를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다.
: 참고로 헤더 정보가 필요하다면 HttpEntity 를 사용하거나 @RequestHeader 를 사용하면 된다.
-> 이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam , @ModelAttribute 와는 전혀 관계가 없다.

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

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

(10) HTTP 요청 메시지 - JSON

1. HTTP 요청 메시지 - JSON

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

2. HTTP message - JSON 전송하기

RequestBodyJsonController.java

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

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

requestBodyJsonV2 - @RequestBody 문자 변

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

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

requestBodyJsonV3 - @RequestBody 객체 변환

@RequestBody 객체 파라미터

@RequestBody HelloData data

@RequestBody 에 직접 만든 객체를 지정할 수 있다.

HttpEntity , @RequestBody 를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환해준다.
-> HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해주는데, 우리가 방금 V2에서 했던 작업을 대신 처리해준다.

@RequestBody는 생략 불가능

스프링은 @ModelAttribute , @RequestParam 해당 생략시 다음과 같은 규칙을 적용한다.
- String , int , Integer 같은 단순 타입 = @RequestParam
- 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)
-> 이 경우 HelloData에 @RequestBody 를 생략하면 @ModelAttribute 가 적용되어버린다.
--> 따라서 생략 시 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.

requestBodyJsonV5

@ResponseBody

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

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

1. 스프링에서 응답 데이터를 만드는 방법

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

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

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

2. 정적 리소스

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

/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
정적 리소스는 해당 파일을 변경 없이 그대로 서비스하는 것

3. 뷰 템플릿

뷰 템플릿을 거쳐서 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>
ResponseViewController - 뷰 템플릿을 호출하는 컨트롤러

4. Thymeleaf 스프링 부트 설정

build.gradle

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

application.properties

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

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

1. HTTP 응답 - HTTP API

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

2. 소스 정리

ResponseBodyController.java

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.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Slf4j
//@Controller
//@ResponseBody
@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(HttpServletResponse response) throws IOException{
       return new ResponseEntity<>("ok", HttpStatus.OK);
    }

    //@ResponseBody
    @GetMapping("/response-body-string-v3")
    public String responseBodyV3() throws IOException{
        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 응답 메시지를 전달한다.
-> response.getWriter().write("ok")

responseBodyV2
: ResponseEntity 엔티티는 HttpEntity 를 상속 받음
-> HttpEntity는 HTTP 메시지의 헤더, 바디
정보를 가지고 있다.
--> ResponseEntity 는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다.

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

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

responseBodyJsonV2
: @ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다.
-> 물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다. 프로그램 조건에 따라서 동적으로
변경하려면 ResponseEntity 를 사용하면 된다.

@RestController

@RestController 애노테이션은 @Controller + @ResponseBody 의 역할을 한다.

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

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

(13) HTTP 메시지 컨버터

1. HTTP 메시지 컨버터

HTTP API처럼 JSON 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우, HTTP 메시지 컨버터를 사용하면 편리하다.
@ResponseBody 사용 원리

@ResponseBody 를 사용

HTTP의 BODY에 문자 내용을 직접 반환

viewResolver 대신에 HttpMessageConverter 가 동작
-> 기본 문자처리: StringHttpMessageConverter
-> 기본 객체처리: MappingJackson2HttpMessageConverter
-> byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

2. 스프링 MVC의 HTTP 메시지 컨버터 적용

다음의 경우 HTTP 컨버터 적용

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

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

package org.springframework.http.converter;

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 메시지 컨버터는 HTTP 요청, HTTP 응답 둘 다 사용된다.

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

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

4. 스프링 부트 기본 메시지 컨버터

스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 둘을 체크해서 사용여부를 결정한다.
만약 만족하지 않으면 다음 메시지 컨버터로 우선순위가 넘어간다

0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter

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 관련

5. HTTP 요청 데이터 읽기

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

6. HTTP 응답 데이터 생성

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

(14) 요청 매핑 헨들러 어뎁터 구조

0. RequestMappingHandlerAdapter
HTTP 메시지 컨버터는 스프링 MVC 어디쯤에서 있을까?

SpringMVC 구조

-> @RequestMapping 을 처리하는 핸들러 어댑터인
RequestMappingHandlerAdapter (요청 매핑 헨들러 어뎁터)에 있다.
RequestMappingHandlerAdapter 동작 방식

RequestMappingHandlerAdapter

컨트롤러의 파라미터, 에노테이션 정보를 기반으로 전달 데이터 생성 (Argument Resolver)

핸들러 호출 (controller)

컨트롤러의 반환값 변환 ( ReturnValueHandler)

1. ArgumentResolver

ArgumentResolver

애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있다.
-> HttpServletRequest , Model, @RequestParam, @ModelAttribute, @RequestBody , HttpEntity 등 유연한 처리
--> 이렇게 파라미터를 유연하게 처리할 수 있는 이유가 바로 ArgumentResolver 덕분이다.

requestMappingHandlerAdaptor
: ArgumentResolver 를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다.
-> 이렇게 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.

스프링은 30개가 넘는 ArgumentResolver 를 기본으로 제공한다.

HandlerMethodArgumentResolver.interface

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() 를 호출해서 실제 객체를 생성한다.

생성된 객체가 컨트롤러 호출시 넘어가간다.

원한다면 직접 이 인터페이스를 확장해서 원하는 ArgumentResolver 를 만들 수도 있다.

2. ReturnValueHandler

HandlerMethodReturnValueHandler 를 줄여서 ReturnValueHandle 라 부른다.
응답 값을 변환하고 처리한다.
-> 컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler 덕분이다.
스프링은 10여개가 넘는 ReturnValueHandler 를 지원한다.
예) ModelAndView , @ResponseBody , HttpEntity , String

3. HTTP 메시지 컨버터

HTTP 메시지 컨버터 위치

HTTP 메시지 컨버터를 사용
(@RequestBody, @ResponseBody)

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

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

4. 확장

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

HandlerMethodArgumentResolver
HandlerMethodReturnValueHandler
HttpMessageConverter

(15) 정리

하도야지

프로그래머를 꿈꾸는 코더

이전 포스트

스프링MVC5_구조 이해

다음 포스트