(스프링 MVC 1) 스프링 MVC 기본 기능

로깅 간단히 알아보기

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

로깅 라이브러리

• 스프링 부트 라이브러리를 사용하면, 스프링 부트 로깅 라이브러리(spring-boot-starter-logging)가 함께 포함된다.
• SLF4J는 인터페이스이고, 그 구현체로 Logback 같은 로그 라이브러리를 선택하면 된다.

로그 선언

• private Logger log = LoggerFactory.getLogger(get.class());
• private static final Logger log = LoggerFactory.getLogger(xxx.class)
• @Slf4j : 롬복 사용(위의 코드를 자동으로 반영한다)

로그 호출

• log.info("hello")

LogTestController
@RestController
public class LogTestController {

private 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);

    return "ok";

}

}

• 로그 레벨 설정 변경해서 출력 결과를 살펴보자.
  --> LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
  일반적으로) 개발 서버는 debug 출력
  (일반적으로) 운영 서버는 info 출력

로그 레벨 설정
application.properties

올바른 로그 사용법

• log.debug("data="+data) :
  로그 출력 레벨을 info로 설정해도 위 코드에 있는 "data="+data가 실제 실행이 되어버린다. 결과적으로 문자 더하기 연산이 발생한다. (자바 언어는 debug 메서드를 호출하기 전에, 더하기 연산이 있다면 더하는 연산을 먼저 수행해버린다. (연산이 일어나면서 메모리도 사용하고, cpu도 사용한다.) 따라서 해당 로그는 남겨지지도 않는데 불필요한 연산이 일어나면서 쓸모없이 리소스를 사용하게 된다.
• log.debug("data = {}", data) : 로그 출력 레벨을 info로 설정하면 아무일도 발생하지 않는다. 따라서 앞과 같은 의미없는 연산이 발생하지 않는다. (debug 메서드를 호출하면서 파라미터만 넘기기 때문에 아무 연산이 일어나지 않는다.)

로그 사용시 장점

• 쓰레드 정보, 클래스 이름같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.
• 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다. (애플리케이션 코드를 수정하지 않고, 설정만으로 로그 레벨을 환경별로 다르게 지정할 수 있다.)
• 성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등등) 그래서 실무에서는 꼭 로그를 사용해야 한다.

---

요청 매핑

요청 매핑이란, 요청이 왔을 떄, 어떤 컨트롤러가 호출되어야 하는지를 매핑하는 것을 의미한다. 단순히 URL을 가지고 매핑하는 것 뿐만 아니라, 여러가지 요소들을 조합해서 매핑할 수 있다.

MappingController에서 다양한 매핑을 살펴보자

@RestController
public class MappingController {

    private Logger log = LoggerFactory.getLogger(getClass());


    @RequestMapping("/hello-basic")
    public String helloBasic(){
        log.info("helloBasic");
        return "OK";
    }
}

매핑정보

• @RestController : @Controller는 반환값이 String이면, 뷰 이름으로 인식한다. 그래서 뷰를 찾고, 뷰를 렌더링한다.
  --> @RestController는 반환값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다. 따라서 실행 결과로 "OK" 메시지를 받을 수 있다.

• @RequestMapping("/hello-basic")
  : /hello-basic URL이 호출이 되면, 이 메서드가 실행이 되도록 매핑한다.

HTTP 메서드 매핑

• @RequestMapping에 method 속성으로 HTTP 메서드를 지정하지 않으면, HTTP 메서드와 무관하게 호출된다(모두 허용이 가능하다)
• @RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET)
  --> HTTP 메서드 매핑을 다음과 같이 축약할 수도 있다.
  --> @GetMapping("/hello-basic")
• @GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping과 같이 축약한 애노테이션을 사용하는 것이 더 직관적이다. 이 코드를 보면, 내부에서 @RequestMapping과 Method를 지정해서 사용하는 것을 확인할 수 있다

PathVariable(경로 변수) 사용
: 요청 URL 자체에 값이 들어갈 수 있는 것(경로 변수)

 @GetMapping("/mapping/{userId}")
    public String mappingPath(@PathVariable("userId") String data){
        log.info("mapping userId = {}", data);
        return "OK";
    }

