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

使用 iCloud API 的正確姿勢

編輯:iOS 開發基礎

轉自:SwiftCafe

iCloud 自隨 iOS 5 推出以來,經過幾次迭代已日趨完善。如果你的 App 需要用到文檔存儲相關的功能,那麼 iCloud Document API 是一個很不錯的選擇。相比其他雲存儲平台,iCloud 與 iOS 設備高度集成,API 也更為便捷。但它同時也埋著不少「雷區」,需要我們格外留意。接下來就一起看看使用 iCloud API 的正確姿勢。

正確姿勢一 —— 檢測 iCloud 可用性

在使用 iCloud Document 之前,我們首先要檢測當前設備是否開啟了 iCloud 功能。如果設備本身沒開啟 iCloud,後續所有操作都會失敗。可以通過 NSFileManager 來獲取 iCloud 的狀態:

NSFileManager.defaultManager().URLForUbiquityContainerIdentifier(nil)

這個方法接受一個參數,即要獲取的容器標識。大多數應用只會用到一個 iCloud 容器,所以這裡傳入 nil,代表默認獲取第一個可用的容器。

接著,這個方法內部會查找當前應用擁有的 iCloud 容器:找到就返回該容器的 URL,說明 iCloud 容器可用;找不到則返回 nil,說明 iCloud 不可用。

這樣我們就能根據返回值判斷設備是否開啟了 iCloud 服務。只有在服務開啟時,後續操作才能進行。

不過這個方法拿到的只是 iCloud 容器的根目錄 URL,而大多數情況下我們用的是 Documents 目錄,所以還需要稍作修改:

func getiCloudDocumentURL() -> NSURL? {     if let url = NSFileManager.defaultManager().URLForUbiquityContainerIdentifier(nil) {         return url.URLByAppendingPathComponent("Documents")     }     return nil }

這樣,判斷 iCloud 可用性以及獲取目錄 URL 的邏輯就都完成了。在實現具體邏輯時,用這個方法獲取 URL:能獲取就進行下一步的文件列表操作;獲取失敗則說明設備 iCloud 服務不可用,或當前 App 未開啟 iCloud 服務,這時可以提示用戶去開啟 iCloud。

最後補充一個小 Tip:iCloud 容器和你的 App 文件沙盒,在 iOS 文件系統里其實是分別存放在兩個不同位置的:

iCloud 文件路徑格式 file:///private/var/mobile/Library/Mobile%20Documents/iCloud~com~xxx~aaa/Documents

App 沙盒文件路徑格式 file:///var/mobile/Containers/Data/Application/3B4376B3-89B5-3342-8057-3450D4224518/Documents/

這也說明了,為什麼 iCloud 和 Sandbox 的文件路徑訪問需要兩套不同的方式。

正確姿勢二 —— 獲取 iCloud 文件列表

iCloud 的另一個陷阱就在文件列表的獲取。如果你有 iOS 開發經驗,拿到一個目錄 URL 時,可能會下意識地這樣獲取文件列表:

if let documentURL = getiCloudDocumentURL() {     NSFileManager.defaultManager().contentsOfDirectoryAtURL(documentURL, includingPropertiesForKeys: nil, options: NSDirectoryEnumerationOptions.SkipsHiddenFiles) }

乍看之下似乎沒問題,但一旦把它用在 iCloud 文件操作上,很快就會踩坑。

這要從 iCloud 在 iOS 系統上的運作機制說起。實際上,iCloud 的所有文件同步操作都是由一個駐留在系統里的進程完成的。也就是說,你的 App 所對應的 iCloud 目錄,除了你的 App 進程會操作它,iCloud Daemon 也會操作它,這就帶來了並發訪問資源的管理問題。

但這還不是全部,還有一個更有意思的點。假設你現在用的是 Mac 筆記本,那麼其他設備只要往 iCloud 容器里添加新文件,你的 iCloud Daemon 進程就會自動把它們下載下來。但在 iOS 系統上,出於耗電和網絡流量考慮,iCloud Daemon 並不會自動下載其他設備新添加到容器中的文件,只有你請求打開某個文件時,它才會去下載其內容。

