Application Extension（二）：Today Extension

简介

在通知中心的Today的视图中显示的 extension 叫做 widget ，widget 可以方便用户快速的得到想要的信息，不用再通过复杂的步骤打开app才能找到自己想要的东西，只要下拉就可方便的看到，iOS设备中即使在锁屏的状态下也能查看。例如，用户下拉滑到Today查看现在的股票信息、天气、日程等等，如今越来越多的用户会频繁的通过Today来快速的得到信息。

Today Widget

在创建widget的时候应该注意：
1、确保每次查看时都要更新，显示最新的内容
2、交互流程合理
3、注意性能问题，确保使用流畅

由于用户在使用Today widget是快速短暂的，所以在设计widget的时候应注意UI简洁，限制显示的内容，只把用户最感兴趣的内容显示出来。

在不同的平台上的widget有所不同：
iOS：widget不支持键盘输入，用户需要在 containing app 中去设置对应的 widget 要显示的内容。例如，天气的 widget 要是用户想添加要显示的城市天气，那就需要打开天气应用，在城市列表中添加要显示的城市。

iOS天气widget

macOS：当 Today widget 运行时，用户可以去修改配置改变要显示的内容。例如天气widget可以添加想要显示的城市天气。

macOS天气widget

macOS天气widget编辑

当用户安装了带有Today widget 的应用，可以在通知中心Today的视图内添加该应用的widget，可以在编辑widget的页面添加、删除、修改widget。

创建Today Extension

这里在iOS上创建个Today Extension的小例子用来显示主应用里面的内容。
注意本例子是在 iOS10以上的系统上创建，之前的系统要另行适配。
新建一个项目，在项目里添加target，选择Today Extension：

• Xcode的Today模板会生成默认的实现文件，在Today的Info.plist文件中默认的NSExtension值如下：

NSExtension
    
        NSExtensionMainStoryboard
        MainInterface
        NSExtensionPointIdentifier
        com.apple.widget-extension
    

如不想使用系统默认的 storyboard 可以删除NSExtensionMainStoryboard 键值对，添加自己的实现文件 ，NSExtensionPrincipalClass 对应的是自定义的view controller名。
NSExtensionPointIdentifier对应的值是Extension的反向DNS名称。

创建好之后运行项目，在通知中心中编辑widget添加到刚创建的widget就可看到，如下图：

图标就是你的应用图标，标题默认的创建的Today名称，可以在Info.plist中修改CFBundleDisplayName显示的标题的内容。
然后就可以在TodayViewController中添加想要显示的内容了。常见的widget，在右上角带有展开/折叠按钮，这个在TodayViewController中设置好属性就可以实现

//支持展开、折叠
self.extensionContext.widgetLargestAvailableDisplayMode = NCWidgetDisplayModeExpanded;

Apple 为扩展提供了一个 NSExtensionContext 类来与host app应用进行交互。用户在host app中启动扩展后，host app提供一个上下文给扩展，里面最主要的是包含了 inputItems 这样的待处理的数据。

当点击展开或者折叠时会调用下面的方法，从而去改变widget的高度，默认的为展开的widget的高度是固定的110。
Xcode的TodayExtension的模板中生成的TodayViewController中默认的遵循NCWidgetProviding协议，协议里有下面几个方法：

• widgetPerformUpdateWithCompletionHandler 在TodayViewController中实现这个方法后，当用户操作显示通知中心Today视图，就会调用这个方法只要以显示就会调用，从而可以及时的去更新状态。即使你的扩展现在不可见 (也就是用户没有拉开通知中心)，系统也会时不时地调用实现了的这个方法，来要求扩展刷新界面。在这个方法中我们一般可以做一些像 API 请求之类的事情，在获取到了数据并更新了界面，或者是失败后都使用提供的 completionHandler 来向系统进行报告。
• widgetActiveDisplayModeDidChange 当widget的展开或折叠的状态改变时就会调用该方法，在这个方法里可以通过改变self.preferredContentSize的值改变widget的高度，从而适应不同的状态。展开折叠是在iOS10以后才加入的功能，所以这个方法只有在iOS10之后才有。

Extension和Containing App间共享代码

在App里创建的某个类，要想在Extension中也能使用，在Target Membership中勾选就可以了。同样的要想在Extension中使用App Assets.xcassets里面的图片，勾选就可以了。

Extension和Containing App间共享数据

沙盒限制了我们在设备上随意读取和写入。但是从iOS8开始有了新的功能，App Groups 为同一个 vender 的应用或者扩展定义了一组域，在这个域中同一个 group 可以共享一些资源。对于我们的例子来说，我们只需要使用同一个 group 下的 NSUserDefaults 就能在主体应用不活跃时向其中存储数据，然后在扩展初始化时从同一处进行读取就行了。

对于应用和其对应的扩展来说，可以使用 App Groups 来进行数据共享。

首先我们需要开启 App Groups。选择containing app 的 target，打开它的 Capabilities ，找到 App Groups 并打开开关，然后添加一个 group 名字。接下来你还需要为 TodayExtension 这个 target 进行同样的配置，只不过不再需要新建 group，而是勾选刚才创建的 group 就行。

然后在App中保存要在widget中显示的数据：

NSUserDefaults * groupDefault = [[NSUserDefaults alloc] initWithSuiteName:@"group.myzTodayGroup"];
[groupDefault setObject:dataArray forKey:@"myzTodayDataArray"];

在TodayExtension中就可以获取到数据，从而显示在widget中：

NSUserDefaults * groupDefault = [[NSUserDefaults alloc] initWithSuiteName:@"group.myzTodayGroup"];
NSArray * dataArray = [groupDefault objectForKey:@"myzTodayDataArray"];

从TodayExtension启动应用

接着来处理在widget点击内容后，然后跳转到 containing app 查看详细信息。也就是从 widget 启动 containing app ，还要向 app 传递数据。可以使用系统提供的 NSExtensionContext 类，通过NSExtensionContext 来调用 openURL(URL:completionHandler:)启动 containing app :

[self.extensionContext openURL:[NSURL URLWithString:[NSString stringWithFormat:@"myzwidget://open]] completionHandler:nil];

然后选择containing app 的 target，设置对应的 URL Scheme：

然后在 AppDelegate 中获取打开的事件，做出相应的反应：

- (BOOL)application:(UIApplication *)application openURL:(nonnull NSURL *)url options:(nonnull NSDictionary *)options {
    
    if ([[url scheme] isEqualToString:@"myzwidget"]) {
        //...
        return YES;
    }
    return NO;
}

小例子实现了在widget中显示应用中前三行的内容，效果如下：

Widget.gif

Demo地址：https://github.com/MA806P/MYZAppExtension

Reference

App Extension Programming Guide - Today
https://onevcat.com/2014/08/notification-today-widget/