すべてのプロパティ

spring_boot_starter_flutter_navigation が spring.flutter.navigation の下で読むすべてのプロパティです。一部はアプリの起動時に読まれます。ディープリンクのキーはビルド時に spring_core_dart_generator が読み、それらからプラットフォームのファイルを書き出します。

使う理由

ナビゲーションのほとんどはコード (画面とシェル) ですが、アプリが始まる場所、ガードが人を送る場所、言語、ディープリンクは設定です。これらはプラットフォーム、ビルド、顧客ごとに異なります。このページはそれらを一か所に列挙します。スターターのメタデータは、エディターのために同じキーを記述しています。

例

# lib/resources/application.yml
spring:
  flutter:
    navigation:
      initial: /catalog
      login: /login
      redirects:
        "[/home]": /catalog
      languages: [en, ja]
      web:
        url-strategy: path
      deep-links:
        scheme: neonbooks
        domains: [books.example.com]
        exclude: [/checkout, /admin/**]
# lib/resources/application.properties: 同じ内容
spring.flutter.navigation.initial=/catalog
spring.flutter.navigation.login=/login
spring.flutter.navigation.redirects[/home]=/catalog
spring.flutter.navigation.languages=en,ja
spring.flutter.navigation.web.url-strategy=path
spring.flutter.navigation.deep-links.scheme=neonbooks
spring.flutter.navigation.deep-links.domains[0]=books.example.com
spring.flutter.navigation.deep-links.exclude[0]=/checkout
spring.flutter.navigation.deep-links.exclude[1]=/admin/**

redirects のキーはパスなので、角括弧で囲んで書きます: [/home] (YAML ではさらに引用符で囲みます)。

spring.flutter.navigation

キー 型 デフォルト 読まれる時 意味 ページ
spring.flutter.navigation.initial パス なし 起動時 プラットフォームが / を与える場合 (ディープリンクなし、サイトのルート) にアプリが始まる場所。/catalog など 画面
spring.flutter.navigation.login パス なし 起動時 ガード付きの画面が、ログインしていない人を送る場所。アプリはログイン後に戻る。なければ、そうしたナビゲーションはエラー画面を表示する ガード
spring.flutter.navigation.redirects.<from> パス なし 起動時 別のアドレスに導くアドレス ("[/]": /catalog)。同じパスのルート自身のリダイレクトが優先される 画面
spring.flutter.navigation.languages 言語タグのリスト なし (一つの言語、プレフィックスなし) 起動時とジェネレーターが 独自のアドレスを持つ言語。最初のものがデフォルトでプレフィックスなし、他は /<language> の下。ビルドはそれぞれの言語で検索エンジンのためのページを書き出す 言語
spring.flutter.navigation.web.url-strategy path、hash path 起動時 /catalog/books/1、または Flutter の /#/catalog/books/1 Web
キー 型 デフォルト 読まれる時 意味
spring.flutter.navigation.deep-links.enabled bool true ジェネレーターが ディープリンクを書き出すかどうか。プラットフォームのプロファイルで false にすると、そこで無効になる
spring.flutter.navigation.deep-links.scheme URL スキーム なし ジェネレーターが アプリ独自のスキーム。検証されないため、別のアプリが主張することがある
spring.flutter.navigation.deep-links.domains ホスト名のリスト なし ジェネレーターが https のリンクでアプリを開くドメイン (Universal Links、App Links)
spring.flutter.navigation.deep-links.exclude パスパターンのリスト (Spring の構文) なし 起動時とジェネレーターが リンクで開かないアドレス。代わりにアプリは最初の画面を開く
spring.flutter.navigation.deep-links.app-id TEAMID.bundle.id Xcode のプロジェクトから ジェネレーターが apple-app-site-association の iOS アプリ ID
spring.flutter.navigation.deep-links.package Android のパッケージ Gradle ファイルの applicationId ジェネレーターが assetlinks.json のパッケージ
spring.flutter.navigation.deep-links.sha256-cert-fingerprints リスト なし ジェネレーターが Android の署名鍵の SHA-256 フィンガープリント。なければ assetlinks.json は書き出されない

書き出されるファイルについては Web とディープリンク を参照してください。

ナビゲーションが従う他のスターターのキー

キー スターター 意味
spring.flutter.app.type Flutter MaterialApp.router (spring_boot_starter_flutter_material とともに)、CupertinoApp.router (spring_boot_starter_flutter_cupertino とともに)、WidgetsApp.router
spring.flutter.theme.motion.page-transition Flutter すべての画面のトランジション (トランジション を参照)
spring.flutter.theme.motion.scroll-to-top、motion.content-change Flutter RouteContentView がページを切り替える方法 (Markdown の画面 を参照)
spring.flutter.web.seo.from-routes Flutter 検索エンジンのためのルートごとのページ (SEO を参照)

関連項目