LostCatBox

SpringCore CH06

Spring Basic Java
Word count: 5.3kReading time: 33 min
2022/12/24 Share

스프링 MVC 1편 CH06

Created Time: June 29, 2022 3:31 PM
Last Edited Time: December 23, 2022 5:06 PM

프로 젝트 생성

  • start.spring
  • 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
  • Dependencies: Spring Web, Thymeleaf, Lombok
  • Lombok은 설정에서 annotation 검색후 build에 enable설정해주기

Welcome페이지 만들기

  • 스프링 부트에 Jar 를 사용하면 /resources/static/ 위치에 index.html 파일을 두면 Welcome 페이지로 처리해준다. (스프링 부트가 지원하는 정적 컨텐츠 위치에 /index.html 이 있으면 된다.

로깅 간단히 알아보기

로깅 라이브러리

  • 스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리( spring-boot-starter-logging )가 함께 포함된다. 스프링 부트 로깅 라이브러리는 기본으로 다음 로깅 라이브러리를 사용한다.
  • SLF4J - http://www.slf4j.org
    Logback - http://logback.qos.ch
  • 로그 라이브러리는 Logback, Log4J, Log4J2 등등 수 많은 라이브러리가 있는데, 그것을 통합해서 인터페이스로 제공하는 것이 바로 SLF4J 라이브러리다.
    쉽게 이야기해서 SLF4J는 인터페이스이고, 그 구현체로 Logback 같은 로그 라이브러리를 선택하면 된다. 실무에서는 스프링 부트가 기본으로 제공하는 Logback을 대부분 사용한다.

로그 정보

  • 로그가 출력되는 포멧 확인
    • 시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지
  • 로그 레벨 설정을 변경해서 출력 결과를 보자.
    • LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
    • 개발 서버는 debug 출력(debug보다 상위는 모두 출력)
    • 운영 서버는 info 출력(info보다 상위는 모두 출력)
  • @Slf4j 로 변경

로그 선언

  • private Logger log = LoggerFactory.getLogger(getClass());
  • private static final Logger log = LoggerFactory.getLogger(Xxx.class)
  • @Slf4j : 롬복 사용 가능

로그 호출

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@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";
} }
  • 잘못된예시) 로그를 사용하지 않아도 a+b 계산 로직이 먼저 실행됨, 이런 방식으로 사용하면 X
    • log.debug(“String concat log=” + name);

매핑 정보

  • @RestController
    • @Controller 는 반환 값이 String 이면 뷰 이름으로 인식된다. 그래서 뷰를 찾고 뷰가 랜더링 된다.
    • @RestController 는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다.
    • 따라서 실행 결과로 ok 메세지를 받을 수 있다. @ResponseBody 와 관련이 있는데, 뒤에서 더 자세히 설명한다.

로그레벨 설정

  • application.properties
1
2
3
4
5
#전체 로그 레벨 설정(기본 info)(root이므로 변경시 spring 실행때 log들도 다찍힘)
logging.level.root=info

#hello.springmvc 패키지와 그 하위 로그 레벨 설정 
logging.level.hello.springmvc=debug

올바른 로그 사용법

  • log.debug(“data=”+data)
    로그 출력 레벨을 info로 설정해도 해당 코드에 있는 “data=”+data가 실제 실행이 되어 버린다. 결과적으로 문자 더하기 연산이 발생한다. (연산자 실행되므로, 메모리사용O)
  • log.debug(“data={}”, data)
    로그 출력 레벨을 info로 설정하면 아무일도 발생하지 않는다. 따라서 앞과 같은 의미없는 연산이 발생하지 않는다.(debug()함수 호출시, 파라미터보고 해당안되면 바로 반환, 메모리사용X)

로그 사용시 장점

  • 쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.
  • 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.(출력 범위 조절가능)
  • 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다.
  • 특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.
  • 성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등등) 그래서 실무에서는 꼭 로그를 사용해야한다.

추가자료 (!!!)

요청 매핑

  • 컨트롤러
1
2
3
4
5
6
7
8
9
10
11
@RestController
public class Mappingcontroller {

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

    @RequestMapping(value = "/hello-basic",method = RequestMethod.GET)
    public String helloBasic(){
        log.info("basic");
        return "ok";
    }
}

매핑 정보

  • @RestController
    • @Controller 는 반환 값이 String 이면 뷰 이름으로 인식된다. 그래서 뷰를 찾고 뷰가 랜더링 된다.
    • @RestController 는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다.
    • 따라서 실행 결과로 ok 메세지를 받을 수 있다. @ResponseBody 와 관련이 있는데, 뒤에서 더 자세히 설명한다.
  • @RequestMapping(“/hello-basic”)
    • /hello-basic URL 호출이 오면 이 메서드가 실행되도록 매핑한다.
    • 대부분의 속성을 배열[] 로 제공하므로 다중 설정이 가능하다. {“/hello-basic”, “/hello-go”}
  • 둘다 허용
    • 다음 두가지 요청은 다른 URL이지만, 스프링은 다음 URL 요청들을 같은 요청으로 매핑한다.
      • URL 요청: /hello-basic , /hello-basic/
      • 매핑: /hello-basic
  • HTTP 메서드
    • @RequestMapping 에 method 속성으로 HTTP 메서드를 지정하지 않으면 HTTP 메서드와 무관하게 호출된다.
    • 모두 허용 GET, HEAD, POST, PUT, PATCH, DELETE

