스프링MVC - 요청 매핑(@RequestMapping)

Spring/Spirng MVC - 기본기능

스프링MVC - 요청 매핑(@RequestMapping)

진이최고다 2023. 3. 27. 22:25

@RequestMapping

스프링 MVC에서 요청 매핑을 처리하는 어노테이션 중 가장 기본적으로 사용되는 어노테이션이며,

어노테이션은 컨트롤러 클래스 또는 메서드에 적용할 수 있으며, 요청 경로와 HTTP 메서드에 대한 매핑 정보를 지정한다.

value 또는 path: 요청 경로를 지정한다. 다중 값으로 지정할 수 있다.
method: HTTP 요청 메서드를 지정한다. GET, POST, PUT, DELETE, PATCH 등을 사용할 수 있으며, 다중 값으로 지정할 수 있다.
params: 요청 매개변수를 지정한다. "param=value" 형식으로 지정하며, 값이 없는 경우엔 "param!=value" 형식으로 지정할 수 있다.
headers: 요청 헤더를 지정합니다. "header=value" 형식으로 지정하며, 값이 없는 경우엔 "header!=value" 형식으로 지정할 수 있다.

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MappingController {

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

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

@RestController는
@Controller와 달리 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 직접 입력되어
/hello-basic 경로로 요청이 들어오면 helloBasic() 메서드가 실행되도록 @RequestMapping("/hello-basic")을 사용하여 매핑 정보를 설정했다.
따라서, 반환 값인 "ok" 문자열이 HTTP 응답 메시지의 본문에 담겨서 클라이언트로 전송된다.

💡대부분의 속성을 배열[] 로 제공하므로 다중 설정이 가능하다. {"/hello-basic", "/hello-go"}

HTTP 메서드 매핑

@RestController
public class MappingController {

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

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

@RequestMapping 에 method 속성으로 HTTP 메서드를 지정하지 않으면 HTTP 메서드와 무관하게 호출된다.

💡모두 허용 : GET, HEAD, POST, PUT, PATCH, DELETE

💣만약 여기에 POST 요청을 하면 스프링 MVC는 HTTP 405 상태코드(Method Not Allowed)를 반환한다

HTTP 메서드 매핑 축

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

HTTP 메서드를 축약한 애노테이션을 사용하는 것이 더 직관적이다.

👇 코드를 보면 내부에서 @RequestMapping 과 method 를 지정해서 사용하는 것을 확인할 수 있다.

@RequestMapping(method = RequestMethod.GET)
public @interface GetMapping {

PathVariable(경로변수)사용 ⭐️⭐️⭐️⭐️⭐️

/**
 * PathVariable 사용
 * 변수명이 같으면 생략 가능
 * @PathVariable("userId") String userId -> @PathVariable userId
 */
@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable("userId") String data) {
    log.info("mappingPath userId={}", data);
    return "ok";
}

실행 : http://localhost:8080/mapping/userA

h.s.b.requestmapping.MappingController : mappingPath userId=userA

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

/mapping/userA
/users/1
@RequestMapping 은 URL 경로를 템플릿화 할 수 있는데, @PathVariable 을 사용하면 매칭 되는 부분을 편리하게 조회할 수 있다.
@PathVariable 의 이름과 파라미터 이름이 같으면 생략할 수 있다.

PathVariable 사용 - 다중

/**
 * 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

h.s.b.requestmapping.MappingController : mappingPath userId=userA, orderId=100

특정 파라미터 조건 매핑

/**
 * 파라미터로 추가 매핑
 * 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://localhost:8080/mapping-param?mode=debug

h.s.b.requestmapping.MappingController : mappingParam

💡특정 파라미터가 있거나 없는 조건을 추가할 수 있다. 잘 사용하지는 않는다.

특정 헤더 조건 매핑

/**
 * 특정 헤더로 추가 매핑
 * 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 헤더를 사용한다. Postman으로 테스트 해야 한다.

미디어 타입 조건 매핑 - HTTP 요청 Content-Type, consume

/**
 * Content-Type 헤더 기반 추가 매핑 Media Type
 * consumes="application/json"
 * consumes="!application/json"
 * consumes="application/*"
 * consumes="*\/*"
 * MediaType.APPLICATION_JSON_VALUE
 */
@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)을 반환한다.

예시) consumes

consumes = "text/plain"
consumes = {"text/plain", "application/*"}
consumes = MediaType.TEXT_PLAIN_VALUE

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

/**
 * Accept 헤더 기반 Media Type
 * produces = "text/html"
 * produces = "!text/html"
 * produces = "text/*"
 * produces = "*\/*"
 */
@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)을 반환한다.

예시)

produces = "text/plain"
produces = {"text/plain", "application/*"}
produces = MediaType.TEXT_PLAIN_VALUE
produces = "text/plain;charset=UTF-8

출처 : 인프런 - 스프링 MVC 1편 by 우아한형제 김영한이사님