Linking

Linking 为您提供了一个通用接口，用于与传入和传出的应用程序链接进行交互。

每个链接 (URL) 都有一个 URL Scheme，一些网站以 https:// 或 http:// 开头，而 http 是 URL Scheme。我们简称它为 scheme。

除了 https 之外，您可能还熟悉 mailto scheme。当您打开一个带有 mailto scheme 的链接时，您的操作系统将打开一个已安装的邮件应用程序。类似地，还有用于拨打电话和发送 SMS 的 scheme。请阅读下文，详细了解内置 URL scheme。

与使用 mailto scheme 类似，可以通过使用自定义 url scheme 链接到其他应用程序。例如，当您收到来自 Slack 的魔法链接电子邮件时，启动 Slack 按钮是一个锚标记，其 href 类似于：slack://secret/magic-login/other-secret。与 Slack 一样，您可以告诉操作系统您想要处理自定义 scheme。当 Slack 应用程序打开时，它会接收用于打开它的 URL。这通常被称为深度链接。请阅读下文，详细了解如何获取深度链接到您的应用程序中。

自定义 URL scheme 不是在移动设备上打开应用程序的唯一方法。例如，如果您想通过电子邮件向某人发送一个链接以便在移动设备上打开，则使用自定义 URL scheme 并不理想，因为用户可能会在桌面上打开电子邮件，而该链接在桌面上无法工作。相反，您应该使用标准的 https 链接，例如 https://www.myapp.io/records/1234546。在移动设备上，可以将这些链接配置为打开您的应用程序。在 Android 上，此功能称为 深度链接，而在 iOS 上，它被称为 通用链接。

内置 URL Scheme

正如引言中提到的，在每个平台上都存在一些用于核心功能的 URL scheme。以下是一个非详尽的列表，但涵盖了最常用的 scheme。

Scheme	描述	iOS	Android
mailto	打开邮件应用，例如：mailto: [email protected]	✅	✅
tel	打开电话应用，例如：tel:+123456789	✅	✅
sms	打开短信应用，例如：sms:+123456789	✅	✅
https / http	打开 Web 浏览器应用，例如：https://expo.io	✅	✅

启用深度链接

仅限原生代码项目

以下部分仅适用于公开了原生代码的项目。如果您使用的是托管 Expo 工作流程，请参阅 Expo 文档中关于 Linking 的指南，以了解合适的替代方案。

如果您想在您的应用中启用深度链接，请阅读以下指南

Android

有关如何在 Android 上添加对深度链接支持的说明，请参阅 启用应用内容的深度链接 - 为您的深度链接添加 Intent 过滤器。

如果您希望在 MainActivity 的现有实例中接收 intent，您可以在 AndroidManifest.xml 中将 MainActivity 的 launchMode 设置为 singleTask。 有关更多信息，请参阅 <activity> 文档。

xml

<activity
  android:name=".MainActivity"
  android:launchMode="singleTask">

iOS

注意： 在 iOS 上，您需要将 LinkingIOS 文件夹添加到您的头文件搜索路径中，如步骤 3 此处 所述。如果您还想在应用程序执行期间监听传入的应用程序链接，则需要在您的 *AppDelegate.m 中添加以下行

objectivec

// iOS 9.x or newer
#import <React/RCTLinkingManager.h>

- (BOOL)application:(UIApplication *)application
   openURL:(NSURL *)url
   options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
{
  return [RCTLinkingManager application:application openURL:url options:options];
}

如果您以 iOS 8.x 或更早版本为目标，则可以使用以下代码代替

objectivec

// iOS 8.x or older
#import <React/RCTLinkingManager.h>

- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url
  sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
{
  return [RCTLinkingManager application:application openURL:url
                      sourceApplication:sourceApplication annotation:annotation];
}

如果您的应用正在使用 通用链接，您还需要添加以下代码

objectivec

- (BOOL)application:(UIApplication *)application continueUserActivity:(nonnull NSUserActivity *)userActivity
 restorationHandler:(nonnull void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))restorationHandler
{
 return [RCTLinkingManager application:application
                  continueUserActivity:userActivity
                    restorationHandler:restorationHandler];
}

处理深度链接

有两种方法可以处理打开您应用的 URL。

1. 如果应用程序已打开，则应用程序将置于前台，并触发 Linking 'url' 事件

您可以使用 Linking.addEventListener('url', callback) 处理这些事件 - 它会使用链接的 URL 调用 callback({url})

2. 如果应用程序尚未打开，则会打开该应用程序，并且 url 作为 initialURL 传入

您可以使用 Linking.getInitialURL() 处理这些事件 - 它返回一个 Promise，该 Promise 会解析为 URL（如果有）。

---

示例

打开链接和深度链接（通用链接）

TypeScript

JavaScript

打开自定义设置

TypeScript

JavaScript

获取深度链接

TypeScript

JavaScript

发送 Intent (Android)

TypeScript

JavaScript

参考

方法

addEventListener()

tsx

static addEventListener(
  type: 'url',
  handler: (event: {url: string}) => void,
): EmitterSubscription;

通过监听 url 事件类型并提供处理程序，为 Linking 更改添加处理程序。

---

canOpenURL()

tsx

static canOpenURL(url: string): Promise<boolean>;

确定已安装的应用程序是否可以处理给定的 URL。

该方法返回一个 Promise 对象。当确定是否可以处理给定的 URL 时，Promise 将被解析，并且第一个参数是是否可以打开它。

如果无法检查 URL 是否可以打开，或者当以 Android 11 (SDK 30) 为目标时，如果您没有在 AndroidManifest.xml 中指定相关的 intent 查询，则 Promise 将在 Android 上被拒绝。 同样，在 iOS 上，如果您没有在 Info.plist 中的 LSApplicationQueriesSchemes 键中添加特定的 scheme（见下文），则 Promise 将被拒绝。

参数

名称	类型	描述
url 必需	string	要打开的 URL。

对于 Web URL，必须相应地设置协议 ("http://", "https://")！

此方法在 iOS 9+ 上有限制。来自 官方 Apple 文档

• 如果您的应用程序链接到早期版本的 iOS，但在 iOS 9.0 或更高版本中运行，则您可以调用此方法最多 50 次。 达到该限制后，后续调用始终解析为 false。 如果用户重新安装或升级应用程序，iOS 会重置限制。

从 iOS 9 开始，您的应用程序还需要在 Info.plist 中提供 LSApplicationQueriesSchemes 键，否则 canOpenURL() 将始终解析为 false。

当以 Android 11 (SDK 30) 为目标时，您必须在 AndroidManifest.xml 中为您要处理的 scheme 指定 intent。 可以在 此处 找到常见 intent 的列表。

例如，要处理 https scheme，需要将以下内容添加到您的 manifest 中

<manifest ...>
    <queries>
        <intent>
            <action android:name="android.intent.action.VIEW" />
            <data android:scheme="https"/>
        </intent>
    </queries>
</manifest>

---

getInitialURL()

tsx

static getInitialURL(): Promise<string | null>;

如果应用程序启动是由应用程序链接触发的，它将给出链接 url，否则它将给出 null。

要在 Android 上支持深度链接，请参阅 https://developer.android.com.cn/training/app-indexing/deep-linking.html#handling-intents

当远程 JS 调试处于活动状态时，getInitialURL 可能会返回 null。 禁用调试器以确保它被传递。

---

openSettings()

tsx

static openSettings(): Promise<void>;

打开“设置”应用程序并显示应用程序的自定义设置（如果有）。

---

openURL()

tsx

static openURL(url: string): Promise<any>;

尝试使用任何已安装的应用程序打开给定的 url。

您可以使用其他 URL，例如位置（例如，Android 上的 "geo:37.484847,-122.148386" 或 iOS 上的 "https://maps.apple.com/?ll=37.484847,-122.148386"），联系人或任何其他可以使用已安装应用程序打开的 URL。

该方法返回一个 Promise 对象。 如果用户确认打开对话框或 url 自动打开，则 Promise 将被解析。 如果用户取消打开对话框或 url 没有注册的应用程序，则 Promise 将被拒绝。

参数

名称	类型	描述
url 必需	string	要打开的 URL。

如果系统不知道如何打开指定的 URL，则此方法将失败。 如果您传入的是非 http(s) URL，最好先检查 canOpenURL()。

对于 Web URL，必须相应地设置协议 ("http://", "https://")！

此方法在模拟器中的行为可能有所不同，例如，由于无法访问拨号器应用程序，因此无法在 iOS 模拟器中处理 "tel:" 链接。

---

sendIntent()

Android

tsx

static sendIntent(
  action: string,
  extras?: Array<{key: string; value: string | number | boolean}>,
): Promise<void>;

启动带有 extras 的 Android intent。

参数

名称	类型
action 必需	string
extras	Array<{key: string, value: string ｜ number ｜ boolean}>