Spring WebFlux - Annotated Controller with reactor Tutorial
Introduction
이번 글에서는 이전에 작성한 Spring WebFlux - Functional Endpoint With Coroutine Tutorial에 이어 Spring WebFlux를 이용한 또다른 방식의 API를 만들어보는 글을 작성해 보겠다.
이전 글에서는 함수형 앤드포인트방식을 이용하여 API를 만들었는데 이 글에서는 Annotation 기반 컨트롤러방식으로 API를 구현하는 방법에 대해서 다루어 보겠다.
Annotated Controller
Annotated Controller방식은 Spring MVC로 개발을 해본 개발자라면 아주 익숙한 방식으로 개발할 수 있다. 다만 차이가 있다면 반환 값이 Mono 또는 Flux로 감싸져 있다는 것이다. 자세한 내용은 링크를 참고하자.
Reactor
Reactor는 JVM에서 반응형 스트림을 기반으로 비 차단 어플리케이션을 구축하기 위한 반응형 라이브러리이다. 0..1개의 시퀀스를 처리하기 위한 Mono와 0..N개의 시퀀스를 처리하기 위한 Flux 타입이 있다.
Getting Start
이제 주석 기반 컨트롤러 방식으로 간단한 Web API를 만들어 보자. 프로젝트 생성은 이전 글의 Getting Start에서 생성한 프로젝트에서 아래의 의존성을 추가하여 진행하면 된다.
Gradle
주석 기반 컨트롤러는 아래와 같이 WebFlux를 사용하기 위한 의존성만 추가하면 된다.
implementation("org.springframework.boot:spring-boot-starter-webflux")
Controller
Controller를 추가하자.
먼저 PersonController 클래스를 생성하자. 우리는 API를 위한 Controller를 추가하는 것이므로 @RestController 어노테이션을 추가하면 된다. 그런다음 기본 라우팅 경로를 설정하기 위해 @RequestMapping 어노테이션을 추가한다. 데이터베이스에 요청받은 데이터를 저장하기 위해 PersonRepository를 생성자로 주입받는다.
@RestController
@RequestMapping("/persons")
class PersonController(private val repository: PersonRepository)
저장 요청을 다루는 함수를 추가한다. 사용자의 저장요청을 Repository에 전달하고 HTTP 응답을 반환한다. Spring MVC와 다른점은 @RequestBody의 타입이 Mono<Person>이라는 점과 반환값의 타입이 Mono<ResponseEntity<Unit>>이라는 점이다.
@PostMapping
fun create(@RequestBody requestBody: Mono<Person>): Mono<ResponseEntity<Unit>> {
return requestBody
.flatMap { repository.save(it) }
.map { ResponseEntity.created(URI.create("/persons")).build<Unit>() }
}
모든 데이터 목록 조회 요청을 다루는 함수를 추가한다. 사용자의 조회 요청을 받으면 Repository에서 데이터를 조회하고 조회한 결과와 함께 HTTP 응답을 반환한다. 목록에 대한 응답값 유형으로 Flux<Person>을 사용하였다.
@GetMapping
fun findAll(): Flux<Person> {
return repository.findAll()
}
단일 데이터 조회 요청을 다루는 함수를 추가한다. URI의 경로에서 ID값을 가져와서 Repository에서 데이터를 조회하고 조회한 결과와 함께 HTTP 응답을 반환한다. 만약 ID가 존재하지 않는다면 Bad Request 응답을 반환한다. 반환값의 타입은 Mono<ResponseEntity<Person>>을 사용하였다.
@GetMapping("/{id}")
fun findById(@PathVariable("id") id: Long): Mono<ResponseEntity<Person>> {
return repository.findById(id)
.map { ResponseEntity.ok(it) }
.defaultIfEmpty(ResponseEntity.badRequest().build())
}
수정 요청을 다루는 함수를 추가한다. URI의 경로에서 ID값을 가져와서 Repository에서 데이터를 조회하고 데이터가 존재한다면 해당 데이터를 수정 하는 함수를 호출한다. 만약 ID가 존재하지 않는다면 Bad Request 응답을 반환한다. 반환값의 타입은 Mono<ResponseEntity<Unit>>을 사용하였다.
@PutMapping("/{id}")
fun update(
@PathVariable("id") id: Long,
@RequestBody requestBody: Mono<Person>
): Mono<ResponseEntity<Unit>> {
return repository.existsById(id)
.zipWith(requestBody)
.flatMap {
if (it.t1)
Mono.just(it.t2.copy(id = id))
else
Mono.empty()
}
.flatMap { repository.save(it) }
.map { ResponseEntity.ok().build<Unit>() }
.defaultIfEmpty(ResponseEntity.badRequest().build())
}
삭제 요청을 다루는 함수를 추가한다. URI의 경로에서 ID값을 가져와서 Repository에서 데이터를 조회하고 데이터가 존재한다면 해당 데이터를 삭제하는 함수를 호출한다. 만약 ID가 존재하지 않는다면 Bad Request 응답을 반환한다. 반환값의 타입은 Mono<ResponseEntity<Unit>>을 사용하였다.
@DeleteMapping("/{id}")
fun delete(@PathVariable("id") id: Long): Mono<ResponseEntity<Unit>> {
return repository.existsById(id)
.flatMap {
if (it)
repository.deleteById(id)
.then(Mono.just(ResponseEntity.ok().build<Unit>()))
else
Mono.just(ResponseEntity.badRequest().build())
}
}
Testing
테스트는 함수형 앤드포인트 방식의 Testing과 동일한 코드를 사용하면 된다. 다만 사용하는 빈이 달라졌으므로 @WebFluxTest의 매개변수를 아래와 같이 변경해주어야 한다.
@ExtendWith(SpringExtension::class)
@WebFluxTest(PersonController::class)
internal class PersonRouteTest
나머지 테스트 함수들은 변경하지 않고 그대로 테스트를 실행하면 된다.
GIT
해당 튜토리얼에 대한 전체 코드는 Github을 참고하기 바란다. (https://github.com/veluxer62/toy/tree/webflux-annotated-controller-with-reactor-and-r2dbc/spring-data-r2bc-example)
Wrap up
지금까지 Kotlin의 Coroutine을 이용하여 Spring WebFlux의 Annotated Controller 방식의 API를 구현해 보았다. Annotated Controller 방식을 사용하면 Spring MVC에 익숙한 개발자라면 손쉽게 WebFlux API 개발에 적응 할 수 있다. 이러한 장점은 스프링으로 개발하는 개발자가 느낄 수 있는 큰 장점이 아닐까 라는 생각이든다. 또 나는 Reactor를 이용한 튜토르리얼을 진행하였는데, 원한다면 Annotated Controller와 Coroutine을 함께 사용할 수도 있다. Coroutine에 대한 의존성을 추가한 후 suspend function만 사용하면 가능하다. 이 부분은 앞에서 보여준 함수형 앤드포인트 방식을 참고해서 작성하면 되므로 생략하고자 한다.
이후 글에서는 WebFlux에서 Spring Data R2DBC보다 보편적으로 사용되고 있는 ReactiveMongoRepository에 대해서 알아보고자 한다.
이전 글 보기 : Spring WebFlux - Functional Endpoint With Coroutine Tutorial
https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html
https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html#webflux-fn
https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#mvc
https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html
https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Flux.html