iOS - App Extension 整体总结

一、App Extension的介绍

　　App Extension可以让你扩展你APP的自定义功能和内容，使用户可以在与其他应用或者系统进行互动的时候去使用它。app extension即为本文所说的extension。extension并不是一个独立的app，它有一个包含在app bundle中的独立bundle，extension的bundle后缀名是.appex。其生命周期也和普通app不同，这些后文将会详述。extension不能单独存在，必须有一个包含它的containing app。扩展（app Extension ）是 iOS 8 中引入的一个非常重要的新特性

　　extension的激活方式：不同的extension激活方式也不同，有的extension需要用户手动激活而有的可以在任何应用里被激活，比如：Today中的widget需要在Today中激活和关闭；Custom keyboard需要在设置中进行相关设置；Photo Editing需要在使用照片时在照片管理器中激活或关闭；Storage Provider可以在选择文件时出现；Share和Action可以在任何应用里被激活，但前提是开发者需要设置Activation Rules，以确定extension需要在合适出现。

　　我们平时看到的Widget、微信和QQ的share等等，都是App Extension，下图是一些例子：

                                     

　

几个关键词

 

extension point

系统中支持extension的区域叫做extension point(扩展点)，extension的类别也是据此区分的，iOS上共有Today、Share、Action、Photo Editing、Storage Provider、Custom keyboard几种，其中Today中的extension又被称为widget。

每种extension point的使用方式和适合干的活都不一样，因此不存在通用的extension。

 

containing app

containing app我们可以把它理解为容器App，就像上图的微信share extension，容器app就是微信。

尽管苹果开放了extension，但是在iOS中extension并不能单独存在，要想提交到AppStore，必须将extension包含在一个app中提交，并且app的实现部分不能为空,这个包含extension的app就叫containing app。

extension会随着containing app的安装而安装，同时随着containing app的卸载而卸载。

 

host app

我们可以把它理解为宿主的App，能够调起extension的app被称为host app，比如：Safari app 里面网页分享到微信,  Safari就是 host app ; widget的host app就是Today。

二、 Extension的种类

我们可以在Xcode的File--->New--->Target里面看到不同平台的Extension，包括iOS、watchOS、tvOS、macOS等等。这里主要介绍iOS，主要包括以下几种Extensions：

也可直接参考官方文档

iOS 8 系统有 6 个支持扩展的系统区域，分别是 Today 、 Share 、 Action 、 Photo Editing 、 Storage Provider 、 Custom keyboard 。支持扩展的系统区域也被称为扩展点。

Today Widget

Today扩展 可以快速获取更新或者在通知中心的近日视图中执行一项快速任务。对于赛事比分，股票、天气、快递这类需要实时获取的信息，可以在通知中心的Today 视图中创建一个 Today 扩展实现。 Today 扩展又称为 Widget 。

Today扩展效果图

 

Share Extension

分享扩展，发布一个共享网站或者与其他应用共享内容，在 iOS 8 之前，用户只有 Facebook,Twitter 等有限的几个分享选项可以选择。在 iOS 8 中，开发者可以创建自定义的分享选项。

Share扩展效果图

Action Extension

动作扩展，在另一个应用程序的上下文中操作或者查看内容, 在所有支持的扩展点中扩展性最强的一个。它可以实现转换另一个 app 上下文中的内容。苹果在 WWDC 大会上演示了一个 Bing 翻译动作扩展，它可以将在 Safari 中选中的文本翻译成不同的语言。

     

Action扩展效果图

注意⚠️：Host App（照片、Safari、邮件、语音等）分享菜单第一行是：Share Extension ；第二行是: Action Extension；

Photo Editing

图片编辑扩展，在照片app中编辑照片或者视频，在 iOS 8 之前，如果你想为你的照片添加一个特殊的滤镜，你需要进入第三方 app 中，这个过程是相当繁琐的。在 iOS 8 中，你可以直接在 Photos 中使用第三方 app ，如 Instagram ， VSCO cam 、 Aviary 提供的 Photo Editing 扩展完成对图片的编辑，而无需离开当前的 app 。

 