• /mapping/{userId} 에서 {userId} 에 userA를 넣어서 요청한 결과를 보면,
  
  
  정상적으로 실행됨을 확인할 수 있다
• 최근 HTTP API는 다음과 같이 리소스 경로에 식별자를 넣는 스타일을 선호한다.
• @RequestMapping은 URL경로를 템플릿화 할 수 있는데, @PathVariable을 사용하면, 매칭되는 부분을 편리하게 조회할 수 있다.
• @PathVariable의 이름과 파라미터의 이름이 같으면, 생략할 수 있다.

@GetMapping("/mapping/{userId}")
    public String mappingPath(@PathVariable String userId){
        log.info("mapping userId = {}", userId);
        return "OK";
    }

PathVariable 사용 - 다중 매핑

@GetMapping("/mapping/users/{userId}/orders/{orderId}")
    public String mappingPath(@PathVariable String userId, @PathVariable Long orderId){
        log.info("mapping userId = {}, orderId = {}", userId, orderId);
        return "OK";
    }

• /mapping/users/{userId}/orders/{orderId} URL에 userId에는 userA, orderId에는 1000을 넣어서 호출해 보았다.
  

• 정상적으로 실행됨을 확인할 수 있다.

특정 파라미터 조건 매핑
쿼리 파라미터를 조건에 매핑할 수 있다.

@GetMapping(value = "/mapping-param", params = "mode=debug")
    public String mappingParam(){
        log.info("mappingParma");
        return "OK";
    }

• 잘 사용하지는 않는다.

특정 헤더 조건 매핑
: 파라미터 매핑과 비슷하지만, HTTP 헤더를 사용한다.

 @GetMapping(value = "/mapping-header", headers = "mode=debug")
    public String mappingHeader(){
        log.info("mappingHeader");
        return "OK";
    }

미디어 타입 조건 매핑 - HTTP요청 Content - Type, consume
: HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑한다.
( 만약 Content-Type에 따른 조건(application/json인지 text/html인지 등)을 넣고 싶은 경우, consume을 사용해야 한다.

@GetMapping(value = "/mapping-consume", consumes = MediaType.APPLICATION_JSON_VALUE)
    public String mappingConsume(){
        log.info("mappingConsumes");
        return "OK";
    }

• consume : 컨트롤러가 소비하는 타입이 무엇이어야 하는지 지정(HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑해야 한다)

(참고) consumes 예시
consumes = "text/plain"
consumes = {"text/plain", "application/*"}
consumes = MediaType.TEXT_PLAIN_VALUE

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

 @PostMapping(value = "/mapping-produce", produces = MediaType.TEXT_HTML_VALUE)
    public String mappingProduces(){
        log.info("mappingProduces");
        return "OK";
    }

• produces 컨트롤러가 생산해내는 타입이 무엇이어야 하는지 지정(HTTP 요청의 Accept 헤더를 기반으로 미디어 타입으로 매핑한다.)

(참고) produces 예시
produces = "text/plain"
produces = {"text/plain", "application/*"}
produces = MediaType.TEXT_PLAIN_VALUE
produces = "text/plain;charset=UTF-8"

---

요청 매핑 - API 예시

회원 관리 API

• 회원 목록 조회: GET(/users)

• 회원 등록 : POST(/users)

• 회원 조회: GET(/users/{userId})

• 회원 수정 : PATCH(/users/{userId})

• 회원 삭제 : DELETE(/userss/{userId})

• 회원 (목록 조회 / 등록), 회원 (조회 / 수정 / 삭제)
  --> URL은 똑같이 제공하고, HTTP Method로 행위를 구분하였다.

MappingClassController

@RequestMapping("/mapping/users")
public class MappingClassController {
    //1. 회원 목록 조회: GET ( /users )
    @GetMapping
    public String user(){
        return "get users";
    }

    //2. 회원 등록: POST ( /users )
    @PostMapping
    public String addUser(){
        return "post user";
    }

    //3 . 회원 조회: GET ( /users/{userId} )
    @GetMapping("/{userId}")
    public String findUser(@PathVariable String userId){
        return "get userId = " + userId;
    }
    
    //4. 회원 수정: PATCH ( /users/{userId} )
    @PatchMapping("/{userId}")
    public String updateUser(@PathVariable String userId){
        return "update userId = " + userId;
    }
    
    //5. 회원 삭제: DELETE ( /users/{userId} )
    @DeleteMapping("/{userId}")
    public String deleteUser(@PathVariable String userId){
        return "delete useId = " + userId;
    }
}

• @RequestMapping("/mapping/users")
  클래스 레벨에 매핑 정보를 두면 메서드 레벨에서 해당 정보를 조합해서 사용한다.

---

HTTP 요청 - 기본, 헤더 조회

스프링 MVC가 제공하는 기본, 헤더 조회에 대해서 알아보자
--> 애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원한다.

RequestHeanderController

@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";

    }
}

