Universal Links 实现细节
最近项目中使用到了 Universal Links 功能,下面记录一下实现过程
简介
Universal Links 是一个可以实现外部链接跳转应用的功能。
When you support universal links, iOS users can tap a link to your website and get seamlessly redirected to your installed app without going through Safari. If your app isn’t installed, tapping a link to your website opens your website in Safari.
摘自 App Search Programming Guide - Support Universal Links
一、在你的应用中添加Associated Domains Entitlement
1.如果你目前开发的项目使用的是分发的开发者证书,那么你就需要登录苹果开发者网站,点击 App IDs,找到你的 App 对应的 Bundle ID,并设置Associated Domains Enable
。其中 ID 就是 Bundle ID 或者 通配符ID,Prefix 就是 Team ID(一般情况下),需要记住 Team ID 与 Bundle ID,后面需要用到。
然后需要重新配置 Development Provisioning Profile,下载并安装。
2.如果你在Xcode中登录了你的开发者账号,且项目中设置了 Signing 为 Automatically manage signing,那么你可以省略第一步的设置,不过还是要确认Team ID 与 Bundle ID。
然后在项目中的 Capabilities 中手动打开 Associated Domains,Xcode会自动开启app对应的 App ID 的
Associated Domains Enable
;点击「+」添加
applinks:<fully qualified domain>
,<fully qualified domain>
就是域名,不是IP地址,也不要带http
或https
,可以设置多个applinks
。(如果测试的时候只有一个起作用,可以尝试全部删除,重新添加。)屏幕快照 2019-06-24 下午5.11.55.png
注意:这里一定要确定 app 发布时使用的 Distribution Provisioning Profile 中设置的是不是对应的已经设置
Associated Domains Enable
的 App ID,因为在生成 Distribution Provisioning Profile 是可以选择通配符 App ID 也可以选择唯一 App ID,除了自动生成的*
通配符 App ID,其它的都可以设置Associated Domains Enable
。
官方链接:
Enabling Universal Links
Setting Up an App’s Associated Domains
Associated Domains Entitlement
二、创建并上传apple-app-site-association
文件到服务器
创建一个名为apple-app-site-association
的文件,没有后缀,但是内容是json
格式。apps
必须设置为[]
,appID的结构为TeamID.bundleID
,其中 Team ID 在第一步已经获取到了,bundleID 可以设置唯一ID也可以设置通配符ID,关键就是Bundle ID是否设置了Associated Domains Enable
。
上传时的MINI TYPE
一定是application/json
。上传到服务器的根目录下或者.well-known目录下,且能通过网址https://<fully qualified domain>/apple-app-site-association
或者https://<fully qualified domain>/.well-known/apple-app-site-association
访问这个文件,不论是否是下载还是直接在浏览器中能直接看到文件内容。
{
"applinks": {
"apps": [],
"details": [
{
"appID": "9JA89QQLNQ.com.apple.wwdc",
"paths": [ "/wwdc/news/", "/videos/wwdc/2015/*"]
},
{
"appID": "ABCD1234.com.apple.wwdc",
"paths": [ "*" ]
}
]
}
}
三、测试
1.在官方App Search API Validation Tool网站测试服务器是否配置成功,输入网址:https://<fully qualified domain>
。如果出现以下错误,不要着急,说明配置是成功的。这是因为你的 app 还没有上传到 App Store 的原因。
2.在设备上测试
重要的事情说三遍:
测试时,使用移动流量安装app
测试时,使用移动流量安装app
测试时,使用移动流量安装app
在备忘录中输入测试的网址,直接点击,如果可以直接跳转,恭喜你,你已经成功了。
也可以在 Safari 中输入你的服务器网站https://<fully qualified domain>
,下滑画面:
When your app is installed on an iOS device, the system attempts to download and verify the association file from the domains listed in your entitlement. For each domain, iOS appends /apple-app-site-association (or /.well-known/apple-app-site-association) to its name. With this new URL, the system downloads the contents and ensures the file includes the app’s application identifier.
当你安装 app 后,系统会尝试访问你的服务器并下载apple-app-site-association
文件,文件下载成功就可以跳转了。
第一次测试时,可能会失败,检查之前的设置是否正确,如果没有错误,说明这是因为网络原因,不要着急,等个一两个小时,或者换个好的网络,比如4G,尝试重新安装。
四、处理点击链接跳转到应用的事件
在 AppDelegate.swift 中实现代理方法,官方链接:Handling Universal Links
func application(_ application: UIApplication,
continue userActivity: NSUserActivity,
restorationHandler: @escaping ([Any]?) -> Void) -> Bool
{
guard userActivity.activityType == NSUserActivityTypeBrowsingWeb,
let incomingURL = userActivity.webpageURL,
let components = NSURLComponents(url: incomingURL, resolvingAgainstBaseURL: true),
let path = components.path,
let params = components.queryItems else {
return false
}
print("path = \(path)")
if let albumName = params.first(where: { $0.name == "albumname" } )?.value,
let photoIndex = params.first(where: { $0.name == "index" })?.value {
print("album = \(albumName)")
print("photoIndex = \(photoIndex)")
return true
} else {
print("Either album name or photo index missing")
return false
}
}