搜索
开发文档
应用开发
快应用开发
小游戏开发
开发文档/应用开发/服务能力/CloudKit/后台使用流程
后台使用流程更新时间: 2025-02-26 15:50:00

一、进入CloudKit管理后台

开发者确认启用CloudKit服务后,通过以下方式进入CloudKit配置后台
左侧菜单栏进入

  • 访问小米澎湃OS开发者平台,登录开发者账号,访问管理中心选择接入CloudKit能力的应用
  • 点击左侧菜单栏【开发】-【CloudKit配置】,进入CloudKit配置后台

二、创建Container

  • 切换到Container管理,点击【创建Container】
    • 仅支持输入Container名称和描述信息,创建完成后列表可以查看创建的Container
    • 支持查看Container关联的应用信息,以及修改Container描述信息
    • 目前每个开发者暂且支持最多创建10个Container

三、 配置Container

1、 创建recordType

  • 切换到【Container配置】,选择开发环境【DEVELOPMENT】,点击左侧【配置Record Types】,选择【新建Record Type】
    • 输入recordType名称,限制64个字符,只支持字母、数字、_和.
    • 输入recordType对应的数据库名称,位于 /data/data/<应用包名>/databases/ 目录下,例如:notes_database.db,限制256个字符
    • 仅支持在DEVELOPMENT环境新增和删除recordType,一旦部署上线,不能再修改

2、创建recordFields

  • 点击对应的recordType,然后点击【新建Record Field】,可以为该recordType新增需要同步数据的字段
    • 创建recordField,名称限制64个字符,只支持字母、数字、_和.
    • 目前支持的数据类型有Long、Double和String
    • 仅支持在DEVELOPMENT环境新增和删除recordFields,一旦部署上线,不能再删除

注意!!!自增主键是否需要配置,请参考:客户端接入指南-开发步骤-数据库适配-自增主键的多设备同步问题与解决方案 :https://dev.mi.com/xiaomihyperos/documentation/detail?pId=2017

3、配置监听文件路径

  • 开发者可以为开发的应用配置需要同步文件的路径,点击左侧配置监听文件路径,然后选择【新建私有路径】,类型支持internal和external,路径限制128个字符,不包含":", "*", "?", "\"", "<", ">", "|", "\\"
    • internal,路径展示,将同步/data/data/<应用包名>/您输入路径下的文件到云端,例如files
    • external,路径展示,将同步 /sdcard/Android/data/<应用包名>/ 您输入路径下的文件到云端,例如files
    • 仅支持在DEVELOPMENT环境新增和删除文件路径,一旦部署上线,不能再删除

注意:配置RecordTypes和配置监听文件路径至少选择配置一种

四、App引入配置

1、App关联Container

当开发者配置好对应Container的recordTypes以及监听文件路径时,就可以选择将App关联对应的Container

  • 切换到App管理,选择对应的App,点击【关联Container】,点击确定即可将当前App与选择Container进行绑定

注意:部署上线后的Container不支持解绑

2、导出XML配置

  • 选择【导出】,可以导出对应App对应Container的数据架构的XML信息
    • 一个App目前最多支持绑定两个Container
    • 一个Container可以被多个App绑定
    • 支持导出开发环境配置信息(用于开发测试)和生产环境的配置信息(需要部署上线后才能导出)

3、导入配置文件

将上述配置文件ckconfig.xml放到 ../res/xml 文件夹下,然后打包SDK等操作,具体流程可参考客户端接入指南:https://dev.mi.com/xiaomihyperos/documentation/detail?pId=2017

五、开发环境验证

完成导出的xml打包到对应的SDK,开发者本地调试完成后,如果想查看数据是否同步到了云端,可以操作如下:

  • 切换到【Container配置】,点击左侧【数据Data】-【Records】
  • 选择对应的recordType,然后点击【查询】,会显示该recordType包含所有字段的云端数据

六、同步能力上线

部署变化到线上环境
CloudKit 提供了开发环境和生产环境,确认部署将开发环境配置信息部署到生产环境

  • 开发环境和生产环境的配置信息、存储的结构化数据是隔离的
  • 开发环境可以对配置信息进行变更,增加、删除对应的recordTypes、recordFields以及文件路径
  • 开发环境的配置信息一旦部署上线后,生产环境只能查看配置信息,不能修改

点击【部署变化到线上环境】,将开发环境对应的数据架构(RecordTypes和文件路径)部署到线上生产环境

部署完成后,同样可以查看线上生产环境的配置信息,导出线上XML配置,打包到SDK申请应用发布上线

上一篇:开发准备
下一篇:使用入门
文档内容是否有帮助?
有帮助
无帮助