• HttpMethod : HTTP 메서드를 조회한다.
• Locale :(가장 우선 순위가 높은 )Locale 정보를 조회한다.
• @RequestHeader MultiValueMap<String,String> headerMap: 모든 HTTP 헤더를 MultiValueMap 형식으로 조회한다.
• @RequestHeader("host") String host: 특정 HTTP 헤더를 조회한다,
• @CookieValue(value="myCookie", required = false) String Cookie : 특정 쿠키를 조회한다.
  기본값: defalutValue

MultiValueMap

• Map과 유사한데, 하나의 키에 여러 값을 받을 수 있다.
• HTTP header, HTTP 쿼리 파라미터와 같이 하나의 키에 여러 값을 받을 때 사용한다 (KeyA=value1&KeyA=value2)
  

**@Slf4j

• 다음 코드를 자동으로 생성해서 로그를 선언해준다, 개발자는 편리하게 log라고 사용하면 된다.
• private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(RequestHeaderController.class);

---

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

클라이언트에서 서버로 요청 데이터를 전달할 떄는 주로 다음 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를 주로 사용

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

• GET 쿼리 파라미터 전송
  http://localhost:8080/request-param?username=hello&age=20
• POST, HTML Form 전송
  

GET 쿼리파라미터 전송 방식이든, POST HTML Form 전송 방식이든 둘다 형식이 같으므로 구분없이 조회할 수 있다.
--> 요청 파라미터 (request parameter)조회차고 한다.

RequestParamController

@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가 제공하는 방식으로 요청 파라미터를 조회했다.

Post Form 페이지 생성
먼저 테스트용 HTML Form을 만들어야 한다.
--> 리소스는 /resources/static 아래에 두면 스프링 부트가 자동으로 인식한다. (/resources/static 은 외부에 공개되는 경로이다.)

---

HTTP 요청 파라미터 - @RequestParam

스프링이 제공하는 @RequestParam을 사용하면 요청 파라미터를 매우 편리하게 사용할 수 있다

@ResponseBody
    @RequestMapping("/request-param-v2")
    public String requestParamV2(@RequestParam("username") String username,
                                 @RequestParam("age") int age) {
        log.info("username = {}, age = {}", username, age);

        return "OK";
    }

    @ResponseBody
    @RequestMapping("/request-param-v3")
    public String requestParamV3(@RequestParam String username,
                                 @RequestParam int age) {
        log.info("username = {}, age = {}", username, age);
        return "OK";
    }

    @ResponseBody
    @RequestMapping("/request-param-v4")
    public String requestParamV4(@RequestParam String username, int age){
        log.info("username = {}, age = {}", username, age);

        return "OK";
    }

• 이렇게 단계적으로 코드를 줄여서
  간단하게 작성할 수 있다.

파라미터 필수 여부 requestParamRequired

 @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 으로 요청하게 되면, username 은 true이기 때문에 400예외가 발생한다
• (주의) /request-param?username = 으로 요청하게 되면, 빈문자 형태 ""로 null이 아니라 빈문자 형태로 출력하게 된다.

기본 값 적용 - requestParamDefault

@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";
   }

• 파라미터의 값이 없을 경우, defalutValue를 사용하면, 기본 값을 적용할 수 있다.
• defalutValue는 빈 문자의 경우에도 설정한 기본 값이 적용된다.

파라미터를 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";
   }

• RequestParam Map : Map(key=value)
• paramMap.get으로 "username", "age" 값을 꺼내서 넣는다.

---

HTTP 요청 파라미터 - @ModelAttribute

