[Spring] URI 조립을 위한 ServletUriComponentsBuilder

 

 

ServletUriComponenetsBuilder

Rest API를 구현하다 보면 사용자로부터 요청이 왔을 때 특정값을 포함한 URI를 전달해야하는 상황이 발생할 수 있다. 이 때 사용하는 것이 ServletUriComponenetsBuilder다. ServletUriComponenetsBuilder를 통해 적절한 URI를 만들고 요청한 사용자에게 특정값을 포함한 URI를 전달할 수 있다.

ServletUriComponenetsBuilder는 UriComponenetsBuilder를 상속받는 클래스다. ServletUriComponenetsBuilder는 이전 요청의 URI를 재사용하여 보다 편리한 URI를 사용할 수 있도록 도와준다.

주로 파일 업로드 후 파일 다운로드 경로를 사용자에게 보내주고자할 때 자주 사용한다.

@PostMapping("/users")
public ResponseEntity<User> createUser(@RequestBody User user) {
    User savedUser = service.save(user);

    URI location = ServletUriComponentsBuilder.fromCurrentRequest()  // 사용자 요청 URI
            .path("/{id}")  // builderAndExpand를 통해 얻은 값이 들어온다.
            .buildAndExpand(savedUser.getId())   // .path("{/id}") 의 id 값에 들어올 값
            .toUri();  // URI 생성

    return ResponseEntity.created(location).build();
}

 

 

 

 

---

👀 참고 자료

https://blog.naver.com/PostView.naver?blogId=aservmz&logNo=222322019981&parentCategoryNo=&categoryNo=&viewDate=&isShowPopularPosts=false&from=postView 

[Spring] 38. 스프링에서 URI 조립을 위한 UriComponentsBuilder

 

https://pooney.tistory.com/65

Spring boot ServletUriComponentsBuilder

 

https://tecoble.techcourse.co.kr/post/2021-05-10-response-entity/

ResponseEntity - Spring Boot에서 Response를 만들자