iOS 8開始, 蘋果公司推出了today widget. 用來方便用戶查看各個app的個性消息.
目錄
- 創建一個widget
- 如何去掉today widget的storyboard 的綁定
- widget 布局
- widget喚醒拉起app
- widget和宿主程序間數據訪問
- 更改widget顯示的名稱
- 設置widget的展開/折疊
- widget也需要配置AppId 和配置文件
- 修改AppID支持App group
- widget工程使用宿主工程中的類文件
- widget工程使用宿主工程中的第三方庫
- 需要注意的問題
創建一個widget
在需要添加widget功能的工程中, 點擊"file - new - target", 如下圖:
創建后, 工程列表如下圖:
去掉today widget的storyboard 的綁定
我個人習慣使用代碼編寫, 去掉默認的storyboard.
點擊widget中的info.plist , 將NSExtension節點的NSExtensionMainStoryboard子節點刪除, 添加NSExtensionPrincipalClass子節點, value設置為類文件名, 例如本案例中的TodayViewController. 修改后如圖:
widget 布局
因為widget容器本來就存在邊框(大概是8), 計算容器的寬度, 然后在容器中布局, 需要用屏幕寬度減去 8*2, 如下布局:
- (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);
}];
}
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中. (注意是兩個都要加入). 如圖:
加入組后, 通過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的展開/折疊
WidgetViewController 遵守NCWidgetProviding協議, iOS 10開始, NCWidgetProviding提供了widget展開/折疊的能力, 如圖:
注意:
折疊狀態下: 高度固定為110, 即使設置折疊狀態的高度, 也不會起作用
展開狀態下: 如果設置高度小于110，那么default = 110
展開狀態下: 如果設置高度大于最大的616，那么default = 616
(5s,6s是110~528, plus是110~616)
/*設置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添加到列表即可.
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工程使用宿主工程中的類文件, 這兩個操作是互通的. (添加列表會自動勾選, 添加勾選也會自動添加到列表)
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
需要注意的問題
1. 我使用xcode 9創建的工程, 在ios 11上運行沒問題, 但是在ios 10上卻不能添加widget .(today widget頁面點擊編輯按鈕,看不到這個app的待選項).
問題愿意: xcode 9新建的widget 默認支持系統是ios 11, 需要我們更改這個支持的版本. 和主工程選擇支持版本一樣:
2. 運行報錯:Safe Area Layout Guide Before iOS 9.0 MainInterface.storyboard
解決方法, 取消storyboard的 Use Safe Area Layout Guide選項.