실제 개발을 하다보면, 요청 파라미터를 받아서 필요한 객체를 마들고, 그 객체에 값을 넣어주어야 한다.

요청 파라미터를 바인딩 받을 객체를 만들고, @ModelAttribute를 적용해보자

@Data
public class HelloData {
    private String username;
    private int age;
}

* @Data(롬복) : @Getter, @Setter, @ToString, @EqualsAndHashCode, @RequiredArgsConstructor를 자동으로 적용해준다.

modelAttributeV1

    @ResponseBody
    @RequestMapping("/model-attribute-v1")
    public String modelAttributeV1(@ModelAttribute HelloData helloData){
        log.info("username = {}, age = {}", helloData.getUsername(), helloData.getAge());
        
        return "OK";
    }

스프링 MVC는 @ModelAttribute가 있으면 다음을 실행한다.

• HelloData 객체를 생성한다

• 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼리틔 setter를 호출해서 파라미터의 값을 입력한다.
• 예) 파라미터 이름이 username 이면 setUsername() 메서드를 찾아서 호출하면서 값을 입력한다.

modelAttributeV2

@ResponseBody
    @RequestMapping("/model-attribute-v2")
    public String modelAttributeV2(HelloData helloData){
        log.info("username = {}, age = {}", helloData.getUsername(), helloData.getAge());

        return "OK";
    }

@ModelAttribute는 생략할 수 있다. 하지만, @RequestParam도 생략할 수 있어 혼란이 발생할 수도 있다.

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

---

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

HTTP message body에 데이터를 직접 담아서 요청하는 경우

• HTTP API에서 주로 사용 (JSON, XML, TEXT 등을 담을 수 있다.)
• 데이터 형식은 주로 JSON tkdyd
• PUT, POST, PATCH

가장 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송하고 읽어보자
(HTTP메시지 바디의 데이터를 InputStream을 사용해서 직접 읽을 수 있다)

requestBodyString

@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");
        
    }
}

requestBodyStringV2

 @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 응답 메시지의 바디에 직접 결과 출력

requestBodyStringV3

@PostMapping("/request-body-string-v3")
    public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity){
        String messageBody = httpEntity.getBody();
        log.info("messageBody = {}", messageBody);
        
        return new HttpEntity<>("OK");
    }

스프링 MVC는 다음 파라미터를 지원한다

• HttpEntity : HTTP header, body 정보를 편리하게 조회
  --> 메시지 바디 정보를 직접 조회
  --> 요청 파라미터를 조회하는 기능과는 전혀 관계 없음
• HttpEntity는 응답에도 사용 가능
  --> 메시지 바디 정보 직접 반환
  --> 헤더 정보도 포함 가능
• HttpEntity 를 상속 받은 다음 객체들도 같은 기능을 제공한다
  --> RequestEntity : HttpMethod, url 정보가 추가, 요청에서 사용
  --> ResponseEntity : HTTP 상태코드 설정 가능, 응답에서 사용

 @PostMapping("/request-body-string-v3-v1")
    public HttpEntity<String> requestBodyStringV3V1(RequestEntity<String> httEntity){
        String messageBody = httEntity.getBody();
        log.info("messageBody = {}", messageBody);
        
        return new ResponseEntity<>("OK", HttpStatus.CREATED);
    }

requestBodyStringV4

@ResponseBody
    @PostMapping("/request-body-string-v4")
    public String requestBodyStringV4(@RequestBody String messageBody){
        log.info("messageBody = {}",messageBody);
        return "OK";
    }

@RequestBody

• @RequestBody를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다.
• 참고로, 헤더 정보기 필요하다면 HttpEntity 를 사용하거나 @RequestHeader를 사용하면 된다.

요청 파라미터 조회 VS HTTP 메시지 바디 조회

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

---

HTTP 요청 메시지 - JSON

HTTP API에서 주로 사용하는 JSON 데이터 형식을 조회해보자

requestBodyJsonV1

@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를 사용해서 자바 객체로 변환한다.

@RequestBody - requestBodyJsonV2

 @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를 통해서 자바 객체로 변환한다.

requestBodyJsonV3 (@RequestBody 객체 변환)

