在使用相册时,大家应该都用过其分享功能,它可以很方便的分享到各个应用:
那如何让我们自己开发的App也能出现在这个分享面板中,并接收到图片数据呢?
这里就需要用到系统为我们提供的App Extension了;
App Extension
官方文档
简单的说,App Extension 可以让开发者拓展自定义的功能和内容到其他应用,并在用户与其他应用程序或系统交互时提供给用户;
- App Extension不是一个App,它是实现了一个特定任务的模块,它有自己的进程;
- 每一个App Extension都是一个独立的二进制文件,它独立于Containing app。但我们必须使用一个Containing app去包含并发布这个App Extension。
- App Extension的运行并不一定需要Containing app的参与,只要有Host app调用它就会工作
这里需要理解几个概念:
- Containing app:
App Extension的容器app,extension需要依赖于容器app;一个Containing app可以有多个Extension; - Host app
App Extension的宿主app,可以理解为Extension寄生于Host app,由Host app才能调起Extension;Extension可以从Host app获取到数据;
以上面相册分享为例,微信app就是Containing app,相册app就是Host app,分享面板上的微信就是App Extension;
App Extension、Containing app、Host app通信
- App Extension和Containing app不能够直接通信;Containing app没有运行但它包含的App Extension也可以直接运行
- Containing app和Host app没有任何通信
- Host app发起request调用App Extension,并将数据传入context中;App Extension运行并展示界面,从context中获取到数据并处理任务
- App Extension和Containing app确实需要通信的(比如App Extension需要将数据传给Containing app并打开Containing app),可以通过
Shared resources
间接数据共享,并通过Open URL调用Containing app;
Shared resources有几种方式:- UserDefaults
- FileManger
- CoreData
Share Extension
Share Extension是用于上面相册分享功能的一种App Extension;
创建Share Extension:
- 在Containing app的project中添加新的target:File->New->Target->ShareExtension;
- 填写 Product Name及其他常用选项,点击Finish
- 在弹出窗口中选择Activate
- 项目中会自动生成Extension模板文件
ShareViewController用于编写分享的界面及功能,info.plist为相关的配置;
Share Extension调试
经过以上步骤,一个默认的Share Extension就已经实现好了;现在可以调试看下效果:
- scheme切换至Share Extension,选择设备(真机和模拟器均可)运行
- 弹框中选择一个Host app(如照片app)
- 选择后,Share Extension和Containing app都会运行同时会调起Host app
- Host app(照片)选择分享,即可看到我们自己编写的Share Extension了
此时只是有个简单界面没有任何功能,要实现更多功能就要编写ShareViewController;
编写代码
ShareViewController继承自SLComposeServiceViewController,里面实现了上图中默认的分享界面;
代码结构:
override func isContentValid() -> Bool {
// Do validation of contentText and/or NSExtensionContext attachments here
// 验证分享的内容 返回值true则发布按钮会禁用
return true
}
/// 点击右上角post按钮
override func didSelectPost() {
// Inform the host that we're done, so it un-blocks its UI. Note: Alternatively you could call super's -didSelectPost, which will similarly complete the extension context.
// 通知host app任务完成,并且extension界面自动dismiss
self.extensionContext!.completeRequest(returningItems: [], completionHandler: nil)
}
override func configurationItems() -> [Any]! {
// 配置界面item
return []
}
获取分享的数据
数据是通过上下文context存储,UIViewController的extensionContext属性可以获取到该context;
数据存储位置: extensionContext->inputItems->NSExtensionItem->attachments->NSItemProvider
以分享图片为例,获取图片数据的代码:
guard let inputItems = self.extensionContext?.inputItems.map({ $0 as? NSExtensionItem }) else {
self.extensionContext?.cancelRequest(withError: ShareError(message: "extensionItem error"))
return
}
for inputItem in inputItems {
guard let providers = inputItem?.attachments else { return }
for itemProvider in providers {
if (itemProvider.hasItemConformingToTypeIdentifier(kUTTypeImage as String)) {
itemProvider.loadDataRepresentation(forTypeIdentifier: kUTTypeImage as String) { (data, error) in
if error != nil {
self.extensionContext?.cancelRequest(withError: error!)
return
}
guard let imgData = data else {
self.extensionContext?.cancelRequest(withError: ShareError(message: "data error"))
return
}
// 分享的图片
let image = UIImage(data: imgData)
}
}
}
}
获取到图片数据后,再异步处理自己的逻辑;(比如发起网络请求上传图片等)
数据共享
如果App Extension需要调用Containing app处理任务(例如分享到QQ的“发送给好友”),就要实现上面说的间接通信:
在默认情况下,iOS的应用是存在一个沙盒里面的,不允许应用之间直接进行数据交互。也就是说App Extension和Containing app也不能进行数据交互;不过,苹果提供了App Groups 服务用于开发者自己的应用之间进行数据传输。
利用 App Groups 服务传输数据主要有 UserDefaults、FileManager、CoreData 三种方式;
添加App Groups 服务:
分别在App Extension和Containing app和2个target配置中选择 Signing & Capabilities,添加 App Groups Capability ,然后增加一个App Groups
Group的名称统一即可
以UserDefaults为例,实现数据共享代码:
//App Extension
// 保存分享的图片
let ud = UserDefaults.init(suiteName: SUITNAME) // SUITNAME即刚创建的group名
ud?.setValue(imgData, forKey: SHARE_IMAGE_KEY)
// Containing app
// 读取图片
let ud = UserDefaults.init(suiteName: SUITNAME)
if let imageData = ud?.object(forKey: SHARE_IMAGE_KEY) as? Data {
let image = UIImage(data: imageData)
shareImageView.image = image
}
Share Extension中是禁用openURL的,要实现跳转至Containing app需要额外的技巧:
/// 打开Container app
private func openContainerApp() {
let scheme = "momoshare://"
let url: URL = URL(string: scheme)!
let context = NSExtensionContext()
context.open(url, completionHandler: nil)
var responder = self as UIResponder?
let selectorOpenURL = sel_registerName("openURL:")
while (responder != nil) {
if responder!.responds(to: selectorOpenURL) {
responder!.perform(selectorOpenURL, with: url)
break
}
responder = responder?.next
}
}
以上就实现了一个简单界面版的分享功能,测试一下:选择照片并分享至自己的Share Extension,点击post,之后Container app被调起并能显示分享的图片:
自定义UI
如果默认的UI不能满足需求,可以完全自定义UI,只需将ShareViewController 改为继承于UIViewController,然后和平常编写界面一样实现自己的UI ;
Share Extension配置
info.plist用于自定义一些配置;
具体的配置可以参考官方文档;
这里着重讲下NSExtensionActivationRule:
这个配置主要用于设置在各种情况下显示是否显示自己的Share Extension,默认情况是TRUEPREDICATE,也即不管什么情况都显示;其还有以下几个配置;
如果没有添加对应key,则表示不开启、不会显示extension;如果数量不满足条件也不会显示extension;
比如NSExtensionActivationSupportsImageWithMaxCount设置为2,则分享图片时如果选择了3张,则分享面板中就看不到我们的Share Extension;
这里扒拉下微信的配置看下:
可以分析出,微信支持 图片、文件、文字、视频、网页链接分享方式;图片最多能分享9张,文件、视频只能分享一个;如果选择了2个视频分享,面板中找不到微信就不用奇怪
注意事项
Share Extension 的使用限制:
- 不能访问 sharedApplication 对象
- 不能使用任何标记NS_EXTENSION_UNAVAILABLE宏的API,或者类似的宏,或者不可用framework里面的API,例如HealthKit framework不能用于App extensions
- 不能访问相机或者麦克风(iMessage app可以访问这些资源,只要在Info.plist里面进行配置使用描述即可)
- 尽量不要运行一个长时间的后台任务(根据不同平台而异)
- 不能使用AirDrop接收数据
过审:
- 发布App时为了过审,Containing app必须提供基本功能给用户,同时不能只有app extension
- 为了过审,无论你为containing app选择哪种目标设备系列,都必须为app extension指定“iPhone / iPad”(universal)作为目标设备系列