Dart の設定でのルート
ルートはコードでも宣言できます。ScreenRoutes.route() で組み立てる ScreenRoutes Bean です。@ScreenRoute と @RouteShell と同じモデルを、Spring WebFlux の RouterFunctions の形で表したものです。そうした Bean がいくつあっても、アノテーション付きの画面とマージされ、起動時にまとめてチェックされます。
使う理由
アノテーションは、自分のアドレスを持つ画面に適しています。コードは、データから組み立てるルート (機能フラグごとの画面)、レビューのために一か所にまとめるルート、アプリがアノテーションを付けられないライブラリの画面に適しています。どちらの形も同じチェックを共有します。二度宣言されたパスは起動を止め、両方の場所を示します。
例
@Configuration()
class AppRoutes {
@Bean()
ScreenRoutes routes() => ScreenRoutes.route()
.shell((shell) => MainTabs(shell), (tabs) => tabs
.branch('/catalog', (b) => b
.screen('/catalog', (r) => const CatalogPage())
.screen('/catalog/books/{isbn}', (r) => const BookPage()))
.branch('/profile', (b) => b
.screen('/profile', (r) => const ProfilePage())))
.screen('/checkout', (r) => const CheckoutPage(),
transition: PageTransition.fade)
.nest((admin) => admin
.screen('/admin', (r) => const AdminPage())
.filter(AdminOnly())) // このネストのルートだけ
.redirect('/', '/catalog')
.notFound((r) => const NotFoundPage())
.build();
}
ビルダー
| メソッド | 意味 |
|---|---|
screen(path, builder, {name, title, params, extra, shell, branch, transition, attributes, content, link}) |
builder が組み立てる、path の画面。名前付き引数は @ScreenRoute と @RouteInfo(link:) のもの |
shell(builder, branches, {key}) |
builder が組み立てるシェル (ShellState を受け取る)。branches がそのブランチを宣言する。key で名前を付けると、画面の shell: から参照できる |
branch(path, screens) |
shell の中で: path で始まり、screens が宣言する画面を持つブランチ |
nest(nested) |
nested が宣言するルート。そのフィルターはそれらにだけ適用される |
filter(filter) |
このビルダーのすべての画面のための RouteFilter |
redirect(from, to) |
アドレス from を to に送る |
notFound(builder) |
未知のアドレスの画面 |
error(builder) |
失敗したナビゲーションの画面。RouteState.error が理由を示す |
build() |
ルート |
パスは完全な形で書きます。ブランチの中で宣言されながらそのパスの外にある画面 (/more の中の /motion) も、そのブランチの中で、ブランチの最初の画面の上に開きます。
コードのルートのための定数
@RouteDeclarations() を付けたクラスは、コードだけで宣言されたルートのための生成された定数 (to(...)、キー) を得ます。起動時に、それぞれが登録されているかがチェックされます。
Spring (Java) との対応
RouterFunctions.route()
.GET("/books/{isbn}", handler::book)
.filter(adminOnly)
.build();