Android SDK 简介

接入SDK

通过gradle引入SDK。

implementation 'com.aliyun.pds:android-sdk:0.1.4'

源码地址 aliyun-pds-android-sdk。

初始化

在使用SDK之前，请确保您已经开通PDS服务，并且在控制台创建了实例，参见快速搭建云盘服务。

// 这个通用流程是你们登入自己的账号系统后获取，后端使用 PDS 平台申请的 appKey & appSecret 换取 token 返回给客户端
val token = SDToken("you access token") 
// 请在PDS控制台获取您的 api host
val apiHost = "you api host"            
val config = SDConfig.Builder(token, apiHost, 3600)
    // 是否支持妙传，默认true (选填)
    .canFastUpload() 
    // 请求的ua (选填)
    .userAgent() 
    // 最大重试次数,默认3  (选填)
    .maxRetryCount()
    // 是否开启调试模式,默认false (选填)
    .isDebug()
    // 下载分片大小,默认10M,不要填过小或者过大(选填)
    .downloadBlockSize() 
    // 上传分片大小,默认4M,不要填过小或者过大(选填)
    .uploadBlockSize() 
    // 建立网络连接超时时间设置,默认15s (选填)
    .connectTimeout()
    // 网络连接响应超时时间设置,默认60s (选填)
    .readTimeout()
    // 网络传输响应超时时间设置,默认60s (选填)
    .writeTimeout()         
    .build()
SDClient.instance.init(this, config)

任务进度回调

// currentSize 为当前的进度，注意回调不在主线程
interface OnProgressListener {
    fun onProgressChange(currentSize : Long)
}

任务结束回调

interface OnCompleteListener {
    fun onComplete(taskId: String, fileMeta : SDFileMeta, errorInfo: SDErrorInfo?)
}

其中fileMeta 为文件相关信息

class SDFileMeta(
    // 文件id
    val fileId: String?,
    // 文件名
    val fileName: String?,
    // 文件路径，上传任务为要上传文件的路径，下载任务为文件保存路径
    val filePath: String?,
    // 上传任务的 uploadId，不涉及相关业务可以忽略
    val uploadId: String? = "" 
)

class SDErrorInfo(
    // 相关错误码
    val code: SDTransferError,
    // 错误描述
    val message: String,
    // 异常，用于查看堆栈, 以及错误处理
    val exception: Exception?,
    // 如果是后端请求相关错误，则会有该值用于和后端排查问题
    var requestId: String? = "" 
)

错误信息错误码说明

SDTransferError.Unknown // 未知错误
SDTransferError.Network // 网络错误
SDTransferError.Server // 服务器错误
SDTransferError.FileNotExist // 上传时，本地文件没有找到
SDTransferError.SpaceNotEnough // 下载时，本地空间不足
SDTransferError.TmpFileNotExist // 下载时，本地临时文件不存在
SDTransferError.PathRuleError // 下载时，保存路径规则错误