SpringBootでは、Webアプリケーションの入口としてコントローラーを作成してURLとメソッドをマッピングさせます。Spring WebFluxを利用すると、関数を利用してリクエストをルーティングすることができます。

Spring WebFluxはリアクティブプログラミングで非同期なアプリケーションを開発することができます。SpringMVCのようにアノテーション付きコントローラーでも作成することはできますが、今回は関数エンドポイントを利用してみます。

依存モジュール

まず依存モジュールにspring-boot-starter-webを入れないようにします。

<dependencies>
	<!--
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
	-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-webflux</artifactId>
		</dependency>

		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>io.projectreactor</groupId>
			<artifactId>reactor-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

基本

まず関数型エンドポイントを作成するためにはHandlerFunctionとRouterFunctionというインターフェースを利用します。

https://spring.pleiades.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/function/server/RouterFunction.html

https://spring.pleiades.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/function/server/HandlerFunction.html

https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html

https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Flux.html

HandlerFunction
- リクエストを処理する関数
RouterFunction
- リクエストをハンドラー関数にマッピングさせる。
- @RequestMappingアノテーションと同じような位置
Mono
- 0〜1個の要素からなるリアクティブストリーム
Flux
- 0〜N個の要素からなるリアクティブストリーム

ルーティング情報を記載した設定クラスを作成します

route/Config.java

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.RouterFunctions;
import org.springframework.web.reactive.function.server.ServerResponse;
import com.volkruss.flextest.model.User;
import reactor.core.publisher.Mono;

@Configuration
public class Config {

	@Bean
	public RouterFunction<ServerResponse> routerFunction(){
		User user = new User("ステイル", 14);
		return RouterFunctions.route().GET("/test", req -> ServerResponse.ok().body(Mono.just(user) ,User.class)).build();		
	}
}

@Configurationアノテーションを付けてコンポーネントスキャンの対象にします
@BeanでRouterFunctionをBean登録します
GETで/testにアクセスする時のルーティングを定義しています
今回は1件のみ取得するのでMono.justを利用しています

起動すると以下のようにNettyWebServerが開始されるログが流れていることがわかります

Userクラスは簡単に作っています

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.Setter;

@AllArgsConstructor
// アクセサメソッド必須
@Getter
@Setter
public class User {
	private String name;
	private int no;
}

画面にアクセスすると以下のように取得できます

※画像はageになっていますが実際はnoが出力されます

Fluxを試す

次に複数のデータを返すためにFluxを利用します

いろいろと省略していますが、ハンドラークラスとDAOクラスを作成してそこからUserを取得するようにします

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;
import com.volkruss.flextest.dao.UserDao;
import com.volkruss.flextest.model.User;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

@Component
public class TestHandle {
	
	@Autowired
	private UserDao dao;
	
	public Mono<ServerResponse> getUsers(ServerRequest request){
		Flux<User> users = this.dao.getUsers();
		return ServerResponse.ok().body(users,User.class);
	}

}

後で作成するUserDaoからuserを取得します
Fluxに返却するUserを突っ込んで返します

次にUserDaoクラスです

import java.time.Duration;
import org.springframework.stereotype.Component;
import com.volkruss.flextest.model.User;
import reactor.core.publisher.Flux;

@Component
public class UserDao {
	
	public Flux<User> getUsers(){
		return Flux.range(1, 10)
				.delayElements(Duration.ofSeconds(1))
				.doOnNext(this::writeLog)
				.map(this::createUser);
	}
	
	private User createUser(int i) {
		return new User("sampleUser", i);
	}
	
	private void writeLog(int i) {
		System.out.println("done " + String.valueOf(i) + " .");
	}
}

Flux.rangeで10要素のUserを順番に取得しています
delayElementsメソッドでインターバルを発生させています
doOnNextメソッドで処理を挟んでいます
- ここではログの出力をしています

ルーティングを定義します。

@Configuration
public class Config {
	
	@Autowired
	private TestHandle testHandle;

	@Bean
	public RouterFunction<ServerResponse> routerFunction(){
		User user = new User("ステイル", 14);
		return RouterFunctions.route().GET("/test", req -> ServerResponse.ok().body(Mono.just(user) ,User.class))
				.GET("/test/users",testHandle::getUsers)
				.build();		
	}
}

既存のルーティングにさらに付け加えるだけでOK
作ったハンドラークラスはメソッド参照で利用可能です

これを実行すると毎秒ログが出力されて10秒後に画面が表示されます。

ログが毎秒流れていく。

画面は全ての処理が終わってから一気に表示される

ストリーム処理

ストリーム処理を1件ずつ画面に表示させるには、レスポンスに対して以下の一文を付け加えるだけでOKです

contentType(MediaType.TEXT_EVENT_STREAM)

@Component
public class TestHandle {
	
	@Autowired
	private UserDao dao;
	
	public Mono<ServerResponse> getUsers(ServerRequest request){
		Flux<User> users = this.dao.getUsers();
		return ServerResponse.ok().
				contentType(MediaType.TEXT_EVENT_STREAM).
				body(users,User.class);
	}
}

今度は画面でも1件ずつ要素が表示されています

クライアントが要求しているのでなく、処理の通知を受けているのがポイントで、1件ずつ通知を受けて画面に表示しています。

最初と最後に処理

次に完了時に処理を行います。doOnCompleteメソッドを利用します

@Component
public class UserDao {
	
	public Flux<User> getUsers(){
		return Flux.range(1, 10)
				.delayElements(Duration.ofSeconds(1))
				.doOnNext(this::writeLog)
				.doOnComplete(this::complete) //　追加
				.map(this::createUser);
	}
	
	private void complete() {
		System.out.println("処理が終了しました");
	}
	
	private User createUser(int i) {
		return new User("sampleUser", i);
	}
	
	private void writeLog(int i) {
		System.out.println("done " + String.valueOf(i) + " .");
	}
}

これで全ての処理が完了した時に処理を実行できます

次に最初に処理をさせます

@Component
public class UserDao {
	
	public Flux<User> getUsers(){
		return Flux.range(1, 10)
				.delayElements(Duration.ofSeconds(1))
				.doFirst(this::first) // 追加
				.doOnNext(this::writeLog)
				.doOnComplete(this::complete)
				.map(this::createUser);
	}
	
	private void first() {
		System.out.println("処理を開始します");
	}
	
	private void complete() {
		System.out.println("処理が終了しました");
	}
	
	private User createUser(int i) {
		return new User("sampleUser", i);
	}
	
	private void writeLog(int i) {
		System.out.println("done " + String.valueOf(i) + " .");
	}
}

次回はもう少し深堀してみます

参考

https://www.baeldung.com/spring-5-functional-web

https://spring.pleiades.io/spring-framework/docs/current/reference/html/web-reactive.html

https://github.com/Java-Techie-jt/springboot-webflux-demo

https://medium.com/javarevisited/spring-webflux-tutorial-how-to-build-a-reactive-web-app-1132e4255406

https://www.amitph.com/introduction-spring-webflux-reactive-api/

Spring WebFlux | 関数型エンドポイント