@PathVariable

2023. 2. 24. 11:27@Annotaion Book

@PathVariable 어노테이션은 Spring MVC에서 사용되며, URL 경로에 포함된 변수 값을 메서드 파라미터로 받아올 때 사용합니다. 일반적으로 RESTful API에서 자주 사용됩니다.

예를 들어, /user/{id}와 같은 URL 경로에서 {id} 부분을 파라미터로 받아와서 처리하는 경우에 @PathVariable 어노테이션을 사용할 수 있습니다.

아래는 @PathVariable 어노테이션을 사용한 예시 코드입니다.

@GetMapping("/users/{id}")
public User getUser(@PathVariable Long id) {
    User user = userService.getUserById(id);
    return user;
}

위 코드에서는 @GetMapping 어노테이션을 사용하여 HTTP GET 요청을 처리하고 있습니다. URL 경로의 /users/{id}에서 {id} 부분은 @PathVariable 어노테이션을 사용하여 메서드 파라미터로 받아올 수 있습니다. 이렇게 받아온 id 값을 사용하여 userService.getUserById() 메서드를 호출하고, 해당하는 사용자 정보를 반환합니다.

@PathVariable 어노테이션은 다양한 옵션을 제공합니다. 가령, 변수 이름과 경로 변수 이름이 다를 경우 @PathVariable("경로변수이름")과 같이 어노테이션에 변수 이름을 명시할 수 있습니다. 또한, 기본값을 지정하거나 값의 타입을 변경하는 등의 설정도 가능합니다.

Spring MVC에서는 @PathVariable 어노테이션을 사용하여 URL 경로에 포함된 변수 값을 메서드 파라미터로 간단하게 받아올 수 있어, RESTful API를 개발할 때 매우 유용합니다.

'@Annotaion Book' 카테고리의 다른 글

자주 사용하는 어노테이션  (0) 2023.02.24
@Data  (0) 2023.02.24
@RequiredArgsConstructor  (0) 2023.02.24
@RestController  (0) 2023.02.24
@PreAuthorize  (0) 2023.02.24