Skip to main content
Version: v4

Android SDK 开发指南

本文介绍如何在游戏中加入云存档功能。

集成前准备​

  1. 参考 开发者中心配置 创建应用、开启云存档服务
  2. 参考 Android 集成指南 完成基础接入
  3. 云存档模块依赖于 TapTap 登录模块,开发者接入前应先完成 TapTap 登录的接入

权限说明​

该模块需要如下权限:

权限使用目的权限申请时机
网络权限用于访问网络数据用户首次使用该功能时会申请权限
网络状态权限用于检查网络连接状态(如 Wi-Fi 或移动数据是否可用)用户首次使用该功能时会申请权限

该模块将在应用中添加如下权限:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

SDK 获取​

在 app module 的 build.gradle 中添加对应依赖:

dependencies {
implementation 'com.taptap.sdk:tap-core:4.11.1'
implementation 'com.taptap.sdk:tap-login:4.11.1'
implementation 'com.taptap.sdk:tap-cloudsave:4.11.1'
}

注册/注销统一状态码监听回调​

统一状态回调,不同 code 代表不同的状态。

import com.taptap.sdk.cloudsave.internal.TapCloudSaveCallback;
import com.taptap.sdk.cloudsave.TapTapCloudSave;

TapCloudSaveCallback callback = new TapCloudSaveCallback(){

@Override
public void onResult(int resultCode) {
// 处理云存档的状态码
// 300001:需要登录
// 300002:初始化失败 需重新初始化
}
};

TapTapCloudSave.registerCloudSaveCallback(callback);

// 不再接收状态时,传入同一个回调对象注销
TapTapCloudSave.unregisterCloudSaveCallback(callback);

参数说明:

方法参数类型说明
registerCloudSaveCallbackcallbackTapCloudSaveCallback接收需要登录、初始化失败等模块状态。当前实现只保留最近一次注册的状态回调。
unregisterCloudSaveCallbackcallbackTapCloudSaveCallback注销状态回调,需传入注册时的同一个对象。

状态码取值见结果码说明。状态回调不返回单次创建、下载等请求的结果;各请求结果由 TapCloudSaveRequestCallback 返回。

创建存档​

创建游戏存档并上传云端。

info

存档名称仅支持【英文/数字/下划线/中划线】,不支持中文

存档摘要 (summary) 以及额外信息 (extra) 无此限制,但 summary 不能为空字符串

一分钟内最多可调用 60 次(与更新存档共享冷却时间)

import androidx.annotation.NonNull;
import com.taptap.sdk.cloudsave.ArchiveData;
import com.taptap.sdk.cloudsave.ArchiveMetadata;
import com.taptap.sdk.cloudsave.TapTapCloudSave;
import com.taptap.sdk.cloudsave.internal.TapCloudSaveRequestCallback;

// 存档元信息
ArchiveMetadata metadata = new ArchiveMetadata.Builder()
.setName("archive_name") // 存档名称
.setSummary("archive_desc") // 存档描述
.setExtra("extra_info") // 额外信息
.setPlaytime(0) // 游戏时长(秒)
.build();

// 存档文件路径(单个存档文件大小不超过10MB)
String archiveFilePath = "path/to/archive/file";
// 存档封面路径(可选,封面大小不超过512KB)
String archiveCoverPath = "path/to/cover/image";

// 请求回调
TapCloudSaveRequestCallback callback = new TapCloudSaveRequestCallback() {

@Override
public void onRequestError(int errorCode, @NonNull String errorMessage) {
// 处理请求错误
}

@Override
public void onArchiveCreated(@NonNull ArchiveData archive) {
// 创建成功,archive.uuid 为云存档唯一标识
// archive.fileId 为存档文件标识
}
};

TapTapCloudSave.createArchive(metadata, archiveFilePath, archiveCoverPath, callback);

参数说明:

参数类型必填说明
archiveMetadataArchiveMetadata是存档元信息,字段说明见下表。
archiveFilePathString是本地存档文件路径。SDK 会读取该路径对应的文件并上传,文件大小不能超过 10 MB。
archiveCoverPathString否本地封面文件路径。传入 null 或空字符串表示不上传封面,封面大小不能超过 512 KB。
callbackTapCloudSaveRequestCallback是接收创建存档的成功或失败结果。

ArchiveMetadata.Builder 字段:

