浅谈URL Scheme 在移动终端App中的使用
简介
在移动终端上,运行着各色各样的App。但是这些App也不是完全独立存在的,很多App会使用其他App提供的服务。比如我们在很多App中用到的微信登录、微信分享、支付宝支付等功能,都是调用微信App和支付宝App的能力。这些跨App的能力调用,主要是通过URL Scheme实现。
URL Scheme 是一种在 iOS、Android 等移动操作系统中用于指定App之间进行通信和交互的机制。它允许应用程序定义自己的协议或规范,以便其他应用程序可以通过特定的 URL 格式来调用其功能或与之进行数据交换。
URL Scheme详细格式
URL Scheme协议完整格式:scheme://host:port/path?query_parameters#fragment_identifier
每个组成部分的含义如下所述:
-
scheme
: 表示要使用的协议,例如http、https、ftp等。在URL Scheme中,它代表了特定应用程序的协议,比如mailto
、tel
等。例如,mailto
用于发送电子邮件,tel
用于拨打电话。 -
host
: 表示要访问的主机名或IP地址。对于本地应用程序,可以使用特殊的主机名,例如localhost
。 -
port
(可选): 表示要使用的端口号。它通常是可选的,默认使用协议的默认端口号。例如,HTTP的默认端口是80,HTTPS的默认端口是443。 -
path
(可选): 表示要访问的资源路径。它指定了应用程序或资源的特定位置。对于应用程序,路径可以是特定的操作或页面。对于资源,路径可以是文件或目录路径。 -
query_parameters
(可选): 表示查询参数,用于向应用程序传递额外的数据。它们以键值对的形式出现,用key=value
的格式表示,并使用&
符号分隔多个参数。例如,?param1=value1¶m2=value2
。 -
fragment_identifier
(可选): 表示片段标识符,用于指定资源中的特定片段或位置。它通常在网页中使用,并以符号开头。
在移动应用中,应用程序可以注册自己的 URL Scheme,使得其他应用程序可以通过特定的 URL 格式来启动该应用程序并传递相关的数据。例如,微信应用程序注册了weixin://
这样的 URL Scheme,其他应用程序可以通过调用weixin://
这样的 URL 来启动微信并传递相关的数据。
URL Scheme实现原理
URL Scheme 的基本原理是在应用程序中注册一个自定义的 URL Scheme,然后在应用程序中生成一个特定格式的 URL,包含所需的参数和操作。当用户点击这个 URL 时,操作系统会尝试打开与该 URL 关联的应用程序,并将 URL 传递给该应用程序进行处理,这个过程是一个进程间通信的过程。如果该应用程序未安装或不支持该 URL Scheme,操作系统可能会提示用户安装该应用程序或执行其他操作。
URL Scheme 的实现原理涉及两个主要方面:注册和处理。
Url Scheme原理 (1).png注册URL Scheme
开发者需要在其应用程序的配置文件中注册URL Scheme。这样,操作系统就知道应该将特定的URL请求发送到哪个应用程序进行处理。注册URL Scheme时,开发者需要指定一个唯一的标识符,以便操作系统可以将请求正确地路由到相应的应用程序。
处理URL Scheme 请求
当用户点击包含已注册URL Scheme 的特定链接或执行其他操作时,操作系统会检测到该URL,并将其发送到相应的应用程序进行处理。应用程序需要在其代码中实现一个处理URL Scheme 的方法,以接收并解析传递的参数,并根据需要执行相应的操作。
应用场景
URL Scheme在以下场景中被广泛使用:
-
打开特定应用程序:通过URL Scheme,可以打开特定的应用程序,并执行特定的操作。例如,可以使用
mailto:
协议来打开默认的邮件应用程序,并自动填充收件人、主题和正文内容;可以使用tel:
协议来打开拨号器应用程序并拨打电话。 -
跳转到应用程序内的特定页面:应用程序可以定义自己的URL Scheme,用于在应用程序内导航到特定页面或执行特定操作。这对于在应用程序之间进行无缝转换或在应用程序内部进行深度链接很有用。例如,一个新闻应用程序可以使用自定义的URL Scheme来打开文章详情页面。
-
传递数据给应用程序:通过URL Scheme的查询参数,可以向应用程序传递数据。这对于从其他应用程序向目标应用程序发送数据或执行特定操作非常有用。例如,可以使用自定义的URL Scheme将数据传递给笔记应用程序,以创建新的笔记。
-
自定义协议交互:URL Scheme还可以用于自定义协议交互,使应用程序能够与其他应用程序或服务进行通信。例如,OAuth认证过程中,应用程序可以使用特定的URL Scheme来接收授权码或访问令牌。
-
在移动应用程序之间进行跳转:在移动应用程序开发中,URL Scheme可以用于在不同的应用程序之间进行跳转。通过在应用程序中使用特定的URL Scheme链接,用户可以从一个应用程序无缝地切换到另一个应用程序。
实现方式
iOS实现
在Info.plist中注册
-
在
Info.plist
中的URL Types
部分,新增新的URL Type
。 -
在
URL Schemes
字段中,输入你想要使用的自定义URL Scheme
。例如,本例截图设置的:schemedemo
,表示应用程序可以响应schemedemo://
链接。 -
如果你的应用程序需要在不同的
URL Scheme
下进行响应,可以点击右边的+
按钮来添加更多的URL Scheme
。 -
可选:如果你的
URL Scheme
需要传递参数,你可以在URL Schemes
字段后面添加URL Identifier
字段。这将允许你指定一个标识符,用于在应用程序中解析URL。
通过XXDelegate协议处理请求
在应用程序的AppDelegate
或SceneDelegate
类中(和不同的iOS版本有关),通过相应的回调方法,获取通过参数url
来获取传入的URL Scheme
。本文以SceneDelegate
类为例,在(void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts
方法中,获取包含URL Scheme内容的URL对象。
- (void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
UIOpenURLContext *context = URLContexts.allObjects.firstObject;
if (context) {
NSLog(@"%@", context.URL);
NSLog(@"%@", context.options);
NSLog(@"scheme = %@", [context.URL scheme]);
NSLog(@"host = %@", [context.URL host]);
NSLog(@"port = %@", [context.URL port]);
NSLog(@"path = %@", [context.URL path]);
NSLog(@"query = %@", [context.URL query]);
}
}
通过URL Scheme唤起页面
通过UIApplication
的openURL
方法,打开URL Scheme
。例如:
NSString *url = @"schemedemo://com.zr.example:9999/home/mainPage?key01=value01&key02=value02";
[[UIApplication sharedApplication] openURL:[NSURL URLWithString:url] options:@{} completionHandler:nil];
Android实现
在AndroidManifest.xml文件中定义
- 设置Activity的action
<action android:name="android.intent.action.VIEW" />
- 设置Activity的category
<category android:name="android.intent.category.DEFAULT" />
- 设置URL Scheme的具体内容,使用data标签
<data
android:scheme="schemedemo"
android:host="com.zr.example"
android:port="9999"
android:path="/home/mainPage"
/>
一个整体Activity设置URL Scheme例子如下:
<activity android:name=".MainActivity">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.LAUNCHER" />
<data
android:scheme="schemedemo"
android:host="com.zr.example"
android:port="9999"
android:path="/home/mainPage"
/>
</intent-filter>
</activity>
在Activity的Intent中接收处理
在Activity中,使用getIntent()
方法来获取启动Activity的Intent。然后,我们检查Intent是否存在,并且是否包含数据(URL)。如果有数据,我们使用getData()
方法获取URL的Uri对象,然后可以使用Uri对象的相关方法(如getScheme()
、getHost()
、getPath()
、getQuery()
)来获取URL Scheme的详细信息。例如:
private void initData() {
Intent intent = getIntent();
Uri uri = intent.getData();
if (uri != null) {
//完整的url信息
String url = uri.toString();
//scheme部分
String schemes = uri.getScheme();
//host部分
String host = uri.getHost();
//port部分
int port = uri.getPort();
//访问路径
String path = uri.getPath();
//query部分
String queryString = uri.getQuery();
}
}
获取Intent主要有两个时机:
-
Activity首次打开:在onCreate()方法中获取
-
Activity处于活动状态:在onNewIntent方法中获取
通过URL Scheme唤起页面
创建一个新的Intent
对象,并使用Intent.ACTION_VIEW
来指定action。使用Uri.parse()
将URL Scheme字符串转换为Uri对象,并将其作为Intent的数据源。最后,通过调用startActivity(intent)
来启动这个Intent。例如:
Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse("schemedemo://com.zr.example:9999/home/mainPage?key01=value01&key02=value02"));
startActivity(intent);
H5实现
H5页面,主要是作为唤起方,通过URL Scheme唤起应用并传递数据。实现方式主要有两种,分别是基于HTML
和JavaScript
的方式。
HTML使用
在 HTML 中,可以使用 <a>
标签来创建一个 URL Scheme 链接。例如:
<a href="schemedemo://com.zr.example:9999/home/mainPage?key01=value01&key02=value02">打开应用程序</a>
JavaScript使用
在 JavaScript 中,可以使用 window.location.href
属性来打开一个 URL Scheme 链接。例如:
window.location.href = "schemedemo://com.zr.example:9999/home/mainPage?key01=value01&key02=value02";
结束语
总而言之,URL Scheme提供了一种标准化的方式,使应用程序能够通过链接进行交互,并在不同的应用程序之间实现无缝的导航、数据传递和操作执行。通过定义和使用自己的 URL Scheme,你可以为你的应用程序提供更好的可用性和整合性。