iOS10通知扩展之Notification Service Extension

iOS 10增加了两种新的通知扩展：Notification Service Extension和Notification Content Extension，本文只介绍前者（通知服务扩展）。想要接入使用通知服务扩展，需确保App已经具备了接收push的能力，如果有需求，可以参考iOS Push从0到1文章。

1、Notification Service Extension

通知服务扩展（Notification Service Extension），在通知显示给用户之前会给你时间处理通知payloads，例如将要展示在通知中的image、GIF、Video、解密文本下载下来。

1.1 创建Service Extension

使用Xcode打开项目，选中File -> New -> Target...，在出现的弹窗中选择Notification Service Extension模板。如下图所示：

notificationService_0.png

点击Next后，你需要填写特定于应用程序的相关信息。添加完毕，点击Finish可以在项目的TARGETS里看到多了Service Extension一项。如图所示：

notificationService_1.png

而项目中则会生成NotificationService文件夹，以及相应的类文件和plist文件，如图所示：

notificationService_2.png

1.2 Extension LifeCycle

一旦你给App配置了通知服务扩展程序后，每个通知都会执行以下过程：

App收到通知。
系统创建扩展类的实例对象并在后台启动它。
你的扩展程序会执行内容编辑和/或下载某些内容操作。
如果你的扩展程序执行太长时间而不能完成它的工作，将会收到通知并被立即终止。
通知显示给用户。

1.3 Extension Code

在NotificationService类文件中有两个回调方法，方法如下：

// 重写此方法以实现推送通知的修改
- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler;
// 扩展程序被系统终止之前会被调用，你可以选择是否覆盖此方法
- (void)serviceExtensionTimeWillExpire;

系统受到通知后，在有限的时间（不超过30s）内，你的扩展程序可以在didReceiveNotificationRequest:withContentHandler:方法内对通知做相应的更改并执行contentHandler代码块。如果你没有及时执行，系统将会调用上面的第二个方法serviceExtensionTimeWillExpire，在这里给你提供最后一次执行contentHandler代码块的机会。如果你什么都没做，系统将向用户显示通知的原始内容，你做的所有修改都不会生效。

- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
    self.contentHandler = contentHandler;
    self.bestAttemptContent = [request.content mutableCopy];
    
    // 根据约定好的key获取image地址
    NSString *imageUrlString = [request.content.userInfo objectForKey:@"url_key"];
    if (![imageUrlString isKindOfClass:[NSString class]]) {
        return;
    }
    
    NSURL *url = [NSURL URLWithString:imageUrlString];
    if (!url)
        return;
    
    [[[NSURLSession sharedSession] downloadTaskWithURL:url completionHandler:^(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error) {
        if (!error) {
            NSString *tempDict = NSTemporaryDirectory();
            
            NSString *filenameSuffix = response.suggestedFilename ? response.suggestedFilename : [response.URL.absoluteString lastPathComponent];
            NSString *attachmentID = [[[NSUUID UUID] UUIDString] stringByAppendingString:filenameSuffix];
            NSString *tempFilePath = [tempDict stringByAppendingPathComponent:attachmentID];
            
            if ([[NSFileManager defaultManager] moveItemAtPath:location.path toPath:tempFilePath error:&error]) {
                UNNotificationAttachment *attachment = [UNNotificationAttachment attachmentWithIdentifier:attachmentID URL:[NSURL fileURLWithPath:tempFilePath] options:nil error:&error];
                
                if (!attachment) {
                    NSLog(@"Create attachment error: %@", error);
                } else {
                    _bestAttemptContent.attachments = [_bestAttemptContent.attachments arrayByAddingObject:attachment];
                }
            } else {
                NSLog(@"Move file error: %@", error);
            }
        } else {
            NSLog(@"Download file error: %@", error);
        }
        
        dispatch_async(dispatch_get_main_queue(), ^{
            self.contentHandler(self.bestAttemptContent);
        });
    }] resume];
}

2、Push payload

简单看一下push payload的格式：

{
    "aps":{
        "alert":{
            "title":"Push Title",
            "subtitle":"Push Subtitle",
            "body":"Push Body"
        },
        "sound":"default",
        "badge":1,
        "mutable-content":1
    },
    "landing_page":"https://www.baidu.com"
}

注意：

如果要支持扩展服务，一定要确保payload的aps字典中包含mutable-content字段，值为1。

3、Push开关是否打开

Push功能完成后，我们一般会有判断App是否打开了通知开关的需求。如果用户没有打开可以提示用户再次打开，以保证Push消息能够推动给更多的用户，提高消息转化率。由于iOS10以上的通知相关API发生了较大变化，我们需要针对不同的系统版本使用不同的API来判断。具体代码如下：

+ (BOOL)isOpenNotificationSetting {
    __block BOOL isOpen = NO;
    if (@available(iOS 10.0, *)) { //iOS10及iOS10以上系统
       dispatch_semaphore_t semaphore;
       semaphore = dispatch_semaphore_create(0);
       // 异步方法，使用信号量的方式加锁保证能够同步拿到返回值
       [[UNUserNotificationCenter currentNotificationCenter] getNotificationSettingsWithCompletionHandler:^(UNNotificationSettings * _Nonnull settings) {
           if (settings.authorizationStatus == UNAuthorizationStatusAuthorized) {
               isOpen = YES;
           }
           dispatch_semaphore_signal(semaphore);
       }];
       dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
   } else { 
       UIUserNotificationSettings *settings = [[UIApplication sharedApplication] currentUserNotificationSettings];
       if (settings.types != UIUserNotificationTypeNone) {
           isOpen = YES;
       }
   }
   return isOpen;
}

由于getNotificationSettingsWithCompletionHandler:方法是一个异步方法，如果直接在回调中去判断当前的push授权状态的话，还未给isOpen赋值就已经return返回结果了。

问题有了，那么解决方案也有很多，如代码中所示，我们使用了信号量dispatch_semaphore，功能类似于iOS开发中的锁（比如NSLock，@synchronize等），它是一种基于计数器的多线程同步机制。

使用dispatch_semaphore_create创建信号量semaphore，此时信号量的值是0。
异步跳过block块代码，执行dispatch_semaphore_wait，信号量的值减1。此时当前线程处于阻塞状态，等待信号量加1才能继续执行。
block块代码异步执行，dispatch_semaphore_signal执行后发送一个信号，信号量的值加1，线程被唤醒，继续执行，给isOpen赋值，然后return，保证了每次能够正确取到当前的push开关状态。

4、相关配置

如果是一个新App，你需要创建2个App ID，一个用于App本身，一个用于创建通知服务扩展；如果App已经存在，再增加通知服务扩展，只需要创建用于扩展程序的App ID。
与1同样，还需要创建用于扩展程序的Provisioning Profile。
创建完成再Xcode完成相应的配置。

5、推送测试工具`Pusher`

iOS App的推送消息测试是比较麻烦的，Pusher提供了相当完善的push推送功能，可以帮助我们很好的完成push调试。

notificationService_3.png

选择对应的p12推送证书
Should use sandbox environment选项代表你要发送push的环境是开发环境还是生产环境
第三行是要输入你当前要发送push设备的device token
最下面的输入框是push payload，将编辑好的json文本粘贴到这点击Push推送即可

最后附上效果图。

notificationService_4.png

notificationService_5.png

参考

iOS 10: Notification Service Extensions

iOS推送通知及推送扩展

NWPusher Github