Photo Editing扩展效果图

Document Provider

Document Provider 让跨多个文件存储服务之间的管理变得更简单。类似 Dropbox 、 Google Drive 等存储提供商通过在 iOS 8 中提供一个 Document Provider 扩展， app 直接可以使用这些扩展检索和存储文件而不再需要创建不必要的拷贝。

 

Document Provider扩展效果图

Custom Keyboard

键盘扩展，例如第三方的键盘，搜狗输入法，百度输入法等。苹果公司在 2007 年率先推出了触摸屏键盘，但一直没多大改进。在这一方面， Android 则将键盘权限开放给了第三方开发者，所以出现了许多像 Swype ， SwiftKey 等优秀的键盘输入法。在 iOS 8 中，苹果终于将键盘权限开发给了第三方开发者，自定义键盘输入法可以让用户在整个系统范围内使用。

 

Custom Keyboard扩展效果图

 

以下是iOS 9和之后中新增扩展

1.Audio Unit Extension：音频单元扩展

2.Broadcast UI Extension：广播UI 扩展

3.Broadcast Upload Extension：广播上传扩展

4.Call Directory Extension：呼叫目录扩展

5.Content Blocker Extension：内容拦截器扩展

6.iMessage Extension：消息的扩展

7.Intents Extension：Intents扩展

8.Intents UI Extension：Intents UI扩展

9.Notification Content Extension：通知内容扩展

10.Notification Service Extension：通知服务扩展

11.Shared Links Extension：分享链接扩展

12.Spotlight Index Extension：Spotlight 索引扩展

13.Sticker Pack Extension：贴纸包扩展

三、App Extensions的生命周期

以下是苹果官方提供的图片：

1.用户选择要使用的App extension

2.系统启动App Extension

3.App Extension 代码运行

4.运行完之后系统kill掉App Extension

这就是App Extension的生命周期，举个例子：

一个Share Extension，在图库里面你选择了一张图片，然后点击分享，选择你的Share Extension(第一步)，此时系统会启动你的Share Extension（第二步）。然后你将选择的图片分享到指定的程序（例如微信的发送给朋友）（第三步）。接下来分享页面关闭，系统kill掉了Share Extension。

四、App Extension的通信方式

App Extension主要的通信是和他的host app

Host app (如微信)  ； App extension （safari里面分享点击出来的微信extension）；Containing app (safari)

这个展示的就是正在运行的App Extension、host app和containing app之间的关系。可以看出：Containing App和app Extension并没有直接的沟通。甚至有的时候Containing app可以不运行，而App Extension直接运行。Containing app和Host app没有任何的沟通。

在一个典型的request/response中，系统打开代表host app(图库)的extension（微信分享的share extension），把host app提供的数据(图片和选择的好友)输送到extension的context，然后extension展示界面，提供一些功能任务（例如微信的分享到朋友）。

还有一种是app extension可以直接和他的containing app沟通：

例如Today Widget，可以直接告诉系统打开他的Containing app，只需要调用NSExtensionContext的openURL:CompletionHandler:方法即可。

app extension和containing app可以共同读写一个被称为Shared resources的存储区域，这是通过App Groups实现的。

这里需要注意的是：

只有 Today Extension 才支持通过调用 -[NSExtensionContext openURL:completionHandler:] 访问 URL Scheme 链接打开 Containing App。

在 iOS 8.3 之前，Share/Action Extension 要想实现 URL Scheme，可通过创建一个 Sink UIWebVew （所谓“Sink”是指隐而不显，例如frame=CGRectZero）对 URL 进行 loadRequest 实现曲线救国。但是在 iOS 8.3 之后苹果在系统层面和评审阶段都枪毙了这种违规的做法。

根据苹果官方对 Share Extension 的原教旨，其被建议用于 Facebook/WeiBo 那种社交分享（social sharing websites）或 WeChat/WunderList 那种上传会话服务（upload services）场景，被设定（限定）在 Host App 弹出的模态窗口中轻量交互完成分享，不建议（禁止）调起 Containing App 这种大动作来完成分享任务！

