로깅 간단히 알아보기
- 운영 시스템에서 System.out.println() 같은 시스템 콘솔을 사용하지 않고, 별도의 로깅 라이브러리를 사용해서 로그를 출력
로깅 라이브러리
- 스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리(spring-boot-starter-logging)가 포함됨
- 스프링 부트 로깅 라이브러리는 기본으로 다음 로깅 라이브러리를 사용
- SLF4J : http://www.slf4j.org
- LobBack : http://logback.qos.ch
로그 라이브러리는 Lobback, Log4J, Log4J2 등등 수 많은 라이브러리가 존재하지만, 그것을 통합해서 인터페이스로 제공하는 것이 SLF4J 라이브러리
SLF4J는 인터페이스이고, 그 구현체로는 Lobback 같은 로그 라이브러리를 선택하면 됨
스프링 부트가 기본으로 제공화는 Logback을 사용하자
로그 선언
private Logger log = LoggerFactory.getLogger(getClass());
private final Logger log = LoggerFactory.getLogger(LogTestController.class);- 둘 중 하나 사용
- @Slf4j 사용
로그 호출
log.info(" info log={}", name);- 실무에서 시스템 콘솔로 직접 출력하는 것 보다는 로그를 사용
@RestController
public class LogTestController {
private final Logger log = LoggerFactory.getLogger(LogTestController.class);
@RequestMapping("/log-test")
public String logTest() {
String name = "Spring";
System.out.println("name = " + name);
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);
return "ok";
}
}
매핑 정보
- @RestController
- @Controller 는 반환 값이 String이면 뷰 이름으로 인식됨, 뷰를 찾고 뷰 랜더링
- @RestController 는 반환 값으로 뷰를 찾는 것이 아닌, HTTP 메시지 바디에 바로 입력됨
실행 결과로 ok 메시지를 받을 수 있음, @ResponseBody와 관련됨
테스트
- 로그가 출력되는 포멧 확인
- 시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스 명, 로그 메시지
- 로그 레벨 설정을 변경해서 출력 결과
- LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
- 개발 서버는 debug 출력
- 운영 서버는 info 출력
- @Slf4j 로 변경
로그 레벨 설정
#전체 로그 레벨 설정(기본 info)
logging.level.root=info
#hello.springmvc 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=trace
올바른 로그 사용법
- log.debug("data="+data)
- 로그 출력 레벨을 info로 설정해도 해당 코드에 있는 "data="+data가 실제 실행됨
- 결과적으로 문자 더하기 연산이 발생 (실제로 사용하지 않기 떄문에 쓸데없는 리소스 낭비)
- log.debug("data={}, data)
- 로그 출력 레벨을 info로 설정하면 아무일도 발생하지 않음
- 앞과 같은 의미없는 연산 발생 X
로그 사용시 장점
- 쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양 조정 가능
- 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력, 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절 가능
- 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있음
- 특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할 가능
- 성능도 일반 System.out 보다 좋음. (내부 버퍼링, 멀티 쓰레드 등등) 그래서 실무에서 꼭 로그 사용
요청 매핑
매핑 정보 (앞에서 다룬 내용)
- RestController
- @Controller 는 반환 값이 String 이면 뷰 이름으로 인식됨. 뷰를 찾고 뷰가 랜더링됨
- @RestController는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력
실행 결과로 ok 메시지를 받을 수 있음 @ResponseBody와 관련
- @RequestMapping("/hello-basic")
- /hello-basic URL 호출이 오면 이 메서드가 실행되도록 매핑
- 대부분의 속성은 배열로 제공하므로 다중 설정 가능
HTTP 메서드
- @RequestMapping에 method 속성으로 HTTP 메서드를 지정하지 않으면 HTTP 메서드와 무관하게 호출됨
모두 허용 GET, HEAD, POST, PUT, PATCH, DELETE
HTTP 메서드 매핑
@RequestMapping(value = "/hello-basic", method = RequestMethod.GET)
public String mappingGetV1() {
log.info("mapping-get-v1");
return "ok";
}메서드가 GET이기 때문에 POST 요청을 하면 스프링 MVC는 HTTP 405 상태코드(Method Not Allowed) 반환
HTTP 메서드 매핑 축약
@GetMapping("/mapping-get-v2")
public String mappingGetV2() {
log.info("mapping-get-v2");
return "ok";
}HTTP 메서드를 축약한 애노테이션을 사용하는 것이 더 직관적
코드를 보면 내부에 @RequesetMapping과 method를 지정해서 사용함
PathVariable(경로 변수) 사용
@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable("userId") String data) {
log.info("mappingPath userId={}", data);
return "ok";
}
http://localhost:8080/mapping/userA
- @RequestMapping은 URL 경로를 템플릿화 할 수 있음
- @PathVariable을 사용하면 매칭 되는 부분을 편하게 조회 가능
- @PathVariable의 이름과 파라미터 이름이 같으면 생략 가능
@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable String userId) {
log.info("mappingPath userId={}", userId);
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";
}http://localhost:8080/mapping/users/userA/orders/100
특정 파라미터 조건 매핑
@GetMapping(value = "/mapping-param", params = "mode=debug")
public String mappingParam() {
log.info("mappingParam");
return "ok";
}http://localhost:8080/mapping-param?mode=debug
특정 헤더 조건 매핑
@GetMapping(value = "/mapping-header", headers = "mode=debug")
public String mappingHeader() {
log.info("mappingHeader");
return "ok";
}http://localhost:8080/mapping-header
파라미터 매핑과 비슷하지만, HTTP 헤더를 사용
미디어 타입 조건 매핑 = HTTP 요청 Content-Type, consume
@PostMapping(value = "/mapping-consume", consumes = "application/json")
public String mappingConsumes() {
log.info("mappingConsumes");
return "ok";
}
@PostMapping(value = "/mapping-consume", consumes = MediaType.APPLICATION_JSON_VALUE)
public String mappingConsumes() {
log.info("mappingConsumes");
return "ok";
}http://localhost:8080/mapping-consume
HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑
만약 맞지 않으면 HTTP 415 상태코드(Unsupported Media Type)을 반환
미디어 타입 조건 매핑 - HTTP 요청 Accept, produce
@PostMapping(value = "/mapping-produce", produces = "text/html")
public String mappingProduces() {
log.info("mappingProduces");
return "ok";
}
@PostMapping(value = "/mapping-produce", produces = MediaType.TEXT_HTML_VALUE)
public String mappingProduces() {
log.info("mappingProduces");
return "ok";
}http://localhost:8080/mapping-produce
HTTP 요청의 Accept 헤더를 기반으로 미디어 타입으로 매핑
만약 맞지 않으면 HTTP 406 상태코드(Not Acceptable)을 반환
요청 매칭 - API 예시
회원 관리를 HTTP API로 만든다고 생각하고 매핑을 어떻게 할까?
회원관리 API
- 회원 목록: GET /users
- 회원 등록: POST /users
- 회원 조회: GET /users/{userId}
- 회원 수정: PATCH /users/{userId}
- 회원 삭제: DELETE /users/{userId}
@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {
@GetMapping()
public String user() {
return "get users";
}
@PostMapping()
public String addUser() {
return "post user";
}
@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") : 클래스 레벨에 매핑 정보를 두면 메서드 레벨에서 해당 정보를 조합해서 사용
HTTP 요청 - 기본, 헤더 조회
애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원
HTTP 헤더 정보를 조회하는 방법은?
@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";
}
}- HttpServletRequest
- HttpServletResponse
- HttpMethod: HTTP 메서드를 조회
- Locale: Locale 정보를 조회
- @RequestHeader MultiValueMap<String, String> headerMap
- 모든 HTTP 헤더를 MultiValueMap 형식으로 조회
- @RequestHeader("host") String host
- 특정 HTTP 헤더를 조회
- 속성
- 필수 값 여부: required
- 기본 값 속성: defaultValue
- @CookieValue(value="myCookie", required=false) String cookie
- 특정 쿠키를 조회
- 속성
- 필수 값 여부: required
- 기본 값: defaultValue
MultiValueMap
- Map 과 유사한데, 하나의 키에 여러 값을 받을 수 있음
- HTTP header, HTTP 쿼리 파라미터 같이 하나의 키에 여러 값을 받을 때 사용
- keyA=value1&key=value2
MultiValueMap<String, String> map = new LinkedMultiValueMap<>();
map.add("keyA", "value1");
map.add("keyA", "value2");
List<String> values = map.get("keyA");
HTTP 요청 파라미터 - 쿼리 파라미터, HTML Form
HTTP 요청 데이터 조회 - 개요
HTTP 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달하는 방법은?
클라이언트에서 서버로 요청 데이터를 전달할 때는 주로 3가지 방법 사용
- GET: 쿼리 파라미터
- /url?username=hello&age=20
- 메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
ex) 검색, 필터, 페이징 등에서 많이 사용하는 방식
- POST: HTML Form
- content-type: application/x-www-form-urlencoded
- 메시지 바디에 쿼리 파라미터 형식으로 전달 username=hello&age=20
ex) 회원 가입, 상품 주문, HTML Form 사용
- HTTP message body 에 데이터를 직접 담아서 요청
- HTTP API에서 주로 사용, JSON, XML, TEXT
- 데이터 형식으로 주로 JSON 사용
- POST, PUT, PATCH
요청 파라미터 - 쿼리 파라미터, HTML Form
HttpServeltRequest의 request.getParameter()를 사용하면 2가지 요청 파라미터를 조회 가능
1. GET, 쿼리 파라미터 전송
http://localhost:8080/request-param?username=hello&age=20
2. POST, HTML Form 전송
POST/request-param...
content-type: application/x-www-form-urlencoded
username=hello&age=20
- GET 쿼리 파라미터 전송 방식이든, POST HTML Form 전송 방식이든 둘다 형식이 같으므로 구분 없이 조회 가능
- 요청 파라미터 (request parameter) 조회
@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 요청 파라미터 - @RequestParam
스프링이 제공하는 @RequestParam을 사용하면 요청 파라미터를 매우 편리하게 사용 가능
@ResponseBody
@RequestMapping("/request-param-v2")
public String requestParamV2(
@RequestParam("username") String memberName,
@RequestParam("age") int memberAge) {
log.info("username={}, age={}", memberName, memberAge);
return "ok";
}- @RequestParam: 파라미터 이름으로 바인딩
- @ResponseBody: View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력
@RequestParam의 name(value) 속성이 파라미터 이름으로 사용
- @RequestParam("username") String memberName
-> request.getParameter("username")
@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="username") 생략 가능
@ResponseBody
@RequestMapping("/request-param-v4")
public String requestParamV4(String username, int age) {
log.info("username={}, age={}", username, age);
return "ok";
}HTTP 파라미터 이름이 변수 이름과 같고, String, int, Integer 등의 단순 타입이면 @RequestParam 도 생략 가능
※ 참고: 애노테이션을 완전히 생략해도 되지만, @RequestParam이 있으면 명확히 요청 파라미터에서 데이터를 읽는 다는 것을 알 수 있음
@ResponseBody
@RequestMapping("/request-param-required")
public String requestParamRequired(
@RequestParam(required = true) String username,
@RequestParam(required = false) Integer age) {
// required=false 이고, 실제로 값이 입력되지 않으면 null 값이 들어가는데
// int 에는 null 이 들어갈 수 없기 때문에 Integer 로 바꿔줌
log.info("username={}, age={}", username, age);
return "ok";
}- @RequestParam.required
- 파라미터 필수 여부
- 기본값이 파라미터 필수(true)
- /request-param 요청
- username이 없으면 400 예외가 발생
※ 주의! - 파라미터 이름만 사용한 경우
- /request-param?username=
- 파라미터 이름만 있고 값이 없는 경우 -> 빈문자로 통과
※ 주의! - 기본형(primitive)에 null 입력
- /request-param 요청
- @RequestParam(required=false) int age
null은 int에 입력하는 것은 불가능(500 예외 발생)
null을 받을 수 있는 Integer로 변경 또는 defaultValue 사용
@ResponseBody
@RequestMapping("/request-param-default")
public String requestParamDefault(
@RequestParam(defaultValue = "guest") String username,
@RequestParam(defaultValue = "-1") int age) {
// defaulValue가 있으므로 required 필요X
log.info("username={}, age={}", username, age);
return "ok";
}
- 파라미터에 값이 없는 경우 defaultValue를 사용하면 기본 값 적용 가능
- 이미 기본 값이 있기 때문에 required 의미 없음
- default value는 빈 문자의 경우에도 설정한 기본 값이 적용됨
- /request-param?username=
@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으로 조회 가능
- @RequestParam Map
- Map(key=value)
- @RequestParam MultiValueMap
- MultiValueMap(key=[value1, value2, ...]
ex) (key=userIds, value=[id1, id2])
- 파라미터의 값이 1개가 확실하다면 Map을 사용해도 좋지만 그렇지 않다면 MultiValueMap을 사용
HTTP 요청 파라미터 - @ModelAttribute
요청 파라미터를 받아서 필요한 객체를 만들고 그 객체에 값을 넣어줌
@RequestParam String username;
@RequestParam int age;
HelloData data = new HelloData();
data.setUsername(username);
data.setAge(age);스프링은 이 과정을 완전 자동화해주는 @ModelAttribute 기능을 제공
@Data
public class HelloData {
private String username;
private int age;
}@ResponseBody
@RequestMapping("/model-attribute-v1")
public String modelAttribute1(@ModelAttribute HelloData helloData) {
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}HelloData 객체가 생성되고, 요청 파라미터의 값도 모두 들어감
스프링 MVC는 @ModelAttribute가 있으면
1. HelloData 객체를 생성
2. 요청 파라미터 이름으로 HelloData 객체의 프로퍼티를 찾음
3. 해당 프러퍼티의 setter를 호출해서 파라미터 값을 입력(바인딩)
ex) 파라미터 이름이 username 이면 setUsername() 메서드를 찾아서 호출 후 값 입력
프로퍼티
객체에 getUsername9), setUsername() 메서드가 있으면, 이 객체는 username이라는 프로퍼티를 갖음
username 프로퍼티의 값을 변경하면 setUsername()이 호출되고, 조회하면 getUsername()이 호출됨
바인딩 오류
age=abc 처럼 숫자가 들어가야 할 곳에 문자를 넣으면 BindException 이 발생
이러한 바인딩 오류를 처리하는 방법은 검증 부분에서 다룸
@ResponseBody
@RequestMapping("/model-attribute-v2")
public String modelAttribute2(HelloData helloData) {
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}- @ModelAttribute는 생략 가능
- @RequestParam도 생략 가능하므로 혼란 발생 가능
스프링은 해당 생략시 다음과 같은 규칙 적용
- String, int, Integer 같은 단순 타입 = @RequestParam
- 나머지 = @ModelAttribute (argument resolver로 지정해둔 타입 외)
HTTP 요청 메시지 - 단순 텍스트
HTTP message body에 데이터를 직접 담아서 요청
- HTTP API에 주로 사용, JSON, XML, TEXT
- 데이터 형식으로 주로 JSON 사용
- POST, PUT, PATCH
요청 파라미터와 다르게 HTTP 메시지 바디를 통해 직접 데이터가 넘어오는 경우는 @RequestParam, @ModelAttribute를 사용할 수 없음 (물론 HTML Form 형식으로 전달되는 경우는 요청 파라미터로 인정됨)
- 가장 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송 가능
- HTTP 메시지 바디의 데이터를 InputStream을 사용해서 직접 읽을 수 있음
@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");
}
@PostMapping("/request-body-string-v2")
public void requestBodyStringV2(InputStream inputStream, Writer responseWriter) throws IOException {
String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
log.info("messageBody={}", messageBody);
responseWriter.write("ok");
}스프링 MVC는 다음 파라미터를 지원
- InputStream(Reader): HTTP 요청 메시지 바디의 내용을 직접 조회
- OutputStream(Writer): HTTP 요청 메시지 바디에 직접 결과를 출력
@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: HTTP header, body 정보를 편하게 조회
- 메시지 바디의 정보를 직접 조회
- 요청 파라미터를 조회하는 기능과는 관계 X, (@RequestParam X, @ModelAttribute X)
- HttpEntity는 응답에도 사용 가능
- 메시지 바디 정보 직접 반환
- 헤더 정보 포함 가능
- view 조회 X
HttpEntity를 상속받은 다음 객체들도 같은 기능 제공
- RequestEntity
- HttpMethod, url 정보가 추가, 요청에서 사용
- ReseponseEntity
- HTTP 상태 코드 설정 가능, 응답에서 사용
- return new ResponseEntity<String>("Hello World", responseHeaders, HttpStatus.CREATED)
※ 참고: 스프링 MVC 내부에서 HTTP 메시지 바디를 읽어서 문자나 객체로 변환해서 전달해주는데, 이때 HTTP 메시지 컨버터(HttpMessageConverter) 라는 기능을 사용
@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody) throws IOException {
log.info("messageBody={}", messageBody);
return "ok";
}@RequestBody
- @RequestBody를 사용하면 HTTP 메시지 바디 정보를 편하게 조회 가능
- 참고로 헤더 정보가 필요하다면 HttpEntity를 사용하거나, @RequestHeader를 사용
- 이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam, @ModelAttribute와 전혀 관계X
요청 파라미터 vs HTTP 메시지 바디
- 요청 파라미터를 조회하는 기능: @RequestParam, @ModelAttribute
- HTTP 메시지 바디를 직접 조회하는 기능: @RequestBody
@ResponseBody
- @ResponseBody를 사용하면 응답 결과를 HTTP 메시지 바디에 직접 담아서 전달 가능
- 물론 이 경우에도 view 사용 X
HTTP 요청 메시지 - JSON
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 데이터를 Jackson 라이브러리인 objectMapper를 사용해서 자바 객체로 변환
private ObjectMapper objectMapper = new ObjectMapper();
@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 메시지에서 데이터를 꺼내고 messageBody에 저장
- 문자로 된 JSON 데이터인 messageBody를 objectMapper를 통해서 자바 객체로 변환
문자로 변환하고 다시 json으로 변환하는 과정 불편, @ModelAttribute 처럼 한번에 객체로 변환 가능?
@ResponseBody
@PostMapping("/request-body-json-v3")
public String requestBodyJsonV3(@RequestBody HelloData helloData) throws IOException {
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}@RequestBody 파라미터
- @ReuqestBody HelloData helloData
- @RequestBody 에 직접 만든 객체를 지정 가능
- HttpEntity, @RequestBody를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환
- HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환
@RequestBody는 생략 불가능
- 스프링은 @ModelAttribute, @RequestParam 생략시 다음 규칙 적용
- String, int, Integer 같은 단순 타입 = @RequestParam
- 나머지 = @ModelAttribute (argument resolver로 지정해둔 타입 외)
따라서 이 경우 HelloData에 @RequestBody를 생략하면 @ModelAttribute가 적용됨
HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 됨
※ 주의: HTTP 요청시에 content-type이 application/json인지 꼭 확인해야 함.
그래야 JSON을 처리할 수 있는 HTTP 메시지 컨버터가 실행됨
@ResponseBody
@PostMapping("/request-body-json-v4")
public String requestBodyJsonV4(HttpEntity<HelloData> httpEntity) throws IOException {
HelloData helloData = httpEntity.getBody();
log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
return "ok";
}HttpEntity 사용 가능
@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
응답의 경우에도 @ResponseBody를 사용하면 해당 객체를 HTTP 메시지 바디에 직접 넣기 가능
- @RequestBody 요청
- JSON 요청 -> HTTP 메시지 컨버터 -> 객체
- @ResponseBody 응답
- 객체 -> HTTP 메시지 컨버터 -> JSON 응답
HTTP 응답 - 정적 리소스 , 뷰 템플릿
스프링(서버)에서 응답 데이터를 만드는 방법은 3가지
1. 정적 리소스
ex) 웹 브라우저에 정적인 HTML, CSS, JS를 제공할 때는 정적 리소스를 사용
2. 뷰 템플릿 사용
ex) 웹 브라우저에 동적인 HTML을 제공할 때는 뷰 템플릿을 사용
3. 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
뷰 템플릿 생성
src/main/resources/templates/response/hello.html
@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");
//mapping url 의 값과 이동할 주소의 값이 같으면
//return 하지 않아도 해당 주소로 이동 (권장 X)
}
}String을 반환하는 경우 - View or HTTP 메시지
- @ResponseBody가 없으면 response/hello 로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링
- @ResponseBody가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 /response/hello라는 문자가 입력됨
여기서는 뷰의 논리 이름인 response/hello를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는 것 확인 가능
- 실행: templates/response/hello.html
Void를 반환하는 경우 (권장 X)
- @Controller를 사용하고, HttpServletResponse, OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용
- 요청 URL: /response/hello
- 실행: templates/response/hello.html
- 참고로 이 방식은 명시성이 너무 떨어지고 맞는 경우도 많이 없어서, 권장X
Thymeleaf 스프링 부트 설정
build.gradle에
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf스프링 부트가 자동으로 ThymeleafViewResolver와 필요한 스프링 빈들을 등록
해당 설정은 기본 값, 변경이 필요할 때만 설정
application.properties에
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html
HTTP 응답 - HTTP API, 메시지 바디에 직접 입력
HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이러를 실어 보냄
※ 참고
HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달됨
앞으로의 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 전달하는 경우를 말함
@Slf4j
@Controller
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";
}
/**
* JSON 처리
*/
@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) //ResponseEntity 에서 상태코드 지정 가능했던 것을 대체
@ResponseBody
@GetMapping("/response-body-json-v2")
public HelloData responseBodyJsonV2() {
HelloData helloData = new HelloData();
helloData.setUsername("userA");
helloData.setAge(20);
return helloData;
}
}responseBodyV1
- 서블릿을 직접 다둘 때 처럼
- HttpServletResponse 객체를 통해서 HTTP 메시지 바디에 직접 응답 메시지 전달
response.getWriter.write("ok")
responseBodyV2
- ResponseEntity 엔티티는 HttpEntity를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있음
- ResponseEntity는 여기에 더해 HTTP 상태 코드 설정 가능
responseBodyV3
- @ResponseBody를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력 가능
- ResponseEntity도 동일한 방식으로 동작
responseBodyJsonV1
- ResponseEntity를 반환 HTTP 메시지 컨버터를 통해서 JSON 형식으로 변환되서 반환
responseBodyJsonV2
- ResponseEntity는 HTTP 응답 코드를 설정 가능, @ResponseBody를 사용하면 설정 까다로움
- @ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정 가능
- 물론 애노테이션이기 때문에 응답 코드를 동적으로 변경 불가, 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity를 사용하면 됨
@RestController
- @Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두@ResponseBody가 적용되는 효과가 있음 (@RestController = @Controller + @ResponseBody + ...)
- 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력
- 이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러
HTTP 메시지 컨버터
뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아니라, HTTP API처럼 JSON 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용하면 편함
@ResponseBody를 사용
- HTTP의 BODY에 문자 내용을 직접 반환
- viewResolver 대신에 HttpMessageConverter가 동작
- 기본 문자처리: StringHttpMessageConverter
- 기본 객체처리: MappingJackson2HttpMessageConverter
- byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음
※ 참고: 응답의 경우 클라이언트의 HTTP Accept 해더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해서 HttpMessageConverter가 선택됨
스프링 MVC는 다음의 경우에 HTTP 메시지 컨버터를 적용
- HTTP 요청: @RequestBody, HttpEntity(RequestEntity)
- HTTP 응답: @ResponseBody, HttpEntity(ResponseEntity)
스프링 부트 기본 메시지 컨버터
0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter
스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 둘을 체크해서 사용여부를 결정
만약 만족하지 않으면 다음 메시지 컨버터로 우선순위 넘어감
- ByteArrayHttpMessageConverter: byte[] 데이터를 처리
- 클래스 타입: byte[], 미디어 타입: */*
ex) 요청: @RequestBody byte[] data
ex) 응답: @ResponseBody return byte[] 쓰기 미디어타입 application/octet-stream
- StringHttpMessageConverter: String 문자로 데이터를 처리
- 클래스 타입: String, 미디어타입: */*
ex) 요청: @RequestBody String data
ex) 응답: @ResponseBody return "ok" 쓰기 미디어타입 text/plain
- MappingJackson2HttpMessageConverter: application/json 관련
- 클래스 타입: 객체 또는 HashMap, 미디어타입: application/json 관련
ex) 요청: @RequestBody HelloData data
ex) 응답: @ResponseBody return helloData 쓰기 미디어타입: application/json 관련
StringHttpMessageConverter
content-type: application/json
@RequestMapping
void hello(@RequetsBody String data) {}MappingJeckson2HttpMessageConverter
content-type: application/json
@RequestMapping
void hello(@RequetsBody HelloData data) {}
HTTP 요청 데이터 읽기
- HTTP 요청이 오고, 컨트롤러에서 @RequesteBody, HttpEntity 파라미터를 사용
- 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead()를 호출
- 대상 클래스 타입을 지원하는가?
ex) @RequestBody의 대상 클래스 (byte[], String, HelloData)
- HTTP 요청의 Content-Type 미디어 타입을 지원하는가?
ex) text/plain, application/json, */*
- canRead() 조건을 만족하면 read()를 호출해서 객체 생성 후 반환
HTTP 응답 데이터 생성
- 컨트롤러에서 @ResponseBody, HttpEntity로 값이 변환됨
- 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite() 를 호출
- 대상 타입을 지원하는가?
ex) return 의 대상 클래스 (byte[], String, HelloData)
- HTTP 요청의 Accept 미디어 타입을 지원하는가?
ex) text/plain, application/json, */*
- canWrite() 조건을 만족하면 write()를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성
출처 : https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1/dashboard
'Spring > Spring MVC' 카테고리의 다른 글
| 웹 애플리케이션 이해 (0) | 2021.08.09 |
|---|