[Spring] Request 어노테이션 (parameter mapping)

Request가 들어오는 타입에 따라 받는 방식이 나뉜다.

1. URI
2. Query String
3. body
4. form

---

@PathVariable

@GetMapping( "/api/v1/customers/{customerId}")
@ResponseBody
public ResponseEntity<Customer> findCustomer(@PathVariable("customerId") UUID customerId){
    var customer = customerService.getCustomer(customerId);
    return customer.map(v -> ResponseEntity.ok(v)).orElse(ResponseEntity.notFound().build());
}

URI 변수를 통해 Request가 들어오는 타입

http://localhost/api/v1/customers/{customerId}

: 일반적을 GET 방식의 파라미터 전달로 흔히 볼수있는 URI를 이용하여 파라미터 처리하는 방식

: GetMapping 뿐만 아니라 당연히 다른 Method도 가능하다.

 

 

파라미터가 전달되지않았을 경우를 대비하여 에러가 발생하지않게 다음과 같은 처리도 가능하다.

(required = false)을 설정하면 값이 없을 경우 null로 설정한다.

@GetMapping(value = { "/api/v1/customers", "/api/v1/customers/{customerId}" })
@ResponseBody
public String getEmployeesByIdWithRequired(@PathVariable(required = false) UUID customerId) {
    if(custmoerId == null) 
        //....
    else {
      	var cutomer = customerService.getCustomer(customerId);
        //....
    }
}

https://www.baeldung.com/spring-pathvariable

 

 

@RequestParam

@GetMapping("api/v1/products")
@ResponseBody
public List<Product> productList(@RequestParam Optional<String> category){
    return category
            .map(productService::getProductByCategory)
            .orElse(productService.getAllProducts()); 
						// optional map 메소드를 사용하면 객체를 변환할 수 있다. 비어 있을 경우 연산을 수행하지 않는다.
}

• 사용자가 요청시 전달하는 값을 Controller 의 매개변수로 1:1 맵핑할 때 사용되는 어노테이션

 

Query String으로 값이 전달될 경우 파라미터값으로 넘겨 받을 수 있다.

http://localhost/api/v1/products?category=

: GET 메소드를 통해 위와같은 URL로 값을 전달 받을 수 있다.

 

 

HTML 태그의 Form 데이터를 POST 메소드로 전송할때도 값을 받을 수 있다.

: @RequestParam 은 url 상에서 데이터를 찾는다. <form> 태그를 이용하여 데이터를 입력하고 제출 버튼을 누르면 입력한 데이터들이 위와같은 url을 통해서 전달된다.

https://amagrammer91.tistory.com/106

 

 

@RequestBody

@PostMapping("/api/v1/orders")
@ResponseBody
public Order createOrder(@RequestBody CreateOrderRequest createOrderRequest){
    return orderService.createOrder(
           new Email(createOrderRequest.email()),
            createOrderRequest.address(),
            createOrderRequest.postcode(),
            createOrderRequest.orderItems()
    );
}

Json 형태의 HTTP Body를 통한 request를 받을 수 있다.

: MessageConverter를 통한 데이터 변환 과정을 거쳐 java 객체를 자동객체 생성해준다.

: @RequestBody를 사용할 객체는 필드를 바인딩할 생성자나 setter 메서드가 필요없다.

• 다만 직렬화를 위해 기본 생성자는 필수다.
• 또한 데이터 바인딩을 위한 필드명을 알아내기 위해 getter나 setter 중 1가지는 정의되어 있어야 한다.

 

 

---

 

Query String 및 Form 형식으로 받은 데이터를 java 객체로 변환시켜주고 싶다면 @ModelAttribute 어노테이션을 사용한다.

https://tecoble.techcourse.co.kr/post/2021-05-11-requestbody-modelattribute/

@RequestBody vs @ModelAttribute

 

 

 

잘못된 정보가 있다면 댓글을 통해 알려주세요. 감사합니다.