Builder 方法字段类型必填说明
setName(name)String是存档名称,不能为空,最多 60 字节;仅支持英文字母、数字、下划线和中划线。
setSummary(summary)String是存档描述,不能为空,最多 500 字节。
setExtra(extra)String否开发者自定义信息,最多 1000 字节,允许为空。可用于记录存档版本等业务信息。
setPlaytime(playtime)Int是当前存档对应的游戏时长,单位为秒,必须是非负数。Builder 默认值为 -1,因此需要显式设置。

创建成功后返回 ArchiveData。其中 uuid 和 fileId 由服务端生成,name、summary、extra 和 playtime 由 SDK 从本次请求的元信息中补充:

字段类型说明
uuidString云存档的唯一标识,用于更新或删除存档。
fileIdString存档文件标识,与 uuid 一起用于下载存档数据或封面。
nameString存档名称。
summaryString存档描述。
extraString开发者写入的自定义信息。
playtimeInt游戏时长,单位为秒。
saveSizeLong存档文件大小,单位为字节。创建结果不保证返回该字段,未返回时为 -1。
coverSizeLong存档封面大小,单位为字节。创建结果不保证返回该字段,未返回时为 -1。
createdTimeLong存档创建时间,秒级时间戳。创建结果不保证返回该字段,未返回时为 -1。
modifiedTimeLong存档最后修改时间,秒级时间戳。创建结果不保证返回该字段,未返回时为 -1。

如需读取包含文件大小和时间信息的完整存档数据,请调用获取存档列表接口。

获取存档列表​

获取当前用户的存档列表。

import androidx.annotation.NonNull;
import com.taptap.sdk.cloudsave.ArchiveData;
import com.taptap.sdk.cloudsave.TapTapCloudSave;
import com.taptap.sdk.cloudsave.internal.TapCloudSaveRequestCallback;
import java.util.List;

TapCloudSaveRequestCallback callback = new TapCloudSaveRequestCallback() {
@Override
public void onArchiveListResult(@NonNull List<ArchiveData> archiveList) {
// 处理存档列表
}

@Override
public void onRequestError(int errorCode, @NonNull String errorMessage) {
// 处理请求错误
}
};

TapTapCloudSave.getArchiveList(callback);

参数说明:

参数类型必填说明
callbackTapCloudSaveRequestCallback是接收存档列表或请求失败结果;没有存档时列表为空。

列表中的每一项均为 ArchiveData,字段说明见创建存档中的返回字段表。

下载存档​

下载指定的存档文件。

import androidx.annotation.NonNull;
import com.taptap.sdk.cloudsave.TapTapCloudSave;
import com.taptap.sdk.cloudsave.internal.TapCloudSaveRequestCallback;

// 存档UUID
String archiveUuid = "archive_uuid";
// 存档文件ID
String archiveFileId = "archive_file_id";
TapCloudSaveRequestCallback callback = new TapCloudSaveRequestCallback() {
@Override
public void onArchiveDataResult(@NonNull byte[] archiveData) {
// 处理下载的存档数据
}

@Override
public void onRequestError(int errorCode, @NonNull String errorMessage) {
// 处理请求错误
}
};

TapTapCloudSave.getArchiveData(archiveUuid, archiveFileId, callback);

参数说明:

参数类型必填说明
archiveUUIDString是云存档唯一标识,使用创建存档或获取存档列表时返回的 ArchiveData.uuid。
archiveFileIDString是存档文件标识,使用同一条 ArchiveData 中的 fileId。
callbackTapCloudSaveRequestCallback是接收存档文件的原始字节数据或请求失败结果;游戏需要自行解析数据或写入本地文件。

更新存档​

更新指定的存档文件。

info

存档名称仅支持【英文/数字/下划线/中划线】,不支持中文

存档摘要 (summary) 以及额外信息 (extra) 无此限制,但 summary 不能为空字符串

一分钟内最多可调用 60 次(与创建存档共享冷却时间)

import androidx.annotation.NonNull;
import com.taptap.sdk.cloudsave.ArchiveData;
import com.taptap.sdk.cloudsave.ArchiveMetadata;
import com.taptap.sdk.cloudsave.TapTapCloudSave;
import com.taptap.sdk.cloudsave.internal.TapCloudSaveRequestCallback;

// 存档UUID
String archiveUuid = "archive_uuid";
// 存档元信息
ArchiveMetadata metadata = new ArchiveMetadata.Builder()
.setName("new_archive_name") // 更新后的存档名称
.setSummary("new_archive_desc") // 更新后的存档描述
.setExtra("extra") // 额外信息
.setPlaytime(0) // 游戏时长(秒)
.build();
// 新的存档文件路径(单个存档文件大小不超过10MB)
String archiveFilePath = "path/to/new/archive/file";
// 新的存档封面路径(可选,封面大小不超过512KB)
String archiveCoverPath = "path/to/new/cover/image";

