[Spring Boot] @PathVariable vs. @RequestParam 뭘 써야할까? (feat.@QueryParam)

프로젝트를 할 때 매개변수 받아서 특정 자원을 조회하고 싶을 때

(ex. id가 10인 게시글을 보고싶을 때)

쓰는 방법으로 대표적으로

@PathVariable을 많이 씀.

​

근데 @ReqeustParam도 어디서 봤는데,

둘 중 뭘써야할까!!

​

어떨 때 무엇을 써야할까..정리해보겠음

​

---

@PathVariable

가장 많이 쓰이는 방식인데,

 

@GetMapping("/api/articles/{id}")
    public ResponseEntity<ArticleResponseDto> findArticle(@PathVariable("id") Long id) {

        Article article = blogService.findById(id);

        return ResponseEntity.ok().body(new ArticleResponseDto(article));
}

 

이런식으로 특정 자원을 조회할 때 씀!!!

articles에서 id가 10인걸 보고싶으면

​

URL이

GET api/artibles/10

 

 

이런식으로 매우 RESTful한 방식이 됨.

​

그럼 전부 이걸 쓰면 되는거 아니냐

​

다른 방식은 왜 잇는걸까??

 

---

@RequestParam

위 소스코드를 그대로 RequestParam으로 바꿔보면

 

 

@GetMapping("/api/articles")
public ResponseEntity<ArticleResponseDto> findArticle(@RequestParam("id") Long id) {

    Article article = blogService.findById(id);

    return ResponseEntity.ok().body(new ArticleResponseDto(article));
}

이렇게 됨.

​

생긴건 거의 비슷한데,

​

RequestParam은 이럴때 쓰는게 아님@!!!!

 

 

@GetMapping("/api/articles")
public ResponseEntity<List<ArticleResponseDto>> findArticles(
        @RequestParam(required = false) String title,
        @RequestParam(required = false) String author,
        @RequestParam(defaultValue = "0") int page,
        @RequestParam(defaultValue = "10") int size
) {
    List<Article> articles = blogService.searchArticles(title, author, page, size);

    List<ArticleResponseDto> response = articles.stream()
            .map(ArticleResponseDto::new)
            .toList();

    return ResponseEntity.ok().body(response);
}

RequestParam은 이런식으로

여러 검색 조건, 필터링, 페이징 등을 걸고 싶을때

빛을 발하는 어노테이션임

​

​

이렇게 되면 요청 URL이

GET /api/articles?title=JPA&author=홍길동&page=0&size=5

 

이런식으로 되는거임.

 

 

---

챗지피티가 이러케 정리해줌

 

---

추가)
@QueryParam 은 뭘까?

@RequestParam이랑 똑같은 애라고 보면 됨

다만!!!!!!

​

@RequestParam은 소속이 Spring MVC

@QueryParam은 소속이 JAX-RS

​

스프링은 자체 프레임워크인 Spring MVC를 쓰기 때문에

내가 스프링부트로 프젝 하고있다 하면

@QueryParam은 쓸일이 없음.