但是如果你不怕苹果审核不通过 或者 下架 也可以用以下方法打开：

//    UIWebView *webView = [[UIWebView alloc]init];
//    webView.hidden = YES;
//    NSURLRequest *request = [[NSURLRequest alloc]initWithURL:[NSURL URLWithString:@"weixin://"]];
//    [webView loadRequest:request];
//    [self.view addSubview:webView]; //这个方法已经打不开了

    UIResponder* responder = self;
    while ((responder = [responder nextResponder]) != nil) {
        if ([responder respondsToSelector:@selector(openURL:)] == YES) {
            [responder performSelector:@selector(openURL:) withObject:[NSURL URLWithString:[NSString stringWithFormat:@"weixin://"]]];
        }
    }

stackoverflow 里面有关于 Share Extension to open containing app 相关的解答

五、App Groups 实现数据共享

这是iOS8新开放的功能，在OS X上早就可用了。它主要用于同一group下的app共享同一份读写空间，以实现数据共享。

extension和containing app共同读写一份数据是很合理的需求，比如系统的股市应用，widget和app中都需要展示几个公司的股票数据，这就可以通过App Groups实现。

 

功能开启 

为了便于后续操作，请先确保你的开发者账号在Xcode上处于登录状态。（或者在开发者账号中先创建好app group id ）

 

一、在app中开启

App Groups位于：

1. TARGETS-->AppExtensionDemo-->Capabilities-->App Groups

找到以后，将App Groups右上角的开关打开，然后选择添加groups，比如我的是group.wangzz，当然这是为了测试随便起得名字，正规点得命名规则应该是：group.com.company.app。

 

添加成功以后如下图所示：

 

 

二、在extension中也要开启

我创建的是widget，target名称为TodayExtension，对应的App Groups位于：

1. TARGETS-->TodayExtension-->Capabilities-->App Groups

开启方式和app中一样，需要注意的是必须保证这里地App Groups名称和app中的相同，即为group.wangzz。

 

三、extension和containing app数据共享

App Groups给我们提供了同一group内app可以共同读写的区域，可以通过以下方式实现数据共享：

 

3.1 通过NSUserDefaults共享数据

存数据

通过以下方式向NSUserDefaults中保存数据：

- (void)saveTextByNSUserDefaults { 

    NSUserDefaults *shared = [[NSUserDefaults alloc] initWithSuiteName:@"group.wangzz"]; 

    [shared setObject:_textField.text forKey:@"wangzz"]; 

    [shared synchronize]; 

} 

需要注意的是：

 

1.保存数据的时候必须指明group id；

 

2.而且要注意NSUserDefaults能够处理的数据只能是可plist化的对象，详情见Property List Programming Guide。

 

3.为了防止出现数据同步问题，不要忘记调用[shared synchronize];

 

读数据

对应的读取数据方式：

- (NSString *)readDataFromNSUserDefaults {
    NSUserDefaults *shared = [[NSUserDefaults alloc] initWithSuiteName:@"group.wangzz"]; 

    NSString *value = [shared valueForKey:@"wangzz"]; 

　return value;
} 

3.2 通过NSFileManager共享数据

 

NSFileManager在iOS7提供了containerURLForSecurityApplicationGroupIdentifier方法，可以用来实现app group共享数据。

 

保存数据

- (BOOL)saveTextByNSFileManager { 

    NSError *err = nil;
    NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"group.wangzz"]; 

    containerURL = [containerURL URLByAppendingPathComponent:@"Library/Caches/good"]; 

    NSString *value = _textField.text;
    BOOL result = [value writeToURL:containerURL atomically:YES encoding:NSUTF8StringEncoding error:&err]; 

    if (!result) { 

        NSLog(@"%@",err);
    } else { 

        NSLog(@"save value:%@ success.",value);
    } 

    return result; 

} 

读数据

- (NSString *)readTextByNSFileManager { 

    NSError *err = nil; 

    NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"group.wangzz"]; 

    containerURL = [containerURL URLByAppendingPathComponent:@"Library/Caches/good"]; 

    NSString *value = [NSString stringWithContentsOfURL:containerURL encoding:NSUTF8StringEncoding error:&err]; 

