iOS Widget 开发小结

一、 什么是Extension ?

    扩展 (Extension) 是 iOS 8 和 OSX 10.10 加.入的.一个.非常.大的功能点,开发者可以通过系统提供给我们的扩展接.入点 (Extension point) 来为系统特定的服务提供某些附加的功能。
    Extension并不是独立的,它有一个包含在app bundle中的独立bundle,extension的bundle后缀名是.appex;需要依赖于containning app。
    调试主App则运行主App;调试扩展则运行扩展,扩展App想要使用的图片资源等,需要引入到扩展文件夹下。
    创建一个Extension之前,需要有一个承载扩展的应用,称为containing app。Extension 不能单独存在和发布,随containing app 的安装而安装,随containing app的发布而发布,一个containing app 可以添加多个Extension。
    最后用一个话回答,Widget是什么呢?
    Widget就是一个依赖于Container App的另外一个小App,它有自己Bundle Id,有自己的生命周期.
widget.jpg

二、 添加Widget

1. 添加Today Extension

Xcode菜单 => File => New => Target.. => 选择 Today Extension


todayExtension.png

image.png
2. 查看Widget生成的Info.plist

Bundle display name:Widget在通知栏显示的名称
NSExtension
如果你是使用纯代码进行开发,请按照下面进行操作:
(1)请删除绿色区域代码
(2)请添加红色区域代码


image.png

三、 开发Widget

iOS 8
  1. iOS8下没有折叠和展开功能,默认的Widget高度为self.preferredContentSize设置的高度。
self.preferredContentSize = CGSizeMake(kScreenW, 100);
  1. iOS8下所有组件默认右移30单位,可以通过下面的方法修改上下左右的距离。
- (UIEdgeInsets)widgetMarginInsetsForProposedMarginInsets:(UIEdgeInsets)defaultMarginInsets {
    
    return UIEdgeInsetsMake(0, 0, 0, 0);
}
iOS 10

iOS 10以后,Widget可玩性更高,有了两种显示模式

NCWidgetDisplayModeCompact, // Fixed height,高度固定,最低高度为110
NCWidgetDisplayModeExpanded, // Variable height,高度可变

注意:设定显示模式,需要在设定Size前设定这个属性!

if ([[UIDevice currentDevice] systemVersion].intValue >= 10) {

    self.extensionContext.widgetLargestAvailableDisplayMode = NCWidgetDisplayModeCompact;
    
    // self.extensionContext.widgetLargestAvailableDisplayMode = NCWidgetDisplayModeExpanded;
}

TodayViewController.m viewDidLoad的代码如下:
- (void)viewDidLoad {
    [super viewDidLoad];
    
    if ([[UIDevice currentDevice] systemVersion].intValue >= 10) {
        
        self.extensionContext.widgetLargestAvailableDisplayMode = NCWidgetDisplayModeCompact;
    }
    
    self.preferredContentSize = CGSizeMake(kScreenW, 100);
    
    [self setupUI];
}

- (UIEdgeInsets)widgetMarginInsetsForProposedMarginInsets:(UIEdgeInsets)defaultMarginInsets {
    
    return UIEdgeInsetsMake(0, 0, 0, 0);
}


当显示模式设置为NCWidgetDisplayModeExpanded时,点击折叠和打开时,会触发下面这个方法,在这个方法中可以修改对应状态的高度

- (void)widgetActiveDisplayModeDidChange:(NCWidgetDisplayMode)activeDisplayMode withMaximumSize:(CGSize)maxSize {
    
    if (activeDisplayMode == NCWidgetDisplayModeCompact) {
    
        self.preferredContentSize = CGSizeMake(maxSize.width, 110);
    }
    else {
    
        self.preferredContentSize = CGSizeMake(maxSize.width, 200);
    }
}

在下面的方法中更新视图

-(void)widgetPerformUpdateWithCompletionHandler:(void (^)(NCUpdateResult))completionHandler {
//    NCUpdateResultNewData   新的内容需要重新绘制视图
//    NCUpdateResultNoData    部件不需要更新
//    NCUpdateResultFailed    更新过程中发生错误
  completionHandler(NCUpdateResultNoData);
}

注意:iOS9版本差异,每次进入today页面都会调用这个方法刷新数据,但是iOS9却不会。所以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) {}];
    }
}

四、 共享数据

通过App Groups提供的同一group内app共同读写区域,可以用NSUserDefaults和NSFileManager两种方式实现extension和containing app之间的数据共享。

1. 创建App Groups
image.png
2. 修改主App的App ID

1.勾选App Groups -> Edit


image.png

2.选择刚创建的App Groups -> Continue


image.png
3. 同上修改Widget的App ID

注意:需给Widget创建新的AppID,Bundle ID 需要以主App的Bundle ID为前缀!

