iOS Widget开发
在说widget开发前,先来了解下APP Extensions和App Groups:
一、关于App Extensions
extension是iOS8新开放的一种对几个固定系统区域的扩展机制,它可以在一定程度上弥补iOS的沙盒机制对应用间通信的限制。
extension的出现,为用户提供了在其它应用中使用我们应用提供的服务的便捷方式,比如用户可以在Today的widgets中查看应用展示的简略信息,而不用再进到我们的应用中,这将是一种全新的用户体验;但是extension的出现可能会减少用户启动应用的次数。
了解几个关键词
extension point:
系统中支持extension的区域,extension的类别也是据此区分的,iOS上共有Today、Share、Action、Photo Editing、Storage Provider等多种,其中Today中的extension又被称为widget。
每种extension point的使用方式和适合干的活都不一样,因此不存在通用的extension。
app extension:
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之间的关系:
1、不能直接通信:尽管extension的bundle是放在containing app的bundle中,但是他们是两个完全独立的进程,之间不能直接通信。不过extension可以通过openURL的方式启动containing app(当然也能启动其它app),不过必须通过extensionContext借助host app来实现:
- (void)jumpToWidgetAPP:(UIButton *)sender {
[self.extensionContext openURL:[NSURL URLWithString:@"WidgetDemo://xxx"] completionHandler:^(BOOL success) {
NSLog(@"open url result: %d",success);
}];
}
2、可以共享资源数据:extension和containing app可以共同读写一个被称为Shared resources的存储区域,这是通过App Groups实现的,后文将会详述。
3、containing app能够控制extension的出现和隐藏:
让隐藏的插件重新显示YES/隐藏NO
[[NCWidgetController widgetController] setHasContent:YES forWidgetWithBundleIdentifier:@"com.w.app.extension"];
extension和containing app以及host app三者之间的关系:
三者之间的关系可以用官网的两张图片形象说明;
二、关于App Groups
App Groups是iOS8新开放的功能,在OS X上早就可用了,它主要用于同一group下的app共享同一份读写空间,以实现数据共享。extension和containing app共同读写一份数据是很合理的需求,比如系统的股市应用,widget和app中都需要展示几个公司的股票数据,这就可以通过App Groups实现。(如何开启以及使用App Groups下文会说明 )
三、widget开发过程:
接下来我们从环境搭建和业务逻辑实现两大方面来说一下widget开发的过程:(接下来的提到的主项目即为上面说到的containing app)
环境搭建:
1、添加widget项目
在APP中选择target-》 添加一个类型为Today Extension的工程,就是我们想要的widget;含有widget的app目录结构如下:
2、配置证书
由于widget项目和主项目其实是两个独立的appID,因为需要单独给widget配置证书,配置证书的过程参考APP证书配置;
3、开启APP Groups
开启APP Groups是为了widget和app之间实现数据共享;为了便于后续操作,请先确保你的开发者账号在Xcode上处于登录状态。
在app中开启:
TARGETS-->AppExtensionDemo-->Capabilities-->App Groups
找到以后,将App Groups右上角的开关打开,然后选择添加groups,注意命名要规范,比如:group.com.company.app;
在extension中开启:假设创建widget target的名称为TodayExtension,对应的App Group位于
TARGETS-->TodayExtension-->Capabilities-->App Groups
开启的方式和APP中一样,注意必须要保证这里的App Groups名称和APP中相同。
业务逻辑实现:
搭建好开发环境后接下来主要从几个功能实现的角度来谈谈如何进行widget开发。
1、纯代码实现布局
widget项目默认是使用storyboard作为布局的,如果喜欢用纯代码实现布局,则需要做如下处理:
(1)删除Storyboard文件,并在widget项目的plist,删除NSExtensionMainStoryboard;
(2)添加NSExtensionPrincipalClass字段 并设为TodayViewController;
2、设置展开/折叠:
在系统提供的方法中设置widget展开/折叠的高度,即可实现widget的展开/折叠,但是不能主动设置在什么情况下是展开的,在什么情况下的折叠的,也就是说不能代码控制展开还是折叠,只能是用户点击按钮来展开和折叠,苹果没有给出那么多的自由。
3、共享数据
widget做为主项目的扩展,必然要经常和主项目共享数据,上面我们已经提到可以通过App Groups来进行数据共享,具体实现上主要有NSUserDefault和NSFileManager两种方式进行数据共享。
3.1 通过NSUserDefaults共享数据
主项目中存数据:通过以下方式向NSUserDefaults中保存数据:需要注意的是:
1、保存数据的时候必须指明group id;
2、而且要注意NSUserDefaults能够处理的数据只能是可plist化的对象,详情见Property List Programming Guide。
3、为了防止出现数据同步问题,不要忘记调用[shared synchronize];
widget项目中取数据 :对应的读取数据方式:
3.2 通过NSFileManager共享数据
主项目中存数据:
widget项目中取数据:
4、使用主项目的自定义类,以及第三方库
widget开发时,肯定会遇到想使用主项目的类的情况,只需要将要使用的类的.m文件,多加上一个target,选择widget项目即可。(如图)
使用主项目中的第三方库:
我们知道,通过pods维护第三方库的时候Podfile文件会指定每个第三方库要加入的target,因此Widget如果想使用第三方库,只需要在在widget的target中,加上要使用的第三方库即可;
target 'CSMBP-Widget' do
pod 'AFNetworking', '3.1.0'
end
5、唤起主项目
可以通过URL Schemes的方式从widget项目跳转到APP中;
(1)在主项目里配置一个对应widget的URL:
(2)在需要唤起主项目的地方通过self.extensionContext来实现跳转:
[self.extensionContext openURL:[NSURL URLWithString:@"WidgetDemo://xxx"] completionHandler:^(BOOL success) {
NSLog(@"open url result: %d",success);
}];
(3)在主项目appdelegate的openURL代理方法中,截取URL并做处理:
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation {
if ([url.description hasPrefix:@"WidgetDemo://"]) {
// 根据url处理具体跳转页面
}
return YES;
}