Chae Seungmin

DevOps & carefree life [TMON] Channel Service Dev. Team

4 minute read

@RequestMapping 다중 설정

@RequestMapping({"/carefree/v1", "/carefree/v3"})
  • @RequestMapping() 은 대부분의 속성을 배열[]로 제공한다.
    • 따라서 위와 같이 기존 괄호() 안에 중괄호{}를 배치하여 중괄호{} 안에 , 로 분리된 서로 다른 여러 URL을 지정할 수 있다.
    • 그 결과로 서로 다른 URL에 요청이 오더라도 같은 메소드를 실행하여 같은 값(뷰 or String)을 반환할 수 있다.



HTTP 메서드

  • @RequestMapping에 method속성으로 HTTP 메서드를 지정하여 각 HTTP 요청을 분류하여 호출 여부를 정할 수 있다.
    • method 속성의 지정이 없을 경우 모든 HTTP 요청을 허용, 메서드 호출.
    • @RequestMapping(value = "/carefree", method = "RequestMethod.GET")
// 'method = ' 에 특정된 HTTP 메서드 요청만 허용하여 호출됨.
// GET, HEAD, POST, PUT, PATCH, DELETE 메서드가 있다.
  • 만약 특정된 메서드 외의 요청을 하면 MVC는 HTTP 405 (Method Not Allowed)를 반환한다.



HTTP 메서드 매핑 간편하게 사용하기

  • 위와 같이 특정 HTTP 메서드 마다의 호출 허용을 위해 @RequestMapping(value = , method = ) 를 일일히 작성해야 하는 문제의 해결책으로 HTTP 메서드를 축약한 애노테이션이 있다.
    • @GetMapping
    • @PostMapping
    • @PutMapping
    • @DeleteMapping
    • @PatchMapping

  • 이전보다 더 직관적인 코드가 생성되므로 축약 애노테이션을 사용하는 것이 좋다. 

      /**
  * 편리한 축약 애노테이션 
  * @GetMapping
  * @PostMapping
  * @PutMapping
  * @DeleteMapping
  * @PatchMapping
  */
  @GetMapping(value = "/carefree-v2")
  public String mappingGetV2() {
    log.info("carefree-v2");
    return "ok";
  }



  • 위와 같은 HTTP 축약 메서드의 내부를 보면 @RequestMapping 과 해당 method 형태가 지정되어 있는 것을 볼 수 있다.
    • getmapping_Procdess
      @GetMapping의 내부 모습

  • 같은 URL을 지정 하더라도 HTTP 축약 애노테이션의 종류에 따라 다른 메서드를 호출 할 수 있다.
    • sameurl_Procdess
      같은 URL을 통해 요청하지만 GetMapping과 PostMapping은 각각 다른 메서드를 호출한다.



PathVariable(경로 변수)?

  • 최근 HTTP API는 다음과 같이 리소스 경로에 식별자를 넣는 스타일을 선호한다.
    • /carefree/user1
    • /members/2

  • @RequestMapping은 @PathVariable(경로 변수)를 사용하여 URL 경로를 템플릿화 할 수 있다.
@GetMapping("/carefree/{userId}") // URL 경로 + {경로 변수의 이름}
public String mappingPath(
        @PathVariable("userId") String data // PathVariable("경로 변수의 이름") + 파라미터 
        ) {
    log.info("mappingPath userId={}", data);
    return "ok";
}



  • 만약 @PathVariable의 이름과 파라미터의 이름이 같으면 아래와 같이 생략이 가능하다. 
    // "경로 변수의 이름" 과 파라미터의 이름이 같다.
public String mappingPath(@PathVariable("userId") String userId)
// -------------------생략---------------------
public String mappingPath(@PathVariable String userId)



@PathVariable 다중 사용

  • @PathVariable 의 다중 사용도 아래와 같이 가능하다.

@GetMapping("/carefree/users/{userId}/orders/{orderId}")
public String mappingPath(
        // @PathVariable 애노테이션은 생략할 수 없다.
        @PathVariable String userId, 
        @PathVariable Long orderId
        ) {
    log.info("mappingPath userId={}, orderId={}", userId, orderId);
    return "ok";
}



특정 헤더 조건 매핑

  • HTTP 요청에 특정 헤더가 포함되어있는 경우 실행
   /**
   *특정 헤더로 추가 매핑
   * 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 헤더를 기반하여 미디어 타입으로 매핑.
    • 만약 같지 않을 경우 HTTP 415(Unsupported Media Type) 반환.
/**
 * Content-Type 헤더 기반 추가 매핑 Media Type
 * 
 * * consumes="application/json"
 * consumes="!application/json"
 * consumes="application/*"
 * consumes="*\/*"
 * MediaType.APPLICATION_JSON_VALUE
 */
@PostMapping(value = "/mapping-consume", consumes = "application/json")
public String mappingConsumes() {
    log.info("mappingConsumes");
    return "ok";
}



  • HTTP 요청의 Accept 헤더를 기반하여 미디어 타입으로 매핑.
    • 만약 같지 않을 경우 HTTP 406(Not Acceptable) 반환.
/**
 * 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"
}



HTTP Request Header 조회

애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원하여
HTTP Request Header 의 많은 정보를 받아올 수 있다.

HTTP 요청 메시지의 헤더에서 파라미터로 받아 올 수 있는 요소들

  • HTTPServletRequest / HTTP ServletResponse
  • HttpMethod : Get, Post, Put, Patch, Delete 등의 Http Method를 조회 할 수 있다.
    • org.springframework.http.HttpMethod
  • Locale : Locale 정보를 조회한다 (각 나라별 언어 정보)
  • @RequestHeader MultiValueMap<String, String> headerMap
    • 모든 HTTP Header를 MultiValueMap 형식으로 조회한다.
      • MultiValueMap<key, value> 이란?
        • Map과 유사하나, 하나의 키에 여러 값을 받을 수 있다.
        • HTTP header, HTTP 쿼리 파라미터와 같이 하나의 키에 여러 값을 받을 때 사용한다.
        • keyA=value1&keyA=value2
        • MultiValueMap<String, String> map = new LinkedMultiValueMap();
map.add("keyA", "value1");
map.add("keyA", "value2");
          
List<String> values = map.get("keyA"); // 실행결과: [value1,value2]



HTTP 요청 파라미터 - Query Parameter, HTML Form

HTTP 요청 메시지를 통해 Client 에서 Server로 데이터를 전달하는 방법을 알아보자.

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

  1. GET - Query Parameter
    • /url?username=carefree&age=26
    • message body 없이 URL의 Query Parameter 에 데이터를 포함해서 전달.
    • 검색, 필터, 페이징 등에서 많이 사용하는 방식이다.
  2. POST - HTML Form
    • content-type:application/x-www-form-urlencoded
    • 메시지 바디에 QueryParameter 형식으로 전달. username=carefree&age=26
    • 회원가입, 상품 주문 등의 작업에서 많이 사용하는 방식.
  3. HTTP message body 에 데이터를 직접 담아서 요청
    • HTTP API 에서 주로 사용한다. (JSON, XML, TEXT)
    • 데이터 형식을 주로 JSON 사용
    • POST, PUT, PATCH



요청 파라미터 - Query Parameter, HTML Form

  • HTTPServletRequest 의 request.getParameter() 을 사용하여 다음 두 가지 요청 파라미터를 조회할 수 있다.
    • Get - Query Parameter 를 통한 전송
      • ex. http://localhost:8080/request-param?username=carefree&age=26
    • Post - HTML Form을 통한 전송
      • ex. ```java POST /request-param … content-type: application/x-www-form-urlencoded

      username=carefree&age=26 ```



최대한의 설명을 코드 블럭 내의 주석으로 달아 놓았습니다.

혹시 이해가 안가거나 추가적인 설명이 필요한 부분, 오류 등의 피드백은 언제든지 환영합니다!

긴 글 읽어주셔서 감사합니다. 포스팅을 마칩니다.



처음으로~

참고:Inflearn - 김영한님_강의

Task Lists

  • @RequestMapping 다중 설정
  • HTTP 메서드
  • HTTP 메서드 매핑 간편하게 사용하기
  • PathVariable(경로 변수)?
  • @PathVariable 다중 사용
  • 특정 헤더 조건 매핑
  • 미디어 타입 조건 매핑

Comments

You May Also Enjoy