跳到主要内容
版本：v4

通过通用链接和应用链接实现深度链接

平台: iOS, Android

通用链接（iOS）和应用链接（Android）能够将用户直接带到原生应用内的特定内容（通常称为深度链接）。

当用户点击深度链接时，用户会被直接发送到您的应用中，而无需先经过设备的网络浏览器或网站。如果应用未安装，则用户会被引导至网站。如果用户直接导航到网站，他们将保持在网站上。这使得深度链接成为为 Web、iOS 和 Android 构建的跨平台应用的绝佳功能：提供无缝的移动体验，并能优雅地回退到网站。

优势：

  • 安全：通用链接/应用链接使用链接到您拥有的网站域名的 HTTPS URL，确保没有其他应用可以使用您的链接。
  • 无缝体验：一个 URL 既适用于您的网站也适用于应用，确保用户能够成功访问他们寻找的内容而不会出错。
  • 提高参与度：链接可以从电子邮件客户端、搜索引擎结果等位置打开。

演示视频​

以下是实际效果示例。在这个例子中，用户安装了原生应用。他们从电子邮件中点击应用链接，被直接带入应用本身。首先，点击根链接（https://beerswift.app），将用户引导到应用主页。接着，点击一个深度链接（https://beerswift.app/tabs/tab3）将用户带到 Tab3 页面。

前提条件​

  • 预先配置好的 Capacitor 应用
  • 对于 iOS，需要加入 Apple Developer Program

出于说明目的，将使用 https://beerswift.app 作为 Web 应用链接。

使用 Capacitor App API 实现深度链接路由​

当点击深度链接后打开原生应用时，移动操作系统不会自动知道将用户路由到哪里。这必须在应用启动时使用 Capacitor App API 在应用内部实现。

如果您的网站和应用路径不匹配，您将需要实现更高级的 URL 模式匹配（有关示例，请参阅本指南）。但如果您的移动应用和 Web 应用使用相同的代码库，这将非常简单——只需重定向到相同的 URL。以下示例假设了这种情况。

Angular​

路由应该在 app.component.ts 中实现。首先从 Angular 导入 NgZone 和 Router，然后从 Capacitor 导入 App：

import { Component, NgZone } from '@angular/core';
import { Router } from '@angular/router';
import { App, URLOpenListenerEvent } from '@capacitor/app';

接下来，将 Router 和 NgZone 添加到构造函数中：

constructor(private router: Router, private zone: NgZone) {
    this.initializeApp();
}

最后，监听 appUrlOpen 事件，并在找到深度链接时重定向：

initializeApp() {
    App.addListener('appUrlOpen', (event: URLOpenListenerEvent) => {
        this.zone.run(() => {
            // 示例 URL：https://beerswift.app/tabs/tab2
            // slug = /tabs/tab2
            const slug = event.url.split(".app").pop();
            if (slug) {
                this.router.navigateByUrl(slug);
            }
            // 如果没有匹配项，则不执行任何操作——让常规的路由逻辑接管
        });
    });
}

React​

React 有多种选择。一种方法是将 App API 监听器功能包装到一个新组件中，然后将其添加到 App.tsx 内部。首先创建 AppUrlListener.tsx，然后导入 React Router 的 useHistory 钩子以及 Capacitor App API：

import React, { useEffect } from 'react';
import { useHistory } from 'react-router-dom';
import { App, URLOpenListenerEvent } from '@capacitor/app';

接下来，定义 AppUrlListener 组件，监听 appUrlOpen 事件，并在找到深度链接时重定向：

const AppUrlListener: React.FC<any> = () => {
  let history = useHistory();
  useEffect(() => {
    App.addListener('appUrlOpen', (event: URLOpenListenerEvent) => {
      // 示例 URL：https://beerswift.app/tabs/tab2
      // slug = /tabs/tab2
      const slug = event.url.split('.app').pop();
      if (slug) {
        history.push(slug);
      }
      // 如果没有匹配项，则不执行任何操作——让常规的路由逻辑接管
    });
  }, []);

  return null;
};

export default AppUrlListener;

在 App.tsx 中，导入新组件：

import AppUrlListener from './pages/AppUrlListener';

然后将其添加到 IonReactRouter 中（或者您的应用启动的任何地方，只需确保 History 钩子可用）：

const App: React.FC = () => {
  return (
    <IonApp>
      <IonReactRouter>
        <AppUrlListener></AppUrlListener>
        <IonRouterOutlet>
          <Route path="/home" component={Home} exact={true} />
          <Route exact path="/" render={() => <Redirect to="/home" />} />
        </IonRouterOutlet>
      </IonReactRouter>
    </IonApp>
  );
};

Vue​

VueJS 提供了一个与 Vue 原生集成的官方路由系统，称为 Vue Router。要使用 Vue Router 设置深度链接，请从您用来配置所有路由的文件开始（通常是 routes.js 或类似文件）。

首先，我们从插件中导入 capacitor 的 App，以及 Vue 和 VueRouter。

import { App, URLOpenListenerEvent } from '@capacitor/app';
import Vue from 'vue';
import VueRouter from 'vue-router';

接下来，使用 Vue Router 配置您的路由（有关Vue Router 入门的更多信息）。

const router = new VueRouter({
  routes: [],
});

建议使用 mode: history，这样您就不必处理 #。

让 Vue 知道您正在使用 Vue Router，并在 Vue 中注册路由器：

const VueApp = new Vue({
  router,
}).$mount('#app');

最后，我们需要为深度链接注册我们的应用。为此，我们在 Capacitor App 的 appUrlOpen 事件上添加一个事件监听器。Capacitor 会捕获此事件，然后我们将其交给 Vue Router 导航到请求的页面。

App.addListener('appUrlOpen', function (event: URLOpenListenerEvent) {
  // 示例 URL：https://beerswift.app/tabs/tabs2
  // slug = /tabs/tabs2
  const slug = event.url.split('.app').pop();

  // 仅当存在 slug 时才推送到路由
  if (slug) {
    router.push({
      path: slug,
    });
  }
});

创建网站关联文件​

为了让 Apple 和 Google 允许深度链接打开您的应用，必须在您的网站和应用之间创建双向关联。必须为每个平台创建一个文件，并将其放置在您网站上的 .well-known 文件夹中，例如：https://beerswift.app/.well-known/。

继续阅读 iOS 和 Android 的配置详情。

iOS 配置​

iOS 配置涉及创建网站关联文件，并配置原生应用以识别应用域名。

您必须加入 Apple Developer Program。

创建网站关联文件​

首先，登录 Apple Developer 网站。导航到 "Certificates, Identifiers, & Profiles" 部分，选择你的应用标识符。记下 Team ID 和 Bundle ID，然后在 Capabilities 下启用 "Associated Domains" 并保存：

iOS 标识符配置

接下来，创建网站关联文件（apple-app-site-association）。

注意：尽管这是一个 JSON 文件，但保存时不要添加文件扩展名。

下面是一个 apple-app-site-association 文件的示例。请务必将 TEAMID.BUNDLEID 替换为你自己的 ID（例如：8L65AZE66A.com.netkosoft.beerswift）。

{
  "applinks": {
    "apps": [],
    "details": [
      {
        "appID": "TEAMID.BUNDLEID",
        "paths": ["*"]
      }
    ]
  }
}

接着，将文件上传到你的网站（需托管在 HTTPS 上），然后使用 Apple 的工具 此处 验证配置是否正确。URL 应遵循此格式：https://beerswift.app/.well-known/apple-app-site-association

添加关联域名​

最后一步是配置 iOS 应用以识别传入的链接。打开 Xcode，然后导航到 Signing & Capabilities。点击 "+ Capability"，然后选择 Associated Domains。在出现的 Domains 条目中，使用格式 applinks:yourdomain.com 进行编辑：

Xcode 关联域名

Android 配置​

Android 配置涉及创建一个网站关联文件，并配置原生应用使用 Intent 过滤器来识别应用链接。

创建网站关联文件​

创建网站关联文件需要你的 Android 证书的 SHA256 指纹。

如果你还没有证书，请创建一个：

keytool -genkey -v -keystore KEY-NAME.keystore -alias ALIAS -keyalg RSA -keysize 2048 -validity 10000

使用你现有的（或新创建的）Keystore 证书，通过 keytool 命令列出 keystore 的详细信息：

keytool -list -v -keystore my-release-key.keystore

打印的输出将包含 SHA256 指纹：

Keytool 输出

接下来，使用 Google 的 Asset Links 工具 来创建网站关联文件。填写网站域名、应用包名和 SHA256 指纹，然后点击 "Generate statement"：

Android 标识符配置

将 JSON 输出复制到一个新的本地文件中，位置为 .well-known/assetlinks.json。

// assetlinks.json
[{
  "relation": ["delegate_permission/common.handle_all_urls"],
  "target": {
    "namespace": "android_app",
    "package_name": "com.netkosoft.beerswift",
    "sha256_cert_fingerprints": ["43:12:D4:27:D7:C4:14..."]
  }
}]

将文件部署到你的网站（需托管在 HTTPS 上），然后点击 Asset Link 工具中的 "Test statement" 按钮进行验证。如果配置正确，将出现成功消息：

成功！主机 [website] 授予应用 [app package] 深度链接权限。

添加 Intent 过滤器​

最后一步是配置 Android 应用以识别传入的链接。为此，在 AndroidManifest.xml 的 <activity> 元素内 添加一个新的 Intent 过滤器：

<intent-filter android:autoVerify="true">
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="https" android:host="beerswift.app" />
</intent-filter>

完整的 Activity 应类似这样：

<activity
    android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale"
    android:name="com.netkosoft.beerswift.MainActivity"
    android:label="@string/title_activity_main"
    android:theme="@style/AppTheme.NoActionBarLaunch"
    android:launchMode="singleTask">

    <intent-filter>
        <action android:name="android.intent.action.MAIN" />
        <category android:name="android.intent.category.LAUNCHER" />
    </intent-filter>

    <intent-filter android:autoVerify="true">
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data android:scheme="https" android:host="beerswift.app" />
    </intent-filter>
</activity>

网站配置​

网站配置会根据所使用的工具和后端而有所不同。下面是一些建议。

Angular​

将关联文件放置在 src/.well-known 下。接着，配置构建过程，确保这些文件能够按原样部署（保证 Apple/Google 能够正确读取它们）。打开 angular.json，在 architect => assets 下，向数组中添加一个新条目：

{
  "glob": "**/*",
  "input": "src/.well-known",
  "output": ".well-known/"
}

构建并部署网站。

NuxtJS​

将关联文件放置在 static/.well-known 下。无需额外步骤；直接构建并部署网站即可。

React​

将关联文件放置在 public/.well-known 下。无需额外步骤；直接构建并部署网站即可。

WordPress​

有关 WordPress 的说明，请参见 此处。

验证​

为了验证网站和原生应用配置正确，网站需要托管网站关联文件，但应用不需要上架应用商店。

将设备连接到计算机，构建并部署原生应用，然后通过点击网站链接进行测试。如果原生应用被打开，则说明所有步骤都已正确实施。

资源​

Contents

编辑此页