4. 添加App Groups

分别为主App和Widget添加App Groups


image.png

五、 两种数据存储方式

1.使用NSUserDefault

这里不能使用[NSUserDefaults standardUserDefaults];方法来初始化NSUserDefault对象,正像之前所说,由于沙盒机制,拓展应用是不允许访问宿主应用的沙盒路径的,因此上述用法是不对的,需要搭配app group完成实例化UserDefaults。正确的使用方式如下:

//存
NSUserDefaults *userDefaults = [[NSUserDefaults alloc] initWithSuiteName:@"申请的AppGroups的ID"];
    [userDefaults setObject:self.textField.text forKey:@"widget"];
    [userDefaults synchronize];
//取
NSUserDefaults *userDefaults = [[NSUserDefaults alloc] initWithSuiteName:@"申请的AppGroups的ID"];
    self.contentStr = [userDefaults objectForKey:@"widget"];
2.使用NSFileManager共享数据
//存
-(BOOL)saveDataByNSFileManager
{
    NSError *err = nil;
    NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"申请的AppGroups的ID"];
    containerURL = [containerURL URLByAppendingPathComponent:@"Library/Caches/ widget"];
    NSString *value = @"asdfasdfasf";
    BOOL result = [value writeToURL:containerURL atomically:YES encoding:NSUTF8StringEncoding error:&err];
    if (!result)
    {
        NSLog(@"%@",err);
    }
    else
    {
        NSLog(@"save value:%@ success.",value);
    }
    return result;
}

//取
-(NSString *)readDataByNSFileManager
{
    NSError *err = nil;
    NSURL *containerURL = [[NSFileManager defaultManager] containerURLForSecurityApplicationGroupIdentifier:@"申请的AppGroups的ID"];
    containerURL = [containerURL URLByAppendingPathComponent:@"Library/Caches/ widget"];
    NSString *value = [NSString stringWithContentsOfURL:containerURL encoding: NSUTF8StringEncoding error:&err];
    return value;
}

六、 应用唤醒

1.配置主App URL Scheme
image.png
2.唤醒主程序
- (void)openURLContainingAPP
{
    [self.extensionContext openURL:[NSURL URLWithString:@"HYWidgetDemo://hello"]
                 completionHandler:^(BOOL success) {
                     NSLog(@"open url result:%d",success);
                 }];
}
3.接收数据
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
{
    [self handleOpenFromWidgetWithUrl:url];
    return YES;
}


#if __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_9_0
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<NSString *,id> *)options
{
    [self handleOpenFromWidgetWithUrl:url];
    return YES;
}
#endif

- (void)handleOpenFromWidgetWithUrl:(NSURL *)url {
    if ([[url absoluteString] hasPrefix:@"HYWidgetDemo"])
    {
        UIAlertController *alertController = [UIAlertController alertControllerWithTitle:@"提示" message:[NSString stringWithFormat:@"你点击了%@",[url host]] preferredStyle:UIAlertControllerStyleAlert];
        UIAlertAction *cancel = [UIAlertAction actionWithTitle:@"取消" style:UIAlertActionStyleCancel handler:^(UIAlertAction * _Nonnull action) {
            
        }];
        UIAlertAction *shure = [UIAlertAction actionWithTitle:@"确定" style:UIAlertActionStyleDefault handler:^(UIAlertAction * _Nonnull action) {
            
        }];
        [alertController addAction:cancel];
        [alertController addAction:shure];
        
        UIWindow *alertWindow = [[UIWindow alloc] initWithFrame:[UIScreen mainScreen].bounds];
        alertWindow.rootViewController = [[UIViewController alloc] init];
        alertWindow.windowLevel = UIWindowLevelAlert + 1;
        [alertWindow makeKeyAndVisible];
        [alertWindow.rootViewController presentViewController:alertController animated:YES completion:nil];
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容

  • 从iOS8开始, 系统开始支持iOS Widget,就是如下图.Widget是Extension的一种Today,...
    iDeveloper阅读 2,331评论 0 4
  • 在说widget开发前,先来了解下APP Extensions和App Groups: 一、关于App Exten...
    爱恨的潮汐阅读 1,018评论 0 2
  • 在说widget开发前,先来了解下APP Extensions和App Groups: 一、关于App Exten...
    P大迷妹阅读 4,258评论 1 10
  • 一直很期待亲子课程,16年4月报名,却一直因为工作忙碌,到17年4月2日Q27期北京班才成行。 近一年,繁忙的工作...
    大树妈妈xiaoling阅读 350评论 0 2
  • 1.今天下午娃和小暖一起玩,给大罐车涂颜色,俩人一边涂一边商量着玩着,我在一边看书,外边下着小雨,打在玻璃上有一声...
    唐23333阅读 481评论 0 3