HTTP 메서드 매핑

  • 만약 method아닌 다른 요청시 405반환
1
2
3
4
5
6
7
8
/**
* method 특정 HTTP 메서드 요청만 허용
* GET, HEAD, POST, PUT, PATCH, DELETE */
  @RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET)
  public String mappingGetV1() {
      log.info("mappingGetV1");
      return "ok";
  }

HTTP 메서드 매핑 축약

  • 아래처럼 사용해보자, 좀더 직관적이다.
1
2
3
4
5
6
7
8
9
10
11
12
/**
* 편리한 축약 애노테이션 (코드보기) * @GetMapping
* @PostMapping
* @PutMapping
* @DeleteMapping
* @PatchMapping
*/
@GetMapping(value = "/mapping-get-v2")
public String mappingGetV2() {
  log.info("mapping-get-v2");
  return "ok";
}

PathVariable(경로 변수) 사용(!!!)

  • 최근 HTTP API는 다음과 같이 리소스 경로에 식별자를 넣는 스타일을 선호한다.
  • @RequestMapping 은 URL 경로를 템플릿화 >> 매칭된 부분 편리한조회
  • @PathVariable 의 이름과 파라미터 이름이 같으면 생략할 수 있다.
1
2
3
4
5
6
7
8
9
10
11
/**
     * PathVariable 사용
     * 변수명이 같으면 생략 가능
     * @PathVariable("userId") String userId -> @PathVariable userId
     *
     */
    @GetMapping("/mapping/{userId}")
    public String mappingPath(@PathVariable("userId") String data){
        log.info("mappingPath userId={}",data);
        return "ok";
    }

PathVariable 사용 - 다중

1
2
3
4
5
6
7
8
9
/**
 * 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";
}

특정 파라미터 조건 매핑

  • 사용빈도 낮음
  • 특정 파라미터가 있거나 없는 조건을 추가할 수 있다.
1
2
3
4
5
6
7
8
9
10
11
12
13
/**
 *파라미터로 추가 매핑
* 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 헤더를 사용한다.
1
2
3
4
5
6
7
8
9
10
11
12
/**
 *특정 헤더로 추가 매핑
 * 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 요청 Content-Type, consume

  • HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑한다.
  • 맞지 않으면 415 상태코드 반환
  • consume인 이유: controller가 요청에 타입을 소비(조회)하여, 응답하므로
1
2
3
4
5
@PostMapping(value = "/mapping-consume", consumes = "application/json")
    public String mappingConsumes() {
        log.info("mappingConsumes");
        return "ok";
    }

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

  • HTTP 요청의 Accept 헤더를 기반으로 미디어 타입으로 매핑한다.
  • 맞지 않으면 406 상태코드 반환한다
  • produces인 이유: Accept는 요청자가 받을수있는 형식을 담고있다. produces와 일치하는 것이 있어야 해당 형식으로 응답
  • Accept에 맞는것이 없다면 406상태코드 반환
1
2
3
4
5
6
7
8
9
10
11
/**
     * 요청에서 Accept헤더 필요 (요청이 받을수있는 유형을 넣어둠)
     * 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";
    }

요청 매핑 - API예시

  • 회원 관리를 HTTP API로 만든다 생각하고 매핑을 어떻게 하는지 알아보자.
    (실제 데이터가 넘어가는 부분은 생략하고 URL 매핑만)
  • 회원 관리 API
    • 회원 목록 조회: GET /users
    • 회원 등록: POST /users
    • 회원 조회: GET /users/{userId}
    • 회원수정: PATCH /users/{userId}
    • 회원 삭제: DELETE /users/{userId}

실습

  • MappingClassController
    • 요즘 스타일, 공통되는 uri부분은 클래스쪽으로 뺀다
    • PathVariable사용
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {

    @GetMapping
    public String user(){
        return "get users";
    }
    @PostMapping
    public String addUser(){
        return "add user";
    }

    @GetMapping("/{userId}")
    public String finderUser(@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;
    }
}
  • /mapping :는 강의의 다른 예제들과 구분하기 위해 사용했다.
  • @RequestMapping(“/mapping/users”)
    클래스 레벨에 매핑 정보를 두면 메서드 레벨에서 해당 정보를 조합해서 사용한다.

HTTP 요청 - 기본, 헤더 조회

  • 애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원한다.
    이번 시간에는 HTTP 헤더 정보를 조회하는 방법을 알아보자.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@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 메서드를 조회한다. org.springframework.http.HttpMethod

  • 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&keyA=value2
    1
    2
    3
    4
    5
    MultiValueMap<String, String> map = new LinkedMultiValueMap();
        map.add("keyA", "value1");
        map.add("keyA", "value2");
        //[value1,value2]
        List<String> values = map.get("keyA");

참고> @Conroller 의 사용 가능한 파라미터 목록은 다음 공식 메뉴얼에서 확인할 수 있다. https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-arguments

@Conroller 의 사용 가능한 응답 값 목록은 다음 공식 메뉴얼에서 확인할 수 있다.
https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-return-types

HTTP 요청 파라미터

쿼리 파라미터, HTML Form

개요

  • HTTP 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달하는 방법을 알아보자.

  • 클라이언트에서 서버로 요청 데이터를 전달할 때는 주로 다음 3가지 방법을 사용한다.

    • GET - 쿼리 파라미터
      /url?username=hello&age=20메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
      예) 검색, 필터, 페이징등에서 많이 사용하는 방식
    • POST - HTML Form
      content-type: application/x-www-form-urlencoded
      메시지 바디에 쿼리 파리미터 형식으로 전달 username=hello&age=20
      예) 회원 가입, 상품 주문, HTML Form 사용
    • HTTP message body에 데이터를 직접 담아서 요청
      HTTP API에서 주로 사용, JSON, XML, TEXT
      데이터 형식은 주로 JSON 사용
      POST, PUT, PATCH

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

    • HttpServletRequest 의 request.getParameter() 를 사용하면 다음 두가지 요청 파라미터를 조회할 수 있다.
    • GET 쿼리 파리미터 전송 방식이든, POST HTML Form 전송 방식이든 둘다 형식이 같으므로 구분없이 조회할 수 있다.
      이것을 간단히 요청 파라미터(request parameter) 조회라 한다.

  • RequestParamController

    • void 메서드이며, response.getWriter().write() 호출한다면, view조회안하고 응답값 직접 가능하다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@RestController
@Slf4j
public class RequestParamController {

		/**
		* 반환 타입이 없으면서 이렇게 응답에 값을 직접 집어넣으면, view 조회X
		*/
    @RequestMapping("/request-param-v1")
    public void requestParamV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));
        log.info("username={}, age={}", username, age);

        response.getWriter().write("ok");
    }

