App Clips

该文章属于刘小壮原创,转载请注明:刘小壮


前两天leader让我调研一下App Clips,我简单调研了一下,这是我调研的一些总结,大家可以看看,有问题欢迎评论区讨论。

简介

App Clips类似微信的小程序,不需要显式的去App Store里下载,苹果会在对应的时机进行后台下载。App Clips可以在不打开主App的情况下,单独进行使用,交互操作和主App无异,例如登录、列表视图、支付等。

使用流程

通过Safari Banner、iMessage等如下方式,可以打开App Clips。例如从Safari点击上面的banner调起App Clips,系统会根据调用URL来确定卡片显示的原数据,随后将原数据例如标题、背景图等显示在App Clips的卡片页。

卡片页可以选择是否开启通知以及下载App,进入此页面系统就会开始后台下载App Clips,点击open即可打开App Clips。如果已经安装主App,则打开的就是主App。打开App Clips或主App时,都会带过去一个URL,也就是我们配置的invocation URL,可以对此URL进行解析,以打开对应的页面或功能。

调起流程

开发

App Clips以主工程的一个target的形式存在于项目中,与主工程共享代码及资源文件。App Clips可以访问蓝牙、NFC等硬件,相当于一个smart app。如果有主客户端则调起客户端,如果没有客户端则调起App Clips。

App Clips从iOS14开始支持,所以可以直接用SwiftUI进行开发。

Apple Connect配置

每个应用程序只能有一个App Clips,但可以有多个配置,配置包括image、title、URL等。根据不同的URL,展示不同的配置信息。配置信息在Apple Connect填写,例如标题、封面图等。

信息

开发流程

在主工程中新建一个target并选择为App Clips,并且关联到我们的主工程Fruta即可。对于开发语言我们只能选择Swift,无论你当前的工程是OC还是Swift的。

因为App Clips是从iOS14推出的,而SwiftUI是从iOS13推出的,所以我们可以选择使用SwiftUI进行开发,这也是苹果推荐的开发方案,当然也可以选择UIKit的方式。

创建项目

创建App Clips后,系统会生成对应的iOSClip.entitlements文件,需要在里面设置App Group、Parent Identifier、Associated Domains,以关联主App。

我们填写应用程序标示符时,苹果推荐以{主App Bundle id}+Clip的格式命名,这种命名也更清晰一些。

客户端代码

客户端对于App Clips需要做的处理,主要是解析传入的URL,其他的就都是业务逻辑相关了。对于URL的处理,使用UIKit和SwiftUI的处理方式不同,如果是UIKit则采用下面的方法处理URL传参。

UIKit通过UIScene的代理方法接收回调,例如下面的方式。

func scene(_ scene: UIScene, continue userActivity: NSUserActivity) {
    guard userActivity.activityType == NSUserActivityTypeBrowsingWeb else { return }
    guard let url = userActivity.webpageURL else { return }

    presentExperience(for: url)
}

func presentExperience(for url: URL) {
    // Route user to the appropriate place in your App Clip.
}

SwiftUI的处理方式需要注册一个NSUserActivityTypeBrowsingWeb类型的userActivity,并在回调方法中解析webpageURL即可。

因为如果安装主App后,这个操作就要交由主App来处理,所以主App也需要有相同的处理代码。

struct FrutaAppClip: App {
    var body: some Scene {
        WindowGroup {
            NavigationView {
                SmoothieMenu()
            }
            .onContinueUserActivity(NSUserActivityTypeBrowsingWeb, perform: handleUserActivity)
        }
    }
    
    func handleUserActivity(_ userActivity: NSUserActivity) {
        guard
            let incomingURL = userActivity.webpageURL,
            let components = NSURLComponents(url: incomingURL, resolvingAgainstBaseURL: true),
            let queryItems = components.queryItems
        else {
            return
        }
    }
}

数据共享

App Clips可以和主应用共享数据,也就是相互访问沙盒,将二者的group id设置成相同的即可。这个App Group是需要在苹果后台创建的,如果没有创建则需要进入开发者中心的Groups选项,创建的对应的group id。

App Group

不同target或应用间访问沙盒很简单,可以通过NSUserDefaults并传入对应的group的方式创建userDefaults对象,可以对key、value进行操作。

NSUserDefaults *userDefaults = [[NSUserDefaults alloc] initWithSuiteName:@"group.company.appGroupName"];

还可以通过containerURLForSecurityApplicationGroupIdentifier方法获取到沙盒路径,随后对文件进行操作。

NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:APP_GROUP_ID];
NSURL *directoryPath = [containerURL URLByAppendingPathComponent:GroupShareRelativeDirectory];

通知

App Clips可以接收通知,在info.plist中配置后,代码实现和普通通知一样。可以通过NSAppClipRequestEphemeralUserNotification字段设置开启通知,如果设置此字段后默认为开启,但用户可以点击options关闭通知。苹果允许用户启动App Clips后的八小时内向用户发送通知。

卡片

注意点

  1. 由于是小程序,所以安装包大小被限制在10MB以内。
  2. 一段时间不活动后,系统会将其删掉,类似于微信小程序。
  3. 下面这些库在App Clips不支持,编译时并不会报错,但调用时会出现调用无效等问题。CallKit、CareKit、CloudKit、HealthKit、HomeKit、ResearchKit、SensorKit、Speech。
  4. 为了保护用户隐私,在App Clips中下面的API禁止使用。通讯录、Files、相册、iTunes。
  5. App Clips无法进行后台活动,目前看主要是后台网络请求。

代码差异

在开发App Clips过程中,由于二者大多数使用的都是同一份代码,有些代码可能与主程序有差异,并不能运行到主程序或App Clips上。可以通过在Active Compilation Conditions设置对应的环境变量,来区分不同的target。

设置环境变量

判断代码如下。

#if !APPCLIP
// Code you don't want to use in your app clip.
#else
// Code your app clip may access.
#endif

服务端开发

在打开App Clips之前,苹果会验证配置信息,验证方式是苹果请求公司服务器,公司服务器返回给苹果一个JSON格式的配置文件。苹果要求设置的请求地址必须是https协议,并且不能进行重定向。这里的appIDs指的是App Clips配置的bundle id。

{
  "applinks": {
      "details": [
           {
             "appIDs": [ "ABCDE12345.com.example.app", "ABCDE12345.com.example.app2" ],
             "components": [
               {
                  "#": "no_universal_links",
                  "exclude": true,
                  "comment": "Matches any URL whose fragment equals no_universal_links and instructs the system not to open it as a universal link"
               },
             ]
           }
       ]
   },
   "webcredentials": {
      "apps": [ "ABCDE12345.com.example.app" ]
   }
}

应用推荐

可以在APP clips的下方显示一个叠层,来推荐用户下载我们的App,通过SKOverlay来进行配置。

func displayOverlay() {
    guard let scene = view.window?.windowScene else { return }

    let config = SKOverlay.AppClipConfiguration(position: .bottom)
    let overlay = SKOverlay(configuration: config)
    overlay.present(in: scene)
}

本地测试

进行本地测试时,可以将在Apple Connect中配置的要测试的URL,配置在App Clips的scheme中,并以_XCAppClipURL进行命名来测试,记得将其勾选。

这里的域名需要和Associated Domains一致。

设置调起URL

审核

App Clips是作为应用程序的一部分参与审核的,所以需要随客户端版本上线。