最近,关于苹果Universal Links,我发现有很多苹果开发者遇到微信分享或打开小程序多次跳转微信后连接中后又返回APP的问题,谷歌了很久没有一个说到关键点上,当然也是因为我对官方文档的解读存在理解偏差,让我踩了多次坑。接下来,为大家全面又重点的说明,保证你能立马解决Universal Links跳转问题😄。
重点排查:
在apple-app-site-association文件格式正确的情况下,是否放在指定服务器根目录或者根目录新建的.well-known/文件夹下。
比如你的apple-app-site-association文件需要放在如下路径:
https://x.y.com/apple-app-site-association
或者
https://x.y.com/.well-known/apple-app-site-association
否则,JSON文件在客户端是down不下来的。错误示例:
https://x.y.com/a/b/apple-app-site-association
或者
https://x.y.com/a/b/.well-known/apple-app-site-association
全面弄清楚Universal Links需要理解以下几个概念及关系:
- Universal Links
- Associated Domains
- apple-app-site-association
Universal Links
Universal Links是苹果推出的通用链接,它的用处是iOS用户可以点击指向你网站的链接并无缝重定向到你的APP,不需要再通过Safari。你可能会问,这种打开APP的操作一个scheme不就可以了。是的,但是苹果要这样干,咱也不敢问,况且微信QQ已经放弃scheme,为了能够使用微信分享、支付和小程序,也只能使用Universal Links方式了。关于Universal Links最终定义,文末示例有说明。
Associated Domains
Associated Domains是关联域,简单理解就是存放关联域文件apple-app-site-association的地方,本文中,我们的JSON文件放在https://x.y.com/apple-app-site-association
或者https://x.y.com/.well-known/apple-app-site-association
下,那么它的关联域就是x.y.com
,并且需要同步配置在Xcode工程Associated Domains内,格式要严格按照:applinks:x.y.com,
apple-app-site-association
apple-app-site-association就是关联域文件,这里面苹果那边有个版本的更新。
旧的格式是这样:
{
"applinks": {
"apps": [],
"details": [
{
"appID": "teamID.BundleID",
"paths": [ "/mm/nn/", "/sb/*"] //匹配路径为/mm/nn/的URL,匹配路径以/sb/为开头的任意URL
},
{
"appID": "teamID.BundleID2",
"paths": [ "*" ] //匹配任意路径的URL
}
]
}
}
新的改成这样:
{
"applinks": {
"details": [
{
"appIDs": [ "teamID.BundleID", "teamID.BundleID2" ],
"components": [
{
"#": "no_universal_links",
"exclude": true,
"comment": "这是和Universal Links不匹配的一个安全提示,咱不管,抄过来即可"
},
{
"/": "/mm/nn/*",
"exclude": true,
"comment": "匹配路径以/mm/nn/为开头的任意URL"
},
{
"/": "/sb/*",
"comment": "匹配路径以/sb/为开头的任意URL"
},
{
"/": "/help/*",
"?": { "articleNumber": "????" },
"comment": "暂时用不上,不管"
}
]
}
]
},
"webcredentials": {
"apps": [ "teamID.BundleID", "teamID.BundleID2" ]
},
"appclips": {
"apps": ["teamID.BundleID.Clip", "teamID.BundleID2.Clip" ]
}
}
格式上,别犹豫,用新的。如果用了老的,问题不大,苹果已经做了兼容。但是不论是新老版本的JSON文件,如果有文件上的改动,注意不要影响老版本。比如BundleID改了,路径改了,可以新增,但是别替换。
示例中"teamID"就是你的开发者账号对应的teamID,其他完全按照官方格式来即可。比较重要的老格式中的"paths"字段和新格式中的"/"字段,它们表示URL匹配符,比如"/mm/nn/*"就表示匹配路径以/mm/nn/开头的任何URL。
简单举例:本例中,apple-app-site-association放在了https://x.y.com/.well-known/apple-app-site-association
,
本例中Universal Links它可以是:https://x.y.com/mm/nn/
或者https://x.y.com/sb/a/
或者https://x.y.com/
或者https://x.y.com/mm/nn/a/
或者https://x.y.com/help/a/b/
都行,明白了吗?它的格式就是Associated Domains + apple-app-site-association中定义的路径(文中有官方格式说明) + 其他子路径(可加可不加),但是微信开放平台等三方平台中的Universal Links必须和其保持一致。可以通过Safari浏览器中输入Universal Links,看顶部是否有打开你的App的提示(微信等也会通过该Universal Links直接跳转返回我们的APP)。
比如:
相信已经比较清晰了,有几点注意事项:
- 关于关联域,它可以是你们公司的官网地址,也可以是其他稳定域,比如阿里云等。
- apple-app-site-association还是按照苹果官网最新要求放在服务器根目录下新建的.well-known/文件夹下,需要同步给公司的运维小伙伴,直接放在根目录可能运维后期不易理解不好维护。
- 关于版本兼容,这个水比较深,第一,若你的应用先用了老版本的apple-app-site-association,放在原来的关联域服务器下,但是现在需要升级,为了不影响原来的老版本APP使用,可以放在新的关联域下。因为苹果对apple-app-site-association的管理有时效、有缓存、也有规则。若APP已经下载过apple-app-site-association文件,再次下载触发的条件比较苛刻,比如重装、更新、达到指定周期。该周期,网上说是1-3天,我还没测出来,不敢妄加揣测。稳一点,换一个自家服务器存放该文件。APP会第一时间下载更新后的apple-app-site-association文件。
- 关联域,请确保它的稳定性,不要把放在根目录下的apple-app-site-association文件弄丢了,我们因为官网更新把该文件弄丢导致大批量的用户打开微信失败。还有一个比较重要的是,请确保该关联域不要关联多个服务器,若有多个服务器,除非每个服务器上都配置了apple-app-site-association,否则无法下载该文件,一样无法使用。
- 若有其他问题,欢迎咨询讨论,1262078574@qq.com
参考文献:
https://developer.apple.com/library/archive/documentation/General/Conceptual/AppSearch/UniversalLinks.html
https://developer.apple.com/documentation/xcode/supporting-associated-domains
https://support.iterable.com/hc/en-us/articles/360035496511-iOS-Universal-Links-