您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

iOS 擴展開發實戰:Today Widget 與分享擴展完整實現

編輯:iOS 開發基礎

概述

從 iOS 8 開始,Apple 引入擴展(Extension)機制,用於增強系統應用的服務能力以及應用之間的互操作。正是它的出現,自定義鍵盤、系統分享集成這類依賴系統入口的開發才成為可能。WWDC 2016 的多項更新也圍繞這一主題展開——Siri 集成與 iMessage Apps 背後都是擴展在支撐。Xcode 8 beta 更是新增了大量擴展模板,讓不同類型擴展的接入門檻顯著降低。本文就以 Today 擴展與分享擴展為例,走一遍完整開發流程。

擴展的生命周期

iOS 支持的擴展類型已從最初的 6 類增加到 iOS 10 的 19 類,且隨系統演進還在繼續擴展。各類型擴展的用途和用法不盡相同,但工作原理與開發方式高度相似。幾個共同點:

  • 擴展依附於應用存在,無法單獨發布或部署;

  • 擴展與其容器應用(containing app)生命周期彼此獨立,運行於兩個不同進程;

  • 擴展的運行依賴宿主應用(host app),生命周期由宿主決定;

  • 對開發者而言,擴展是一個獨立的 target;

  • 擴展通常展示在系統 UI 或其他應用中,應當啟動迅速、功能單一。

官方對生命周期的描述如下圖。當用戶選擇某個擴展入口時(例如在分享菜單中選中你的分享擴展),宿主會向擴展發送請求將其啟動,擴展生命周期由此開始。由於擴展由控制器構成,此時會走類似 viewDidLoad 的流程完成界面佈局與邏輯處理,任務結束後應盡快把控制權交還宿主,生命周期隨之終止。

雖然擴展與容器應用的生命周期沒有直接關聯,但擴展的存在意義本就是服務於容器應用,兩者的交互不可避免。典型做法是擴展通過自定義 Scheme 調用容器應用,容器應用處理完畢後再通過數據共享把結果回傳。

Today 擴展實戰

Today 擴展(Widget)是最常被使用的類型之一。微博的擴展可以發微博、看更新,墨跡天氣展示今明兩日天氣,網易雲音樂則推薦歌單與專輯。

本文的例子要做一個簡易的待辦清單:容器應用 ToDoList 支持增刪待辦事項,Today 插件展示最新的幾條;若無數據則顯示添加按鈕,點擊列表或按鈕跳回容器應用。最終效果如下:

動手之前先想清楚三個問題:

  1. 數據存哪裡?擴展與容器應用處於兩個不同沙盒,容器應用寫入的數據要讓 Today 讀到,必須提前設計共享存儲方案。

  2. 如何復用代碼?兩端都要讀寫數據,若各寫一份必然產生重複代碼。

  3. 如何跳轉回容器應用?擴展中 openURL 被禁用(合理,因為擴展中的 UIApplication 指向宿主應用而非容器應用,開發者若直接操作宿主應用相當危險),需要另尋途徑。

第一個問題的答案就是 App Groups。iOS 8 引入這一能力來解決應用間數據共享(該功能在 macOS 上早已存在)。在 Xcode 的 Capabilities 中找到 App Groups,開啟並添加一個名為 group.com.cmjstudio.todolist 的分組——名稱必須以 group 開頭。這一步等價於在開發證書中啟用 App Groups 服務並註冊分組,同時會在 Build Settings 的 Code Signing Entitlements 中寫入對應配置,並生成 ToDoList.entitlements 文件。由於 App Groups 與證書綁定,同一證書下簽發的應用只要配置相同分組即可互通數據。App Groups 支持 NSUserDefaults、NSFileManager、NSFileCoordinator、NSFilePresenter、UIPasteboard、KeyChain、NSURLSession 等多種共享方式,這裡選擇最簡單的 NSUserDefaults。

先把數據層寫好,放在 TaskService.swift 中:

import Foundation

let TaskServiceDataKey = "TaskServiceData"

public struct TaskService {

    public static let ToDoListGroupName = "group.com.cmjstudio.todolist"

    public static func addItem(title: String) {
        let userDefault = NSUserDefaults(suiteName: TaskService.ToDoListGroupName)
        var items = self.getItems()
        items.append(title)
        userDefault?.setObject(items, forKey: TaskServiceDataKey)
        userDefault?.synchronize()
    }

    public static func removeItem(title: String) {
        let items = self.getItems()
        let newItems = items.filter { (item) -> Bool in
            item != title
        }
        let userDefault = NSUserDefaults(suiteName: TaskService.ToDoListGroupName)
        userDefault?.setObject(newItems, forKey: TaskServiceDataKey)
        userDefault?.synchronize()
    }