리소스는 /resources/static 아래에 두면 스프링 부트가 자동으로 인식한다.
경로아래 hello-form.html을 만들고 post도 테스트 해보자

@RequestParam 사용

  • 스프링이 제공하는 @RequestParam 을 사용하면 요청 파라미터를 매우 편리하게 사용할 수 있다.
  • v2
    • @RequestParam : 파라미터 이름으로 바인딩
    • @ResponseBody : View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력
1
2
3
4
5
6
7
8
@ResponseBody
    @RequestMapping("/request-param-v2")
    public String requestParamV2(
            @RequestParam("username") String memberName,
            @RequestParam("age") int memberAge){
        log.info("username={}, age={}", memberName, memberAge);
        return "ok";
    }
  • v3
    • HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name=”xx”) 생략 가능
1
2
3
4
5
6
7
8
@ResponseBody
    @RequestMapping("/request-param-v3")
    public String requestParamV3(
            @RequestParam String username,
            @RequestParam int age){
        log.info("username={}, age={}", username, age);
        return "ok";
    }

  • v4

    • String , int , Integer 등의 단순 타입이면 @RequestParam 도 생략 가능
    • 하지만 이는 너무 과하다는 생각이다. 명확하게 표시하는 @RequestParam! 준수하자
    1
    2
    3
    4
    5
    6
    @ResponseBody
        @RequestMapping("/request-param-v4")
        public String requestParamV4(String username, int age){
            log.info("username={}, age={}", username, age);
            return "ok";
        }

  • v5

    • 파라미터 필수 여부 - requestParamRequired
    • @RequestParam.required
      • 파라미터 필수 여부
      • 기본값이 파라미터 필수( true )이다.
1
2
3
4
5
6
7
8
9
@ResponseBody
    @RequestMapping("/request-param-required")
    public String requestParamRequired(
            @RequestParam(required = true) String username,
            @RequestParam(required = true) Integer age){  //int는 기본형 타입이기때문에 null불가능, 안적을시 오류500 >>Integer 변경해야함
        // 참고로 null, ""은 다름, null은 안되지만, ""는 가능
        log.info("username={}, age={}", username, age);
        return "ok";
    }
  • v5주의 할점
    • 주의! - 파라미터 이름만 사용
      • /request-param?username=
      • ****파라미터 이름만 있고 값이 없는 경우 빈문자 통과
    • 주의! - 기본형(primitive)에 null 입력
      • /request-param 요청
        @RequestParam(required = false) int age
      • null 을 int 에 입력하는 것은 불가능(500 예외 발생)
      • 따라서 null 을 받을 수 있는 Integer 로 변경하거나, 또는 다음에 나오는 defaultValue 사용
  • requestParamDefault
    • defaultValue설정시 빈문자열, null값일때 자동으로 디폴트 값 반영함
    • required의미가 없어짐
1
2
3
4
5
6
7
8
@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";
  }
  • 파라미터를 Map으로 조회하기 - requestParamMap
    • @RequestParam Map (보통사용!)
      • Map(key=value)
    • @RequestParam MultiValueMap
      • MultiValueMap(key=[value1, value2, …] ex) (key=userIds, value=[id1, id2])
    • 파라미터의 값이 1개가 확실하다면 Map 을 사용해도 되지만, 그렇지 않다면 MultiValueMap 을 사용하자.

HTTP 요청 파라미터 - @ModelAttribute

  • 실제 개발을 하면 요청 파라미터를 받아서 필요한 객체를 만들고 그 객체에 값을 넣어주어야 한다. 보통 다음과 같이 코드를 작성할 것이다.
  • HelloModel
    • lombok을 사용하여, @Data 애노테이션사용
    • @Getter , @Setter , @ToString , @EqualsAndHashCode , @RequiredArgsConstructor 를 자동으로 적용해준다.
1
2
3
4
5
6
7
import lombok.Data;

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

@ModelAttribute적용전

  • 직접 요청 파라미터에서 찾아서 직접 바인딩해주는 과정이 필요하다
1
2
3
4
5
6
7
8
9
10
11
12
@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";
}

@ModelAttribute적용후

  • HelloData 객체를 생성한다.
  • 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩) 한다.
    예) 파라미터 이름이 username 이면 setUsername() 메서드를 찾아서 호출하면서 값을 입력한다.
  • 바인딩 오류
    • age=abc 처럼 숫자가 들어가야 할 곳에 문자를 넣으면 BindException 이 발생한다. 이런 바인딩 오류를 처리하는 방법은 검증 부분에서 다룬다.

프로퍼티(!!!)
일부 객체 지향 프로그래밍 언어에서 필드(데이터 멤버)와 메소드 간 기능의 중간인 클래스 멤버의 특수한 유형이다.
객체에 getUsername() , setUsername() 메서드가 있으면, 이 객체는 username 이라는 프로퍼티를 가지고 있다. username 프로퍼티의 값을 변경하면 setUsername() 이 호출되고, 조회하면 getUsername() 이 호출된다.

1
2
3
4
5
6
7
@ResponseBody
    @RequestMapping("/model-attribute-v1-1")
    public String modelAttributeV1_1(@ModelAttribute HelloData helloData){
        log.info("helloData={}", helloData);

        return "ok";
    }

@ModelAttribute적용후 v2

  • 아예 애노테이션을 제거해도 가능하다
  • @ModelAttribute 는 생략할 수 있다.
    그런데 @RequestParam 도 생략할 수 있으니 혼란이 발생할 수 있다.
  • 스프링은 해당 생략시 다음과 같은 규칙을 적용한다.
    String , int , Integer 같은 단순 타입 = @RequestParam
  • 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)
1
2
3
4
5
6
7
@ResponseBody
@RequestMapping("/model-attribute-v2")
public String modelAttributeV2(HelloData helloData){
    log.info("helloData={di}", helloData);

    return "ok";
}

HTTP 요청 메시지

단순 텍스트(!!!)

  • HTTP message body에 데이터를 직접 담아서 요청
    • HTTP API에서 주로 사용, JSON, XML, TEXT
    • 데이터 형식은 주로 JSON 사용
    • POST, PUT, PATCH
  • 요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 넘어오는 경우는 @RequestParam , @ModelAttribute 를 사용할 수 없다. (물론 HTML Form 형식으로 전달되는 경우는 요청 파라미터로 인정된다.)(즉, POST의 www.x-form.com형식으로 오는 경우는가능)
  • HTTP 메시지 바디의 데이터를 InputStream 을 사용해서 직접 읽을 수 있다.
    • Stream은 바이트 코드이므로 이를 인코딩하여 문자열 반영, 이과정필수
1
2
3
4
5
6
7
8
9
10
11
12
13
@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);// Stream은 바이트 코드이므로 이를 인코딩하여 문자열 반영, 이과정필수

        log.info("MessageBody={}", messageBody);

        response.getWriter().write("ok");

    }
  • Input, Output 스트림, Reader - requestBodyStringV2
    • InputStream(Reader): HTTP 요청 메시지 바디의 내용을 직접 조회
    • OutputStream(Writer): HTTP 응답 메시지의 바디에 직접 결과 출력
1
2
3
4
5
6
7
8
9
@PostMapping("/request-body-string-v2")
    public void requestBodyStringV2(InputStream inputStream, Writer responseWriter) throws IOException {
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);// Stream은 바이트 코드이므로 이를 인코딩하여 문자열 반영, 이과정필수

        log.info("MessageBody={}", messageBody);

        responseWriter.write("ok");

    }
  • HttpEntity - requestBodyStringV3
    • 스프링 MVC는 다음 파라미터를 지원한다.
    • HttpEntity: HTTP header, body 정보를 편리하게 조회
      • 메시지 바디 정보를 직접 조회(타입적어주면 타입으로변환)
      • 요청 파라미터를 조회하는 기능과 관계 없음
        @RequestParam X, @ModelAttribute X
    • HttpEntity는 응답에도 사용 가능
      • 메시지 바디 정보 직접 반환
      • 헤더 정보 포함 가능
      • view 조회X
    • HttpEntity 를 상속받은 다음 객체들도 같은 기능을 제공한다.
      • RequestEntity
        HttpMethod, url 정보가 추가, 요청에서 사용
      • ResponseEntity
        HTTP 상태 코드 설정 가능, 응답에서 사용
        return new ResponseEntity<String>("Hello World", responseHeaders,HttpStatus.CREATED)
1
2
3
4
5
6
7
8
9
@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 내부에서 HTTP 메시지 바디를 읽어서 문자나 객체로 변환해서 전달해주는데, 이때 HTTP 메시지 컨버터( HttpMessageConverter )라는 기능을 사용한다. 이것은 조금 뒤에 HTTP 메시지 컨버터에서 자세히 설명한다.

  • @RequestBody - requestBodyStringV4 (흔하게사용)
    • @RequestBody
      @RequestBody 를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다. 참고로 헤더 정보가 필요하다면 HttpEntity 를 사용하거나@RequestHeader 를 사용하면 된다. 이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam ,@ModelAttribute 와는 전혀 관계가 없다.
