开发文档
业务介绍更新时间: 2025-02-25 18:44:00
一、业务简介
CloudKit SDK 是一套面向开发者的工具集,旨在帮助您的应用程序将数据高效、安全地存储到小米云服务中,并在多个设备之间实现实时同步。无论是用户的私人数据还是公共数据,CloudKit 都可以轻松处理,使开发者能够专注于核心业务逻辑
- 核心能力:
- 多端数据同步:确保用户在不同设备上访问到的内容始终保持一致
- 数据安全性:利用小米云的隐私保护机制,为用户提供可靠的数据存储和访问体验
- 开发便捷性:集成了数据库、文件存储、用户认证等模块,让开发者能够快速实现复杂的功能
无论是构建数据密集型应用,还是希望通过云存储实现规模化扩展,CloudKit 都是理想的选择
二、 产品优势
1、 对用户的价值
1.1、 无缝体验:
- 多端同步能力确保用户在手机、平板、电脑等设备上的数据始终一致。例如,用户在一台设备上编辑的文档可以立即在另一台设备上查看和继续编辑,省去了手动传输的麻烦
- 离线访问与智能更新功能,即使在断网情况下,用户也能访问关键数据,重新联网后自动更新数据
1.2、 数据安全与隐私保护:
- 数据存储在小米云服务中,采用端到端加密和严格的隐私保护策略,用户数据只有用户本人可访问,无需担心泄露或丢失问题
2、对开发者的价值
2.1、 提升用户体验:
- 数据的实时同步让应用程序的流畅性和便捷性大幅提升,减少用户因数据不一致或丢失导致的使用障碍,从而提高用户的活跃度和粘性
- 通过对离线与在线状态的灵活支持,用户无论在何种网络环境下都能保持良好的使用体验
2.2、 提供增值功能,带来收入增长:
- 同步功能本身可以作为应用的付费增值项,例如高级会员服务中包含多端同步能力
- 开发者后台提供详尽的用户数据管理和监控功能,帮助开发者深入了解用户行为,优化产品设计
2.3、 简化开发流程,降低开发成本:
- CloudKit 将数据库、文件存储、用户认证整合为一体,减少开发者使用多种工具和服务的复杂度
- 高效的 SDK 集成方式和清晰的文档支持,帮助开发者快速上手,缩短开发周期
三、场景介绍
1、同步结构化数据
- 案例:TODO-同步待办项
- 案例:笔记-同步笔记里的文字内容
- 案例:日历-同步日程
2、同步文件
- 案例:PDF 查看工具-同步PDF文件
- 案例:文件管理器-同步上传以及编辑修改的文件
- 案例:笔记-同步笔记里的附件
- 案例:录音机-同步录音文件
四、运作机制
1、 流程图

2、 网页操作流程图

五、功能介绍
功能 | 描述 |
双向同步与数据管理 | 实现本地端与云端数据的双向同步,确保数据一致性 |
监听与同步 | APP 通过 CloudKit SDK 监听本地数据库和文件变动,将变化同步到云端 |
多业务调度枢纽 | CloudKit 服务负责本地变更与云端更新之间的调度和同步,推动云端更新回传至本地 |
UI 反馈与进度展示 | 小米云服务客户端通过 UI 展示同步的结果 |
支持多种同步需求 | 满足文件同步和数据同步的场景需求 |
六、 受限说明
1、 支持的终端设备
时间 | 版本 | 支持的终端设备列表 |
2025/1/8 | 1.0.0 | 小米手机(云服务1.12.0.4.40版本及以上) |
2025/2/11 | 1.0.1 | 小米手机(云服务1.12.0.4.40版本及以上) |
2、 支持的国家/地区
时间 | 版本 | 平台 | 支持的国家/地区列表 |
2025/1/8 | 1.0.0 | 小米手机(云服务1.12.0.4.40版本及以上) | 中国大陆 |
2025/2/11 | 1.0.1 | 小米手机(云服务1.12.0.4.40版本及以上) | 中国大陆 |
七、 常见术语
7.1、 环境 :CloudKit 提供了 开发环境 和 生产环境,帮助开发者在不同阶段安全管理和测试数据
- DEVELOPMENT(开发环境):用于开发和测试,所有改动仅影响开发版本的数据,不会对线上版本产生影响
- PRODUCTION(生产环境):线上环境,适用于正式发布的 App。在生产环境中,开发者只能进行有限的架构修改,以避免对已有用户数据产生影响
7.2、 数据记录: CloudKit 中的数据记录指的是直接存储在 CloudKit 数据库中的具体数据条目,每条记录都可被精确访问和管理
7.3、 数据框架:数据框架是开发者管理 CloudKit 数据库架构的核心工具,提供对存储结构的查看、编辑和优化功能:
- Container(容器):存储相关数据项的逻辑单元。一个 App 通常会使用单个容器来存储所有生产数据,但也支持以下情况:
- 单个 App 使用多个容器(用于区分模块数据)
- 多个 App 共享单个容器(便于跨 App 数据共享)。 容器确保数据隔离,并可独立管理架构与权限
- Record(记录):存储在容器中的具体数据条目。每个记录对应一行数据,并包含多个字段
- Record Type(记录类型):开发者定义的记录数据表的表名,用于组织和分类数据。例如,一个用户信息表可以命名为
UserInfo
- Record Field(记录字段):记录表中的具体列,用于存储特定的属性值。例如,
UserInfo
表中可能包含Name
、Age
和Email
等字段 - 监听文件路径:开发者配置的本地同步路径。指定路径下的文件会被 CloudKit 自动监听并同步到云端
上一篇:
下一篇: