본 포스팅은 인프런 - 스프링 MVC 1편을 강의를 바탕으로 공부하고 정리한 글입니다.
📢 본 포스팅에 앞서 예제를 위한 프로젝트를 생성하자.
더보기
더보기
📌 스프링 프로젝트 생성
스프링 부트 스타터를 이용해서 스프링 프로젝트를 생성해주도록 하자.
- 프로젝트 선택
- Project: Gradle
- Project Language: Java
- Spring Boot: 2.6.x (정식버전 중 가장 최신 버전 선택)
- Project Metadata
- Group: hello
- Artifact: springmvc
- Name: springmvc
- Package name: hello.springmvc
- Packaging: Jar (주의!)
- Java: 11
- Dependencies : Spring Web, Thymeleaf, Lombok
📌 실행 확인
인텔리제이로 프로젝트를 Open하고, 동작하는지 확인한다.
- 기본 메인 클래스 실행
- http://localhost:8080 호출해서 Whitelabel Error Page가 나오면 정상 동작
📌 자바로 실행하기
최근 인텔리제이 버전은 Gradle을 통해 실행하는 것이 기본값인데, 이렇게 하면 실행속도가 느리기 때문에 자바로 바로 실행하도록 설정을 변경해준다.
- 윈도우 사용자 : File → Setting → Gradle 검색
- 맥 사용자 : Preferences → Gradle 검색
- Build and run using : Gradle → IntelliJ IDEA 변경
- Run tests using : Gradle → IntelliJ IDEA
인텔리제이 무료 버전의 경우 War 파일의 톰캣이 정상 시작되지 않는 문제가 발생할 수 있어 해당 설정을 IntelliJ IDEA가 아닌 Gradle로 설정해야 한다. (유료버전은 정상 동작)
또는 build.gradle에 있는 다음 코드를 제거해도 된다.
→ providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
📌 롬복 적용
- File → Setting(맥:Preferences) → plugin → lombok 검색 설치 (재시작)
- File → Setting(맥:Preferences) → Annotation Processors 검색 → Enable annotation processing 체크 (재시작)
- 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인
📌 웰컴 페이지 만들기
학습할 내용을 편하게 참고하기 위해 웰컴 페이지를 만들어 주도록 하겠다.
스프링 부트의 Jar를 사용할 경우 /resource/static/index.html 파일을 웰컴 페이지로 인식한다.
📁 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>
<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>
요청 매핑
매핑 방법
클라이언트로부터 요청이 왔을 경우 어떻게 컨트롤러와 매핑이 진행되는 것인지 알아보자.
👉🏻 기본 매핑
더보기
더보기
/**
* 기본 요청
* 둘다 허용 /hello-basic, /hello-basic/
* HTTP 메서드 모두 허용 GET, HEAD, POST, PUT, PATCH, DELETE
*/
@RequestMapping("/hello-basic")
public String helloBasic() {
log.info("helloBasic");
return "ok";
}- @RequestMapping(/hello-basic)
- 해당 URL(/hello-basic)로 요청이 오면 이 메소드가 실행되도록 매핑한다.
- 대부분 속성을 배열로 제공하기 때문에 여러개의 URL을 설정하는 것도 가능하다.
- 예) @RequestMapping({"/hello-basic", "/hello-go"})
- 스프링은 다음 URL 요청들을 같은 요청으로 매핑한다.
- 매핑 : /hello-baisc
- 요청 : /hello-basic, /hello-basic/
- @RequestMapping에 method 속성을 따로 지정하지 않을 경우 HTTP 메소드와 무관하게 매핑된다.
- 모두 허용 : GET, POST, HEAD, PUT, PATCH, DELETE
👉🏻 특정 HTTP method 허용 매핑
더보기
더보기
/**
* 특정 HTTP method 요청만 허용
* GET, HEAD, POST, PUT, PATCH, DELETE
*/
@RequestMapping(value = "/hello-get-v1", method = RequestMethod.GET)
public String mappingGetV1() {
log.info("helloBasic");
return "ok";
}- method = RequestMethod.Get
- GET 요청일 경우에만 매핑된다.
- 만약 POST 요청이 올 경우 스프링 MVC는 HTTP 405 상태코드(Method Not Allowed)를 반환한다.
👉🏻 HTTP 메소드 매핑 축약
더보기
더보기
/**
* 편리한 축약 애노테이션
* @GetMapping
* @PostMapping
* @PutMapping
* @DeleteMapping
* @PatchMapping
*/
@GetMapping(value = "/hello-get-v2")
public String mappingGetV2() {
log.info("helloBasic");
return "ok";
}- 매번 method 속성을 지정해주는 것은 번거롭고 가독성이 떨어지므로, HTTP 메소드를 축약한 어노테이션을 사용하는 것이 더 직관적이다.
- GET, POST, PUT, DELETE 등 모든 HTTP 메소드에 다한 축약 어노테이션이 제공된다.
- 실제 이 어노테이션 내부에는 @RequestMapping과 method를 지정해서 사용한다.
👉🏻 PathVariable(경로 변수)를 사용한 매핑
더보기
더보기
/**
* PathVariable 사용
* 변수명이 같으면 생략 가능
* @PathVariable("userId") String userId -> @PathVariable String userId
*/
@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable("userId") String data) {
log.info("mappingPath={}", data);
return "ok";
}- 최근 HTTP API는 다음과 같이 리소스 경로에 식별자를 넣는 스타일을 선호한다.
- /mapping/userA
- /users/1
- @RequestMapping은 URL 경로를 템플릿화 할 수 있으며, @PathVariable을 사용해 매핑되는 부분을 편리하게 조회할 수 있다.
- 이때 @PathVariable 이름과 파라미터 이름이 같으면 생략할 수 있다.
- 예) @PathVariable("username") String username → PathVariable String username
- 실행 : http://localhost:8080/mapping/userA
👉🏻 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";
}- 하나 이상의 PathVariable 사용도 가능하다.
- 실행 : http://localhost:8080/mapping/users/userA/orders/100
👉🏻 특정 파라미터 조건 매핑
더보기
더보기
/**
* 파라미터로 추가 매핑
* 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";
}- 특정 파라미터가 있거나 없는 조건을 추가할 수 있다.
- 잘 사용하지는 않음
- 실행 : http://localhost:8080/mapping-param?mode=debug
👉🏻 특정 헤더 조건 매핑
더보기
더보기
/**
* 특정 헤더로 추가 매핑
* 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";
}- 파라미터 매핑과 비슷하지만, params이 아닌 headers를 사용한다.
- 실행 (Postman)
👉🏻 미디어 타입 조건 매핑 - 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";
}- HTTP 요청이 Content-Type 헤더를 기반으로 매핑한다.
- consumes = "application/json"
- 헤더의 Content-Type이 application/json인 경우에만 해당 컨트롤러가 정상 호출된다.
- 일치하지 않을 경우 HTTP 415 상태코드(Unsupported Media Type)을 반환한다.
💡 예시
consumes = "text/plain"
consumes = {"text/plain", "application/*"}
consumes = MediaType.TEXT_PLAIN_VALUE
👉🏻 미디어 타입 조건 매핑 - HTTP 요청 Accept, 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";
}- HTTP 요청의 Accept 헤더를 기반으로 매핑한다.
- 일치하지 않을 경우 HTTP 406 상태코드(Not Acceptable)을 반환한다.
💡 예시
produces = "text/plain"
produces = {"text/plain", "application/*"}
produces = MediaType.TEXT_PLAIN_VALUE
produces = "text/plain;charset=UTF-8"
API 예제
회원관리 웹 어플리케이션을 HTTP API로 만든다 가정하고 매핑을 어떻게 하는지 알아보자.
- 회원 목록 조회: GET /users
- 회원 등록: POST /users
- 회원 조회: GET /users/{userId}
- 회원 수정: PATCH /users/{userId}
- 회원 삭제: DELETE /users/{userId}
📁 basic/requestmapping/MappingClassController
@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {
/**
* 회원 목록 조회: GET /users
* 회원 등록: POST /users
* 회원 조회: GET /users/{userId}
* 회원 수정: PATCH /users/{userId}
* 회원 삭제: DELETE /users/{userId}
*/
@GetMapping
public String user() {
return "get users";
}
@PostMapping
public String addUser() {
return "post users";
}
@GetMapping("/{userId}")
public String findUser(@PathVariable String userId) {
return "get userId =" + 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;
}
}- @ReqeustMapping("/mapping/users")
- 클래스 레벨에 매핑 정보를 두면 메소드 레벨의 정보와 조합해서 사용한다.
- 테스트 (Postman)
- 회원 목록 조회: GET /mapping/users
- 회원 등록: POST /mapping/users
- 회원 조회: GET /mapping/users/id1
- 회원 수정: PATCH /mapping/users/id1
- 회원 삭제: DELETE /mapping/users/id1
HTTP 요청 헤더 조회
애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원한다.
컨트롤러가 HTTP 요청 헤더 정보를 조회하는 방법을 코드를 통해 알아보자.
📁 basic/request/RequestHeaderController
@Slf4j
@RestController
public class RequestHeaderCotroller {
@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";
}
}- HttpMethod : HTTP 메소드를 조회한다.
- Locale : Locale 정보를 조회한다. (ko-kr, euc-kr, kr ...)
Locale (로케일)
• 로케일은 사용자의 언어, 국가 뿐 아니라 사용자 인터페이스에서 사용자가 선호하는 사항을 지정한 매개변수의 모임이다.
- @RequestHeader MultiValueMap<String, String> headerMap
- 모든 HTTP 헤더를 MultiValueMap 형식으로 조회한다.
- MultiValueMap
- MAP과 유사한데, 하나의 키에 여러 값을 받을 수 있다.
- HTTP header, HTTP 쿼리 파라미터와 같이 하나의 키에 여러 값을 받을 때 사용한다.
- 예) keyA=value1&keyA=value2
- @RequestHeader("host") String host
- 특정 HTTP 헤더를 조회한다.
- 속성
- 필수 값 여부: required
- 기본 값 속성: defaultValue
- @CookieValue(value = "myCookie", required = false) String cookie
- 특정 쿠키를 조회한다.
- 속성
- 필수 값 여부: required
- 기본 값: defaultValue
- @Slf4j
- 로그 선언 코드를 자동으로 선언해준다.
- 개발자는 편리하게 log.으로 사용하면 된다.
공식 메뉴얼(@Controller의 사용 가능한 파라미터 목록)
공식 메뉴얼(@Controller의 사용 가능한 응답 값 목록)
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을 사용할 수 있다.
쿼리 파라미터 형식으로 요청 메세지를 전달하는 것은 GET 쿼리 파라미터, POST HTML Form 전송 방식이 있다.
이 두 방식은 데이터 전송 형식이 같기 때문에 구분 없이 조회할 수 있으며, 이를 요청 파라미터(request parameter) 조회라고 한다.
👉🏻 GET - 쿼리 파라미터 전송
http://localhost8080/request-param?username=hello&age=20👉🏻 POST -HTML Form 전송
POST /request-param ...
content-type: application/x-www-form-urlencoded
username=hello&age=20
이전 서블릿에서 학습했던 요청 파라미터를 조회하는 방법과 비교해, 스프링이 얼마나 깔끔하고 효율적으로 바꾸어주는지 알아보자.
먼저 진행 전에 POST -HTML Form 전송을 위해 폼을 만들어 주자.
👉🏻 Post 전송을 위한 페이지 생성
더보기
더보기
📁 reource/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>
HttpServletRequest
HTTP 요청 메세지를 개발자가 사용하기 편하게 변환해 제공하는 것이 HttpServletRequest 객체이다.
이 객체의 getParameter()를 이용하면 요청 파라미터를 조회할 수 있다.
👉🏻 v1
📁 basic/request/RequestParamCon troller
@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");
}
}- GET - 쿼리파라미터 전송 실행
- http://localhost:8080/request-param-v1?username=hello&age=20
- 출력 로그
- http://localhost:8080/request-param-v1?username=hello&age=20
- POST - HTML Form 전송 실행
- http://localhost:8080/basic/hello-form.html
- 출력 로그
- http://localhost:8080/basic/hello-form.html
@RequestParam
스프링이 제공하는 @RequestParam을 사용하면 요청 파라미터를 매우 편리하게 조회할 수 있다.
👉🏻 V2
/**
* @RequestParam 사용
* 파라미터 이름으로 바인딩
* @ResponseBody 추가
* View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력 → @RestController와 동일한 기능
*/
@ResponseBody
@RequestMapping("/request-param-v2")
public String requestParamV2(@RequestParam("username") String memberName,
@RequestParam("age") int memberAge) {
log.info("username={}, age={}", memberName, memberAge);
return "ok";
}👉🏻 V3
/**
* @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";
}- HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx") 생략 가능
👉🏻 V4
/**
* @RequestParam 사용
* String, int 등의 단순 타입이면 @RequestParam 도 생략 가능
*/
@ResponseBody
@RequestMapping("/request-param-v4")
public String requestParamV4(String username, int age) {
log.info("username={}, age={}", username, age);
return "ok";
}- 파라미터가 String , int , Integer 등의 단순 타입이면 @RequestParam도 생략 가능
👉🏻 requestParamRequired - 파라미터 필수 여부
/**
* required=ture : 필수 파라미터
* required=false : 없으면 null
* int 타입은 null 불가하기 때문에 Integer 래퍼클래스를 사용
*/
@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";
}- @RequestParam(required = xxx) : 파라미터 필수 여부 (기본값 : true)
- required = true : 파라미터가 없으면 400 예외가 발생한다.
- required = false : 파라미터가 없으면 null 로 처리한다.
- required = true : 파라미터가 없으면 400 예외가 발생한다.
기본형에 null 입력 ?
• null을 int에 입력받는 것은 불가능하다(500 예외 발생)
• 따라서 값이 없을 경우 null을 받을 수 있는 Integer로 변경하거나, 다음에 나오는 defautlValue를 사용해야 한다.
파라미터 이름만 있는 경우
• 파라미터 이름만 있고 값이 없는 경우(/request-param-required?username=)
• 빈 문자("")로 값이 들어와 통과한다는 점을 주의해야 한다.
👉🏻 requestParamDefault - 기본값 지정
/**
* @RequestParam(defaultValue = "")
* 값이 없을 때 기본값 지정
*/
@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";
}- @RequestParam(defalutValue = "xxx")
- 파라미터에 값이 없는 경우 기본 값을 적용할 수 있다.
- 빈 문자인 경우에도 설정한 기본 값이 적용된다.
- http://localhost:8080/request-param-default?
- http://localhost:8080/request-param-default?
👉🏻 requestParamMap - 파라미터를 Map으로 조회하기
@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";
}- 파라미터를 Map, MultiValueMap으로 조회할 수 있다.
- 파라미터의 값이 1개가 확실하다면 Map을 , 그렇지 않다면 MultiValueMap을 사용
- @RequestParam Map → Map(key=value)
- @RequestParam MultiValueMap → MultiValueMap(key=[value1, value2, ...])
- http://localhost:8080/request-param-map?username=hello&age=20,30
- 파라미터의 값이 1개가 확실하다면 Map을 , 그렇지 않다면 MultiValueMap을 사용
@ModelAttribute
위에서 @RequestParam을 이용해 요청 파라미터를 하나하나 받아줬다.
애노테이션을 사용해 편리하게 받을 수 있었지만, 다음과 같이 요청 파라미터가 하나의 객체가 되어야 하는 경우 각각의 파라미터를 조회해 객체에 값을 넣어서 생성해줘야 하므로 번거로울 수 있다.
스프링은 이런 번거로운 과정을 자동화해주는 @ModelAttribute 애노테이션을 제공해준다.
👉🏻 요청 파라미터를 바인딩 할 객체
더보기
더보기
📁 basic/HelloData
@Data
public class HelloData {
private String username;
private int age;
}- @Data :Getter, Setter, toString, EqualsAndHashCode, @RequiredArgsConstructor를 자동으로 생성해준다.
👉🏻 @RequestParam을 사용한 HelloData 객체 생성
@ResponseBody
@RequestMapping("/model-attribute-v1")
public String modelAttributeV1(@RequestParam String username, @RequestParam int age) {
HelloData helloData = new HelloData();
helloData.setUsername(username);
helloData.setAge(age);
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}👉🏻 @ModelAttribute을 사용한 HelloData 객체 생성
public String modelAttributeV1(@ModelAttribute HelloData helloData) {
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}- @ModelAttribute를 사용해 HelloData 객체가 생성되고, 요청 파라미터의 값이 모두 들어가 있다.
❗ 스프링MVC는 @ModelAttirbute가 있으면 다음을 수행한다.
- HelloData 객체를 생성한다.
- 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾고, 해당 프로퍼티의 setter를 호출해 파라미터의 값을 바인딩한다.
→ 파라미터 이름이 username일 경우 setUsername 메소드를 찾아 호출하며 값을 입력
프로퍼티
• 객체에 getUsername(), setUsername() 메소드가 있으면, 이 객체는 username이라는 프로퍼티를 가지고 있다는 것이다.
• username 프로퍼티의 값을 변경하면 setUsername()이 호출되고, 조회하면 getUsername()이 호출된다.
바인딩 오류
• 만약 age 프로퍼티에 숫자가 아닌 문자가 들어오면(age=hello) BindException이 발생한다.
(바인딩 오류를 처리하는 방법은 검증 부분에서 다룰 예정)
👉🏻 @ModelAttribute 생략
/**
* @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";
}- @ModelAttribute 생략할 수 있다.
- 그런데 @RequestParam도 생략할 수 있기 때문에 어느 어노테이션이 생략된 것인지 혼란이 발생할 수 있다.
- 따라서 스프링은 해당 생략시 다음과 같은 규칙을 적용한다.
- String, int, Integer 같은 단순 타입 = @RequestParam
- 나머지(argument resolver로 지정해둔 타입 제외) = @ModelAttribute
* argument resolver는 뒤에서 학습 예정
HTTP 요청 메시지 조회
지금까지 쿼리 파라미터 형식의 요청 파라미터 조회 방법을 알아보았다.
요청 파라미터와는 다르게 HTTP message body에 데이터를 직접 담아서 요청하는 경우에는 @RequestParam, @ModelAttribute를 사용할 수 없다.
그렇다면 HTTP message body에 데이터를 직접 담아서 요청하는 경우 어떻게 요청 데이터를 조회하는지 알아보자.
먼저, 요청 메시지로 단순 텍스트를 담아 전송하고 읽어보며 알아보자.
InputStream
HTTP 메시지 바디의 데이터를 InputStream을 사용해 직접 읽을 수 있다.
👉🏻 V1
📁 basic/request/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");
}
}- 테스트 (포스트맨)
- POST http://localhost:8080/request-body-string-v1
- Body row, Text ("hello") 전송
- 결과
👉🏻 V2
/**
* 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");
}- 매개변수에서 바로 InputStream과 Writer를 받아 사용할 수 있다.
HttpEntity
HttpEntity를 사용해 더 편리하게 조회가 가능하다.
👉🏻 V3
@PostMapping("/request-body-string-v3")
public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) {
String messageBody = httpEntity.getBody();
log.info("messageBody={}", messageBody);
return new HttpEntity<>("ok");
}- HttpEntity
- HTTP 헤더, 바디 정보를 편리하게 조회할 수 있다.
- 요청 파라미터를 조회하는 @RequestParam, @ModelAttribute 기능과는 전혀 관계 없음
- 응답에도 사용이 가능하다.
- 메시지 바디 정보를 직접 반환한다.
- 헤더 정보 포함 기능
- view를 조회하지 않는다.
- HttpEntity를 상속받은 다음 객체들도 같은 기능을 제공한다.
- RequestEntity
- HttpMethod, url 정보 추가, 요청에서 사용
- ResponseEntity
- HTTP 상태 코드 설정 가능, 응답에서 사용
- RequestEntity
@PostMapping("/request-body-string-v3")
public HttpEntity<String> requestBodyStringV3(RequestEntity<String> requestEntity) {
String messageBody = requestEntity.getBody();
log.info("messageBody={}", messageBody);
return new ResponseEntity<String>("ok", HttpStatus.OK);
}스프링MVC 내부에서 HTTP 메시지 바디를 읽어 문자나 객체로 변환해서 전달해주는데, 이때 HTTP 메시지 컨버터(HttpMessageConverter)라는 기능을 사용한다.
@RequestBody, @ResponseBody
@RequestBody를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다. 만약 헤더 정보가 필요하다면 HttpEntity를 사용하거나 @RequestHeader를 사용하면 된다.
이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 기능과는 전혀 관계가 없다!
- 요청 파라미터를 조회하는 기능 : @ReqeustParam, @ModelAttribute
- HTTP 메시지 바디를 직접 조회하는 기능 : @RequestBody
또한 @ResonseBody를 사용하면 응답 결과를 HTTP 메시지 바디에 직접 담아서 전달할 수 있다.
👉🏻 V4
@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody) {
log.info("messageBody={}", messageBody);
return "ok";
}
이번에는 단순 텍스트가 아닌 HTTP API에서 주로 사용하는 JSON 데이터 형식을 조회하는 방법을 알아보자.
👉🏻 V1 - InputStream 사용
더보기
더보기
/**
* {"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 helloData = objectMapper.readValue(messageBody, HelloData.class);
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
response.getWriter().write("ok");
}
}- HttpServletRequest, HttpServletResponse 객체를 통해 InputStream을 사용해 메시지 바디를 읽고, ObjectMapper로 객체 바인딩 한다.
- HttpServletRequest를 사용해서 직접 HTTP 메시지 바디에서 데이터를 읽어와서, 문자로 변환한다.
- 문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper 를 사용해서 자바 객체(HelloData)로 변환한다.
- 테스트 (포스트맨)
- POST http://localhost:8080/request-body-json-v1
- raw, JSON, content-type: application/json
- {"username":"hello", "age":20}
- 결과
👉🏻 V2 - @RequestBody 문자 변환
더보기
더보기
/**
* @RequestBody
* HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
*
* @ResponseBody
* - 모든 메서드에 @ResponseBody 적용
* - 메시지 바디 정보 직접 반환(view 조회X)
* - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
*/
@ResponseBody
@PostMapping("/request-body-json-v2")
public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {
log.info("messageBody={}", messageBody);
HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}- 이전에 학습했던 @RequestBody를 사용해 HTTP 메시지 데이터를 꺼내고, 메시지 바디에 저장한다.
- 문자로 된 JSON 데이터인 messageBody를 objectMapper를 통해 자바 객체(HelloData)로 변환한다.
이때 문자로 변환하고 다시 JSON으로 변환하는 과정이 번거롭다.
요청 파라미터의 @ModelAttribute처럼 한번에 객체로 변환할 수 있는 방법은 없을까?
👉🏻 V3 - @RequestBody 객체 변환
더보기
더보기
/**
* @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
* HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (contenttype: application/json)
*/
@ResponseBody
@PostMapping("/request-body-json-v3")
public String requestBodyJsonV3(@RequestBody HelloData helloData) {
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}- @RequestBody
- @RequestBody HelloData hellodata : @RequestBody에 직접 만든 객체를 지정할 수도 있다.
- @RequestBody는 생략이 불가능하다.
- HelloData에 @RequestBody를 생략할 경우 @ModelAttribute가 적용되어 버린다.
- 따라서 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.
- HttpEntity, @RequestBody를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환해준다.
- HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해주는데, 우리가 이전에 V2에서 했던 작업을 대신 처리해준다.
HTTP 요청 시 content-type이 application/json인지 꼭 확인해야 한다.
그래야 JSON을 처리할 수 있는 HTTP 메시지 컨버터가 실행된다.
👉🏻 V4 - HttpEntity 사용
더보기
더보기
@ResponseBody
@PostMapping("/request-body-json-v4")
public String requestBodyJsonV4(HttpEntity<HelloData> httpEntity) {
HelloData helloData = httpEntity.getBody();
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}
👉🏻 V5 - @RequestBody, @ResponseBody 사용
더보기
더보기
/**
* @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 helloData) throws IOException {
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return helloData;
}- 응답의 경우에도 @ResponseBody를 사용해 해당 객체를 HTTP 메시지 바디에 직접 넣어줄 수 있다.
- 이 경우에도 HttpEntity를 사용해도 된다.
- @RequestBody 요청 : JSON 요청 ➡ HTTP 메시지 컨버터 ➡ 객체
- @ResponseBody 응답 : 객체 ➡ HTTP 메시지 컨버터 ➡ JSON 응답
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
실제로 타임리프 뷰 템플릿을 이용해 간단한 페이지를 만들어보자.
📂 resource/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>📁 basic/response/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!");
}
}- v1 - ModelAndView을 반환하는 경우
- 객체에서 View를 꺼내 물리적인 뷰 이름으로 완성한 뒤 뷰 리졸버가 실행되어 뷰를 찾고 렌더링 한다.
- v2 - String을 반환하는 경우
- @ResponseBody가 없으면 뷰 리졸버가 실행되어 뷰를 찾고 렌더링 한다.
- @ResponseBody가 있으면 뷰 리졸버가 실행되지 않고, HTTP 메세지 바디에 직접 문자가 입력된다.
- v3 - void를 반환하는 경우
- @Controller를 사용하고, HttpServletResponse, OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해 논리 뷰 이름으로 사용한다.
- 요청 URL : /response/hello
- 실행 : templates/response.hello.html
- 이 방식은 명시성이 너무 떨어지기 때문에 권장하지 않음!
- @Controller를 사용하고, HttpServletResponse, OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해 논리 뷰 이름으로 사용한다.
메시지 바디에 직접 입력
HTTP API를 제공하는 경우 HTML이 아닌 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.
HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 데이터를 담아서 전달한다.
하지만 이번 포스팅에서 말하는 내용은 정적 리소스나, 뷰 템플렛이 아닌 직접 HTTP 응답 메시지를 전달하는 경우에 대해 정리 할 것이다.
📁 basic/response/ResponseBodyController
@Slf4j
@RestController //@Controller + @ResponseBody
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);
}
// @ResponseBody
@ResponseStatus(HttpStatus.OK)
@GetMapping("/response-body-json-v2")
public HelloData responseBodyJsonV2() {
HelloData helloData = new HelloData();
helloData.setUsername("userA");
helloData.setAge(20);
return helloData;
}
}- 단순 텍스트 데이터 전송
- v1 - 서블릿 사용
- HttpServletResponse 객체를 통해 HTTP 메시지 바디에 직접 ok 응답 메시지를 전달한다.
➡ response.getWriter().write("ok")
- HttpServletResponse 객체를 통해 HTTP 메시지 바디에 직접 ok 응답 메시지를 전달한다.
- v2 - ResponseEntity 사용
- ResponseEntity는 HttpEntity를 상속 받으며, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다. ResponseEntity는 이에 더해 HTTP 응답 코드를 설정할 수 있다.
➡ HttpStatus.OK
- ResponseEntity는 HttpEntity를 상속 받으며, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다. ResponseEntity는 이에 더해 HTTP 응답 코드를 설정할 수 있다.
- v3 - @ResponseBody 사용
- @ResponseBody 어노테이션을 사용하면 view를 사용하지 않고 HTTP 메시지 컨버터를 통해 HTTP 메시지를 직접 입력할 수 있다.
- v1 - 서블릿 사용
- JSON 데이터 전송
- v1 - ResponseEntity 사용
- ResponseEentity를 반환한다.
- HTTP 메시지 컨버터를 통해 JSON 형식으로 변환되어 반환된다.
- v2 - @ResponseBody + @ResponseStatus 사용
- @ResponseBody를 사용하면 HTTP 응답 코드를 설정할 수 없다. 그래서 이런 경우 @ResponseStatus 어노테이션을 사용해 응답 코드도 함께 설정할 수 있다.
(하지만, 어노테이션이기 때문에 응답 코드를 동적으로 변경할 수 는 없다. 프로그램 조건에 따라 동적으로 변경하려면 ResponseEntity를 사용하면 된다.)
- @ResponseBody를 사용하면 HTTP 응답 코드를 설정할 수 없다. 그래서 이런 경우 @ResponseStatus 어노테이션을 사용해 응답 코드도 함께 설정할 수 있다.
- v1 - ResponseEntity 사용
- @RestController
- @Controller 대신에 @RestController 어노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody가 적용되는 효과가 있다.
- 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력하게 된다.
- 이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러이다.
HTTP 메시지 컨버터
뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아닌, HTTP API처럼 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용하면 편리하다.
HTTP 메시지 컨버터를 설명하기 전 @ResponseBody의 사용원리를 살펴보자.
💡 @ResponseBody 사용원리
- @ResponseBody를 사용
- HTTP Body에 문자 내용을 직접 반환
- viewResolver 대신에 HttpMessageConverter가 동작한다.
- 기본 문자처리: StringHttpMessageConverter
- 기본 객체처리: MappingJackson2HttpMessageConverter
- byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음
정리하자면 스프링 MVC는 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 적용한다.
- HTTP 요청 : @RequestBody, HttpEntity(RequestEntity)
- HTTP 응답 : @ResponseBody, HttpEntity(ResponseEntity)
👉🏻 HTTP 메시지 컨버터 인터페이스
📂 org/springframework/http/onverter/HttpMessageConverter
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 응답 둘다 사용된다.
- 요청 : JSON → 객체
- 응답 : 객체 → JSON
- canRead() , canWrite() : 메시지 컨버터가 해당 클래스, 미디어타입을 지원하는지 체크하는 메소드
- read() , write() : 메시지 컨버터를 통해서 메시지를 실제로 읽고 쓰는 메소드
기본 메시지 컨버터
스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 둘을 체크해서 사용여부를 결정 한다.
만약 만족하지 않으면 다음 메시지 컨버터로 우선순위가 넘어간다.
몇가지 주요한 메시지 컨버터에 대해 알아보자.
// 일부 생략
0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter- ByteArrayHttpMessageConverter : byte[] 데이터를 처리한다.
- 클래스 타입: byte[] , 미디어타입: */* ,
- 요청 예) @RequestBody byte[] data
- 클래스 타입: byte[] , 미디어타입: */* ,
- StringHttpMessageConverter : String 문자로 데이터를 처리한다.
- 클래스 타입: String , 미디어타입: */*
- 요청 예) @RequestBody String data
- 응답 예) @ResponseBody return "ok", 미디어타입 text/plain
- 클래스 타입: String , 미디어타입: */*
- MappingJackson2HttpMessageConverter : application/json 데이터를 처리한다.
- 클래스 타입: 객체 또는 HashMap , 미디어타입 application/json 관련
- 요청 예) @RequestBody HelloData data
- 응답 예) @ResponseBody return helloData, 미디어타입 application/json 관련
- 클래스 타입: 객체 또는 HashMap , 미디어타입 application/json 관련
💡 HTTP 요청, 응답 데이터 읽기/쓰기 과정
- 읽기
- HTTP 요청이 오고, 컨트롤러에서 @RequestBody, HttpEntity 파라미터를 사용한다.
- 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead()를 호출한다.
- 대상 클래스 타입을 지원하는가?
- HTTP 요청의 Content-Type 미디어 타입을 지원하는가?
- canRead() 조건을 만족하면 read()를 호출해서 객체 생성하고, 반환한다.
- 쓰기
- 컨트롤러에서 @ResponseBody, HttpEntity로 값이 반환된다.
- 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite()를 호출한다.
- 대상 클래스 타입을 지원하는가?
- HTTP 요청의 Accept 미디어 타입을 지원하는가. (더 정확히는 @RequestMapping 의 produces)
- canWrite() 조건을 만족하면 write()를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.
메시지 컨버터는 어디에?
그렇다면 HTTP 메시지 컨버터는 스프링 MVC 어디쯤에서 사용되는 것일까?
스프링 MVC의 구조를 보면 HTTP 요청부터 응답까지 여러 과정을 거치는데, 여기서 HTTP 메시지 컨버터는 어노테이션 기반의 컨트롤러, @RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter(요청 매핑 핸들러 어댑터)에 있다.
💡 동작 방식
어노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다.
HttpServletRequest, Model, @RequestParam, @ModelAttribute 같은 어노테이션 그리고 @RequestBody, HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 정말 많은 요청 파라미터를 처리하는데, 이렇게 파라미터를 유연하게 처리할 수 있는 이유는 ArgumentResolver 덕분이다.>
- 어노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdaptor는 ArgumentResolver를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터 값(객체)을 생성한다.
- 그리고 파라미터 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.
가능한 파라미터 목록은 공식 메뉴얼에서 확인할 수 있다.
ArgumentResolver
스프링은 30개가 넘는 ArgumentResolver(정확히는 HandlerMethodArgumentResolver)를 기본으로 제공한다.
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로 우선순위가 넘어간다.
ReturnValueHandler
ArgumentResolver와 비슷한데, ReturnValueHandler(정확히는 HandlerMethodReturnValueHandler)는 응답 값을 변환하고 처리한다.
스프링은 10여개가 넘는 ReturnValueHandler를 지원한다. (예 - ModelAndView, @ResponseBody, HttpEntity, String)
컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler 덕분이다.
가능한 응답 값 목록은 공식 메뉴얼에서 확인 할 수 있다.
그래서 HTTP 메시지 컨버터는 도대체 어디에 있는 걸까?
- ArgumentResolver와 ReturnValueHandler에서 HTTP 메세지 컨버터를 사용한다.
- 요청의 경우
- @RequestBody를 처리하는 ArgumentResolver가 있고, HttpEntity를 처리하는 ArgumentResolver가 있다.
- 이 ArgumentResolver들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성한다.
- 응답의 경우
- @ResponseBody와 HttpEntity를 처리하는 ReturnValueHandler가 있다.
- 이 ReturnValueHandler에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.
확장
스프링은 다음을 모두 인터페이스로 제공한다. 따라서 필요 시 언제든지 기능을 확장할 수 있다.
- HandlerMethodArgumentResolver
- HandlerMethodReturnValueHandler
- HttpMessageConverter
대부분은 스프링이 필요한 기능을 제공하기 때문에 실제 기능을 확장할 일이 많지는 않다.
만약 기능 확장을 하려면 WebMvcConfigurer 를 상속 받아서 스프링 빈으로 등록하면 된다. (실제 자주 사용하지는 않으니 실제 기능 확장이 필요할 때 WebMvcConfigurer를 검색해보자)
👉🏻 WebMvcConfigurer 확장
@Bean
public WebMvcConfigurer webMvcConfigurer() {
return new WebMvcConfigurer() {
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
//...
}
@Override
public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
//...
}
};
}
'🗺 RoadMap > Spring' 카테고리의 다른 글
| [MVC2] #4 로그인 (쿠키, 세션) (0) | 2022.05.02 |
|---|---|
| [MVC2] #1 타임리프(Thymeleaf) (1) | 2022.03.23 |
| [MVC1] #9 스프링 MVC 웹 페이지 만들기 (0) | 2022.03.22 |
| [MVC1] #8 로깅 (0) | 2022.03.18 |
| [MVC1] #6 스프링 MVC 구조 이해하기 (0) | 2022.03.17 |
| [MVC1] #5 MVC 프레임워크 만들기 (0) | 2022.03.16 |
| [MVC1] #4 서블릿, JSP, MVC 패턴으로 웹 애플리케이션 개발하기 (0) | 2022.03.15 |
| [MVC1] #3 서블릿 (0) | 2022.03.14 |
