iOS widget控件开发细节

iOS 8开始, 苹果公司推出了today widget. 用来方便用户查看各个app的个性消息.

去github下载Demo

目录

• 创建一个widget
• 如何去掉today widget的storyboard 的绑定
• widget 布局
• widget唤醒拉起app
• widget和宿主程序间数据访问
• 更改widget显示的名称
• 设置widget的展开/折叠
• widget也需要配置AppId 和配置文件
• 修改AppID支持App group
• widget工程使用宿主工程中的类文件
• widget工程使用宿主工程中的第三方库
• 需要注意的问题

创建一个widget

在需要添加widget功能的工程中, 点击"file - new - target", 如下图:

Create today extension.png

创建后, 工程列表如下图:

工程目录.png

去掉today widget的storyboard 的绑定

我个人习惯使用代码编写, 去掉默认的storyboard.
点击widget中的info.plist , 将NSExtension节点的NSExtensionMainStoryboard子节点删除, 添加NSExtensionPrincipalClass子节点, value设置为类文件名, 例如本案例中的TodayViewController. 修改后如图:

去掉了sb.png

widget 布局

因为widget容器本来就存在边框(大概是8), 计算容器的宽度, 然后在容器中布局, 需要用屏幕宽度减去 8*2, 如下布局:

布局.png

- (void)viewDidLoad {
    [super viewDidLoad];
    self.view.backgroundColor = [UIColor clearColor];
    
    int num = 4;
    CGFloat sw = self.view.bounds.size.width -8*2;  //容器貌似有两个边距.
    CGFloat y = 20;
    CGFloat margin = 20;
    CGFloat btnW = (sw - margin*(num+1))/num;
    
    for (int i=0; i<num; i++) {
        CGFloat x = margin + i*(margin+btnW);
        UIButton *btn = [[UIButton alloc] initWithFrame:CGRectMake(x, y, btnW, btnW)];
        int tag = i;
        UIColor *bgColor = [UIColor redColor];
        if (tag == 3) {
            bgColor = [UIColor yellowColor];
        }
        else if(tag == 2){
            bgColor = [UIColor blueColor];
        }
        else if(tag == 1){
            bgColor = [UIColor orangeColor];
        }
        [btn setBackgroundColor:bgColor];
        btn.layer.cornerRadius = 8;
        btn.tag = i;
        [self.view addSubview:btn];
        [btn addTarget:self action:@selector(openURLContainingAPP:) forControlEvents:UIControlEventTouchUpInside];
    }
}
//去掉默认的缩进
-(UIEdgeInsets)widgetMarginInsetsForProposedMarginInsets:(UIEdgeInsets)defaultMarginInsets {
    return UIEdgeInsetsZero;
}

widget唤醒拉起app

widget控制器中

- (void)openURLContainingAPP:(UIButton *)sender{
    //通过extensionContext借助host app调起app
    [self.extensionContext openURL:[NSURL URLWithString:[NSString stringWithFormat:@"mywidgettest://%@?tag=%ld",kWidgetBiaozhi, (long)sender.tag]] completionHandler:^(BOOL success) {
        NSLog(@"open url result:%d",success);
    }];
}

配置url types.png

appDelegate中

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<NSString *,id> *)options {
    NSString *urlStr = url.absoluteString;
    if ([urlStr rangeOfString:kWidgetBiaozhi].length>0) {
        NSRange range = [urlStr rangeOfString:@"tag="];
        int tag = 0;
        if (range.length>0) {
            tag = [[urlStr substringFromIndex:(range.location+range.length)] intValue];
            NSLog(@"tag:%d",tag);
        }
        UIColor *bgColor = [UIColor redColor];
        if (tag == 3) {
            bgColor = [UIColor yellowColor];
        }
        else if(tag == 2){
            bgColor = [UIColor blueColor];
        }
        else if(tag == 1){
            bgColor = [UIColor orangeColor];
        }
        UIView *v = [[UIView alloc] initWithFrame:CGRectMake(0, 0, [UIScreen mainScreen].bounds.size.width, 400)];
        v.backgroundColor = bgColor;
        [[[[UIApplication sharedApplication] delegate] window] addSubview:v];
    }
    
    return YES;
}

widget和宿主程序间数据访问

因为widget和程序 是两个完全独立的进程，所以它们之间不能直接通信. 通过App Groups提供的同一group内app共同读写区域，可以用NSUserDefaults和NSFileManager两种方式实现extension和containing app之间的数据共享。
首先, 需要将程序 和widget 都加入app groups中. (注意是两个都要加入). 如图:

程序添加进组.png widget添加进组.png

加入组后, 通过NSUserDefaults方法可以实现数据共享与访问:

//保存数据
- (void)saveDataByNSUserDefaults{
    NSUserDefaults *shared = [[NSUserDefaults alloc] initWithSuiteName:@"group.com.mywidgettest"];
    [shared setObject:@"无聊大法好" forKey:@"widget"];
    [shared synchronize];
}
//读取数据
- (NSString *)readDataFromNSUserDefaults{
    NSUserDefaults *shared = [[NSUserDefaults alloc] initWithSuiteName:@"group.com.mywidgettest"];
    NSString *value = [shared valueForKey:@"widget"];
    return value;
}