　  return value;
} 

 

在这里我试着保存和读取的是字符串数据，但读写SQlite我相信也是没问题的。

 

数据同步

两个应用共同读取同一份数据，就会引发数据同步问题。WWDC2014的视频中建议使用NSFileCoordination实现普通文件的读写同步，而数据库可以使用CoreData,Sqlite也支持同步。

 

四、extension和containing app代码共享

 

和数据共享类似，extension和containing app很自然地会有一些业务逻辑上可以共用的代码，这时可以通过iOS8中刚开放使用的framework实现。苹果在App Extension Programming Guide中是这样描述的：

 

In iOS 8.0 and later, you can use an embedded framework to share code between your extension and its containing app. For example, if you develop image-processing code that you want both your Photo Editing extension and its containing app to share, you can put the code into a framework and embed it in both targets.

 

即将framework分别嵌入到extension和containing app的target中实现代码共享。(意思是：需要分别要将framework分别copy到extension和containing app的main bundle中。) 也就是说代码是不可以共享的 要想用containing app的代码只有 在copy 一份。

 

 

以下自己思考的作为参考：

参考extension和containing app数据共享，我试想能不能将framework只保存一份放在App Groups区域？

4.1 copy framework到App Groups

 

在app首次启动的时候将framework放到App Groups区域：

- (BOOL)copyFrameworkFromMainBundleToAppGroup { 

    NSFileManager *manager = [NSFileManager defaultManager]; 

    NSError *err = nil; 

    NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"group.wangzz"]; 

    NSString *sorPath = [NSString stringWithFormat:@"%@/Dylib.framework",[[NSBundle mainBundle] bundlePath]]; 

    NSString *desPath = [NSString stringWithFormat:@"%@/Library/Caches/Dylib.framework",containerURL.path]; 

    BOOL removeResult = [manager removeItemAtPath:desPath error:&err]; 

    if (!removeResult) {
        NSLog(@"%@",err);
    } else {
        NSLog(@"remove success.");
    } 

    BOOL copyResult = [[NSFileManager defaultManager] copyItemAtPath:sorPath toPath:desPath error:&err]; 

    if (!copyResult) {
        NSLog(@"%@",err);
    } else {
        NSLog(@"copy success.");
    } 

    return copyResult; 

} 

 

4.2 使用framework：

- (BOOL)loadFrameworkInAppGroup
{ 

    NSError *err = nil; 

    NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"group.wangzz"]; 

    NSString *desPath = [NSString stringWithFormat:@"%@/Library/Caches/Dylib.framework",containerURL.path]; 

    NSBundle *bundle = [NSBundle bundleWithPath:desPath]; 

    BOOL result = [bundle loadAndReturnError:&err]; 

    if (result) { 

        Class root = NSClassFromString(@"Person"); 

        if (root) { 

            Person *person = [[root alloc] init]; 

            if (person) { 

                [person run]; 

            } 

        } 

    } else { 

        NSLog(@"%@",err); 

    } 

return result; 

}      

经过测试，竟然能够加载成功。

 

需要说明的是，这里只是说那么用是可以成功加载framework，但还面临不少问题，比如如果用户在启动app之前去使用extension，这时framework还没有copy过去，怎么处理；另外iOS的机制或者苹果的审核是否允许这样使用等。

 

在一切确定下来之前还是乖乖按文档中的方式使用吧。

 

六、在App Extension中不可以做的事情

一个app extension不能有以下情况：

1.访问sharedApplication对象。因此不能使用任何该对象的防范

2.使用任何标记NS_EXTENSION_UNAVAILABLE宏的API，或者类似的宏，或者不可用framework里面的API，例如HealthKit framework不能用于app extensions

3.iOS设备访问相机或者麦克风（iMessage app可以访问这些资源，只要在Info.plist里面进行配置使用描述即可）

4.运行一个长时间的后台任务（根据不同平台而异）

5.使用AirDrop接收数据