@ResponseBody
    @PostMapping("/request-body-json-v3")
    public String requestBodyJsonV3(@RequestBody HelloData data) throws IOException{
        log.info("messageBody = {}", data);
        log.info("username = {}, age = {}", data.getUsername(),data.getAge());
        
        return "OK";
    }

@RequestBody 파라미터 :

• @RequestBody에 직접 만든 객체를 지정할 수 있다.
• HttpEntity, @RequestBody를 사용하면 HTTP메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환시켜준다.

@RequestBody는 생략 불가능

• HelloData에 @RequestBody 를 생략하면 @ModelAttribute 가 적용되어버린다. ( HelloData data -> @ModelAttribute HelloData data )

requestBodyJsonV4 - HttpEntity

@ResponseBody
    @PostMapping("/request-body-json-v4")
    public String requestBodyJsonV4(HttpEntity<HelloData> data){
        HelloData helloData = data.getBody();
        log.info("messageBody = {}", helloData);
        log.info("username = {}, age = {}", helloData.getUsername(), helloData.getAge());
        
        return "OK";
    }

• @ResponseBody 를 사용하면 해당 객체를 HTTP 메시지 바디에 직접 넣어줄 수 있다.

requestBodyJsonV5

@ResponseBody
   @PostMapping("/request-body-json-v5")
   public HelloData requestBodyJsonV5(@RequestBody HelloData helloData){
       log.info("messageBody = {}",helloData);
       log.info("username = {}, age = {}",helloData.getUsername(),helloData.getAge());
       
       return helloData;
   }

@ResponseBody

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

정리

• @RequestBody 요청
  --> JSON요청 -> HTTP 메시지 컨버터 -> 객체
• @ResponseBody 요청
  --> 객체 -> HTTP 메시지 컨버터 -> JSON 응답

---

응답 - 정적 리소스, 뷰 템플릿

스프링(서버)에서 응답 데이터를 만드는 방법은 크게 3가지이다.

정적 리소스

• 웹 브라우저에 정적인 HTML, CSS, JS를 제공할 때에는 정적 리소스를 사용한다(파일 그대로 전달)

뷰 템플릿 사용

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

HTTP 메시지 사용

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

정적 리소스

• 정적 리소스는 파일을 변경 없이 그대로 서비스하는 것이다.
• 스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공한다.
  /static , /public , /resources , /META-INF/resources
• src/main/resources 는 리소스를 보관하는 곳이고, 또 클래스패스의 시작 경로이다.
  --> 따라서 해당 디렉토리 하위에 위 리소스를 넣어두면 스프링 부트가 정적 리소스로 서비스를 제공한다.

뷰 템플릿 생성
1. 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>

2. ResponseViewController - 뷰 템플릿을 호출하는 컨트롤러

@Controller
public class ResponseViewController {
    
    @RequestMapping("/response-view-v1")
    public ModelAndView responseViewV1(){
        ModelAndView mav = new ModelAndView("response/hello");
        mav.addObject("data","hello!");
        return mav;
    }
    
    @RequestMapping("/response-view-v2")
    public String responseViewV2(Model model){
        model.addAttribute("data", "hello!");
        return "response/hello";
    }
}

String을 반환하는 경우 - View or HTTP 메시지

• @Response가 없으면, response/hello로 뷰 리졸버가 실행되어서 뷰로 찾고, 렌더링한다.

• @ResponseBody가 있으면, 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello라는 문자가입력된다.

• 여기서 뷰의 논리 이름인 response/hello를 반환하면 뷰 템플릿이 렌더링 되는 것을 확인할 수 있다!

  ---

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

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

  HTML이나 뷰 템플릿을 사용해도 그것도 결과적으로는 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달된다. 여기서 설명하는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 전달하는 경우를 말한다.

responseBodyV1 메서드

@GetMapping("/response-body-string-v1")
    public void responseBodyV1(HttpServletResponse response) throws IOException {
        response.getWriter().write("OK");
    }

• 서블릿을 직접 다룰 떄처럼, HttpServletResponse 객체를 통해서 HTTP 메시지 바디에 직접 OK 응답 메시지를 전달한다.
  response.getWriter().write("OK")

responseBodyV2 메서드

 @GetMapping("/response-body-string-v2")
    public ResponseEntity<String> responseBodyV2(){
        return new ResponseEntity<>("OK", HttpStatus.OK);
    }

• ResponseEntity 엔티티는 HttpEntity 를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다. ResponseEntity 는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다.
  --> HttpStatus.OK (200응답)

responseBodyV3 메서드

 @GetMapping("/response-body-string-v3")
    @ResponseBody
    public String ResponseBodyV3(){
        return "OK";
    }

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

ResponseBodyJsonV1 메서드

 @GetMapping("/response-body-string-json-v1")
    public ResponseEntity<HelloData> ResponseBodyJsonV1(){
        HelloData helloData = new HelloData();
        helloData.setUsername("이서연");
        helloData.setAge(25);
        
        return new ResponseEntity<>(helloData,HttpStatus.OK);
    }

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

responseBodyJsonV2 메서드

 @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    @GetMapping("/response-body-string-json-v2")
    public HelloData ResponseBodyJsonV2(){
        HelloData helloData = new HelloData();
        helloData.setUsername("이서연");
        helloData.setAge(25);
        
        return helloData;
    }

• ResponseEntity 는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody 를 사용하면 이런 것을 설정하기 까다롭다.
• 그래서 @ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다. --> 물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다.

@RestController

• @Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody가 적용되는 효과가 있다.
• 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다. 이름 그대로 Rest API만들 때 사용하는 컨트롤러
• 참고로 @ResponseBody는 클래스 레벨에 두면 전체 메서드가 적용되는데, @RestController 안에 @ResponseBody가 적용되어 있다.

---

HTTP 메시지 컨버터

뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아니라, HTTP API 처럼 JSON 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우, HTTP 메시지 컨버터를 사용하면 편리하다.

@ResponseBody 사용 원리

• @ResponseBody를 사용하면,
  --> HTTP의 BODY에 문자 내용을 직접 넣어서 반환한다.
  --> viewResolver 대신에 HttpMessageConverter가동작하다.
  --> 기본 문자 처리: (기본 문자 반환시) StringHttpMessageConverter
  --> 기본 객체 처리: (객체 반환시) MappingJackson2HttpMessageConverter
  ---> 객체 에서 Json 형태로 변환

스프링 MVC는 다음의 경우에 HTTP 메시지 컨버터를 적용한다

• HTTP 요청: @RequestBody, HttpEntity 또는 이를 상속 받은 RequestEntity
• HTTP 응답 : @ResponseBody, HttpEntity 또는 이를 상속받은 ResponseEntity

HTTP 메시지 컨버터 인터페이스
HTTP 메시지 컨버터는 HTTP 요청, HTTP 응답 둘 다 사용된다

• canRead(), canWrite(): 메시지 컨버터가 해당 클래스, 미디어 타입을 지원하는지 체크
• read(), write(): 메시지 컨버터를 통해 메시지를 읽고 쓰는 기능

스프링 부트 기본 메시지 컨버터 (일부 생략)
스프링 부트는 기본적으로 메시지 컨버터를 스프링 부트가 올라올 때 몇가지를 등록해둔다.

0 = ByteArrayHttpMessageConverter (바이트로 변환)
1 = StringHttpMessageConverter (스트링으로 변환)
2 = MappingJackson2HttpMessageConverter (객체 -> Json or Json -> 객체 변환)

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

• ByteArrayHttpMessageConverter : byte[] 데이터를 처리한다.
  클래스 타입: byte[] , 미디어타입: / (아무 미디어 타입이나 다 받아들일 수 있다.)
  요청 예) @RequestBody byte[] data
  응답 예) @ResponseBody return byte[]
  위와 같이 응답하면 HTTP 응답 미디어 타입이 application/octet-stream 으로 반환된다. ( 쓰기 미디어타입 application/octet-stream )

• StringHttpMessageConverter : String 문자로 데이터를 처리한다
  클래스 타입: String , 미디어 타입: /
  요청 예) @RequestBody String data
  응답 예) @ResponseBody return "ok"
  위와 같이 응답하면 HTTP 응답 미디어 타입이 text/plain 으로 반환된다. ( 쓰기 미디어타입 text/plain )

