AppExtension:NotificationServiceExtension集成、调试、打包的实践

一、概述

Apple早在iOS10就退出NotificationServiceExtension的扩展,并不是必备项目,因此各家公司产品支持各不相同,主要取决于产品的实际需求是否需要。

2021年我所在项目的一个需求是:“推送内容显示图片(title-image),即推送支持简图”,这个需求就需要用到NotificationServiceExtension 的相关内容。

百度有很多集成的教程,不知道为啥,很多都只说了其中一个片面,其原因在于很多都只是看了官网的教程,实际开发中遇到的问题没有写出来。

以下是相关笔记,
特别是扩展是如何与宿主App的Target关联的?
如何被打包进宿主App的?
它在宿主App的包里面长什么样?
它是如何和宿主App一同提审?

二、NotificationServiceExtension原理篇

1、NotificationServiceExtension 的作用是什么?

NotificationServiceExtension属于AppExtension(扩展)的范畴,属于官方推出的扩展。同NotificationContentExtension一同丰富用户的推送体验,让开发者可以本地拦截和修改推送内容的机会,可以自定义自己的推送内容展示样式。大大提高了整体的用户体验。

2、NotificationServiceExtension相关特性(官网翻译)

  • 只允许修改推送内容,不能包含任何的UI显示。
    A Notification Service app extension doesn't present any UI of its own.

  • 开发者无法自己初始化,在推送到达的时候iOS系统会自动创建UNNotificationServiceExtension对象。开发者只能通过扩展Target下的NotificationServiceExtension的子类来修改自己App推送的内容。
    You don't create UNNotificationServiceExtension objects yourself. Instead, the Xcode template for a Notification Service Extension target contains a subclass for you to modify.

  • iOS收到App的推送的时候,系统自动初始化UNNotificationServiceExtension对象,然后回调给App的扩展子类的方法didReceiveNotificationRequest:withContentHandler:
    When a remote notification for your app is received, the system loads your extension and calls its didReceiveNotificationRequest:withContentHandler: method

  • 响应函数的操作时间只有30秒;如果未处理超时处理,系统会按照默认显示推送。
    Your didReceiveNotificationRequest:withContentHandler: method has only about 30 seconds to modify the payload and call the provided completion handler. If your code takes longer than that, the system calls the serviceExtensionTimeWillExpire method, at which point you must return whatever you can to the system immediately. If you fail to call the completion handler from either method, the system displays the original contents of the notification.

  • 服务端推送的payload格式要求
    必须是alert类型,aps字段必须包含有alert字段,alert里必须是title、subtitle、body任何一个。
    The payload must include an alert dictionary with title, subtitle, or body information.

    aps字段里面必须有mutable-content字段,其值必须为1。
    The remote notification’s aps dictionary includes the mutable-content key with the value set to 1.

3、UNNotificationServiceExtension工作原理篇

详见鄙人另外整理笔记。AppExtension:扩展的学习笔记

三、UNNotificationServiceExtension的实践

1、前提

推送主工程必须开启推送功能,证书也必须支持,bundleId不能包含通配符,这些是基础知识。


1F44689C-0A8E-432D-A3F4-D25E42639203.png

2、创建

在项目工程中,新建Target的方式集成(一个工程允许存在多个Targets),如下


19448884-9DF3-42B3-B64F-A5AD8C130CE0.png

系统模板自动创建:NotificationServiceExtension的文件夹、NotificationService : UNNotificationServiceExtension子类、info.plist配置文件。

CC6A72C8-1FAF-4E7A-ADEC-354DADEB01B4.png

其中info.plist配置文件,扩展关键配置如下,id固定com.apple.usernotifications.service不能更改,class对应子类类名。后续扩展Target的相关配置都在这里面,需要网络的需要开启App Transport Security SettingsAllow Arbitrary Loads为YES。

8BAD934E-85B5-4871-82A2-528DE45ADEF6.png

2、主工程Target与扩展Target的关系(关键的关键)

很多网上的教程都没有说明这点,以至于后续打包和提审都难以理解其原理。(网上很多直说无法单独提审,必须与ContainApp一起提审。)

  • 扩展Target是通过 ”依赖的方式“ 的方式添加到主工程Target中。
    查看主工程Target的 BuildPhasesDependencies 关联扩展Target;同时多了个 Embed App Extensions 里面关联扩展的编译产物.appex执行文件。
    0693088B-0E07-482C-A441-A68B6EC97031.png
  • 扩展最终被打包给.appex的bundle包,同时被打包到ContainApp的包的Pluglns的目录下。

    824DCA63-95E5-41B1-A70D-64B1E2449D8B.png

  • 使用Tree命令,看看.appex的bundle包的内容:

    419D7EDD-A72C-4020-9947-BB3CA2A9CDF6.png

3、调试

网上内容也很多,主要是以下几步:

  • 扩展Target和主工程Target必须配置不同的证书,且主工程开启推送功能。

  • 编译的目标顺序
    1、主工程编译,真机运行。
    2、扩展Target编译运行,选择主工程App,Attachment连接启动。
    3、模拟推送一波,UNNotificationServiceExtension的扩展之类,断点即可执行。

调试一些问题
  • 推送格式错误,具体参见上面格式要求。
  • 对于旧工程,后续接入者莫名其妙的无法调试,可以重新删掉Target,重建一个名字一样的扩展。

4、打包&提审

上面可知,扩展的Target是通过依赖主工程Target的方式一同编译打包的,因此后续打包提审的时候只要对应的配置好证书,打包主工程App,然后提审就行。


47ACD5CC-88CD-4645-83EA-A857556C93A7.png

As with any target, an extension target specifies settings and files that combine to build a product within your app project.
Each template includes extension point–specific implementation files and settings, and produces a separate binary that gets added to your containing app’s bundle.

注意:打包导出的时候,需要同时勾选主Target和扩展Target的对应证书。


9CE6BFF5-D922-4CDB-9979-C464CB585B99.png

四、带图片的推送需求实现

”带图片的推送“需求具体实现,主要是把图片自行下载,然后保存,添加到对应的类中属性即可。

UNNotificationAttachment *resourceAttachment =
[UNNotificationAttachment attachmentWithIdentifier:@"photo" URL:obj options:nil error:&attachmentErrer];
if (resourceAttachment && !attachmentErrer) {
    strongSelf.bestAttemptContent.attachments = @[resourceAttachment];
}

本文不再累赘,参见iOS10推送必看UNNotificationServiceExtension,或者自行百度。

五、UNNotificationServiceExtension 其他

  • 与主工程代码复用,同AppExtension。
  • 与主工程的数据共享,同AppExtension。

具体见AppExtension:扩展的学习笔记


参考

官网-UNNotificationServiceExtension
官网-Modifying Content in Newly Delivered Notifications

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
禁止转载,如需转载请通过简信或评论联系作者。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容