    public static func getItems() -> [String] {
        let userDefault = NSUserDefaults(suiteName: TaskService.ToDoListGroupName)
        var tasks = [String]()
        if let array = userDefault?.stringArrayForKey(TaskServiceDataKey) {
            tasks = array
        }
        return tasks
    }
}

接著新增一個 Today Extension 類型的 target,命名為 ToDoListTodayExtension,並選擇激活它的 scheme 以便後續調試。項目根目錄會生成同名文件夾,內含 TodayViewController、MainInterface.storyboard 與 info.plist。info.plist 中定義了擴展入口 com.apple.widget-extension,並指定 MainInterface 為展示入口——不難推測 TodayViewController 就是該 storyboard 中控制器對應的類。

class TodayViewController: UIViewController, NCWidgetProviding {

    override func viewDidLoad() {
        super.viewDidLoad()
    }

    func widgetPerformUpdate(completionHandler: ((NCUpdateResult) -> Void)) {
        completionHandler(NCUpdateResult.newData)
    }
}

這個類實現了 NCWidgetProviding 協議,其中兩個關鍵方法是自定義邊距的 widgetMarginInsetsForProposedMarginInsets 和用於刷新內容的 widgetPerformUpdate。此時直接編譯運行並選擇宿主程序 Today,就能看到一個顯示「Hello World」的擴展——那正是 MainInterface 的默認佈局。同時 Products 下會生成 ToDoListTodayExtension.appex,即擴展包。

Today 擴展的寬度恆定等於屏幕寬度,佈局時不必操心;高度則需通過調整 preferredContentSize 來控制。

接下來是第二個問題:如何複用容器應用裡的 TaskService.swift?依據 Swift 的命名空間與作用域特性,把它抽到一個公共命名空間即可,而命名空間在實踐中通常由一個獨立 target 承載——這也正是官方推薦的做法。新建一個 Cocoa Touch Framework 類型的 target(此處命名 ToDoListKit),把 TaskService.swift 移入其中,並將相關類型與方法聲明為 public。容器應用與擴展都通過 import ToDoListKit 使用它。

最後是第三個問題。擴展中確實無法用 UIApplication 打開應用,但控制器提供了一個 NSExtensionContext 類型的上下文用於管理擴展操作,通過它的 openURL 就能跳回容器應用。完整實現如下:

import UIKit
import NotificationCenter
import ToDoListKit

private let TodayViewControllerMaxCellCount = 3
private let TodayViewControllerCellHeight: CGFloat = 44.0
private let TodayViewControllerTableViewCellKey = "TodayViewControllerTableViewCell"

class TodayViewController: UIViewController, NCWidgetProviding, UITableViewDataSource, UITableViewDelegate {

    override func viewDidLoad() {
        super.viewDidLoad()
        self.setup()
        self.loadData()
    }

    func widgetPerformUpdate(completionHandler: ((NCUpdateResult) -> Void)) {
        self.loadData()
        completionHandler(NCUpdateResult.NewData)
    }

    func widgetMarginInsetsForProposedMarginInsets(defaultMarginInsets: UIEdgeInsets) -> UIEdgeInsets {
        return UIEdgeInsetsZero
    }

    // MARK: - UITableView 數據源和代理方法
    func tableView(tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return self.data.count
    }

    func tableView(tableView: UITableView, cellForRowAtIndexPath indexPath: NSIndexPath) -> UITableViewCell {
        var cell: UITableViewCell! = tableView.dequeueReusableCellWithIdentifier(TodayViewControllerTableViewCellKey)
        if cell == nil {
            cell = UITableViewCell(style: .Subtitle, reuseIdentifier: TodayViewControllerTableViewCellKey)
            cell.textLabel?.textColor = UIColor.whiteColor()
            cell.detailTextLabel?.textColor = UIColor.whiteColor()
        }

        let item = self.data[indexPath.row]

        cell.imageView?.image = UIImage(named: "calendar")
        cell.textLabel?.text = "Date & Time"
        cell.detailTextLabel?.text = item
        return cell
    }

    // MARK: - 事件響應
    @IBAction func addButtonClick(sender: UIButton) {
        let url = NSURL(string: "todolist://add")
        self.extensionContext?.openURL(url!, completionHandler: nil)
    }

    // MARK: - 私有方法
    private func setup() {
        self.addButton.layer.cornerRadius = 3.0
        self.tableView.rowHeight = TodayViewControllerCellHeight
    }

    private func loadData() {
        self.data = [String]()
        let items = TaskService.getItems()

        // 控制最多顯示條數
        for i in 0..= TodayViewControllerMaxCellCount {
                break
            }
        }