TapCloudSaveRequestCallback callback = new TapCloudSaveRequestCallback() {
@Override
public void onArchiveUpdated(@NonNull ArchiveData archive) {
// 处理存档更新成功
}

@Override
public void onRequestError(int errorCode, @NonNull String errorMessage) {
// 处理请求错误
}
};

TapTapCloudSave.updateArchive(archiveUuid, metadata, archiveFilePath, archiveCoverPath, callback);

参数说明:

参数类型必填说明
archiveUUIDString是要更新的云存档唯一标识,使用创建存档或获取存档列表时返回的 ArchiveData.uuid。
archiveMetadataArchiveMetadata是更新后的完整存档元信息,字段限制与创建存档一致。
archiveFilePathString是新的本地存档文件路径。SDK 会读取并上传该文件,文件大小不能超过 10 MB。
archiveCoverPathString否新的本地封面文件路径。传入 null 或空字符串表示不上传封面,封面大小不能超过 512 KB。
callbackTapCloudSaveRequestCallback是接收更新后的存档数据或请求失败结果;后续操作应使用成功结果中的 uuid 和 fileId。

删除存档​

删除指定的存档文件。

import androidx.annotation.NonNull;
import com.taptap.sdk.cloudsave.ArchiveData;
import com.taptap.sdk.cloudsave.TapTapCloudSave;
import com.taptap.sdk.cloudsave.internal.TapCloudSaveRequestCallback;

// 存档UUID
String archiveUuid = "archive_uuid";
TapCloudSaveRequestCallback callback = new TapCloudSaveRequestCallback() {
@Override
public void onArchiveDeleted(@NonNull ArchiveData archive) {
// 处理存档删除成功
}

@Override
public void onRequestError(int errorCode, @NonNull String errorMessage) {
// 处理请求错误
}
};

TapTapCloudSave.deleteArchive(archiveUuid, callback);

参数说明:

参数类型必填说明
archiveUUIDString是要删除的云存档唯一标识,使用创建存档或获取存档列表时返回的 ArchiveData.uuid。
callbackTapCloudSaveRequestCallback是接收被删除的存档数据或请求失败结果。

获取存档封面​

获取指定存档的封面图片。

import androidx.annotation.NonNull;
import com.taptap.sdk.cloudsave.TapTapCloudSave;
import com.taptap.sdk.cloudsave.internal.TapCloudSaveRequestCallback;

// 存档UUID
String archiveUuid = "archive_uuid";
// 存档文件ID
String archiveFileId = "archive_file_id";
TapCloudSaveRequestCallback callback = new TapCloudSaveRequestCallback() {
@Override
public void onArchiveCoverResult(@NonNull byte[] coverData) {
// 处理封面数据
}

@Override
public void onRequestError(int errorCode, @NonNull String errorMessage) {
// 处理请求错误
}
};

TapTapCloudSave.getArchiveCover(archiveUuid, archiveFileId, callback);

参数说明:

参数类型必填说明
archiveUUIDString是云存档唯一标识,使用创建存档或获取存档列表时返回的 ArchiveData.uuid。
archiveFileIDString是存档文件标识,使用同一条 ArchiveData 中的 fileId。
callbackTapCloudSaveRequestCallback是接收封面文件的原始字节数据或请求失败结果;游戏需要自行解码数据或写入本地文件。
note

云存档请求异步执行。若需要在回调中更新界面,请先切换到 Android 主线程。

结果码说明​

结果码说明
300001需要登录
300002初始化失败,需要重新初始化

请求错误码​

以下错误码会在请求失败时返回。

错误码说明
400000非法的存档文件/封面大小
400001存档上传频率超限
400002指定的存档不存在
400003单个应用下存档数量超限
400004单个应用下使用存储空间超限
400005总使用存储空间超限
400006创建/更新云存档超时,通常是由于网络卡顿,耗时过长导致
400007上传云存档并发调用次数超过 10 个,或者并发更新同一个云存档
400008找不到可用的 OSS 供应商
400009存档名称不合法
400010禁止同一台机器同一个ClientID多个进程使用同一账号

国际化​

TapTapCloudSave 支持设置语言:目前只支持简体中文