Spring WebFlux 가이드(Guide to Spring WebFlux)

원본 글: https://www.baeldung.com/spring-webflux

Spring 5에는 웹 애플리케이션에 대한 리액티브 프로그래밍 지원을 제공하는 Spring WebFlux가 포함되어 있습니다.

이 글에서는 RestController, WebClient를 이용한 간단한 reactive Rest 애플리케이션을 만들어봅니다. 또한, Spring Security를 통해 엔드포인트를 보호하는 법도 확인해봅니다.

1. Spring WebFlux Framework

Spring WebFlux는 내부적으로 Project Reactor를 사용하며, Flux와 Mono라는 퍼블리셔(Publisher) 구현체를 활용합니다.

이 새로운 프레임워크는 두 가지 프로그래밍 모델을 지원합니다.

• 어노테이션 기반의 리액티브 컴포넌트
• 함수형 라우팅 및 핸들링

이 중에서 우리는 어노테이션 기반의 리액티브 컴포넌트에 집중할 것입니다.
함수형 라우팅 및 핸들링은 다른글에서 상세한 내용을 확인할 수 있어서 이 글에 적지 않겠습니다.

2. Dependencies

프로젝트에 spring-boot-start-webflux의존성을 추가해야합니다.
해당 의존성은 다른 의존성들을 불러오는데

• Spring Boot 환경설정을 위한 spring-boot, spring-boot-starter
• spring-webflux 프레임워크
• reactive stream과 reactor-netty에 필요한 reactor-core
  를 불러옵니다.

implementation 'org.springframework.boot:spring-boot-starter-webflux:3.4.2' //이 글 최신시점 3.4.2버전입니다.

3. Reactive Rest Application

예제용으로 매우 간단한 리액티브 Rest 직원관리 매니지 애플리케이션을 만들어 보겠습니다.

• id, name 필드를 가지고 있는 Employee라는 간단한 도메인
• RestController를 사용하여 직원에 대한 자원을 단일객체로 주거나 배열 등의 컬렉션에 담아서 주는 Rest API 제작
• 만들어진 API를 호출하는 비동기 WebClient를 작성해, Employee 데이터를 가져옵니다.
• WebFlux를 사용해 리액티브 방식으로 동작하는 보안이 적용된 엔드포인트를 생성합니다.

4. Reactive RestController

Spring Web MVC 프레임워크와 동일한 방법으로 Spring WebFlux도 어노테이션을 이용하여 설정작업들을 진행할 수 있습니다.

우선 서버에서 Employee 리소스의 리액티브 스트림을 제공하는 어노테이션이 달린 컨트롤러를 만듭니다.

@RestController
@RequestMapping("/employee")
public class EmployeeController {

    private final EmployeeRepository employeeRepository;

    public EmployeeController(EmployeeRepository employeeRepository) {
        this.employeeRepository = employeeRepository;
    }
    //...
}

여기서 EmpoyeeRepository는 본문에 설명되어있지는 않습니다. 제 예제 코드를 참고하셔서 작성하시면 됩니다. 글 맨 하단에 링크를 적어놓겠습니다.

4.1 Single Resource

단일 객체를 반환하는 엔드포인트를 작성합니다.

    @GetMapping("/{id}")
    public Mono<Employee> getEmployeeById(@PathVariable int id) {
        return  employeeRepository.findEmployeeById(id);
    }

Mono로 감싸져서 최대 하나의 직원객체만 반환됩니다.

4.2 Collection Resource

여러 객체를 반환하는 엔드포인트를 작성합니다.

    @GetMapping
    public Flux<Employee> getAllEmployees() {
        return employeeRepository.getAllEmployees();
    }

Flux로 감싸져서 0...n개의 객체를 반환하게끔 합니다.

5. Reactive Web Client

Spring5에서 추가된 WebClient는 논-블럭킹 클라이언트를 제공합니다.
Webclient를 이용해서 위에서 만들었던 EmployeeController에 요청을 보낼 수 있습니다.

public class EmployeeWebClient {

    WebClient client = WebClient.create("http://localhost:8080");

}

create() 함수를 통해서 기본 URL을 localhost:8080으로 지정하였습니다.

5.1 Retrieving a Single Resource

    public void getEmployeeMono() {
        Mono<Employee> employeeMono = client.get()
                .uri("/employee/{id}", 1)
                .retrieve()
                .bodyToMono(Employee.class);
        employeeMono.subscribe(System.out::println);
    }

단일 객체를 반환하는 엔드포인트를 client로 호출하는 방법은 위와 같습니다.

5.2 Retrieving a Collection Resource

비슷하게 여러 객체를 반환하는 엔드포인트를 호출하는 방법은 다음과 같습니다.

    public void getEmployeeFlux() {
        Flux<Employee> employeeFlux = client.get()
                .uri("/employee")
                .retrieve()
                .bodyToFlux(Employee.class);
        employeeFlux.subscribe(System.out::println);
    }

6. Spring WebFlux Security

Spring Security를 이용하여 엔드포인트들을 보호할 수 있습니다.

이를 확인하기 위해 EmployeeController에 직원에 대한 정보를 바꿀 수 있는 새로운 엔드포인트를 추가하고, Admin 권한인 경우에만 해당 api를 정상 수행할 수 있도록 변경합니다.

@PostMapping("/update")
public Mono<Employee> updateEmployee(@RequestBody Employee employee) {
    return employeeRepository.updateEmployee(employee);
}

이제 Security Config쪽을 확인합니다.

참고로 implementation 'org.springframework.boot:spring-boot-starter-security' 의존성이 추가되어야합니다.

그리고 원본 글은 Spring Security버전이 5버전으로 보이는데, 6.1버전부터는 문법을 다르게 작성해야하므로 두 개로 나눠서 작성하겠습니다.

//6.1 이전
@EnableWebFluxSecurity
public class EmployeeWebSecurityConfig {

    // ...

    @Bean
    public SecurityWebFilterChain springSecurityFilterChain(
      ServerHttpSecurity http) {
        http.csrf().disable()
          .authorizeExchange()
          .pathMatchers(HttpMethod.POST, "/employees/update").hasRole("ADMIN")
          .pathMatchers("/**").permitAll()
          .and()
          .httpBasic();
        return http.build();
    }
}

//6.1 이후

@Bean
public SecurityFilterChain springSecurityFilterChain(HttpSecurity http) throws Exception {
    http.csrf(csrf -> csrf.disable())
            .authorizeHttpRequests(auth -> auth.requestMatchers(HttpMethod.POST, "/employee/update").hasRole(("ADMIN"))
                    .requestMatchers("/**").permitAll())
            .httpBasic(Customizer.withDefaults());
    return http.build();
}

위 설정은 /empoyee/update 엔드포인트에 대해 제한을 걸어둡니다. ADMIN권한을 가진 유저만 해당 API를 호출할 수 있습니다.

@EnableWebFluxSecurity 어노테이션을 추가함으로써 몇 개의 기본 보안설정과 Spring Security WebFlux를 지원하도록 합니다.

7. 결론

• Spring WebFlux 프레임워크를 통해 리액티브 웹 컴포넌트를 만드는 법을 학습하였습니다.
• RestController와 WebClient 사용법을 배웠습니다.
• Spring Security를 이용해 간단한 보안설정을 학습하였습니다.
• WebSocket도 지원하니까 이 부분도 학습하면 좋을 것 같습니다.

생각

가장 기초 가이드이나 친절하진 않습니다.
시큐리티를 어느정도 학습하였다고 생각하고 레포지토리도 임의로 작성하였습니다.
예제코드를 보시는게 편하실 것 같습니다.