        self.layoutUI()
        self.tableView.reloadData()
    }

    private func layoutUI() {
        if self.data.count > 0 {
            self.addButton.hidden = true
            self.tableView.hidden = false
            self.preferredContentSize.height = CGFloat(self.data.count) * TodayViewControllerCellHeight
        } else {
            self.addButton.hidden = false
            self.tableView.hidden = true
            self.preferredContentSize.height = TodayViewControllerCellHeight
        }
    }

    // MARK: - 私有屬性
    @IBOutlet weak var tableView: UITableView!
    @IBOutlet weak var addButton: UIButton!

    private var data: [String]!
}

注意:官方明確指出 Today 擴展不支持 UIScrollView 滾動,因此只適合展示少量最新數據,更多內容應通過分頁引導用戶打開主應用。

還有一個細節:擴展裡用到了一個日歷圖標,而該圖片已存在於容器應用的 Assets.xcassets 中,擴展卻無法直接訪問。兩種解法:一是往擴展裏再放一份;二是選擇擴展 target → Build Phases → Copy Bundle Resources,把容器應用中的資源加進來。第二種的好處是運行時雖然存在兩份資源,開發時只需維護一份。本文採用第二種。如果你確實需要共享文件而非複製,也可以用 NSFileManager.defaultManager().containerURLForSecurityApplicationGroupIdentifier(groupName) 讀取容器應用中的文件,但這個場景並不合適。

最後別忘了給 ToDoListTodayExtension 也配置 App Groups,分組名稱必須與前面保持一致。運行效果如下:

分享擴展實戰

分享擴展是另一類高頻擴展,QQ、微信、微博都實現了它。這裡以一個圖片社區應用 MyPicture 為例:用戶在系統相冊中選好照片,直接分享到 MyPicture。

默認的分享擴展界面如下:

它的 info.plist 比 Today Extension 多了幾項配置,例如擴展名稱與語言。這裡設置:

  • Bundle display name 設為 MyPicture;

  • 配置激活規則 NSExtensionActivationRule,將 NSExtensionActivationSupportsImageWithMaxCount 設為 9——超過九張時不顯示分享入口,同時也確保網頁分享、文件分享場景中不會出現 MyPicture。

更多配置項可參考 Apple 官方文檔 SystemExtensionKeys,激活規則還支持更複雜的斷言表達式。

分享擴展的控制器繼承自 SLComposeServiceViewController,常用成員有:

  • charactersRemaining:剩餘字符數,顯示於分享界面左下角;

  • isContentValid():內容校驗方法,編輯過程會被反覆調用,返回 false 時分享按鈕不可用;

  • didSelectPost():點擊發送時觸發,通常在這裡上傳圖片與文本;

  • configurationItems():自定義底部配置項,可接收點擊事件,本文用它跳轉到分類選擇頁。

最終效果:點擊 Category 可選擇圖片分類。

這裡著重說明圖片的獲取。擴展拿不到直接的圖片接口——因為分享內容可能是圖片、網頁或視頻,SLComposeServiceViewController 不可能只為圖片開後門。所有待分享數據都封裝在 extensionContext.inputItems 中,它是 NSInputItem 數組,每個元素含一個 attachments 集合,集合中每項是 NSItemProvider,其中承載着圖片、視頻、鏈接、文件等實際內容。

需要注意,通過 NSItemProvider 取資源是一個漫長且阻塞的過程。若在 didSelectPost() 中才去加載,用戶會明顯感到卡頓。更好的做法是在 presentationAnimationDidFinish() 中就異步預加載並緩存起來,供後續直接使用。

此外,上傳過程也應放到後台。首選 NSURLSession 的後台會話模式,但這裡有個容易踩的坑:後台上傳需要先把資源緩存到本地,而擴展無法訪問宿主應用的緩存目錄,因此必須設置 NSURLSessionConfiguration 的 sharedContainerIdentifier,借助 App Group 使用容器應用的存儲空間。完整實現如下:

import UIKit
import Social
import MobileCoreServices
import Alamofire

private let ShareViewControllerContentTextMax = 200
private let ShareViewControllerDefaultCategoryTitle = "Category"

