Web とディープリンク
ルートは、どこでもアプリのアドレスです。ブラウザーのアドレスバーの中、ビルドが検索エンジンのために書き出すページの中、そして外部からアプリを開くリンク (ディープリンク) の中です。ブラウザーのアドレスはデフォルトで # を持ちません。ディープリンクはプロパティから iOS、macOS、Android のプロジェクトに書き込まれます。
使う理由
ディープリンクには、Info.plist、エンタイトルメントのファイル、Android のマニフェスト、そして Web サーバー上の二つの JSON ファイルの編集が必要で、それぞれ独自の形式を持ち、手で同期を保たなければなりません。ここではそれらはいくつかのプロパティです。ジェネレーターが各ファイルを書き出し、すべてのリンクはルートを通るため、ガード付きの画面は引き続きログインを求めます。
例
# lib/resources/application.yml
spring:
flutter:
navigation:
web:
url-strategy: path
deep-links:
scheme: neonbooks # neonbooks://catalog/books/1
domains: [books.example.com] # https://books.example.com/catalog/books/1
exclude: [/checkout, /admin/**]
# lib/resources/application-android.yml
spring:
flutter:
navigation:
deep-links:
sha256-cert-fingerprints:
- 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5
ブラウザーのアドレス
url-strategy |
アドレスバー | ホスト |
|---|---|---|
path (デフォルト) |
/catalog/books/1 |
アプリのすべてのアドレスに index.html で応答しなければならない (またはビルドがパスごとのページを書き出す) |
hash |
/#/catalog/books/1 |
index.html だけを配信する (Flutter 自身のデフォルト) |
path では、スターターはアドレスの #見出し の部分を残します。/docs/beans#bean-methods のようなアドレスを直接開くと (共有されたリンクや検索エンジンの結果)、ページはその見出しまでスクロールした状態で開きます。以前は、最初の読み込みで # の部分が捨てられていました。
検索エンジンのためのページ
spring.flutter.web.seo.enabled と from-routes: true があると、ビルドはルートごとに、そのタイトル、説明 (@RouteInfo)、Markdown のテキストを持つページを、spring.flutter.navigation.languages のすべての言語で書き出します。
| 画面 | ページ |
|---|---|
変数のないパス (/about) |
そのパスに一つのページ |
変数のないパスと content: のファイル |
ファイルの Markdown を持つ一つのページ |
{*name} で終わり、content: のフォルダーを持つパス |
フォルダーの Markdown ファイルごとに一つのページ |
他の変数を持つパス (/books/{isbn}) |
なし。@RouteInfo(paths: [...]) がそのアドレスを列挙する場合を除く |
| 見つからない場合の画面 | なし |
@RouteInfo(index: false) はページをサイトマップから除外します (noindex)。検索エンジン向けのページ と、手順を追った SEO を参照してください。
ディープリンク
ジェネレーターは spring.flutter.navigation.deep-links.* からプラットフォームのファイルを書き出します。実行時に読まれるのは exclude だけです。一つのプラットフォームのための値は、そのプロファイルのファイル (application-ios.yml、application-android.yml) に置きます。
| プラットフォーム | ファイル | 内容 |
|---|---|---|
| iOS | ios/Runner/Info.plist |
FlutterDeepLinkingEnabled とスキーム (CFBundleURLTypes) |
| iOS | ios/Runner/Runner.entitlements |
ファイルが存在する場合、各ドメインの applinks:<domain> (Xcode で Associated Domains のケイパビリティを使って作成する。ファイルがない場合、ビルドは警告するだけ) |
| macOS | macos/Runner/Info.plist |
スキーム |
| Android | android/app/src/main/AndroidManifest.xml |
メインのアクティビティの中に: flutter_deeplinking_enabled、スキームのためのインテントフィルター、ドメインのための検証される (autoVerify) インテントフィルター |
| 各ドメイン | web/.well-known/ (Web アプリ)、それ以外は build/spring/well-known/ |
ドメインが https://<domain>/.well-known/ の下で配信する apple-app-site-association と assetlinks.json。除外したパスは Apple のファイルから省かれる |
- Windows と Linux にはまだディープリンクがありません。
- アプリを開くすべてのリンクはそのルートを通ります。
@RouteInfo(link: false)を持つ画面やexcludeの下の画面は代わりに最初の画面を開き、ガード付きの画面はまずログインを求めます。 - ジェネレーターは、そのブロックをハッシュ付きの
spring:deep-links:startとspring:deep-links:endのコメントの間に書きます。手で変更されたブロックや、ファイルがブロックの外で宣言しているブロックのキー (CFBundleURLTypes) は、ビルドを失敗させます。Xcode のプロジェクトは決して編集しません。
ビルダーについては ディープリンク を参照してください。
プロパティ
| キー | 型 | デフォルト | 読まれる時 | 意味 |
|---|---|---|---|---|
spring.flutter.navigation.web.url-strategy |
path、hash |
path |
起動時 | ブラウザーのアドレスバーがルートを表示する方法 |
spring.flutter.navigation.deep-links.enabled |
bool | true |
ジェネレーターが | ディープリンクを書き出すかどうか。プラットフォームのプロファイルのファイルで false にすると、そこで無効になる |
spring.flutter.navigation.deep-links.scheme |
URL スキーム | なし | ジェネレーターが | アプリ独自のスキーム (neonbooks://catalog/books/1)。検証されないため、別のアプリが主張することがある。そのため人が共有するリンクは domains を通す |
spring.flutter.navigation.deep-links.domains |
ホスト名のリスト | なし | ジェネレーターが | https のリンクでアプリを開くドメイン (Universal Links、App Links)。ホスト名だけで、スキームやパスは書かない |
spring.flutter.navigation.deep-links.exclude |
パスパターンのリスト | なし | 起動時とジェネレーターが | @RouteInfo(link: false) と同じく、リンクで開かないアドレス (代わりに最初の画面が開く)。Apple のファイルからも除外される |
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 の署名鍵 (アップロード鍵と Google Play のもの) の SHA-256 フィンガープリント。なければ assetlinks.json は書き出されず、Android はドメインを検証しない |