• MappingJackson2HttpMessageConverter: application/json을 주로 처리
  클래스 타입: 객체 또는 HashMap , 미디어타입 application/json 관련
  요청 예) @RequestBody HelloData data
  응답 예) @ResponseBody return helloData
  위와 같이 응답하면 HTTP 응답 미디어 타입이 application/json 관련 정보로 반환된다. ( 쓰기 미디어타입 application/json 관련 )

HTTP 요청 데이터 읽기

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

HTTP 응답 데이터 생성

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

(예시)

• @RequestBody의 타입 : String
• StringHttpMessageConvert가 동작
• 타입이 String 이고, 이후 미디어 타입도 체크한다
  --> 미디어 타입 : application/json인데, 모든 미디어 타입을 받을 수 있으므로,
• StringHttpMessageConverter가 동작한다
  
• MappingJacson2MessageConverter 동작(객체 타입이므로, 대상이 된다)
• 미디어 타입 application/json이므로 합격
• 따라서 결과적으로 이 경우에는, MappingJacson2HttpMessageConverter가 동작한다. ( 이후 해당 json 데이터는 HelloData 객체로 만들어져서 주입한다)

• 객체타입 MappingJacson2HttpMessageConverter가 해당
• 미디어 타입이 application/json이 아니므로 탈락
• MappingJacson2HttpMessageConverter도 해당되지 않기에 탈락이다. (결국 선택되는 것 없이 오류날 것)

---

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

HTTP 메시지 컨버터는 스프링 MVC의 어디쯤에서 사용되는 걸까?
모든 비밀은 애노테이션 기반의 컨트롤러, @RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter(요청 매핑 핸들러 어뎁터) 에 있다

RequestMappingHandlerAdaper 동작 방식
(참고)

• DispatcherServlet이 RequestMapping 핸들러 어댑터를 호출한다.
  그러면 핸들러 어댑터는 핸들러(컨트롤러)를 호출해 줘야 한다.
• 그런데 해당 컨트롤러가 호출이 되려면, 해당 컨트롤러에서 파라미터로 받기위해 선언했을 수도 있는 (HttpServletRequest, HttpServletResponse, InputStream, HttpEntity, @RequestParam, @RequestBody, ...) 등등의 파라미터 정보가 있다면, 이와 관련한 적절한 값들도 만들어져서 주입되어야 한다.

Argument Resolver
애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다. HttpServletRequest , Model 은 물론이고, @RequestParam , @ModelAttribute 같은 애노테이션 그리고 @RequestBody , HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다.
-> 유연하게 처리할 수 있는 이유가 바로 Argument Resolver이다.

• 애노테이션 기반 컨트롤러가 처리하는 RquestMappingHandlerAdater는 바로 ArgumentResolver를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)를 생성한다.
  --> 그리고 이렇게 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.

정확히는 HandlerMethodArgumentResolver 인데 줄여서 ArgumentResolver 라고 부른다.

동작 방식

• ArgumentResolver 의 supportsParameter() 를 호출해서 해당 파라미터를 지원하는지 체크하고, 지원하면 resolveArgument() 를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다

ReturnValueHandler

• 정확히는HandlerMethodReturnValueHandler 인데 줄여서 ReturnValueHandler 라 부른다. ( ArgumentResolver 와 비슷한데, 이것은 응답 값을 변환하고 처리한다. )
• 컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler 덕분이다

파라미터로 넘어가는 것은 ArgumentResolver가 생성하는 것을 확인했다.
그러면 HTTP 메시지 컨버터는 어디에서 동작할까 ? HTTP 메시지 컨버터는 어디쯤 있을까?

HTTP 메시지 컨버터 위치

• HTTP 메시지 컨버터를 사용하는 @RequestBody 도 결국 컨트롤러가 필요로 하는 파라미터의 값에 사용된다. (즉, ArgumentResolver가 해결해야 함.) @ResponseBody 의 경우도 컨트롤러의 반환 값을 이용한다. (즉, ReturnValueHandler가 해결해야 함.)

요청의 경우 @RequestBody 를 처리하는 ArgumentResolver 가 있고, HttpEntity 를 처리하는 ArgumentResolver 가 있다. 이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용(이전에 봤던 주요 3개 메시지 컨버터 동작 방식 참고)해서 필요한 객체를 생성하는 것이다.

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