스프링 부트 스타터로 이동해서 스프링 프로젝트 생성
프로젝트 선택
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
의존성 관리
주의!
- Packing는 War가 아니라 Jar 를 선택해주어야 합니다
- JSP를 사용하지 않기 때문에 Jar를 사용하는 것이 좋다고 합니다
- 앞으로 스프링 부트를 사용하면 이 방식을 주로 사용하게 됩니다
- Jar를 사용하면 항상 내장 서버(톰캣등)을 사용하고, webapp 경로도 사용하지 않는다고 합니다
- 내장 서버 사용에 최적화 되어 있는 기능입니다
- 최근에는 주로 이 방식을 사용합니다
- War를 사용하면 내장 서버도 사용가능 하지만, 주로 외부 서버에 배포하는 목적으로 사용합니다
스프링 부트에 Jar를 사용하면 /resources/static/index.html 위치에 index.html 파일을 두면 Welcome 페이지로 처리해줍니다
스프링 부트가 지원하는 정적 컨텐츠 위치에 /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>
v1</a></li>
<li><a href="/request-param-v1?username=hello&age=20">요청 파라미터 <li><a href="/request-param-v2?username=hello&age=20">요청 파라미터
v2</a></li>
v3</a></li>
v4</a></li>
<li><a href="/request-param-v3?username=hello&age=20">요청 파라미터
<li><a href="/request-param-v4?username=hello&age=20">요청 파라미터
<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">요청 파라미터 <li><a href="/model-attribute-v1?username=hello&age=20">요청 파라미터
MAP</a></li>
@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>
💡 참고
스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리 (spring-boot-starter-logging)가 함께 포함됩니다
스프링 부트 로깅 라이브러리는 기본으로 다음 로깅 라이브러리를 사용합니다
SLF4J = http://www.slf4j.org
Logback : http://logback.qos.ch
로깅을 사용하기위해 먼저 로깅 객체를 생성해야 한다고 합니다
// getClass()메서드를 통해 사용되는 클래스 타입 변환하여 삽입
private final Logger log = LoggerFactory.getLogger(getClass());
// 직접적으로 해당 클래스타입을 입력해주어도 된다.
private static final logger log = LoggerFactory.getLogger(Xxx.class);
@Slf4j
public class LogTestController {
...
}
log.info("hello")
➡️ 시스템 콘솔로 직접 출력하는 것보다 로그를 사용하면 다음과 같은 장점이 있습니다
package hello.springmvc.basic;
// ..
@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
// 문자 반환시 String이 반환된다.
}
}
@RestController
➡️ @Controller는 반환 값이 String이면 뷰 이름으로 인식하기에 뷰를 찾고 뷰가 렌더링됩니다
➡️ @RestController는 반환 값으로 뷰를 찾는게 아니라 HTTP 메세지 바디에 바로 입력합니다
(클래스 레벨이 아닌 메서드 레벨에서 @ResponseBody를 사용하면 @Controller를 사용하더라도 바로 HTTP 메세지 바디에 입력해서 반환을 해줍니다)
로그 출력 포맷
➡️ 시간, 로그 레벨, 프로세스 ID(PID), 쓰레드 명, 클래스 명, 로그 메세지
5개의 로그를 출력시도 하였지만, 실행결과에서는 3개가 나왔습니다
이유
원하는대로 로그 레벨을 설정할 수 있습니다
application.properties에서 레벨을 설정할 수 있습니다
# 전체 로그 레벨 설정(기본 info)
logging.level.root=info
# hello.springmvc 패키지와 그 하위 로그 레벨 설정
#logging.level.hello.springmvc=[변경을 원하는 로그 레벨]
logging.level.hello.springmvc=debug
log.debug("data"+data)
: 올바르지 않은 로그 사용
- 로그 출력 레벨을 info로 설정해도 해당 코드에 있는 "data="+data가 실제 실행이 되어 버립니다
- 문자 더하기 연산이 발생
- 리소스 낭비
log.debug("data={}", data)
: 올바른 로그 사용
참고
스프링 부트가 제공하는 로그 기능은 다음을 참고하자 : https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot- features.html#boot-features-logging
💡 참고
https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot- features.html#boot-features-logging
MappingController
package 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", "/hello-go"})
@RequestMapping("/hello-basic")
public String helloBasic() {
log.info("helloBasic");
return "ok";
}
...
}
둘다 허용
다음 두가지 요청은 다른 URL이지만, 스프링은 다음 URL 요청들을 같은 요청으로 매핑합니다
HTTP 메서드
- @RequestMapping 에 method 속성으로 HTTP 메서드를 지정하지 않으면 HTTP 메서드와 무관하게 호출됩니다
- 모두 허용 : GET, HEAD, POST, PUT, PATCH, DELETE
/**
* method 특정 HTTP 메서드 요청만 허용
* GET, HEAD, POST, PUT, PATCH, DELETE
*/
@RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET)
public String mappingGetV1() {
log.info("mappingGetV1");
return "ok";
}
/**
* 편리한 축약 애노테이션 (코드보기)
* @GetMapping
* @PostMapping
* @PutMapping
* @DeleteMapping
* @PatchMapping
*/
@GetMapping(value = "/mapping-get-v2")
public String mappingGetV2() {
log.info("mapping-get-v2");
return "ok";
}
/**
* PathValuer
* PathVariable 사용
* 변수명이 같으면 생략 가능
*
* @PathVariable("userId") String userId -> @PathVariable userId
* /mapping/userA
*/
@GetMapping
public String mappingPath(@PathVariable("userId") String data) {
log.info("mappingPath userId={}", data);
return "ok";
}
실행
/**
* 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";
}
실행
/**
* 특정 헤더로 추가 매핑
* 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";
}
/**
* 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";
}
consumes = "text/plain"
consumes = {"text/plain", "application/*"}
consumes = MediaType.TEXT_PLAIN_VALUE
/*
* 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";
}
produces = "text/plain"
produces = {"text/plain", "application/*"}
produces = MediaType.TEXT_PLAIN_VALUE
produces = "text/plain;charset=UTF-8"
회원 관리 API
회원 목록 조회 : GET /users
회원 등록 : POST /users
회원 조회 : GET /users/{userId}
회원 수정 : PATCH /users/{userId}
회원 삭제 : DELETE /users/{userId}
MappingClassController
package hello.springmvc.basic.requestmapping;
import org.springframework.web.bind.annotation.*;
@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;
}
/**
* DELETE /mapping/users/{userId}
*/
@DeleteMapping("/{userId}")
public String deleteUser(@PathVariable String userId) {
return "delete userId=" + userId;
}
}
package hello.springmvc.basic.request;
// ..
@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";
}
}
2022-01-13 17:39:19.887 INFO 3816 --- [ main] hello.springmvc.SpringmvcApplication : Started SpringmvcApplication in 4.118 seconds (JVM running for 4.766)
2022-01-13 17:39:32.888 INFO 3816 --- [nio-8080-exec-2] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring DispatcherServlet 'dispatcherServlet'
2022-01-13 17:39:32.889 INFO 3816 --- [nio-8080-exec-2] o.s.web.servlet.DispatcherServlet : Initializing Servlet 'dispatcherServlet'
2022-01-13 17:39:32.894 INFO 3816 --- [nio-8080-exec-2] o.s.web.servlet.DispatcherServlet : Completed initialization in 5 ms
2022-01-13 17:39:32.963 INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : request=org.apache.catalina.connector.RequestFacade@c63f133
2022-01-13 17:39:32.967 INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : response=org.apache.catalina.connector.ResponseFacade@784f4db
2022-01-13 17:39:32.967 INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : httpMethod=PATCH
2022-01-13 17:39:32.967 INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : locale=ko_KR
2022-01-13 17:39:32.967 INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : headerMap={user-agent=[PostmanRuntime/7.28.4], accept=[*/*], postman-token=[535fdef6-68a1-46d5-ae87-ac4e9567229f], host=[localhost:8080], accept-encoding=[gzip, deflate, br], connection=[keep-alive], content-length=[0]}
2022-01-13 17:39:32.967 INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : header host=localhost:8080
2022-01-13 17:39:32.967 INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController : myCookie=null
MultiValueMap
MultiValueMap<String, String> map = new LinkedMultiValueMap();
map.add("keyA", "value1");
map.add("keyA", "value2");
//[value1,value2]
List<String> values = map.get("keyA");
private static final org.slf4j.Logger log =
org.slf4j.LoggerFactory.getLogger(RequestHeaderController.class);
💡 참고
@Controller
사용 가능한 파라미터 목록 공식 메뉴얼 : https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann- arguments
사용 가능한 응답 값 목록 공식 메뉴얼 : https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann- return-types
ex)
http://localhost:8080/request-param?username=hello&age=20
ex)
POST /request-param ...
content-type: application/x-www-form-urlencoded
username=hello&age=20
// ..
@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");
}
}
GET 실행
POST Form 페이지 생성
테스트용 HTML Form
리소스는 resources/static 아래에 두면 스프링 부트가 자동으로 인식합니다
<!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>
💡 참고
Jar를 사용하면 webapp 경로를 사용할 수 없습니다
이제부터 정적 리소스도 클래스 경로에 함께 포함해야 합니다
스프링이 제공하는 @RequestParam을 사용하면 요청 파라미터를 매개변수 레벨에서 더 빠르게 바로 꺼내서 사용할 수 있습니다
RequestParamController.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의 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 애노테이션을 생략하면 스프링 MVC는 내부에서 required=false를 적용합니다
💡 참고
이렇게 애노테이션을 완전히 생략해도 되는데, 너무 없는 것도 약간 과하다는 주관적 생각이 있습니다
@RequestParam이 있으면 명확하게 요청 파라미터에서 데이터를 읽는다는 것을 알 수 있습니다
/**
* @RequestParam.required
* /request-param -> username이 없으므로 예외 *
* 주의!
* /request-param?username= -> 빈문자로 통과 *
* 주의!
* /request-param
* int age -> null을 int에 입력하는 것은 불가능, 따라서 Integer 변경해야 함(또는 다음에 나오는
defaultValue 사용) */
@ResponseBody
@RequestMapping("/request-param-required")
public String requestParamRequired(
@RequestParam(required = true) String username,
@RequestParam(required = false) Integer age){
// int a = null; // 오류
// Integer b = null; // null이 들어갈 수 있다.
log.info("username={}, age={}", username, age);
return "ok";
}
/**
* @RequestParam
* - defaultValue 사용 *
* 참고: defaultValue는 빈 문자의 경우에도 적용 * /request-param?username=
*/
@ResponseBody
@RequestMapping("/request-param-default")
public String requestParamDefault(
@RequestParam(required = true, defaultValue = "guest") String username,
@RequestParam(required = false, defaultValue = "-1") Integer age){
// int a = null; // 오류
// Integer b = null; // null이 들어갈 수 있다.
log.info("username={}, age={}", username, age);
return "ok";
}
/**
* @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])
@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());
log.info("helloData={}", helloData);
return "ok";
}
➡️ 요청 파라미터가 많아질수록 코드는 길어지고 오류의 확률이 높다.
package hello.springmvc.basic;
import lombok.Data;
@Data
public class HelloData {
private String username;
private int age;
}
/*
* @ModelAttribute 사용
* 참고: model.addAttribute(helloData) 코드도 함께 자동 적용됨, 뒤에 model을 설명할 때 자세히 설명
*/
@ResponseBody
@RequestMapping("/model-attribute-v1")
public String modelAttributeV1(@ModelAttribute HelloData helloData) {
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
log.info("helloData={}", helloData);
return "ok";
}
스프링 MVC는 @ModelAttribute가 있으면 다음을 실행합니다
class HelloData {
getUsername();
setUsername();
}
/**
* @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());
log.info("helloData={}", helloData);
return "ok";
}
💡 참고
argument resolver는 뒤에서 학습합니다
HTTP message body에 데이터를 직접 담아서 요청
- HTTP API에서 주로 사용, JSON, XML, TEXT
- 데이터 형식은 주로 JSON 사용
- POST, PUT, PATCH
요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 데이터가 넘어오는 경우는 (HTML Form 방식을 제외하고) @RequestParam, @ModelAttribute를 사용할 수 없습니다
@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");
}
}
Postman을 사용해서 테스트
Body → row, Text 선택
Input, Output 스트림, Reader - RequestBodyStringController.requestBodyStringV2
매개변수에서 바로 inputStream과 writer를 받을 수 있습니다
/**
* 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");
}
/**
* 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) throws IOException {
String messageBody = httpEntity.getBody();
log.info("messageBody={}", messageBody);
return new HttpEntity<>("ok");
}
HttpEntity: HTTP header, body 정보를 편리하게 조회할 수 있습니다
➡️ 메시지 바디 정보를 직접 조회
➡️ 요청 파라미터를 조회하는 기능과 관계가 없습니다 (@RequestParam X, @ModelAttribute X)
HttpEntity는 응답에서도 사용 가능
➡️ 메시지 바디 정보 직접 반환
➡️ 헤더 정보 포함 가능
➡️ View 조회 불가능
HttpEntity를 상속받은 다음 객체들도 같은 기능을 제공합니다
(1) RequestEntity
HttpMethod, url 정보가 추가, 요청에 사용
(2) ResponseEntity
HTTP 상태 코드 설정 가능, 응답에서 사용
return new ResponseEntity("Hello World", responseHeaders, HttpStatus.CREATED)
💡 참고
스프링MVC 내부에서 HTTP 메시지 바디를 읽어서 문자나 객체로 변환해서 전달해주는데, 이때 HTTP
메시지 컨버터( HttpMessageConverter )라는 기능을 사용합니다
- 이것은 조금 뒤에 HTTP 메시지 컨버터에서 자세히..
/**
* @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, @ModelAttibute와는 전혀 관계가 없다.
요청 파라미터 vs HTTP 메시지 바디
@ResponseBody
JSON
{
"username":"chang",
"age":20
}
Object
@Data
public class HelloData{
private String username;
private int age;
}
예전 방식의 HttpServletRequest, HttpServletResponse 객체에서 메세지 바디를 읽어와 ObjectMapper로 객체 바인딩을 하는 코드
package hello.springmvc.basic.request;
// ..
/**
* {"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");
}
}
Postman으로 테스트
처리해야할 기본 로직이 상당히 많으며 JSON을 받아서 사용해야할 컨트롤러가 많을수록 코드 중복이 많아질 수 밖에 없는 상황입니다
RequestBodyJsonController.requestBodyJsonV2 - @RequestBody 문자 변환
@RequestBody 애노테이션을 이용해 메시지 바디를 바로 받아서 사용하면 InputStream을 꺼내서 StreamUtils로 변환해줄 필요 없이 바로 ObjectMapper로 객체 변환할 수 있습니다
/**
* @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=P{}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}
문자로 변환하고 다시 json으로 변환하는 과정이 불편합니다@ModelAttribute처럼 한번에 객체로 변환할 수는 없을까?
RequestBodyJsonController.requestBodyJsonV3 - @RequestBody 객체 변환
/**
* @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
* HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (content-
type: application/json)
*
*/
@ResponseBody
@PostMapping("/request-body-json-v3")
public String requestBodyJsonV3(@RequestBody HelloData helloData){
log.info("username=P{}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}
@RequestBody 객체 파라미터
@RequestBody는 생략 불가능
스프링은 @ModelAttribute, @RequestParam 생략 시, 다음과 같은 규칙을 적용합니다
➡️ 따라서 이 경우 HelloData에 @RequestBody 를 생략하면 @ModelAttribute 가 적용되어버립니다
➡️ HelloData data → @ModelAttribute HelloData data
➡️ 따라서 생략하면 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 됩니다
⚠️ 주의
RequestBodyJsonController.requestBodyJsonV4 - HttpEntity
앞서 배운 것과 같이 HttpEntity를 사용해도 된다고 합니다
@ResponseBody
@PostMapping("/request-body-json-v4")
public String requestBodyJsonV4(HttpEntity<HelloData> httpEntity){
HelloData data = httpEntity.getBody();
log.info("username=P{}, age={}", data.getUsername(), data.getAge());
return "ok";
}
RequestBodyJsonController.requestBodyJsonV5
/**
* @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
* HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (content-
type: application/json)
*
* @ResponseBody 적용
* - 메시지 바디 정보 직접 반환(view 조회X)
* - HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter 적용
(Accept: application/json)
*/
@ResponseBody
@PostMapping("/request-body-json-v5")
public HelloData requestBodyJsonV5(@RequestBody HelloData data){
log.info("username=P{}, age={}", data.getUsername(), data.getAge());
return data;
}
@ResponseBody
➡️ 응답의 경우에도 @ResponseBody 를 사용하면 해당 객체를 HTTP 메시지 바디에 직접 넣어줄 수 있습니다
➡️ 물론 이 경우에도 HttpEntity 를 사용해도 된다고 합니다
➡️ V5가 애노테이션을 최대한 활용하였고, V1보다 훨씬 간결해진 코드가 완성됩니다
@RequestBody 요청
➡️ JSON 요청 → HTTP 메시지 컨버터 → 객체
@ResponseBody 응답
➡️ 객체 → HTTP 메시지 컨버터 → JSON 응답
웹 브라우저에 정적인 HTML, css, js을 제공할 때는, 정적 리소스를 사용합니다
2. 뷰 템플릿 사용
웹 브라우저에 동적인 HTML을 제공할 때는 뷰 템플릿을 사용합니다
3. HTTP 메시지 사용
HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보냅니다
src/main/resources/static일 때,
➡️ src/main/resources/static/basic/hello-form.html 경로에 파일이 들어 있으면
➡️ http://localhost:8080/basic/hello-form.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 - 뷰 템플릿을 호출하는 컨트롤러
위에서 작성한 hello라는 뷰를 호출하는 컨트롤러
// ..
@Controller
public class ResponseViewController {
@RequestMapping("/response-view-v1")
public ModelAndView responseViewV1(){
ModelAndView mav = new ModelAndView("response/hello").addObject("data", "hello!");
return mav;
}
// @ResponseBody를 사용후 String 반환시 문자가 그냥 반환된다.
@RequestMapping("/response-view-v2")
public String responseViewV2(Model model){
model.addAttribute("data", "hello2");
return "response/hello";
// ""이면서 string일시 view의 논리적 이름으로 반환된다.
}
@RequestMapping("/response/hello")
public void responseViewV3(Model model){
model.addAttribute("data", "hello3");
}
}
(1) ModelAndView를 반환하는 경우(responseViewV1)
➡️ 객체에서 View를 꺼내어 물리적인 뷰 이름으로 완성한 뒤 뷰를 찾아 렌더링(2) String을 반환하는 경우 - View or HTTP 메시지(responseViewV2)
➡️@ResponseBody
(혹은 클래스 레벨에서@RestController
)가 없으면response/hello
라는 문자가 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링
➡️@ResponseBody
(혹은 클래스 레벨에서@RestController
)가 있으면 뷰 리졸버를 실행하지 않고 HTTP 메시지 바디에 직접response/hello
라는 문자가 입력됩니다
➡️ 여기서는 뷰의 논리 이름인response/hello
를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는 것을 확인할 수 있습니다
- 실행 :
templates/response/hello.html
(3) Void를 반환하는 경우(responseViewV3)
➡️@Controller
를 사용하고,HttpServletResponse
,OutputStream(Writer)
같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용합니다
- 요청 URL:
/response/hello
- 실행:
templates/response/hello.html
➡️ 참고로 이 방식은 명시성이 너무 떨어지고 이렇게 딱 맞는 경우도 많이 없어서, 권장하지 않습니다
HTTP 메시지
@ResponseBody
, HttpEntity
를 사용하면, 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 응답 데이터를 출력할 수 있습니다
이미 프로젝트 생성시점에서 Thymeleaf 라이브러리를 추가해놓았습니다
build.gradle
`implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'`
스프링 부트가 자동으로 ThymeleafViewResolver 와 필요한 스프링 빈들을 등록합니다
스프링 설정을 통해 해당 뷰 리졸버에서 뷰 템플릿의 물리적 경로를 완성할 때 접두사나 접미사를 변경할 수도 있습니다
그리고 다음 설정도 사용합니다
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html
💡 참고
- 스프링 부트의 타임리프 관련 추가 설정은 다음 공식 사이트를 참고합니다 (페이지 안에서 thymeleaf 검색)
- https://docs.spring.io/spring-boot/docs/2.4.3/reference/html/appendix-application- properties.html#common-application-properties-templating
---
### 8. HTTP 응답 - HTTP API, 메시지 바디에 직접 입력
- HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 합니다
- HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보냅니다
- HTTP 요청에서 응답까지 대부분 다루었으므로 이번 시간에는 정리를 해보겠습니다
>💡 참고
- HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달됩니다
- 여기서 설명하는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 전달하는 경우를 말합니다
#### A. 소스
- ResponseBodyController
```java
package hello.springmvc.basic.response;
// ..
@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() throws IOException {
return new ResponseEntity<>("ok", HttpStatus.OK);
}
@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 응답 메세지를 전달합니다 → response.getWriter().write("ok")
responseBodyV2
➡️ ResponseEntity 엔티티는 HttpEntity 를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있습니다
➡️ ResponseEntity 는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다. → return new ResponseEntity<>(helloData, HttpStatus.OK);
responseBodyV3
➡️ @ResponseBody 를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있습니다
➡️ ResponseEntity 도 동일한 방식으로 동작합니다
responseBodyJsonV1
➡️ ResponseEntity 를 반환합니다
➡️ HTTP 메시지 컨버터를 통해서 JSON 형식으로 변환되어서 반환됩니다
(5) responseBodyJsonV2
➡️ ResponseEntity 는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody 를 사용하면 이런 것을 설정하기 까다롭습니다
➡️ @ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있습니다
➡️ 물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없습니다
➡️ 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity 를 사용하면 됩니다
@RestController
➡️ @Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody 가 적용되는 효과가 있습니다
➡️ 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력합니다
이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러입니다
➡️ 참고로 @ResponseBody 는 클래스 레벨에 두면 전체에 메서드에 적용되는데, @RestController 에노테이션 안에 @ResponseBody 가 적용되어 있습니다
HTTP 메시지 컨버터를 설명하기 전에 @ResponseBody의 사용 원리를 살펴보겠습니다
@ResponseBody를 사용
HTTP의 BODY에 문자 내용을 직접 반환
viewResolver 대신에 HttpMessageConverter 가 동작
기본 문자처리: StringHttpMessageConverter
기본 객체처리: MappingJackson2HttpMessageConverter
byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있습니다
💡 참고
응답의 경우 클라이언트의 HTTP Accept 해더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해서 HttpMessageConverter 가 선택된다. 더 자세한 내용은 스프링 MVC 강의에서 설명하겠습니다
스프링 MVC는 다음의 경우에 HTTP 메시지 컨버터를 적용합니다
HTTP 요청: @RequestBody , HttpEntity(RequestEntity)
HTTP 응답: @ResponseBody , HttpEntity(ResponseEntity)
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 응답 둘 다 사용됩니다
➡️ 요청 시 : json → 객체
➡️ 응답 시 : 객체 → JSON
0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter
중요한 메시지 컨버터
1. 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 관련
content-type: application/json
@RequestMapping
void hello(@RequetsBody String data) {}
content-type: application/json
@RequestMapping
void hello(@RequetsBody HelloData data) {}
content-type: text/html
@RequestMapping
void hello(@RequetsBody 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 응답 메시지 바디에 데이터를 생성합니다
그렇다면 HTTP 메시지 컨버터는 스프링 MVC 어디쯤에서 사용되는 것일까? 다음 그림에서 보이지 않는다.
SpringMVC 구조
RequestMappingHandlerAdapter 동작 방식
스프링 MVC의 구조를 보면 HTTP 요청부터 응답까지 여러 과정을 거쳐서 결과가 응답되는데, HTTP 메시지 컨버터는 어디서 사용되는 것일까?
모든 비밀은 애노테이션 기반의 컨트롤러, 그러니까 @RequestMapping 을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter (요청 매핑 헨들러 어뎁터)에 있습니다
RequestMappingHandlerAdapter 동작 방식
어떤 종류들이 있는지 살짝 코드로 확인만 해보겠습니다
💡 참고
(1) ArgumentResolver 인터페이스
정확히는 HandlerMethodArgumentResolver이지만 줄여서 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() 를 호출해서 해당 파라미터를 지원하는지 체크한다.
💡 참고
HTTP 메시지 컨버터 위치
HTTP 메시지 컨버터는 어디쯤 있을까?
HTTP 메시지 컨버터를 사용하는 @RequestBody 도 컨트롤러가 필요로 하는 파라미터의 값에 사용됩니다
➡️ 요청의 경우 : @RequestBody 를 처리하는 ArgumentResolver 가 있고, HttpEntity 를 처리하는 ArgumentResolver 가 있다. 이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것입니다
@ResponseBody 의 경우도 컨트롤러의 반환 값을 이용하므로 그 시점에서 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) {
//...
}
};
}