更改widget显示的名称

widget显示名.png 配置显示名.png

设置widget的展开/折叠

WidgetViewController 遵守NCWidgetProviding协议, iOS 10开始, NCWidgetProviding提供了widget展开/折叠的能力, 如图:
注意:
折叠状态下: 高度固定为110, 即使设置折叠状态的高度, 也不会起作用
展开状态下: 如果设置高度小于110，那么default = 110
展开状态下: 如果设置高度大于最大的616，那么default = 616
(5s,6s是110~528, plus是110~616)

折叠状态.png 展开状态.png

/*设置extensionContext.widgetLargestAvailableDisplayMode*/
- (void)viewDidLoad {
    [super viewDidLoad];
    
    //如果需要折叠, 需要设置extensionContext.widgetLargestAvailableDisplayMode
    //iOS 10才可以设置
    if (@available(iOS 10.0, *)) {
        self.extensionContext.widgetLargestAvailableDisplayMode = NCWidgetDisplayModeExpanded;
    } else {
        // Fallback on earlier versions
    }
}
/*实现NCWidgetProviding协议的-(void)widgetActiveDisplayModeDidChange:(NCWidgetDisplayMode)activeDisplayMode withMaximumSize:(CGSize)maxSize方法*/
// iOS10 新增的方法
// 用来设置Widget是展开还是折叠状态的方法，可以设置相关的preferredContentSizes属性修改大小
-(void)widgetActiveDisplayModeDidChange:(NCWidgetDisplayMode)activeDisplayMode withMaximumSize:(CGSize)maxSize{
    if (@available(iOS 10.0, *)) {
        if (activeDisplayMode == NCWidgetDisplayModeCompact) {
            self.preferredContentSize = CGSizeMake([UIScreen mainScreen].bounds.size.width, 100);
        } else {
            self.preferredContentSize = CGSizeMake([UIScreen mainScreen].bounds.size.width, 150);
        }
    } else {
        // Fallback on earlier versions
    }
}

widget也需要配置AppId 和配置文件

由于widget是一个独立的target, 它拥有区别于宿主程序的bundle id, 所以它也需要单独配置AppID和描述文件.

修改AppID支持App group

增加App group 数据共享, 需要修改AppID支持App group.
第一步先在 Identifiers 中的 APPGroup节点, 添加一个APPGroup的id, 然后宿主程序和widget的appid都需要增加对APPGroup的支持, 点击edit按钮, 将之前增加的APPGroupID添加到列表即可.

app group.png

widget工程使用宿主工程中的类文件

如果在widget中直接使用宿主工程中的类文件, 会出现以下报错:(以widget使用宿主程序中的 MyTools工具类为例)
Undefined symbols for architecture arm64: "_OBJC_CLASS_$_MyTools", referenced from: objc-class-ref in TodayViewController.o ld: symbol(s) not found for architecture arm64 clang: error: linker command failed with exit code 1 (use -v to see invocation)

通过将MyTools.m文件添加到 widget的Build Phases 列表中, 或者将MyTools.m文件的Target Membersship框中勾选widget选项, 都可以实现widget工程使用宿主工程中的类文件, 这两个操作是互通的. (添加列表会自动勾选, 添加勾选也会自动添加到列表)

添加buildphases.png 勾选Target Membersship.png

widget工程使用宿主工程中的第三方库

如果需要在widget工程中使用宿主工程中的第三方库(.frameword 或.a文件), 需要将这些第三方库的Target Membersship框中勾选widget选项, 这样就可以在widget中使用这些第三方库了.

这时候你可能会遇到这样一种报错:
ld: '/Users/.../IDMPlib/libIDMPCMCC.a(bio_lib.o)' does not contain bitcode. You must rebuild it with bitcode enabled (Xcode setting ENABLE_BITCODE), obtain an updated library from the vendor, or disable bitcode for this target. for architecture arm64 clang: error: linker command failed with exit code 1 (use -v to see invocation)

重点是does not contain bitcode. You must rebuild it with bitcode enabled

build setting中搜索 'bitcode' 将工程和widget都设置为NO

bitcode1.png widget_bitcode.png

需要注意的问题

1. 我使用xcode 9创建的工程, 在ios 11上运行没问题, 但是在ios 10上却不能添加widget .(today widget页面点击编辑按钮,看不到这个app的待选项).

问题愿意: xcode 9新建的widget 默认支持系统是ios 11, 需要我们更改这个支持的版本. 和主工程选择支持版本一样:

需要注意设置widget版本支持.png

2. 运行报错:Safe Area Layout Guide Before iOS 9.0 MainInterface.storyboard

解决方法, 取消storyboard的 Use Safe Area Layout Guide选项.

error.png 解决方法.png