1
2
3
4
5
6
7
8
9
@ResponseBody
    @PostMapping("/request-body-string-v4")
    public String requestBodyStringV4(@RequestBody String messageBody) throws IOException {

        log.info("MessageBody={}", messageBody);

        return "ok";

    }

정리

  • 요청 파라미터 vs HTTP 메시지 바디
    • 요청 파라미터를 조회하는 기능: @RequestParam , @ModelAttribute
    • HTTP 메시지 바디를 직접 조회하는 기능: @RequestBody
  • @ResponseBody
    • @ResponseBody 를 사용하면 응답 결과를 HTTP 메시지 바디에 직접 담아서 전달할 수 있다.
    • 물론 이 경우에도 view를 사용하지 않는다.

HTTP 요청 메시지 - JSON

  • 이번에는 HTTP API에서 주로 사용하는 JSON 데이터 형식을 조회해보자.
  • RequestBodyJsonController
    • v1 코드
    • HttpServletRequest를 사용해서 직접 HTTP 메시지 바디에서 데이터를 읽어와서, 문자로 변환한다.
    • 문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper 를 사용해서 자바 객체로 변환한다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@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");
    }
  • requestBodyJsonV2 - @RequestBody 문자 변환
    • @RequestBody
      • HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
    • @ResponseBody
      • 모든 메서드에 @ResponseBody 적용
      • 메시지 바디 정보 직접 반환(view 조회X)
      • HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
    • 문자로 변환하고 다시 json으로 변환하는 과정이 불편하다. @ModelAttribute처럼 한번에 객체로 변환할 수는 없을까?
1
2
3
4
5
6
7
8
9
@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";
    }
  • requestBodyJsonV3 - @RequestBody 객체 변환
    • @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
    • HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (content-type: application/json)
    • @RequestBody 객체 파라미터
      • @RequestBody HelloData data
      • @RequestBody 에 직접 만든 객체를 지정할 수 있다
    • HttpEntity , @RequestBody 를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가원하는 문자나 객체 등으로 변환해준다. HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해주는데, 우리가 방금 V2에서 했던 작업을대신 처리해준다.
    • 스프링은 @ModelAttribute , @RequestParam 과 같은 해당 애노테이션을 생략시 다음과 같은 규칙을적용한다.
      • String , int , Integer 같은 단순 타입 = @RequestParam
      • 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)
    • HTTP 요청시에 content-type이 application/json인지 꼭! 확인해야 한다. 그래야 JSON을 처리할 수 있는 HTTP 메시지 컨버터가 실행된다.
1
2
3
4
5
6
7
@ResponseBody
    @PostMapping("/request-body-json-v3")
    public String requestBodyJsonV3(@RequestBody HelloData helloData) throws IOException {

        log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
        return "ok";
    }
  • requestBodyJsonV4 - HttpEntity
1
2
3
4
5
6
7
@ResponseBody
@PostMapping("/request-body-json-v4")
public String requestBodyJsonV4(HttpEntity<HelloData> httpEntity) throws IOException {
    HelloData data = httpEntity.getBody();
log.info("username={}, age={}", data.getUsername(),data.getAge());
    return "ok";
}
  • requestBodyJsonV5
1
2
3
4
5
6
7
@ResponseBody
    @PostMapping("/request-body-json-v5")
    public HelloData requestBodyJsonV5(HttpEntity<HelloData> httpEntity) throws IOException {
        HelloData data = httpEntity.getBody();
        log.info("username={}, age={}", data.getUsername(),data.getAge());
        return data;  //httpEntity의 객체가 응답을 주는경우.. 자동으로 다시 json전환
    }
  • 응답의 경우에도 @ResponseBody 를 사용하면 해당 객체를 HTTP 메시지 바디에 직접 넣어줄 수 있다. 물론 이 경우에도 HttpEntity 를 사용해도 된다.
  • @RequestBody 요청
    • JSON 요청 → HTTP 메시지 →컨버터 객체
  • @ResponseBody 응답
    • 객체 →HTTP 메시지 컨버터 → JSON 응답

HTTP 응답

정적 리소스, 뷰 템플릿

  • 응답 부분에 초점맞추어서 정리하자
  • 스프링(서버)에서 응답 데이터를 만드는 방법은 크게 3가지이다.
    • 정적 리소스
      예) 웹 브라우저에 정적인 HTML, css, js를 제공할 때는, 정적 리소스를 사용한다.
    • 뷰 템플릿 사용
      예) 웹 브라우저에 동적인 HTML을 제공할 때는 뷰 템플릿을 사용한다.
    • HTTP 메시지 사용
      HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.

정적 리소스

  • 스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공한다.
    /static , /public , /resources , /META-INF/resources
  • src/main/resources 는 리소스를 보관하는 곳이고, 또 클래스패스의 시작 경로이다. 따라서 다음 디렉토리에 리소스를 넣어두면 스프링 부트가 정적 리소스로 서비스를 제공한다.
  • 정적 리소스 경로
    • src/main/resources/static 다음 경로에 파일이 들어있으면
    • src/main/resources/static/basic/hello-form.html
    • 웹 브라우저에서 다음과 같이 실행하면 된다.
      http://localhost:8080/basic/hello-form.html
      정적 리소스는 해당 파일을 변경 없이 그대로 서비스하는 것이다.

뷰 템플릿 사용

  • 뷰 템플릿을 거쳐서 HTML이 생성되고, 뷰가 응답을 만들어서 전달한다.
    일반적으로 HTML을 동적으로 생성하는 용도로 사용하지만, 다른 것들도 가능하다. 뷰 템플릿이 만들 수 있는 것이라면 뭐든지 가능하다.
  • 뷰 템플릿 경로
    • src/main/resources/templates
  • 뷰 템플릿 생성
    • src/main/resources/templates/response/hello.html
  • ResponseViewController - 뷰 템플릿을 호출하는 컨트롤러
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
@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");
    }

}
  • 3가지 정도 방법 존재
    • 기존 ModelAndView반환
    • String을 반환하는 경우
      • View or HTTP 메시지@ResponseBody 가 없으면 response/hello 로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 한다.
      • @ResponseBody 가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello 라는
        문자가 입력된다.
      • 여기서는 뷰의 논리 이름인 response/hello 를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는 것을 확인할 수 있다.
    • Void를 반환하는 경우(권장안함)
      • @Controller 를 사용하고, HttpServletResponse , OutputStream(Writer) 같은 HTTP 메시지바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용
      • 요청 URL: /response/hello
        실행: templates/response/hello.html
      • 참고로 이 방식은 명시성이 너무 떨어지고 이렇게 딱 맞는 경우도 많이 없어서, 권장하지 않는다.
    • HTTP 메시지
      • @ResponseBody , HttpEntity 를 사용하면, 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 응답 데이터를 출력할 수 있다.

Thymeleaf 스프링 부트 설정
build.gradleimplementation ‘org.springframework.boot:spring-boot-starter-thymeleaf’``

application.properties 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

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

  • HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.
  • 추후에 배우겠지만 @ResponseBody인 경우 viewRevoler 대신에 HttpmessageConverter가 동작하며, 대상이
    • string일경우 StringConverter가 동작
    • 기본 객체 처리는 MappingJackson2HttpMessageConverter가 동작(기본 json반환)

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

  • ResponseBodyController
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
@Controller
@Slf4j
@ResponseBody
@RestController //@ResponseBody+ @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";
    }

    @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 응답 코드를 설정할 수 있다.
    • HttpStatus.CREATED 로 변경하면 201 응답이 나가는 것을 확인할 수 있다.
  • responseBodyV3
    • @ResponseBody 를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있다. ResponseEntity 도 동일한 방식으로 동작한다.
  • responseBodyJsonV1
    • ResponseEntity 를 반환한다. HTTP 메시지 컨버터를 통해서 JSON 형식으로 변환되어서 반환된다.
  • responseBodyJsonV2
    • ResponseEntity 는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody 를 사용하면 이런 것을 설정하기 까다롭다. @ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다.
    • 물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다. 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity 를 사용하면 된다.
  • @RestController
    • @Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody 가 적용되는 효과가 있다. 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다. 이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러이다.

HTTP 메시지 컨버터

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

@ResponseBody사용원리

스크린샷 2022-06-30 오후 11.35.27.png

@ResponseBody 를 사용

  • HTTP의 BODY에 문자 내용을 직접 반환
  • viewResolver 대신에 HttpMessageConverter 가 동작
  • 기본 문자처리: StringHttpMessageConverter
  • 기본 객체처리: MappingJackson2HttpMessageConverter
  • byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

참고: 응답의 경우 클라이언트의 HTTP Accept 해더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해서 HttpMessageConverter 가 선택된다. 더 자세한 내용은 스프링 MVC 강의에서 설명하겠다.

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

  • HTTP 요청: @RequestBody , HttpEntity(RequestEntity)
    • 요청이 들어오면 bodymessage가 있다면 HTTP메시지 컨버터를 사용하여 변환후 @RequestBody 로 객체든, 스트링, 바이트형식이든 넘겨준다.
  • HTTP 응답: @ResponseBody , HttpEntity(ResponseEntity)
    • 응답 전 HTTP메시지 컨버터를 사용하여 객체든, 스트링, 바이트형식을 응답타입으로 변환후 bodymessage에 박아준다.

HTTP 메시지 컨버터 인터페이스

  • StringHttpMessageConverter, MappingJackson2HttpMessageConverter 등의 조상
  • org.springframework.http.converter.HttpMessageConverter
1
2
3
4
5
6
7
8
9
10
11
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 응답 둘 다 사용된다.
    1. canRead() , canWrite() : 메시지 컨버터가 해당 클래스, 미디어타입을 지원하는지 체크
    2. read() , write() : 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능

스프링 부트 기본 메시지 컨버터(!!!)

1
2
3
0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter
  • 스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 둘을 체크해서사용여부를 결정한다. 만약 만족하지 않으면 다음 메시지 컨버터로 우선순위가 넘어간다.
  • 아래 내용은 요청은 처리과정은 컨트롤러에 @RequestBody byte[] data 확인 → byte[] 클래스 타입 처리가능한 httpmessageconverter canRead()로 찾기 → 해당 httpmessageconverter로 read() 호출 → byte[]로 된 결과 data 객체에 넣음

참고로 요청은 바이트 으로 처음 들어오기때문에 거의 그대로 전달, 하지만 String, 객체 등은 http메시지 컴버터를 통해 바이트를 해당 타입에 맞게 해석한다.!!!

  • 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 관련

다시 정리

  • 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 응답 메시지 바디에 데이터를 생성한다.

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

  • 그렇다면 HTTP 메시지 컨버터는 스프링 MVC 어디쯤에서 사용되는 것일까? 다음 그림에서는 보이지 않는다.

SpringMVC구조

스크린샷 2022-07-01 오전 2.50.59.png

  • 구조를 보면 핸들러가 일처리 직전 직후는 핸들러 어댑터가 항상 먼저있다. 따라서 이곳에 httpessageconverter가있다!
  • 모든 비밀은 애노테이션 기반의 컨트롤러, 그러니까 @RequestMapping 을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter (요청 매핑 헨들러 어뎁터)에 있다.

RequestMappingHandlerAdapter 동작 방식

스크린샷 2022-07-01 오전 2.53.33.png

  • 실제 핸들러(컨트롤러)의 파라미터에있는 것들은 모두 핸들러 어댑터가 데이터를 생성하여 넘겨줘야한다!!!!!!!!

ArgumentResolver(=HandlerMethodArguementResolver)

  • 모든 Argument(매개변수)처리해주는것
  • 생각해보면, 애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다. HttpServletRequest , Model은 물론이고, @RequestParam , @ModelAttribute 같은 애노테이션 그리고 @RequestBody , HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다.
    이렇게 파라미터를 유연하게 처리할 수 있는 이유가 바로 ArgumentResolver 덕분이다.
  • 애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdapter 는 바로 이 ArgumentResolver 를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다. 그리고 이렇게 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.
  • 정확히는 HandlerMethodArgumentResolver 인데 줄여서 ArgumentResolver 라고 부른다.

동작 방식

  • ArgumentResolver 의 supportsParameter() 를 호출해서 해당 파라미터를 지원하는지 체크하고, 지원하면 resolveArgument() 를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다.
  • 그리고 원한다면 여러분이 직접 이 인터페이스를 확장해서 원하는ArgumentResolver 를 만들 수도 있다. 실제 확장하는 예제는 향후 로그인 처리에서 진행하겠다.

ReturnValueHandler

  • HandlerMethodReturnValueHandler 를 줄여서 ReturnValueHandler 라 부른다. ArgumentResolver 와 비슷한데, 이것은 응답 값을 변환하고 처리한다.컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler 덕분이다.
  • 어떤 종류들이 있는지 살짝 코드로 확인만 해보자.
    스프링은 10여개가 넘는 ReturnValueHandler 를 지원한다.
    예) ModelAndView , @ResponseBody , HttpEntity , String
  • https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-return-types

HTTP 메시지 컨버터

HTTP 메시지 컨버터 위치

스크린샷 2022-07-01 오전 3.13.12.png

  • HTTP 메시지 컨버터는 어디쯤 있을까?
    HTTP 메시지 컨버터를 사용하는 @RequestBody 도 컨트롤러가 필요로 하는 파라미터의 값에 사용된다. @ResponseBody 의 경우도 컨트롤러의 반환 값을 이용한다.
  • 요청의 경우
    @RequestBody 를 처리하는 ArgumentResolver 가 있고, HttpEntity 를 처리하는 ArgumentResolver 가 있다. 이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다. (어떤 종류가 있는지 코드로 살짝 확인해보자)
  • 응답의 경우 @ResponseBody 와 HttpEntity 를 처리하는 ReturnValueHandler 가 있다. 그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.
  • 결국 messageBody를 이용하기위해, 쓰기위해선 항상 HTTP 메시지 컨버터가 호출되어 처리한후 반환한다.
  • 실제로 HttpEntityMethodProcessor 는 HandlerMethodArguemtResolver의 자손이며, 아래와같이 supportsParameter()내용을 보면 HttpEntity.class, RequestEntity.class를 지원하는것을 알수있다. 그리고 객체 생성중에 readWithMessageConverter()안에 HTTP메세지 컨버터를 돌림.
  • 스프링 MVC는 @RequestBody @ResponseBody 가 있으면
    RequestResponseBodyMethodProcessor (ArgumentResolver)
    HttpEntity 가 있으면 HttpEntityMethodProcessor (ArgumentResolver)를 사용한다.
1
2
3
4
5
6
public class HttpEntityMethodProcessor extends AbstractMessageConverterMethodProcessor {
@Override
	public boolean supportsParameter(MethodParameter parameter) {
		return (HttpEntity.class == parameter.getParameterType() ||
				RequestEntity.class == parameter.getParameterType());
	}

확장

  • 스프링은 다음을 모두 인터페이스로 제공한다. 따라서 필요하면 언제든지 기능을 확장할 수 있다.
    • HandlerMethodArgumentResolver
    • HandlerMethodReturnValueHandler
    • HttpMessageConverter
  • 스프링이 필요한 대부분의 기능을 제공하기 때문에 실제 기능을 확장할 일이 많지는 않다. 기능 확장은 WebMvcConfigurer 를 상속 받아서 스프링 빈으로 등록하면 된다. 실제 자주 사용하지는 않으니 실제 기능 확장이 필요할 때 WebMvcConfigurer 를 검색해보자.
CATALOG
  1. 1. 스프링 MVC 1편 CH06
  2. 2. 프로 젝트 생성
    1. 2.1. Welcome페이지 만들기
  3. 3. 로깅 간단히 알아보기
    1. 3.1. 로깅 라이브러리
    2. 3.2. 로그 정보
    3. 3.3. 로그 선언
    4. 3.4. 로그 호출
    5. 3.5. 매핑 정보
    6. 3.6. 로그레벨 설정
    7. 3.7. 올바른 로그 사용법
    8. 3.8. 로그 사용시 장점
    9. 3.9. 추가자료 (!!!)
  4. 4. 요청 매핑
    1. 4.1. 매핑 정보
    2. 4.2. HTTP 메서드 매핑
    3. 4.3. HTTP 메서드 매핑 축약
    4. 4.4. PathVariable(경로 변수) 사용(!!!)
    5. 4.5. PathVariable 사용 - 다중
    6. 4.6. 특정 파라미터 조건 매핑
    7. 4.7. 특정 헤더 조건 매핑
    8. 4.8. 미디어 타입 조건 매핑 - HTTP 요청 Content-Type, consume
    9. 4.9. 미디어 타입 조건 매핑 - HTTP 요청 Accept, produce
  5. 5. 요청 매핑 - API예시
    1. 5.1. 실습
  6. 6. HTTP 요청 - 기본, 헤더 조회
  7. 7. HTTP 요청 파라미터
    1. 7.1. 쿼리 파라미터, HTML Form
      1. 7.1.1. 개요
    2. 7.2. @RequestParam 사용
    3. 7.3. HTTP 요청 파라미터 - @ModelAttribute
      1. 7.3.1. @ModelAttribute적용전
      2. 7.3.2. @ModelAttribute적용후
      3. 7.3.3. @ModelAttribute적용후 v2
  8. 8. HTTP 요청 메시지
    1. 8.1. 단순 텍스트(!!!)
      1. 8.1.1. 정리
    2. 8.2. HTTP 요청 메시지 - JSON
  9. 9. HTTP 응답
    1. 9.1. 정적 리소스, 뷰 템플릿
      1. 9.1.1. 정적 리소스
      2. 9.1.2. 뷰 템플릿 사용
    2. 9.2. HTTP 응답 - HTTP API, 메시지 바디에 직접 입력
  10. 10. HTTP 메시지 컨버터
    1. 10.1. @ResponseBody사용원리
    2. 10.2. @ResponseBody 를 사용
    3. 10.3. 스프링 MVC는 다음의 경우에 HTTP 메시지 컨버터를 적용한다.(!!!)
      1. 10.3.1. HTTP 메시지 컨버터 인터페이스
      2. 10.3.2. 스프링 부트 기본 메시지 컨버터(!!!)
      3. 10.3.3. 다시 정리
  11. 11. 요청 매핑 헨들러 어뎁터 구조 (RequestMappingHandlerAdapter)
    1. 11.1. SpringMVC구조
    2. 11.2. RequestMappingHandlerAdapter 동작 방식
      1. 11.2.1. ArgumentResolver(=HandlerMethodArguementResolver)
      2. 11.2.2. 동작 방식
      3. 11.2.3. ReturnValueHandler
    3. 11.3. HTTP 메시지 컨버터
      1. 11.3.1. HTTP 메시지 컨버터 위치
      2. 11.3.2. 확장







Total : 224
2024
2023
2022
2021
2020
2019
Review Book Spring Basic DB Mybatis Lombok MessageQ Kafka JPA Advance Vue Project CS Notion Domain Network Mysql API DRF hanbik Junior Devfest HTTPie WebBasic Http Tip Java Issue Elastic Beanstalk AWS Jquery Html FrontEnd Javascript Git Coding Structure Interview OS Web Session Logger R Univ Jenkins Thymeleaf AOP Basic. Python Library Python Tips Knowledge Socket Django ClassView Threading Data Mechanism Advanced Serializer Djagno Docker Dataminging Statistics Endofyear Finish Restart Realestate Excel Skill Aws Drf GDG Google Festival Frontend Ajax Gitlab CI-CD Important Css Front-End Https Ssl Server basic Apt Kakao Problem Nginx Proxy Outsourcing Wsgi QueryDSL Jpa How Linux Ubuntu Ssh PEP Building Analysis Form Thinking English Markdown HTTP Websocket Wordpress TDD Testcode
Review Maven Mybatis Spring ETC MessageQ JPA Vue CS Tips DB API Conference HTTPie Network WebBasic Issue Elastic-Beanstalk Java Jquery Javascript Git OS R Jenkins Basic Library Knowledge Chatting Django Data-Mining Coding DRF Skill Docker Statistics Endofyear realestate Excel Server Frontend Gitlab Tip Important Html-Css Project Kakao Outsourcing Python Report How Linux Analysis Form Thinking Ubuntu Html Markdown TDD