iOS Widget开发小结

从iOS8开始, 系统开始支持iOS Widget,就是如下图.
Widget是Extension的一种Today, WWDC2014 Session 205, 讲的就是关于Extensions的开发.

Widget示例

用一个话回答,Widget是什么呢?

Widget就是一个依赖于Container App的另外一个小App.

它有自己Bundle Id,有自己的生命周期.

新建Today Extension Target, 命名为TodayWidget,如下图.

Today Extension

会产生如下的文件夹:

TodayWidget

运行后(注意没有Widget,则需要在编辑中手动添加),产生如图

Widget

这里有个设计问题, 折叠的高度是固定的, 开发者改不了.

具体开发中有以下注意点:

一. 设置`widgetLargestAvailableDisplayMode`及拉起

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view from its nib.
    
    //不设置,iOS10,可能不会出现展开/折叠按钮
    self.extensionContext.widgetLargestAvailableDisplayMode = NCWidgetDisplayModeExpanded;
}

//使用open Url拉起方式
- (void)openContainingAPPWithURL:(NSString *)urlStr{
    //通过extensionContext借助host app调起app
    NSURL *url = [NSURL URLWithString:urlStr.length>0?[urlStr stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding]:@"TodayWidgetTest://"];
    [self.extensionContext openURL:url completionHandler:nil];
}

二. iOS9版本差异

每次进入today页面都会调用这个方法刷新数据,但是iOS9却不会(-_-)???一脸懵逼的什么鬼,事实就是这样.

- (void)widgetPerformUpdateWithCompletionHandler:(void (^)(NCUpdateResult))completionHandler;

所以iOS9我们要自己手动调用一下

- (void)viewWillAppear:(BOOL)animated{
    [super viewWillAppear:animated];
    if ([[[UIDevice currentDevice] systemVersion] floatValue] < 9.9
        && [[[UIDevice currentDevice] systemVersion] floatValue] > 8.9) {
        [self widgetPerformUpdateWithCompletionHandler:^(NCUpdateResult result) {}];
    }
}

三. TodayWidget文件夹中代码或者其他资源(例如图片等)和外部的是不可共用.尝试调用外部的代码会产生编译链接错误.

解决方法:

如果使用cocoapods的话,直接设置好target引用就可以共用库了. 例如下:

target "TodayExtension" do
    pod 'FMDB'              ,       '2.5'
    pod 'Masonry',                  '0.6.4'
end

将共用的资源制作成framework来共用.
一般Widget都是轻量,共用代码不太多,使用手动添加共享资源更加方便快捷. 如下图手动添加蓝色圈里的代码和图库:

手动添加共享资源

注意共享的源文件需要放在工程的根目录下,同级于两个target名文件夹的目录,否则编译器会找不到,编译会失败.

三. 共享数据,需要将Apps建立Group关系.

在苹果开发者个人中心端的工作, 戳我直达:

1, 新建App Groups,点击下图的选项,按提示操作.

App Group

例如建好一个ID为group.testxx.todaywidget的App Group如下:

todaywidget App Group

2, 将App加入到App Group

选中要加入的App Group的App ID,点击编辑,然后开启App Group:

编辑App ID

点击App Group的编辑按钮:

编辑Group

勾选Group:

勾选Group

将Widget的App ID也加入这个Group.
如果有其他需要共享数据的Extension也加进去.

3, 产生新的Provisioning Profiles并在Xcode中使用.

Provisioning Profiles

在Xcode中对应设置

1, 设置App Group,在这个Group的Target都需要设定.

Xcode中设置App Group

2,使用对应的Provisioning Profiles,在这个Group的Target都需要设定.

Provisioning Profiles

没有的话,preferences下载一下:

preferences

在代码中使用共享Group沙盒

1, 沙盒地址如下(Group ID与上面保持一致):

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

2, 共享的UserDefaults(Group ID与上面保持一致):

NSUserDefaults* userDefault = [[NSUserDefaults alloc] initWithSuiteName:@"group.testxx.todaywidget"];

3, 要使用共享keychain数据,要另外开启Keychain Sharing. (由于没这种需求,暂不展开)

Keychain Sharing

关于实时共享数据,可以参考这位童鞋的心得.(戳我)

Widget空白及无法加载

Widget一直空白的原因很可能是崩溃了,在崩溃日志中能够找到.
开发非常注意稳定性,一旦崩溃了,比较难恢复了.
Widget无法加载的原因,很可能是内存占用过大了.
毕竟Widget不停地运行,要注意内存控制,不宜数据量过大的任务,展示过大的图片.(目前只展示了一张图片,只有100K左右, 没出现无法加载的现象)