CloudKit Share API 初探

作者: MarkNote | 来源:发表于2017-03-11 23:38 被阅读194次

    tags:开发随笔

    缘起

    灯下鼠同学在使用了MarkNotes后,建议增加笔记分享的功能。

    其实这个问题我已经思考了很久,除了自己做服务器端,没有一个太好的方案。所以在目前的版本中,我暂时只提供了通过邮件发送笔记的功能。话说,iOS版本的mail应用真是弱的可以,想写一篇富文本的邮件都很难。MarkNote for iOS简直是一个完美的iOS邮件编辑器。

    当然了,使用 MarkNotes/Marknote你也可以将笔记很方便的导出为HTML或者PDF。甚至你可以借助其强大的过滤功能,导出为静态网站,扔到web服务器上,所有的人都可以看。

    然而,这还不是理想的分享。

    需求

    我觉得一个理想的分享,应该可以满足以下几个场景:
    A: 可以设置为public,所有人都可以读,甚至不需要拥有账号;
    B: 邀请者只读;
    C: 邀请者可写,从而实现协同工作;

    简单分析一下, 场景A其实是一种publish,导出为HTML通过web发布基本上可以满足,只是目前门槛稍微有点高,需要一种方式让整个过程更简单;

    场景B和C需要:

    • 一种机制,可以识别并邀请其他用户;
    • 一种机制将邀请发出;
    • 被邀请者可能有各种古怪的场合,比如还没有安装你的应用;
    • 在此基础上,对读写权限进行控制;

    如果可以用服务器端,上面的需求还是有望从技术上完美实现。但是运营的成本会极大的增加:你需要将大量的用户吸引到你的平台上来,注册,留存,还需要对数据安全等方方面面考虑周全... 可能还要考虑天朝的监管。

    因此我还是希望MarkNotes保持Serverless的架构,保持简单。

    曙光

    苹果在WWDC2016上宣布了Cloudkit的新特性,其中CKShare的特性尤其是吸引了我的目光。

    我将下面的视频看了2遍:
    https://developer.apple.com/videos/play/wwdc2016/226/ 初步觉得可能可以解决大部分的问题。

    查了一些资料后,简单实验了一下。顺便吐槽一下,CKShare方面的文档和代码很少。尤其是代码,能找到的少之又少,不少还有问题。

    CloudKit有2个数据库privateDatabase和publicDatabase。
    要实现场景A,将数据放在public database即可。简单。
    所以我们还是集中精力在场景2和3。简单的说,即让受邀用户来参与。

    CKShare需要一个root record,它是通过树的方式来控制分享的数据的。Root record可以有自己的子节点,子节点还可以有子节点。将root record传给CKShare对象,CKShare来控制谁被邀请,是只读还是读写。

    有一个坑,被CKShare分享的数据只能存在于custom zone中,如果存放于default zone则会报错。

    所以在进行分享前,先要创建custom zone:

    let container: CKContainer = CKContainer.default()
            
            let privateDatabase = container.privateCloudDatabase
            let customZone = CKRecordZone(zoneName: customZoneName)
            privateDatabase.save(customZone, completionHandler: ({returnRecord, error in
                if error != nil {
                    // Zone creation failed
                    OperationQueue.main.addOperation {
                        print("Cloud Error:\(error?.localizedDescription)")
                    }
                } else {
                    // Zone creation succeeded
                    OperationQueue.main.addOperation {
                        print( "The \(self.customZoneName) was successfully created in the private database.")
                    }
                }
            }))
    
    

    之后,我们只需要以root record作为参数创建CKShare对象,然后二者保存到private database中就可以分享了:

    let share = CKShare(rootRecord: newRecord)
                share[CKShareTitleKey] = "hello" as CKRecordValue?
                
                
                let modifyRecordsOperation = CKModifyRecordsOperation( recordsToSave: [newRecord, share], recordIDsToDelete: nil)
                
                modifyRecordsOperation.modifyRecordsCompletionBlock = { records, recordIDs, error in
                    
                    if let error = error {
                        print(error.localizedDescription)
                    }
                    if records != nil {
                        print("Share and Root records saved successfully")
                    }
                    preparationCompletionHandler(share,  container , error)
                }
                
                privateDatabase.add(modifyRecordsOperation)
    

    创建完CKShare对象后,需要将邀请发送给被邀请人。新的API提供了一个UICloudSharingController来简化被邀请人查找等操作UI的工作量。使用方式如下:

    let cloudSharingController: UICloudSharingController = UICloudSharingController{ controller,
                preparationCompletionHandler in
                ...
                 
            }
            cloudSharingController.delegate = self
            cloudSharingController.popoverPresentationController?.sourceView = self.view
            // Set sharing permissions
            cloudSharingController.availablePermissions = [.allowPublic, .allowReadOnly]
            
            
            // Show cloud sharing dialog
            self.present(cloudSharingController, animated: true, completion: nil)
    

    运行效果如下:

    Paste_Image.png

    总结

    CloudKit中最新的Share API提供了一种分享的好机制,虽然如果要考虑用户没装app时的降级措施,可能还需要服务器端,但已经大大的降低了分享的难度。

    说点局限吧:

    • 顾名思义,用户的身份是和iCloud账号绑定的;
    • 邀请者需要知道被邀请者iCloud账号绑定的的邮件或者手机;
    • 基于apple一贯的借助系统升级来促进硬件销售的策略,CloudKit Share API只支持iOS10以上的设备。

    代码

    代码放在github上供参考 https://github.com/marknote/CloudKitSharing。请注意,目前的代码只是 最简单的探索,功能并不完善,细节也未考虑

    相关文章

      网友评论

      • 灯下鼠:是这么回事,一旦开启了 server 端,就直奔着 evernote而去....不穷尽的事都来了...
        MarkNote:@灯下鼠 在取舍间徘徊:relieved:

      本文标题:CloudKit Share API 初探

      本文链接:https://www.haomeiwen.com/subject/gjzzgttx.html