這麼一說,問題就浮出水面了:如果用上面那種遍歷目錄的方法,對於那些從其他設備添加、且尚未下載到本地的文件,就會遍歷不到。顯然這不是我們期望的結果。

那麼在 iOS 上,我們如何拿到完整的文件列表呢?iCloud 雖然不會自動下載這些新文件,但會把這些新文件的元信息(MetaData)同步過來,比如文件名、文件尺寸、修改時間等等。也就是說,我們只要去查詢文件元信息的列表,就能得到與服務端同步的文件列表。

綜上所述,獲取 iCloud 文件列表的正確姿勢是這樣:

let metaQuery = NSMetadataQuery() func listFile() {     metaQuery.searchScopes = [NSMetadataQueryUbiquitousDocumentsScope]     metaQuery.predicate = NSPredicate(value: true)     NSNotificationCenter.defaultCenter().addObserver(self, selector: #selector(listReceived), name:NSMetadataQueryDidFinishGatheringNotification, object: nil)     NSNotificationCenter.defaultCenter().addObserver(self, selector: #selector(listReceived), name:NSMetadataQueryDidUpdateNotification, object: nil)     metaQuery.startQuery() } func listReceived() {     let results = metaQuery.results     for item in results {         let fileURL = item.valueForAttribute(NSMetadataItemURLKey)     }     NSNotificationCenter.defaultCenter().removeObserver(self, name: NSMetadataQueryDidFinishGatheringNotification, object: nil)     NSNotificationCenter.defaultCenter().removeObserver(self, name: NSMetadataQueryDidUpdateNotification, object: nil)     metaQuery.stopQuery() }

這段代碼篇幅稍長。首先我們初始化了一個 NSMetadataQuery 實例,然後在 listFile 方法中設置它的屬性。

metaQuery.searchScopes = [NSMetadataQueryUbiquitousDocumentsScope] 表示我們要查詢 iCloud 的 Documents 目錄中的文件列表。

metaQuery.predicate = NSPredicate(value: true) 是對結果集的過濾選項,這裡默認接受所有文件。

NSMetadataQueryDidUpdateNotification 和 NSMetadataQueryDidFinishGatheringNotification 這兩個通知,分別代表得到查詢數據的更新,以及得到全部查詢數據。

接下來 listReceived 方法處理這兩個通知,此時可以從 metaQuery 的 results 屬性拿到查找到的文件元信息列表,最後用 item.valueForAttribute(NSMetadataItemURLKey) 就能得到包括文件 URL、文件尺寸、修改時間等信息的對象。

獲取完相關信息後,我們可以調用 metaQuery.stopQuery() 結束查詢。此外,NSMetadataQuery 除了這種一次性查詢,還提供了一種長期駐留查詢的機制:只要它的查詢條件所覆蓋的內容發生變化,就會主動發通知給我們。

但要特別注意:NSMetadataQuery 的查詢操作只能在 App 進入前台時開啟,也就是說當 App 切換到後台時,記得暫停查詢。

正確姿勢三 —— 使用 UIDocument

之前的文章里我們討論過一次 UIDocument 的內容,感興趣的可以回顧一下。

對於 iCloud 相關的文件操作,最好使用 UIDocument 來進行。

為什麼要用 UIDocument,而不是直接通過文件操作 API 呢?這要從前面提到的進程間資源共享說起。

首先切記:iCloud 容器中的文件,並不只是你的 App 在操作,還有一個叫 iCloud Daemon 的傢伙也在操作它。多個進程共同操作同一個資源時,就必須保證同一時刻只有一個進程在操作它;否則兩個進程同時操作,會造成非常危險的後果。

比如你的 App 正在把剛修改的內容寫入某個文件,而此時 iCloud Daemon 有可能把服務端對該文件的改動也寫入進來,這樣最終結果必然是其中一個操作覆蓋了另一個操作。

這就需要一套同步機制:當你的 App 進程在寫入時,iCloud Daemon 會等待;等你寫完後,它才會把服務端的改動同步過來。

當然,這個簡化例子只是為了讓大家對資源安全訪問有個直觀理解,實際情況要比這複雜得多。

回到我們的討論:像 NSFileManager 這樣的 API,是無法保證多進程之間這種安全訪問機制的。所以 iOS 引入了兩個類:NSFileCoordinator 和 NSFilePresenter。

直觀地說,假設有 4 個人同時操作一個文檔,每個人都會得到一個 NSFileCoordinator 和 NSFilePresenter。假設其中一人要給文檔加兩行字,他先用他自己的 NSFileCoordinator 向其他三人發出通知;其他三人的 NSFilePresenter 收到通知後,各自可以做一些準備工作,完成後再通過 NSFilePresenter 告訴發起方「準備完成」。只有三人都發出準備完成的通知後,第一個發起者才能把這兩行字寫上去。

這就是 NSFileCoordinator 和 NSFilePresenter 的基本原理——通過這種方式保證文件在多個進程間的訪問安全。實際操作會更複雜些,這裡先做個簡要了解。

iCloud 的官方文檔其實是強制要求使用者對文件的操作都通過 NSFileCoordinator 和 NSFilePresenter 進行的。但文件操作邏輯很多,這兩個類的使用也相對複雜,不熟悉的話用錯了還會導致調試困難。基於這些原因,UIDocument 便應運而生——這也是它最重要的好處:內部已經對 NSFileCoordinator 和 NSFilePresenter 做了封裝,我們直接用就好。

我們通過文件 URL 即可初始化 UIDocument:

let document = UIDocument(fileURL: fileURL)

初始化完成後,直接打開即可:

document.openWithCompletionHandler { success in     document.contents }

UIDocument 會區分 Sandbox 和 iCloud 進行相應處理,並解決多進程操作的問題。調用 openWithCompletionHandler 之後,我們的 UIDocument 就相當於一個已打開的 NSFilePresenter,如果其他進程要修改這個文件,我們就會收到通知並進行準備工作,而 UIDocument 已經為我們提供了默認實現。

文檔使用完畢後,可以調用:

document.closeWithCompletionHandler { success in }

這個方法除了關閉文檔,還會自動為我們處理文件保存操作,並釋放 NSFilePresenter 的占用。

最後,UIDocument 不能直接使用,我們還需要實現兩個方法:

class Doc : UIDocument {     var fileContents: String = "";     override func contentsForType(typeName: String) throws -> AnyObject {         return fileContents.dataUsingEncoding(NSUTF8StringEncoding)!     }     override func loadFromContents(contents: AnyObject, ofType typeName: String?) throws {         fileContents = NSString(data: contents as! NSData, encoding: NSUTF8StringEncoding) as! String     } }

UIDocument 雖然為我們實現了很多底層操作,但如何獲取文件內容的邏輯仍留給了我們自己。contentsForType 和 loadFromContents 都是回調方法:contentsForType 用於保存文件時向 UIDocument 提供要保存的數據;loadFromContents 用於 UIDocument 成功打開文件後,把數據解析成我們需要的文件內容並保存起來。

之所以這樣設計,我的理解是:UIDocument 只是對通用文件的一個抽象,它可以是普通文本文件,也可以是其他類型的文件格式,所以它傳給我們的只是一份原始的 data 數據,如何解析和處理就交給了我們自己。

這裡對 UIDocument 的基本使用做了個介紹,更詳細的用法就需要大家參考相關文檔了。

結尾

我自己也曾開發過 iCloud 相關功能,剛開始總會莫名其妙地陷入一些陷阱,出現莫名其妙的錯誤。於是花了好幾天時間認真研究了 iCloud 相關文檔,過程中發現它的文檔分布非常廣,從設計規範到基於文檔的編程規範等等,散落在很多個主題文檔里,只有把它們融會貫通,才能慢慢理解這套 API 背後的機制。

所以這裡我把看到的一些認為重要的地方做了梳理,希望能幫大家少走彎路,抓住重點。

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