![[SpringMVC] 스프링 MVC - 기본 기능](https://img1.daumcdn.net/thumb/R750x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2FcydVp0%2Fbtq4CsLG28I%2FdHzQm1RFuH7KQ0cg1Hx481%2Fimg.png)
스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의
웹 애플리케이션을 개발할 때 필요한 모든 웹 기술을 기초부터 이해하고, 완성할 수 있습니다. 스프링 MVC의 핵심 원리와 구조를 이해하고, 더 깊이있는 백엔드 개발자로 성장할 수 있습니다., 원
www.inflearn.com
강의를 들으며 생각 정리
지금까지 스프링 MVC의 구조에 대해 자세히 알아봤다. 이제 스프링 MVC 실습을 위해 새 프로젝트를 만들고 기본적인 기능에 대해 알아보자.
프로젝트 생성
스프링 부트 스타터에서 스프링 프로젝트를 생성한다.
+) 이번에는 Packaging을 Jar를 사용한다. JSP를 사용하지 않기 때문에 Jar를 사용하는 것이 좋다. Jar를 사용하면 항상 내장 서버(톰캣 등)을 사용하고, webapp 경로도 사용하지 않는다. 즉, 내장 서버 사용에 최적화 되어 있는 기능이다. 최근에는 주로 이 방식을 사용한다.
War 역시 내장 서버 사용이 가능하지만, 주로 외부 서버에 배포하는 목적으로 사용한다.
+) 참고로 Jar를 사용하면 /resources/static/index.html 파일을 두면 Welcome Page로 처리해준다. (스프링 부트가 지원하는 정적 컨텐츠 위치이다.)
로깅 간단히 알아보기
앞으로 로그를 사용할 것이기 때문에, 로그에 대해서 간단히 알아보자. 관련 글을 참조한다.
로깅
개발을 하다 보면 로그를 출력해야 하는 경우들이 있다. 따라서 로그에 대해 간단히 짚고 넘어가자. 운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해서 필요한 정보를 출력하지 않
gksdudrb922.tistory.com
요청 매핑
@RequestMapping(value = "/hello-basic")
public String helloBasic() {
log.info("helloBasic");
return "ok";
}기본적인 요청 매핑(@RequestMapping)이다. /hello-basic URL 호출이 오면 이 메서드가 실행되도록 매핑한다.
+) 대부분의 속성을 배열로 제공하므로 다중 설정이 가능하다. -> {"/hello-baisc", "/hello-go"}
요청 매핑의 간단한 예제를 살펴보았는데 지금부터 요청 매핑이 제공하는 다양한 속성들에 대해 알아보자.
테스트는 대부분 Postman으로 진행한다.
<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";
}GET 방식 매핑이다. 만약 여기에 POST 요청을 하면 스프링 MVC는 405 상태코드를 반환한다.
+) 특히 @RestController에서 오류 발생 시 스프링이 상태 코드 등의 오류 내용을 HTTP 메시지 바디에 json 형식으로 넣어준다. (Accept 헤더에 따라 형식이 달라진다.)
<HTTP 메서드 매핑 축약>
/**
* 편리한 축약 애노테이션
* @GetMapping
* @PostMapping
* @PutMapping
* @DeleteMapping
* @PatchMapping
*/
@GetMapping(value = "/mapping-get-v2")
public String mappingGetV2() {
log.info("mapping-get-v2");
return "ok";
}메서드를 일일이 매핑하지 않고 @GetMapping을 통해 축약한 애노테이션을 사용하는 것이 더 직관적이다. @GetMapping도 결국 내부를 보면 @RequestMapping에 method를 지정해서 사용한다.
<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는 다음과 같이 리소스 경로에 식별자를 넣는 스타일을 선호한다.
ex) mapping/userA, /users/1
@PathVariable을 통해 URL 경로와 매칭되는 부분을 편리하게 조회할 수 있다.
@PathVariable("userId") String data -> @PathVariable String userId 처럼 이름과 파라미터 이름이 같으면 괄호 내용을 생략할 수 있다.
<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";
}
<특정 파라미터 조건 매핑>
/**
* 파라미터로 추가 매핑
* 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";
}HTTP 헤더를 통한 매핑이다. 해당 URL로 접근해도 헤더에 mode=debug가 포함되지 않았다면 매핑되지 않는다. 따라서 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 = MediaType.APPLICATION_JSON_VALUE)
public String mappingConsumes() {
log.info("mappingConsumes");
return "ok";
}HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑한다. 만약 맞지 않으면 415 상태코드를 반환한다.
+) Content-Type의 경우 header 속성을 사용하지 않고 이처럼 consumes를 사용한다.
-> MediaType.APPLICATION_JSON_VALUE은 "application/json"과 동일하다. 다만 전자의 표현이 더 직관적이기 때문에 보통 MediaType.APPLICATION_JSON_VALUE라고 명시한다.
<미디어 타입 조건 매핑 - HTTP 요청 Accept, produce>
/**
* Accept 헤더 기반 Media Type
* produces = "text/html"
* produces = "!text/html"
* produces = "text/*"
* produces = "*\/*"
*/
@PostMapping(value = "/mapping-produce", produces = MediaType.TEXT_HTML_VALUE)
public String mappingProduces() {
log.info("mappingProduces");
return "ok";
}HTTP 요청의 Accept 헤더를 기반으로 미디어 타입으로 매핑한다. 만약 맞지 않으면 406 상태코드를 반환한다.
요청 매핑 - API 예시
배운 요청 매핑 방식들을 기반으로 회원 관리를 HTTP API로 만든다 생각하고 매핑을 어떻게 하는지 알아보자. (실제 데이터가 넘어가는 부분은 생략하고 URL 매핑만 테스트)
</basic/requestmapping/MappingClassController.java>
@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {
/**
* 회원 목록 조회: GET /users
* 회원 등록: POST /users
* 회원 조회: GET /users/{userId}
* 회원 수정: PATCH /users/{userId}
* 회원 삭제: DELETE /users/{userId}
*/
@GetMapping
public String users() {
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;
}
}- @RequestMapping("/mapping/users") : 클래스 레벨에 매핑 정보를 두면 메서드 레벨에서 해당 정보를 조합해서 사용한다.
- 같은 URL에 대해서도 메서드를 달리 해서 다른 기능을 수행할 수 있다.
- 일반적으로 PathVariable을 포함한 리소스 경로로 데이터를 받는 방식을 많이 사용한다.
매핑 방법을 이해했으니, 이제부터 HTTP 요청이 보내는 데이터들을 스프링 MVC로 어떻게 조회하는지 알아보자.
HTTP 요청 - 기본, 헤더 조회
헤더 정보와 같은 HTTP 요청이 보내는 데이터들을 조회하는 방법을 알아보자.
스프링 컨트롤러는 필요한 요청 정보를 다양한 파라미터로 불러올 수 있다.
</basic/request/RequestHeaderController.java>
@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";
}
}<결과>
2021-05-10 22:33:03.378 INFO 23584 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : request=org.apache.catalina.connector.RequestFacade@2466322f
2021-05-10 22:33:03.383 INFO 23584 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : response=org.apache.catalina.connector.ResponseFacade@7390fbcc
2021-05-10 22:33:03.383 INFO 23584 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : httpMethod=GET
2021-05-10 22:33:03.384 INFO 23584 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : locale=ko_KR
2021-05-10 22:33:03.384 INFO 23584 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : headerMap={content-type=[application/json], user-agent=[PostmanRuntime/7.26.10], accept=[*/*], postman-token=[79093fd6-e49f-4894-9016-2e9d42447dc8], host=[localhost:8080], accept-encoding=[gzip, deflate, br], connection=[keep-alive], content-length=[16]}
2021-05-10 22:33:03.384 INFO 23584 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : header host=localhost:8080
2021-05-10 22:33:03.384 INFO 23584 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : myCookie=null
- 결과 분석(첫줄 부터)
1. HttpServletRequest
2. HttpServletResponse
3. HttpMethod : HTTP 메서드를 조회한다.
4. Locale : Locale 정보를 조회한다. 이 때, 가장 높은 우선순위 locale을 조회한다.
5. @RequestHeader MultiValueMap<String,String> headerMap: 모든 HTTP 헤더를 MultiValueMap 형식으로 조회한다.
6. @RequestHeader("host") String host : 특정 HTTP 헤더를 조회한다.
7. @CookieValue(value = "myCookie", required = false) String cookie: 특정 쿠키를 조회한다. (required : 필수 값 여부)
+) MultiValueMap : Map과 유사한데, 하나의 키에 여러 값을 받을 수 있다.
MultiValueMap<String, String> map = new LinkedMultiValueMap();
map.add("keyA", "value1");
map.add("keyA", "value2");
//[value1,value2]
List<String> values = map.get("keyA");
+) 참고 : @Controller의 사용 가능한 파라미터 목록은 다음 공식 매뉴얼에서 확인할 수 있다.
https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-annarguments
HTTP 요청 파라미터 - 쿼리 파라미터, HTML Form
서블릿에서 학습했던 HTTP 요청 데이터를 조회하는 방법을 다시 떠올려보자.
클라이언트에서 서버로 요청 데이터를 전달할 때는 주로 다음 3가지 방법을 사용한다.
GET - 쿼리 파라미터
메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
POST - HTML Form
content-type: application/x-www-form-urlencoded
메시지 바디에 쿼리 파라미터 형식으로 전달
HTTP message body에 데이터를 직접 담아서 요청
HTTP API에서 주로 사용하고 대부분 JSON을 사용한다.
하나씩 알아보면서 서블릿으로 학습했던 내용을 스프링이 얼마나 깔끔하고 효율적으로 바꾸어주는지 알아보자.
<요청 파라미터 - 쿼리 파라미터, HTML Form>
GET 쿼리 파라미터 전송 방식이든, POST HTML Form 전송 방식이든 둘 다 형식이 같으므로 구분 없이 조회할 수 있다.
ex) username=hello&age=20
이것을 간단히 요청 파라미터(request parameter) 조회라 한다. 지금부터 스프링으로 요청 파라미터를 조회하는 방법을 알아보자.
1. 쿼리 파라미터
</basic/request/RequestParamController.java>
@Slf4j
@Controller
public class RequestParamController {
@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");
}
}- request.getParameter : 서블릿 때와 마찬가지로 HttpServletRequest가 제공하는 방식으로 요청 파라미터를 조회한다.
테스트 : http://localhost:8080/request-param-v1?username=hello&age=20 (쿼리 파라미터)
2. HTML Form
<Post Form 페이지 생성>
리소스는 /resources/static 아래에 두면 스프링 부트가 자동으로 인식한다.
</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>테스트 : http://localhost:8080/basic/hello-form.html
HTTP 요청 파라미터 - @RequestParam
스프링이 제공하는 @RequestParam을 사용하면 요청 파라미터를 매우 편리하게 사용할 수 있다.
<v2>
@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 : String 반환시 View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력
-> @RequestParam("username") -> request.getParameter("username")
<v3>
@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")에서 name 생략 가능
<v4>
@ResponseBody
@RequestMapping("/request-param-v4")
public String requestParamV4(String username, int age) {
log.info("username={}, age={}", username, age);
return "ok";
}- 파라미터가 String, int, Integer 등의 단순 타입이면 @RequestParam도 생략 가능
+) 주의 : @RequestParam 애노테이션을 생략하면 스프링 MVC는 내부에서 required=false를 적용한다.
+) 참고 : 이렇게 애노테이션을 생략해도 되는데 약간 과하다는 생각이 있다. @RequestParam이 있으면 명확하게 요청 파라미터에서 데이터를 읽는다는 것을 알 수 있다.
<required>
@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 : 파라미터 필수 여부 -> 기본값은 파라미터 필수(true)이다.
+) 주의 : 파라미터 이름만 사용
/request-param-required?username=
파라미터 이름만 있고 값이 없는 경우 -> 빈 문자로 통과한다. -> "" (null이 아니다)
+) 주의 : 기본형(primitive)에 null 입력
/request-param-required?username="kim"
age의 required가 false이기 때문에 age는 생략 가능하고 이 때 age에는 null 값이 들어간다. 그런데 null을 int에 입력하는 것은 불가능하다.(500 예외 발생) 따라서 null을 받을 수 있는 Integer로 변경하거나, 또는 다음에 나오는 defaultValue를 사용한다.
<default>
@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";
}- 파라미터에 값이 없는 경우 defaultValue를 사용하면 기본 값을 적용할 수 있다. 이미 기본 값이 있기 때문에 required는 이제 의미가 없다.
defaultValue는 빈 문자의 경우에도 설정한 기본 값이 적용된다.
ex) /request-param-required?username=
<paramMap>
@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을 사용하자.
HTTP 요청 파라미터 - @ModelAttribute
실제 개발을 하면 요청 파라미터를 받아 객체의 형태로 관리하는 경우가 많다.
</basic/HelloData.java>
@Data
public class HelloData {
private String username;
private int age;
}+) 롬복 - @Data : @Getter , @Setter , @ToString , @EqualsAndHashCode , @RequiredArgsConstructor를 자동으로 적용해준다.
그런데 @RequestParam을 사용한다면 필요한 객체를 만들고 그 객체에 값을 넣어주어야 한다.
@RequestParam String username;
@RequestParam int age;
HelloData data = new HelloData();
data.setUsername(username);
data.setAge(age);스프링은 이 과정을 완전히 자동화해주는 @ModelAttribute 기능을 제공한다.
<v1>
@ResponseBody
@RequestMapping("/model-attribute-v1")
public String modelAttributeV1(@ModelAttribute HelloData helloData) {
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}이처럼 @ModleAttribute를 사용하면 HelloData 객체가 알아서 생성되고, 요청 파라미터 값도 모두 들어가 있다.
스프링 MVC는 @ModelAttribute가 있으면 다음을 실행한다.
1. HeeloData 객체를 생성한다.
2. 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩)한다.
ex) 파라미터 이름이 username이면 setUsername() 메서드를 찾아서 호출하면서 값을 입력한다.
+) 프로퍼티
객체에 getUsername(), setUsername() 메서드가 있으면, 이 객체는 username이라는 프로퍼티를 가지고 있다.
getXxx, setXxx -> 프로퍼티 : xxx
<v2>
@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
나머지 = @ModelAtttribute (argument resolver로 지정해둔 타입 외 : ex) HttpServletRequest)
지금까지 요청 파라미터(GET 쿼리 파라미터, POST HTML Form)에 대한 데이터 조회 방법을 알아보았다. 이제 HTTP message body를 통해 데이터가 직접 넘어오는 경우를 알아보자.
HTTP 요청 메시지 - 단순 텍스트
요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 넘어오는 경우는 @RequestParam, @ModelAttribute를 사용할 수 없다.
먼저 Postman을 통해 가장 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송하고, 읽어보자.
<v1>
@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");
}HTTP 메시지 바디의 데이터를 InputStream을 통해 직접 읽을 수 있다. -> request, response를 사용한다.
<v2>
@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, Writer를 지원한다.
<v3>
@PostMapping("/request-body-string-v3")
public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) throws IOException {
String messageBody = httpEntity.getBody();
log.info("messageBody={}", messageBody);
return new HttpEntity<>("ok");
}스프링 MVC는 HttpEntity를 지원한다.
- HttpEntity : HTTP header, body 정보를 편리하게 조회
-> 요청 파라미터를 조회하는 기능과는 관계가 없다.
-> 또한, HttpEntity는 응답에도 사용 가능하다. 헤더 정보와 메시지 바디 정보를 직접 반환할 수 있다.
+) HttpEntity를 상속받은 다음 객체들도 같은 기능에 추가적인 기능들을 제공한다.
- RequestEntity : HttpMethod 등 정보 추가
- ResponseEntity : HTTP 상태 코드 설정 가능 (ex. HttpStatus.CREATED)
<v4>
@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody) throws IOException {
log.info("messageBody={}", messageBody);
return "ok";
}- @RequestBody를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다.
- @ResponseBody를 사용하면 응답 결과를 HTTP 메시지 바디에 직접 담아서 전달할 수 있다.
-> 이 방식을 가장 많이 사용한다.
+) 요청 파라미터 vs HTTP 메시지 바디
요청 파라미터를 조회하는 기능 : @RequestParam, @ModelAttribute
HTTP 메시지 바디를 직접 조회하는 기능 : @RequestBody
HTTP 요청 메시지 - JSON
이번에는 HTTP API에서 주로 사용하는 JSON 데이터 형식을 조회해보자.
<v1>
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를 사용해서 HTTP 메시지 바디에서 데이터를 읽어와서 문자로 변환한다. (단순 텍스트 때와 같다.)
JSON은 여기에 추가로 objectMapper를 사용해서 자바 객체로 변환할 수 있다.
<v2>
@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를 사용해서 데이터를 꺼내고 objectMapper를 통해서 자바 객체로 변환한다.
<v3>
@ResponseBody
@PostMapping("/request-body-json-v3")
public String requestBodyJsonV3(@RequestBody HelloData helloData) {
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}v2에서 문자열인 messageBody를 다시 json 객체로 변환하는 과정이 불편했다.
그래서 @RequestBody HelloData helloData처럼 아얘 객체를 파라미터로 사용할 수 있다. HTTP 메시지 컨버터가 JSON을 자동으로 객체로 변환해준다.
즉, HelloData helloData = objectMapper.readValue(messageBody, HelloData.class) 이 코드를 수행해준다고 볼 수 있다.
+) @RequestBody는 생략 불가능하다.
스프링은 @ModelAttribute, @RequestParam 해당 생략시 다음과 같은 규칙을 적용한다.
- String, int, Integer같은 단순 타입 = @RequestParam
- 나머지 = @ModelAttribute
-> 따라서 이 경우 HelloData에 @RequestBody를 생략하면 @ModelAttribute가 적용되어 버린다. 결국 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.
직관적으로 의미를 보기 쉽게 @RequestParam, @ModelAttribute, @RequestBody 애노테이션을 붙여주는 것이 좋겠다.
<v4>
@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";
}단순 텍스트 때와 마찬가지로 HttpEntity 역시 사용 가능하다.
<v5>
@ResponseBody
@PostMapping("/request-body-json-v5")
public HelloData requestBodyJsonV5(@RequestBody HelloData data) {
log.info("username={}, age={}", data.getUsername(), data.getAge());
return data;
}@ResponseBody를 사용하면 객체를 HTTP 메시지 바디에 직접 넣어줄 수 있다. (반환 타입 확인)
1. @RequestBody 요청 : JSON 요청 -> HTTP 메시지 컨버터 -> 객체
2. @ResponseBody 응답 : 객체 -> HTTP 메시지 컨버터 -> JSON 응답
HTTP 응답 - 정적 리소스, 뷰 템플릿
이번엔 응답에 대해서 알아본다. 스프링(서버)에서 응답 데이터를 만드는 방법은 크게 3가지이다.
1. 정적 리소스 : 웹 브라우저에 정적인 HTML, css, js를 제공할 때
2. 뷰 템플릿 사용 : 웹 브라우저에 동적인 HTML을 제공할 때
3. HTTP 메시지 사용 : HTTP API를 제공하는 경우에 HTML이 아닌 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.
여기서는 정적 리소스와 뷰 템플릿에 대해 알아보자.
<정적 리소스>
스프링에서 src/main/resources는 리소스를 보관하는 곳이고, 클래스패스의 시작 경로이다. 스프링 부트는 클래스패스의 다음 디렉토리에 있는 경우 정적 리소스로 서비스를 제공한다.
-> /static, /public, /resources, /META-INF/resources
예를 들어, src/main/resources/static/basic/hello.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>스프링에서 보통 뷰 템플릿으로 타임리프를 사용한다. -> html 태그와 같이 타임리프를 선언한다.
p 태그의 text부분은 data에 값이 들어오면 "empty"부분을 data 값으로 대체하게 된다.
<뷰 템플릿을 호출하는 컨트롤러>
<v1>
@RequestMapping("/response-view-v1")
public ModelAndView responseViewV1() {
ModelAndView mav = new ModelAndView("response/hello")
.addObject("data", "hello!");
return mav;
}뷰의 논리 이름을 통해 ModelAndView 객체를 생성하고 모델에 "data" -> "hello!" 데이터를 저장하고 리턴한다.
스프링 부트가 자동으로 뷰 리졸버를 통해 뷰의 논리이름에 따라 src/main/resources/templates/response/hello.html 경로의 뷰 템플릿으로 이동한다.
<v2>
@RequestMapping("/response-view-v2")
public String responseViewV2(Model model) {
model.addAttribute("data","hello!");
return "response/hello";
}이렇게 모델을 파라미터로 사용함으로써 뷰의 논리 이름 자체를 String으로 반환할 수도 있다. @ResponseBody가 없기 때문에 response/hello로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링한다.
<v3>
@RequestMapping("/response/hello")
public void responseViewV3(Model model) {
model.addAttribute("data","hello!");
}void를 반환하는 경우이다. @Controller를 사용하고, HttpServletResponse, Writer같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용한다.
요청 URL : /response/hello
실행 : templates/response/hello.html
+) 참고 : 이 방식은 명시성이 너무 떨어지기 때문에 권장하지 않는다.
<Thymeleaf>
타임리프를 사용하기 위해서는 라이브러리를 추가해야 한다. 여기서는 사전에 프로젝트를 생성할 때 추가했었다.
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'라이브러리를 추가하게 되면 스프링 부트가 자동으로 뷰 리졸버와 필요한 스프링 빈들을 등록한다. 그리고 다음 설정도 사용한다.
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html이 설정은 기본 값이기 때문에 변경이 필요하다면 application.properties를 통해 수정하면 된다.
HTTP 응답 - HTTP API, 메시지 바디에 직접 입력
HTTP API를 제공하는 경우 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.
사실 HTTP 요청 메시지 부분에서 HTTP 요청에서 응답까지 대부분 다루었으므로 여기서는 정리를 해보자.
+) 참고 : HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달한다. 여기서 설명하는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 전달하는 경우를 말한다.
<String - v1>
@GetMapping("/response-body-string-v1")
public void responseBodyV1(HttpServletResponse response) throws IOException {
response.getWriter().write("ok");
}서블릿을 직접 다룰 때처럼 HttpServletResponse를 통해 HTTP 메시지 바디에 직접 응답 메시지를 전달한다.
<String - v2>
@GetMapping("/response-body-string-v2")
public ResponseEntity<String> responseBodyV2() throws IOException {
return new ResponseEntity<>("ok", HttpStatus.OK);
}HTTP 메시지의 헤더, 바디 정보를 가지고 있는 HttpEntity를 상속받은 ResponseEntity는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다. HTTP 컨버터를 통해서 HTTP 메시지로 자동 입력된다.
<String - v3>
@ResponseBody
@GetMapping("/response-body-string-v3")
public String responseBodyV3() throws IOException {
return "ok";
}@ResponseBody를 사용하면 view를 사용하지 않고, HTTP 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있다.
<Json - v1>
@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);
}ResponseEntity를 반환한다. HTTP 메시지 컨버터를 통해서 JSON 형식으로 변환되어서 반환된다.
<Json - v2>
@ResponseStatus(HttpStatus.OK)
@ResponseBody
@GetMapping("/response-body-json-v2")
public HelloData responseBodyJsonV2() {
HelloData helloData = new HelloData();
helloData.setUsername("userA");
helloData.setAge(20);
return helloData;
}@ResponseBody를 사용하면 객체만 반환해도 HTTP 컨버터가 JSON 형식으로 변환해 반환한다. 다만 ResponseEntity는 HTTP 응답 코드를 설정할 수 있는 반면, @ResponseBody는 그렇지 못하기 때문에 @ReponseStatus를 사용하면 응답 코드도 설정할 수 있다.
물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없는데 이런 경우 @RestController를 사용하면 된다.
+) @RestController
@Controller 대신에 @RestController를 사용하면 해당 컨트롤러에 모두 @ResponseBody가 적용되는 효과가 있다. 따라서 뷰 템플릿을 사용하는 것이 아닌, HTTP 메시지 바디에 직접 데이터를 입력한다. HTTP API(Rest API)를 만들 때 보통 사용하는 컨트롤러 이다.
@RestController도 결국 내부에 @Controller와 @ResponseBody를 포함하고 있는 형태이다.
-> 보통 API를 만들 때는 @RestController에 Json - v2 방식을 많이 사용한다.
HTTP 메시지 컨버터
HTTP API처럼 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 컨버터를 사용하면 편리하다.
스프링 MVC는 다음의 경우에 HTTP 메시지 컨버터를 적용한다.
- HTTP 요청 : @RequestBody, HttpEntity(RequestEntity)
- HTTP 응답 : @ResponseBody, HttpEntity(ResponseEntity)
HTTP 메시지 컨버터는 인터페이스이고 StringHttpMessageConverter, MappingJackson2HttpMessageConverter 등 각 상황마다 구현체를 다르게 사용한다.
public interface HttpMessageConverter<T> {
boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);
...
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() : 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능
<스프링 부트 기본 메시지 컨버터(일부)>
0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter스프링 부트는 클래스 타입과 미디어 타입 둘을 체크해서 적절한 메시지 컨버터의 사용여부를 결정한다. 만약 만족하지 않으면 다음 메시지 컨버터로 우선순위가 넘어간다.
0. ByteArrayHttpMessageConverter
클래스 타입: byte[] , 미디어타입: */*
1. StringHttpMessageConverter
클래스 타입: String , 미디어타입: */*
2. MappingJackson2HttpMessageConverter
클래스 타입: 객체 또는 HashMap , 미디어타입 application/json 관련
3가지 메시지 컨버터에 따라 요청 데이터의 경우로 예를 들어보자.
ex1)
content-type: application/json
@RequestMapping
void hello(@RequetsBody String data) {}1. HTTP 요청이 오고, 컨트롤러에서 @RequestBody 파라미터를 사용한다.
2. 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead()를 호출한다.
- 대상 클래스 타입을 지원하는가?
-> 클래스 타입이 String이기 때문에 0. byte[](X) -> 1. String(O) (OK)
- HTTP 요청의 Content-Type 미디어 타입을 지원하는가?
-> 1. 의 미디어타입은 */*이기 때문에 모든 타입 허용한다.
3. 결국 1. StringHttpMessageConverter을 만족하기 때문에 read()를 호출한다.
ex2)
content-type: application/json
@RequestMapping
void hello(@RequetsBody HelloData data) {}
ex1과 동일한 방식으로 HelloData는 byte[]도 String도 아니고 객체이기 때문에 2. 컨버터를 만족하고 content-type 역시 application/json으로 2. 의 미디어 타입을 만족하기 때문에 2. MappingJackson2HttpMessageConverter를 실행한다.
ex3)
content-type: text/html
@RequestMapping
void hello(@RequetsBody HelloData data) {}이런 경우는 클래스 타입은 HelloData로 2. 컨버터를 만족하지만 content-type이 application/json이 아니기 때문에 적절한 컨버터를 찾을 수 없다.
+) @ResponseBody가 있을 때, 응답 데이터의 경우 다음 과정을 따른다.
1. 컨트롤러에서 @ResponseBody로 값이 반환되는 상황이다.
2. 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite()를 호출한다.
- 대상 클래스 타입을 지원하는가?
- HTTP 요청의 Accept 미디어 타입을 지원하는가? (더 정확히는 @RequestMapping의 produces)
3. canWrite() 조건을 만족하면 write()를 호출한다.
요청 매핑 핸들러 어댑터 구조
그렇다면 HTTP 메시지 컨버터는 스프링 MVC 어디쯤에서 사용되는 것일까?
-> 바로 @RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter(요청 매핑 핸들러 어댑터)에 있다.
<RequestMappingHandlerAdapter 동작 방식>
HTTP 메시지 컨버터를 알기 전에 먼저 ArgumentResolver와 ReturnValueHandler에 대해 짚고 넘어 가자.
<ArgumentResolver>
애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있다.
-> HttpServletRequest, Model, @RequestParam, @ModelAttribute
그리고 @RequestBody, HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 갖고 있다.
이렇게 파라미터를 유연하게 처리할 수 있는 이유가 바로 ArgumentResolver 덕분이다.
RequestMappingHandlerAdapter는 ArgumentReslver를 호출해서 컨트롤러가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다. 그리고 이렇게 파라미터가 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.
<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()를 호출해서 실제 객체를 생성한다. 이렇게 생성된 객체가 컨트롤러 호출시 넘어간다.
-> 스프링은 30개가 넘는 ArgumentResolver 구현체를 기본으로 제공한다. (여러 파라미터를 제공하기 때문)
+) 원한다면 직접 이 인터페이스를 확장해서 원하는 ArgumentResolver를 만들 수도 있다.
<ReturnValueHandler>
ArgumentResolver와 비슷한데, 이것은 응답 값을 변환하고 처리한다. 컨트롤러에서 String으로 뷰 이름을 반환해도 동작하는 이유가 바로 ReturnValueHandler 덕분이다.
-> 스프링은 10개가 넘는 ReturnValueHandler을 지원한다. (ModelAndView, @ResponseBody, HttpEntity, String 등)
<HttpMessageConverter>
요청 - @RequestBody, HttpEntity(RequestEntity), 응답 - @ResponseBody, HttpEntity(ResponseEntity)의 경우,
ArgumentResolver와 ReturnValueHandler가 바로 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.
+) 확장
스프링은 다음을 모두 인터페이스로 제공한다. 따라서 필요하면 언제든지 기능을 확장할 수 있다.
HandlerMethodArgumentResolver
HandlerMethodReturnValueHandler
HttpMessageConverter
스프링이 필요한 대부분의 기능을 제공하기 때문에 실제 기능을 확장할 일이 많지는 않지만 만약 확장이 필요한 경우 WebMvcConfigurer를 상속 받아서 스프링 빈으로 등록하면 된다.
ex) 확장 예시
@Bean
public WebMvcConfigurer webMvcConfigurer() {
return new WebMvcConfigurer() {
@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver>
resolvers) {
//...
}
@Override
public void extendMessageConverters(List<HttpMessageConverter<?>>
converters) {
//...
}
};
}
'java > spring' 카테고리의 다른 글
| 타임리프(Thymeleaf) - 스프링 뷰 템플릿 (0) | 2021.05.12 |
|---|---|
| [SpringMVC] 스프링 MVC - 웹 페이지 만들기 (0) | 2021.05.12 |
| [Spring] 로깅 (0) | 2021.05.10 |
| [SpringMVC] 스프링 MVC - 구조 이해 (0) | 2021.04.26 |
| [SpringMVC] MVC 프레임워크 만들기 (0) | 2021.04.23 |