要用iCloud來實(shí)現(xiàn)本地文件與云端文件的同步，首先要處理好邏輯的問題。
什么時(shí)候上傳？什么時(shí)候下載？先上傳還是先下載？如何處理文件沖突？
我要實(shí)現(xiàn)的是每天保存一張圖片文件（當(dāng)天過后就不能再修改這個(gè)圖片文件），用來記錄自己的生活狀態(tài)，所以文件系統(tǒng)比較簡(jiǎn)單，我希望我的app邏輯也盡量簡(jiǎn)單，這樣比較好維護(hù)。所以我設(shè)想了一個(gè)最簡(jiǎn)單的同步邏輯：
點(diǎn)擊同步按鈕后，先上傳本地 所有的文件，如果發(fā)現(xiàn)要上傳的文件在云端已經(jīng)有了同名文件，那么就不上傳這一張圖片文件。然后再從云端下載所有文件到本地，同樣，檢查本地是否有同名文件，如果有，則不下載這張圖片文件。最后，每次創(chuàng)建了一張圖片文件時(shí)，就上傳到云端，執(zhí)行覆蓋操作，也就是有同名文件的話，就把云端的同名文件覆蓋，以本地上傳的為主。
這個(gè)邏輯我覺得簡(jiǎn)單粗暴，可行。那么就開始吧。
開啟iCloud Document 能力
在Targets ->Capabilities->iCloud 中打開iCloud特性，如下圖：
UIDocument
我們使用UIDocument這個(gè)類來處理文件的上傳和下載的，不能直接使用這個(gè)類，而要?jiǎng)?chuàng)建它的子類，并重新實(shí)現(xiàn)下面兩個(gè)方法來處理數(shù)據(jù)：
import UIKit
class MyDocument: UIDocument {
var data:NSData?
var imgData:NSData?
//處理文件上傳
override func contents(forType typeName: String) throws -> Any {
if typeName == "public.png" {
return imgData ?? NSData()
} else {
return Data()
}
}
//處理文件下載
override func load(fromContents contents: Any, ofType typeName: String?) throws {
if let userContent = contents as? NSData {
data = userContent
}
}
}
當(dāng)我在其它地方使用這個(gè)類的實(shí)例對(duì)象document執(zhí)行save操作的時(shí)候，就會(huì)走 contents(forType typeName: String) 方法來把這個(gè)方法里面返回值上傳到iCloud，對(duì)于我們也就是imgData；所以我們?cè)趫?zhí)行save操作前，要給MyDocument里面的imgdata賦值。
document.save(to: ubiquityURL2,
for: .forOverwriting,
completionHandler: {(success: Bool) -> Void in
if success {
print("iCloud create OK \(ubiquityURL2)")
} else {
print("iCloud create failed \(ubiquityURL2)")
}
})
//在執(zhí)行save操作前，要給MyDocument里面的imgdata賦值。
let img = UIImage.init(contentsOfFile: fullpath);
if (img != nil) {
let imgData = NSData.init(contentsOfFile: fullpath)
document.imgData = imgData
}
而document在執(zhí)行open操作的時(shí)候，也就是保存文件到本地，這個(gè)時(shí)候會(huì)走 load(fromContents contents: Any, ofType typeName: String?)方法，這個(gè)方法里面的參數(shù)contents就是iCloud傳給我們的數(shù)據(jù)，我們可以對(duì)這個(gè)數(shù)據(jù)進(jìn)行處理。在這里我使用一個(gè)data接收了這個(gè)數(shù)據(jù)，然后在document.open的success的block里面進(jìn)行處理，把它保存到了本地。
document.open(completionHandler: {(success: Bool) -> Void in
if success {
let data = document.data
if data == nil {
print("iCloud file open failed,error ,data = nil ")
}else {
Utils.saveFileToImgFolder(fileName: fileName!, data: data!)
print("iCloud file open OK")
}
} else {
print("iCloud file open failed")
}
})
ubiquityURL
你肯定已經(jīng)注意到了，在上面我說的document.save方法里面，有一個(gè)參數(shù)ubiquityURL2，它前面有一個(gè)to，這個(gè)就是ubiquityURL，它說明了了一個(gè)文件在iCloud中保存的位置信息。
舉個(gè)例子：我的bundle id如果是com.test.demo,那么對(duì)應(yīng)的ubiquityURL是類似這種：file:///private/var/mobile/Library/Mobile%20Documents/iCloudcomtest~demo.我們需要在后面拼接上Documents來表示這個(gè)文件是保存在iCloud中的我的這個(gè)應(yīng)用的Documents下。也就是說iCloudcomtest~demo是用來區(qū)分是哪個(gè)應(yīng)用的，iCloudcomtest~demo后面的是用來區(qū)分應(yīng)用下文件路徑的。
獲取你的應(yīng)用的跟ubiquityURL的方法是通過以下方法：
func initUbiquityURL() {
let filemgr = FileManager.default
let ubiquityURL = filemgr.url(forUbiquityContainerIdentifier: nil)
//如果ubiquityURL = nil，可能是沒有登錄賬戶，或者沒有打開iCloud
guard ubiquityURL != nil else {
print("Unable to access iCloud Account")
print("Open the Settings app and enter your Apple ID into iCloud settings")
return
}
}
需要說明的是，MyDocument的初始化是需要ubiquityURL的，準(zhǔn)確來說是它處理的這個(gè)文件的ubiquityURL?？梢赃@么理解，UIDocument的每個(gè)實(shí)例都是處理一個(gè)文件，不同的文件處理會(huì)創(chuàng)建不同的實(shí)例。
let document = MyDocument(fileURL: ubiquityURL2)
例如：這里的ubiquityURL2=file:///private/var/mobile/Library/Mobile%20Documents/iCloudcomtest~demo/Documents/2017-03-02.png
查詢?cè)贫宋募?/h3>
我們需要獲取到云端的文件，其實(shí)也是需要知道云端文件對(duì)應(yīng)的ubiquityURL，而本地的文件也可以轉(zhuǎn)成對(duì)應(yīng)的ubiquityURL（這個(gè)后面說），所以這樣，云端和本地就構(gòu)成了一種對(duì)應(yīng)的關(guān)系。
查詢?cè)贫宋募?，可以主?dòng)調(diào)用下面的方法：
//查詢?cè)贫说奈募? func askForCloudDataQuery() {
metaDataQuery = NSMetadataQuery()
metaDataQuery?.searchScopes =
[NSMetadataQueryUbiquitousDocumentsScope]
NotificationCenter.default.addObserver(self,
selector: #selector(
CloudDataManager.metadataQueryDidFinishGathering),
name: NSNotification.Name.NSMetadataQueryDidFinishGathering,
object: metaDataQuery!)
metaDataQuery!.start()
}
查詢到結(jié)果，可以走下面的回調(diào)方法。
考慮到不需要查詢那么多次，我直接查詢到Document下所有的文件，然后根據(jù)文件名與本地文件名作對(duì)比。比對(duì)出兩個(gè)包含ubiquityURL元素的數(shù)組，一個(gè)是需要上傳到云端的，一個(gè)是需要下載到本地的，然后分別進(jìn)行比對(duì)操作。
//獲取到云端的所有的文件的url，保存到cloudURLs數(shù)組里面
func metadataQueryDidFinishGathering(notification: NSNotification) -> Void
{
let query: NSMetadataQuery = notification.object as! NSMetadataQuery
query.disableUpdates()
NotificationCenter.default.removeObserver(self,
name: NSNotification.Name.NSMetadataQueryDidFinishGathering,
object: query)
query.stop()
print("query.valueLists = \(query.valueLists),query.resultCount = \(query.resultCount)")
if cloudURLs == nil {
cloudURLs = Array.init()
}else {
cloudURLs?.removeAll()
}
if query.resultCount != 0 {
let count = (query.results as Array).count
for i in 0..<count{
let resultURL = query.value(ofAttribute: NSMetadataItemURLKey,
forResultAt: i) as! URL
cloudURLs?.append(resultURL)
}
print("cloudURLs = \(cloudURLs!)")
//下載到本地
self.downloadFileToLocal()
}
//上傳到云端
self.uploadFileToCloud()
}
//獲取要上傳到icloud的url的數(shù)組
func getNeedUploadToCloudUbiquityURLArray() -> [URL] {
var finalArr = localURLs
for local in localURLs! {
for cloud in cloudURLs! {
if cloud == local {
let index = finalArr?.index(of: local)
finalArr?.remove(at: index!)
continue
}
}
}
print("getNeedUploadToCloudUbiquityURLArray finalArr = \(finalArr!)")
return finalArr!
}
獲得本地文件
//獲得本地所有文件的需要上傳到cloud的時(shí)候的url，保存到localURLs數(shù)組里面
func initLocalURLs() {
if localURLs == nil {
localURLs = Array.init()
}else {
localURLs?.removeAll()
}
let allImgNames = Utils.getAllFileNameInImgFolder()
for imgName in allImgNames {
let imgURL = ubiquityURLOfImg?.appendingPathComponent(imgName)
localURLs?.append(imgURL!)
}
print("localURLs = \(localURLs)")
}
//獲取要保存到本地的url的數(shù)組
func getNeedDownloadTolocalUbiquityURLArray() -> [URL] {
var finalArr = cloudURLs
for cloud in cloudURLs! {
for local in localURLs! {
if cloud == local {
let index = finalArr?.index(of: cloud)
finalArr?.remove(at: index!)
continue
}
}
}
print("getNeedDownloadTolocalUbiquityURLArray finalArr = \(finalArr!)")
return finalArr!
}
上傳下載操作
獲取到要上傳和下載的數(shù)組后，進(jìn)行上傳和下載的操作就可以了。
//保存文件到本地
func downloadFileToLocal() {
//保存文件到本地
let downloadArr = cloudURLs!// self.getNeedDownloadTolocalUbiquityURLArray()
for ubiquityURL in downloadArr {
let fileName = ubiquityURL.path.components(separatedBy: "/").last
let document = MyDocument(fileURL: ubiquityURL as URL)
document.open(completionHandler: {(success: Bool) -> Void in
if success {
let data = document.data
if data == nil {
print("iCloud file open failed,error ,data = nil ")
}else {
Utils.saveFileToImgFolder(fileName: fileName!, data: data!)
print("iCloud file open OK")
}
} else {
print("iCloud file open failed")
}
})
}
}
//上傳文件到云端
func uploadFileToCloud() {
//上傳文件到icloud
let uploadArr = self.getNeedUploadToCloudUbiquityURLArray()
for ubiquityURL2 in uploadArr {
let document = MyDocument(fileURL: ubiquityURL2)
let fileName = ubiquityURL2.path.components(separatedBy: "/").last
let fileManager = FileManager.default
let fullpath = Utils.getImgFolderPath().appending("/\(fileName!)")
if fileManager.fileExists(atPath: fullpath) {
// print("FILE AVAILABLE")
} else {
print("FILE NOT AVAILABLE at \(fullpath)")
}
let img = UIImage.init(contentsOfFile: fullpath);
if (img != nil) {
let imgData = NSData.init(contentsOfFile: fullpath)
document.imgData = imgData
}
document.save(to: ubiquityURL2,
for: .forOverwriting,
completionHandler: {(success: Bool) -> Void in
if success {
print("iCloud create OK \(ubiquityURL2)")
} else {
print("iCloud create failed \(ubiquityURL2)")
}
})
}
}
做完這些，基本就大功告成了，一個(gè)簡(jiǎn)單的iCloud同步功能就實(shí)現(xiàn)了。
需要注意一點(diǎn)的是，在同步之前，一定要判斷iCloud是否可用，只有可用的情況下，才能進(jìn)行上傳和下載，不然就會(huì)導(dǎo)致crash。
判斷是否可用，只需要判斷ubiquityURL是否為nil就可以，如果為nil，說明iCloud 賬號(hào)沒有再手機(jī)上登錄，或者是iCloud Drive按鈕沒有打開。
源代碼：
最后，代碼可以在這里找到。僅供參考。使用語言為swift 3 。
https://github.com/chenhuaizhe/src/tree/master/swift/iCloudDemoCode
