App Extension 讓我們在用戶正在使用其他 App 的時候, 拓展我們 App 的功能。
Today Extension 也叫做 widget。 它能夠讓一些重要的消息更快速的到達你的用戶。比如說, 用戶可以通過它查看天氣，或者股票價格, 查看日程表等等。蘋果在官方文檔中說到， 一個 widget 應該有以下的特點。
- 確保內容是最新的
- 響應的用戶事件
- 性能好(在iOS上占用大量內存，系統可能會kill掉這個widget)
創建 Today Extension
Xcode -> File -> New -> Target -> TodayExtension
跟創建一個新的項目一樣, 設置創建好之后, 項目中會多一個 Target, 修改Scheme 為你剛剛創建的 Extension 再運行, 就能在 通知中心的 Today 里面看到你剛剛創建的 widget 了, 上面寫著“Hello world”
另外 Xcode 給你創建了默認的模版文件。
- TodayViewController.swift(如果是 OC 對應會是
.h和.m文件) - MainInterface.storyboard
- Info.plist
注意: 默認是使用這個 storyboard 作為這個 widget 的入口。如果不需要使用storyboard 可以刪除掉這個storyboard并且將Info.plist 中的
-
NSExtensionMainStoryboard改成NSExtensionPrincipalClass -
MainInterface改成TodayViewController
設置界面
完成了上面的步驟之后, 不論你是選擇用 stroyboard 作為你 widget 的入口, 還是選擇用代碼來做這件事情。都是一樣的。
由于不知道什么原因, 我在網上看到的文章都是使用代碼來做的這件事情。所以在這篇文章以及后面的示例代碼中都將使用 Xcode 默認的 storyboard 來做這個 widget 的布局。
我將解決的問題
- 在 widget 中打開主 App 并傳遞參數
- widget 和 主 App 共享數據
- widget 和 主 App 共用資源
- widget 的打開和折疊
我遇到的坑
也沒什么坑, 畢竟 Today Extension 并不是什么很難的東西。
- 測試的時候, 由于 widget 和 主 App 是兩個不同的 target, 所以在傳遞參數的時候, 在 appdelegate 中打印對應的值沒有效果。最開始我還以為是因為設置的 scheme 是 widget 所以在 主 App 中的修改是無效的。但是實際是并不是這樣。將參數以 alert 的形式表現出來, 這時候能夠發現, 其實主 App 是跑起來了的。
先說說我做的準備工作吧
為了不扯那么多沒用的東西。先說說我做了那些跟今天主題沒什么關系的事情。
寫主 App
在主 App 中我寫了一個 UITableView, 并使用 Userdefault 將我要持久化的數據保存下來。然后對應給 Todo list 做了，添加，和刪除的功能。
widget
在 widget 中我也下了同樣的一個 UITableView 只有查看的功能。
要做的事情
widget 和 主 App 共用資源
widget 和主 App 共享代碼和資源。作為一個工程師, 我們在任何事情的時候都要想到高類聚低耦合著句不變的真理。所以我們還是要盡可能的讓 widget 和主 App 共享代碼。
主要有兩個方案:
- framework
- 直接共享
framework 的話，就拿 cocoapods 來說吧， 由于 widget 是一個新的target, 所以只需要在 podfile 中對應添加代碼就能夠在 widget 中使用。
另外一個是 直接共享, 這個就很簡單了。我在示例中讓主 App 和 widget 共享了一張圖片，一個 TodoCell 類(包括xib 文件)。我做的唯一的一件事情就是在 Xcode 中選中這個文件，然后在 Xcode右邊的 TargetMenberShip 中勾選對應的 target.
widget 和 主 App 共享數據
嚴格來說 widget 和 App 是不同的兩個 App 了, 他們之間要共享數據的話只能使用 App Groups 了。
首先在主 App
target -> capabilities -> App Groups
打開 App Groups 功能, 點擊 + , 設置 id 。如果重復了就改一個。
widget App
target -> capabilities -> App groups
這時候的 group 列表就能夠看到對應的 group 了。勾選即可。
這時候已經完成了widget 和 主 App 共享數據的前提條件。
接下來還需要做的事情, 就是將我們準備工作里面Userdefault相關代碼進行調整。
將 UserDefaults.standard 改成
UserDefaults(suiteName: "your group id")
這樣就可以在 widget 中 使用
let userdefault = UserDefaults(suiteName: "group.com.sunny.group")
獲得在主 App 中持久化的數據了。關于 App Groups 其他的用法，可以繼續深入研究。
widget 的折疊和展開
蘋果的官方文檔里面明確的說了，widget 的界面是不能滑動的。畢竟 widget 和通知中心的滑動不能沖突啊。
所以有時候我們需要將 widget 折疊起來，畢竟太長的 widget 實在是令人討厭啊。
主要還是說說iOS10 上怎么做的吧，畢竟沒有iOS10 以下的設備。
在 TodayViewController 的 didLoad 中添加
// iOS10 添加折疊按鈕
if #available(iOSApplicationExtension 10.0, *) {
extensionContext?.widgetLargestAvailableDisplayMode = .expanded
} else {
// iOS8 、iOS9 上需要自己添加折疊按鈕
}
然后實現 NCWidgetProviding 協議中的方法
func widgetActiveDisplayModeDidChange(_ activeDisplayMode: NCWidgetDisplayMode, withMaximumSize maxSize: CGSize) {
// 由于 iOS8 、iOS9 上沒有這個代理。需要對自己添加的按鈕設置 target-action 然后進行修改
switch activeDisplayMode {
case .compact:
preferredContentSize = maxSize
case .expanded:
preferredContentSize = CGSize(width: 0.0, height: 60 * CGFloat(dataSource.count))
}
}
在 iOS8 和 iOS9 中, 由于系統沒有這個功能。我們只能自己寫一個按鈕然后再來做這些事情了。
widget 打開 主 App
widget 打開主 App 還是老思路，openurl 就可以了，然后在url 中添加對應需要的參數。
準備工作
主 App -> target -> info -> UrlTypes
添加一個 URlType 然后設置 URL Scheme 為你自定義的字符串。 比如 “sunny”。
在 widget 中需要跳轉的地方寫這樣的代碼
self.extensionContext?.open(NSURL(string: "sunny://action=\(dataSource[indexPath.row])")
參數傳遞也就是按照上文, 在url中拼接了。上文有提到, widget 和 App 可以共享數據。這也可能是一種傳遞參數的方式。
這個時候打開主要 App 就是直接進入主要界面了。如果我們需要做一些其他的事情應該怎么做呢？
想想以前做微信或者支付寶支付的時候， 都要在 appdelegate 中寫一些代碼。
func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
let prefix = "sunny://"http:// 判斷是否是可靠的地方傳遞過來的
if url.absoluteString.hasPrefix(prefix) {
// 參數過來了！ 做對應的事情
let a = UIAlertController(title: url.absoluteString, message: nil, preferredStyle: .alert)
a.addAction(UIAlertAction(title: "取消", style: .cancel, handler: nil))
self.window?.rootViewController?.present(a, animated: true, completion: nil)
return true
}
return false
}
others
高度
widget的默認高度是有限制的。
compact 下:
- max = 110
- mim = 110
expanded 下:
- min = 110
- max = 根據不同的機型二不同。
無論怎么設置, 都不回超出這個范圍
widgetPerformUpdate
func widgetPerformUpdate(completionHandler: (@escaping (NCUpdateResult) -> Void)) {
// Perform any setup necessary in order to update the view.
// If an error is encountered, use NCUpdateResult.Failed
// If there's no update required, use NCUpdateResult.NoData
// If there's an update, use NCUpdateResult.NewData
completionHandler(NCUpdateResult.newData)
}
這個方法用來選擇 widget 再出現的時候會不會重新刷新。
通知
在 NSExtensionContext 中看到的幾個通知貌似不是給 TodayExtension 用的。
NSExtensionContext 中能看到幾個通知他們都是監聽 host App 的狀態的。所以對于widget 來說， host App 就是 Today 這個東西啦。
最后
拋磚引玉，本文用Today Extension做了一個很簡單的功能。 當然, 我們能用他做的事情可不止這些。這就需要我們發動我們的聰明才智了。
示例代碼下載鏈接由于使用swift寫的, 由于眾所周知的原因, 你發現編譯不過了。可以聯系我, 我將做適配。