class ShareViewController: SLComposeServiceViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        self.imageDatas = [NSData]()
        self.charactersRemaining = ShareViewControllerContentTextMax
        self.placeholder = "Please enter description"
    }

    // 顯示分享界面時異步加載圖片,避免在 didSelectPost 中再加載影響體驗
    override func presentationAnimationDidFinish() {
        // 用戶輸入項
        guard let extensionItem = self.extensionContext?.inputItems.first else { return }
        guard let attachments = extensionItem.attachments as? [NSItemProvider] else { return }

        for attachment in attachments {
            let imageType = kUTTypeImage as String
            if attachment.hasItemConformingToTypeIdentifier(imageType) {
                dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), {
                    attachment.loadItemForTypeIdentifier(imageType, options: nil, completionHandler: { (coding, error) in
                        if error == nil {
                            guard let fileURL = coding as? NSURL else { return }
                            guard let data = NSData(contentsOfURL: fileURL) else { return }
                            self.imageDatas.append(data)
                        }
                    })
                })
            }
        }
    }

    // 內容驗證,輸入過程中會不斷調用此方法
    override func isContentValid() -> Bool {
        if let text = self.contentText {
            let len = text.characters.count
            if len > ShareViewControllerContentTextMax {
                return false
            }
            self.charactersRemaining = ShareViewControllerContentTextMax - len
        }
        return true
    }

    // 發送分享內容
    override func didSelectPost() {
        // 上傳圖片和編輯內容、分類
        self.upload()
        // 通知 host app 操作完成
        self.extensionContext!.completeRequestReturningItems([], completionHandler: nil)
    }

    // 自定義分享編輯界面 sheet
    override func configurationItems() -> [AnyObject]! {
        return [self.categorySheetItem]
    }

    // MARK: - 私有方法
    private func selectCategory() {
        let temp = CategoryTableViewController(style: .Grouped)
        temp.selectedCategory = self.categorySheetItem.title
        temp.selectedCategoryHandler = { [weak self] category in
            guard let weakSelf = self else { return }
            weakSelf.categorySheetItem.title = category
        }
        self.pushConfigurationViewController(temp)
    }

    private func upload() {
        let urlStr = "https://requestb.in/v34h3lv3"
        self.manager.upload(.POST, urlStr, multipartFormData: { (formData) -> Void in
            for data in self.imageDatas {
                formData.appendBodyPart(data: data, name: "image", mimeType: "image/jpeg")
            }
            if self.contentText != nil {
                formData.appendBodyPart(data: self.contentText.dataUsingEncoding(NSUTF8StringEncoding)!, name: "content")
            }
            if self.categorySheetItem.title != ShareViewControllerDefaultCategoryTitle {
                formData.appendBodyPart(data: self.categorySheetItem.title.dataUsingEncoding(NSUTF8StringEncoding)!, name: "category")
            }
        }) { encodingResult in
            switch encodingResult {
            case Manager.MultipartFormDataEncodingResult.Success(_, _, _):
                debugPrint("request")
            case let Manager.MultipartFormDataEncodingResult.Failure(error):
                debugPrint(error)
            }
        }
    }

    // MARK: - 私有屬性
    private lazy var categorySheetItem: SLComposeSheetConfigurationItem = {
        let temp = SLComposeSheetConfigurationItem()
        temp.title = ShareViewControllerDefaultCategoryTitle
        temp.tapHandler = self.selectCategory
        return temp
    }()

    // 自定義上傳配置:後台上傳避免阻塞 UI。
    // 注意:NSURLSession 上傳過程需要先緩存到本地,但擴展無法使用 Host App 的緩存空間,
    // 因此必須設置 sharedContainerIdentifier,改用容器應用的空間。
    private lazy var manager: Alamofire.Manager = {
        let configName = "com.cmjstudio.mypicture.backgroundsession"
        let configuration = NSURLSessionConfiguration.backgroundSessionConfigurationWithIdentifier(configName)
        configuration.sharedContainerIdentifier = "group.com.cmjstudio.mypicture"
        let manager = Alamofire.Manager(configuration: configuration)
        manager.startRequestsImmediately = true
        manager.backgroundCompletionHandler = {
            debugPrint("completed.")
        }
        return manager
    }()

    private var imageDatas: [NSData]!
}

網絡層這裡直接選用了 Alamofire 做上傳,若需自行實現可參考 iOS 開發系列中的網絡開發章節。另外,若希望完全自定義分享界面,可以讓 ShareViewController 改為繼承 UIViewController,細節參見 Apple 官方指導文檔。

由於使用了 NSURLSession 後台會話,全部任務完成後系統會回調容器應用的 application(_:handleEventsForBackgroundURLSession:completionHandler:),有必要時可在其中做收尾處理。

總結

本文聚焦 Today Extension 與 Share Extension 兩類最常見的擴展。擴展體系龐大,各類型實現細節差異不小,但生命周期與核心原理是一致的:獨立進程、依賴宿主啟動、通過 App Groups 與自定義 Scheme 完成與容器應用的數據和導航互通。理解這幾條主線之後,面對 iOS 10 新增的 Intent Extension、Message Extension 等類型時,也能快速上手。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved