App Extension Today

 App Extensions 是iOS8新开放的扩展机制，之后不断增加功能。App Extension Programming Guide: Today

 

不喜欢废话，直接上干货！

 

一：重要概念：

extension point

系统中支持extension的区域，extension的类别也是据此区分的，iOS上共有Today、Share、Action、Photo Editing、Storage Provider、Custom keyboard等等种类，其中Today中的extension又被称为widget。每种extension point的使用方式和适合干的活都不一样，因此不存在通用的extension。

 

app extension

app extension并不是一个独立的app，它有一个包含在主app bundle中的独立bundle，extension的bundle后缀名是.appex。其生命周期也和普通app不同。extension不能单独存在，必须有一个包含它的containing app。另外，extension需要用户手动激活，不同的extension激活方式也不同，比如： 比如Today中的widget需要在Today中激活和关闭。

 

containing app

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

containing app的卸载而卸载。

 

host app

能够调起extension的app被称为host app，比如widget的host app就是Today。

 

二、extension和containing app、host app

 

extension和host app

extension和host app之间可以通过extensionContext属性直接通信，该属性是新增加的UIViewController分类：

实际上extension和host app之间是通过IPC（interprocess communication）实现的，只是苹果把调用接口高度抽象了，我们并不需要关注那么底层的东西。

 

containing app和host app

他们之间没有任何直接关系，也从来不需要通信。

 

extension和containing app

不能直接通信

首先，尽管extension的bundle是放在containing app的bundle中，但是他们是两个完全独立的进程，之间不能直接通信。不过extension可以通过openURL的方式启动containing app（当然也能启动其它app），不过必须通过extensionContext借助host app来实现.

 

extension中是无法直接使用openURL的,所以使用  self.extensionContext 。

另外：

 

然后再主APP上面进行截取，判断，可以定点打开某个原生页面，或者H5页面

 

可以共享Shared resources

 

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

 

containing app能够控制extension的出现和隐藏

通过以下代码，containing app可以让extension出现或隐藏（当然extension也可以让自己隐藏）：

//让隐藏的插件重新显示
- (void)showTodayExtension
{
    [[NCWidgetController widgetController] setHasContent:YES forWidgetWithBundleIdentifier:@"com.yoowei.app.extension"];
}

//隐藏插件
- (void)hiddeTodayExtension
{
    [[NCWidgetController widgetController] setHasContent:NO forWidgetWithBundleIdentifier:@"com.yoowei.app.extension"];
}

 

三、App Groups

 

这是iOS8新开放的功能 , 它主要用于同一group下的app共享同一份读写空间，以实现数据共享。

extension和containing app共同读写一份数据是很合理的需求.

 

3.1 功能开启

 

为了便于后续操作，请先确保你的开发者账号在Xcode上处于登录状态。

 

在containing app中开启

App Groups位于：

TARGETS-->AppExtensionYoowei-->Capabilities-->App Groups

找到以后，将App Groups右上角的开关打开，然后选择添加groups，比如我的是group.com.yoowei.app (可以随便起)

 

在extension中开启

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

TARGETS-->TodayExtension-->Capabilities-->App Groups

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

 

在Certificates, Identifiers & Profilest添加

Identifiers -- App Groups  选择右上角➕号添加即可，然后还可以编辑。

 

四、extension和containing app数据共享

 

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

 

4.1 通过NSUserDefaults共享数据

 

存数据

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

- (void)saveTextByNSUserDefaults
{
    NSUserDefaults *shared = [[NSUserDefaults alloc] initWithSuiteName:@"group.com.yoowei.app"];
    [shared setObject:_textField.text forKey:@"yoowei"];
    [shared synchronize];
}

需要注意的是：

 

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

 

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

 

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

 

读数据

对应的读取数据方式：

- (NSString *)readDataFromNSUserDefaults
{
    NSUserDefaults *shared = [[NSUserDefaults alloc] initWithSuiteName:@"group.com.yoowei.app"];
    NSString *value = [shared valueForKey:@"yoowei"];

    return value;
}

 

4.2 通过NSFileManager共享数据

 

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

 

保存数据

- (BOOL)saveTextByNSFileManager
{
    NSError *err = nil;
    NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"group.com.yoowei.app"];
    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.com.yoowei.app"];
    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中？

 

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

 

5.1 copy framework到App Groups

 

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

- (BOOL)copyFrameworkFromMainBundleToAppGroup
{
    NSFileManager *manager = [NSFileManager defaultManager];
    NSError *err = nil;
    NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"group.com.yoowei.app"];
    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;
}

 

5.2 使用framework：

- (BOOL)loadFrameworkInAppGroup
{
    NSError *err = nil;
    NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"group.com.yoowei.app"];
    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的机制或者苹果的审核是否允许这样使用等。

 

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

 

六、生命周期

 

extension和普通app的最大区别之一是生命周期。

 

开始

在用户通过host app点击extension时，系统就会实例化extension应用，这是生命周期的开始。

 

执行任务

在extension启动以后，开始执行它的使命。

 

终止

在用户取消任务，或者任务执行结束，或者开启了一个长时后台任务时，系统会将其杀掉。

 

由此可见，extension就是为了任务而生！

 

通过打印日志发现，Today中的widget在将Today切换到全部或者未读通知时都会被杀掉。

 

七、 调试

 

extension和普通app的调试方式差不多，开始调试前先选中extension对应的scheme，点击run.不出意外的话，会弹出一个框：

choose an app to run  也就是说需要选择一个host app，这里选择Today。

 

注意：

开始调试前先选中extension对应的scheme。

 

八、 iOS8应用文件系统

 

发现iOS8的文件系统发生了变化，新的文件系统将可执行文件（即原来的.app文件）从沙盒中移到了另外一个地方，这样感觉更合理。

 

测试代码

下述代码用于打印App Groups路径、应用的可执行文件路径、对应的Documents路径：

- (void)logAppPath
{
    //app group路径
    NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"group.com.yoowei.app"];
    NSLog(@"app group:
%@",containerURL.path);

    //打印可执行文件路径
    NSLog(@"bundle:
%@",[[NSBundle mainBundle] bundlePath]);

    //打印documents
    NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
    NSString *path = [paths objectAtIndex:0];
    NSLog(@"documents:
%@",path);
}

不管是extension还是containing app，他们的可执行文件和保存数据的目录都是分开存放的，即所有app的可执行文件都放在一个大目录下，保存数据的目录保存在另一个大目录下，同样，AppGroup放在另一个大目录下。

 

 

参考文档

 

http://www.cocoachina.com/industry/20140627/8960.html

 

App Extension Programming Guide

 

Crash Course In iOS 8 Widgets

 

Notification Center Framework Reference

 

iOS 8 Release Notes

 

Entitlement Key Reference

 

苹果的插件生态系统，开发者的新世界

 

iOS 8 Extensions: Apple’s Plan for a Powerful App Ecosystem

 

Property List Programming Guide