- 文件上传下载
- 文件操作相关API
implementation 'com.aliyun.pds:android-sdk:0.1.4'** 支持的SDK最低版本为21 **
val token = SDToken("you access token") // 这个通用流程是你们登入自己的账号系统后获取，后端使用 PDS 平台申请的 appKey & appSecret 换取 token 返回给客户端
val apiHost = "you api host" // 请在PDS控制台获取你的 api host
val config = SDConfig.Builder(token, apiHost, 3600)
.canFastUpload() // 是否支持妙传，默认true (选填)
.userAgent() // (选填)
.maxRetryCount() // 最大重试次数,默认3 (选填)
.isDebug() // 是否开启调试模式,默认false (选填)
.downloadBlockSize() // 下载分片大小,默认10M (选填)
.uploadBlockSize() // 上传分片大小,默认4M (选填)
.connectTimeout() // 建立网络连接超时时间设置,默认15s (选填)
.readTimeout() // 网络连接响应超时时间设置,默认60s (选填)
.writeTimeout() // 网络传输响应超时时间设置,默认60s (选填)
.build()
SDClient.instance.init(this, config)注意任务的进度和状态回调都在子线程,若要更新UI请自行切换到主线程
创建一个 下载任务 并操作它 :
// 初始化下载信息
val downloadInfo = DownloadRequestInfo.Builder()
.downloadUrl(url)
.driveId(driveId)
.fileId(fileId)
.fileName(fileName)
.fileSize(fileSize)
.filePath(dir.path) // 文件保存路径
.shareId(shareId) // 文件来自分享：id(不涉及分享业务可不传)
.shareToken(shareToken) // 文件来自分享：token(不涉及分享业务可不传)
.sharePwd(sharePwd) // 文件来自分享：pwd(不涉及分享业务可不传)
.revisionId(revisionId) // 历史版本相关：id(下载文件的历史版本时，需要传入，不涉及可不传)
.contentHash(hash) // hash 效验值
.contentHashName("crc64") // hash 效验算法名 当前只支持 crc64
.build()
// 创建任务并启动任务
val task = SDClient.instance.startDownloadTask(
taskId, // taskId
downloadInfo, // 下载信息
completeListener, // 下载完成监听（成功，失败都会回调。失败时会返回错误信息)
progressListener // 下载进度监听
)
// 默认startDownloadTask即会启动任务，任务被stop后需要再次启动可以调用此方法继续运行
task.start()
// 停止任务，clean参数false代表不清理临时文件，继续start会断点续传，参数为true则代表会清理临时文件及数据，再次start会重头进行任务
task.stop(clean)
注意任务的进度和状态回调都在子线程,若要更新UI请自行切换到主线程
创建一个 上传任务 并操作它 :
// 初始化上传信息
val uploadInfo = UploadRequestInfo.Builder()
.fileName("edmDrive")
.filePath(file.absolutePath)
.fileSize(file.length())
.parentId(parentId)
.driveId(driveId)
.mimeType(mimeType)
.fileId(fileId) // 文件id，覆盖上传时必填
.checkNameMode(checkNameMode) // 同名文件处理模式，默认为"auto_rename"，具体参数说明如下：
// auto_rename: 当发现同名文件是，云端自动重命名，默认为追加当前时间点，如 xxx _20060102_150405;
// ignore: 允许同名文件;
// refuse：当云端存在同名文件时，拒绝创建新文件，直接提示上传成功
.shareId(shareId) //上传到的文件夹来自分享：id(不涉及可不传)
.shareToken(shareToken) //上传到的文件夹来自分享：token(不涉及可不传)
.sharePwd(sharePwd) //上传到的文件夹来自分享：pwd(不涉及可不传)
.build()
// 创建任务并启动
val task = SDClient.instance.startUploadTask(
taskId, // 任务id
uploadInfo, // 上传信息
completeListener, // 上传完成监听（成功，失败都会回调。失败时会返回错误信息)
progressListener // 上传进度监听
)
// 默认startUploadTask即会启动任务，任务被stop后需要再次启动可以调用此方法继续运行
task.start()
// 停止任务，clean参数false代表不清理临时文件，继续start会断点续传，参数为true则代表会清理临时文件及数据，再次start会重头进行任务
task.stop(clean)
// currentSize 为当前的进度，注意回调不在主线程
interface OnProgressListener {
fun onProgressChange(currentSize : Long)
}interface OnCompleteListener {
fun onComplete(taskId: String, fileMeta : SDFileMeta, errorInfo: SDErrorInfo?)
}其中fileMeta 为文件相关信息
class SDFileMeta(
val fileId: String?, // 文件id
val fileName: String?, // 文件名
val filePath: String?, // 文件路径，上传任务为要上传文件的路径，下载任务为文件保存路径
val uploadId: String? = "" //上传任务的 uploadId，不涉及相关业务可以忽略
)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 // 下载时，保存路径规则错误
server错误时具体错误内容判断示例：
if (SDErrorInfo.getException().getErrorCode().equals("ForbiddenFileInTheRecycleBin")) {
return "文件在回收站中，禁止操作"
}注：错误类型为SDTransferError.Server时，错误信息中会包含errorCode，可对照错误码文档确定具体错误原因。
具体请求参数和返回值参考官方API文档
通过 SDClient.fileApi 拿到 fileApi 对象后调用如下方法访问对应 api
注：请求示例中的参数仅为基础参数，其它参数请参考官方API文档
fun fileList(fileListRequest: FileListRequest): FileListResp?
// FileListRequest 示例
val request = FileListRequest()
request.parentId = "root" // 所获取文件夹的fileId(root为根目录)
request.driveId = "" // 获取列表的用户driveIdfun fileSearch(fileSearchRequest: FileSearchRequest): FileListResp?
// FileSearchRequest示例
val request = FileSearchRequest()
request.query = "name match '$keyStr' and status = 'available'" // keyStr:搜索关键词
request.driveId = "" // 搜索的用户driveIdfun fileCreate(createRequest: FileCreateRequest): FileCreateResp?
// FileCreateRequest示例
val createRequest = FileCreateRequest()
createRequest.checkNameMode = "auto_rename" // enum (ignore, auto_rename, refuse)
createRequest.driveId = "" // 实施创建操作的用户driveId
createRequest.name = "" // 新建文件的名称
createRequest.parentFileId = "root" // 目标文件夹的fileId(root为根目录)
createRequest.type = "folder" // enum (file, folder)fun fileGet(getResp: FileGetRequest): FileGetResp?
// FileGetRequest 示例
val getRequest = FileGetRequest()
getRequest.driveId = "" // 实施查看操作的用户driveId
getRequest.fileId = "" // 文件的fileIdfun fileCopy(fileCopyRequest: FileCopyRequest): FileCopyResp?
// FileCopyRequest 示例
val copyRequest = FileCopyRequest()
copyRequest.driveId = "" // 文件的driveId
copyRequest.fileId = "" // 文件的fileId
copyRequest.toDriveId = "" // 拷贝目标文件夹的driveId
copyRequest.newName = "" // 文件拷贝后的新名字
copyRequest.toParentId = "root" // 拷贝目标文件夹的fileId(root为根目录)fun fileMove(fileMoveRequest: FileMoveRequest): FileMoveResp?
// FileMoveRequest 示例
val moveRequest = FileMoveRequest()
moveRequest.driveId = "" // 文件的driveId
moveRequest.fileId = "" // 文件的fileId
moveRequest.toDriveId = "" // 移动目标文件夹的driveId
moveRequest.newName = "" // 文件移动后的新名字
moveRequest.toParentId = "root" // 移动目标文件夹的fileId(root为根目录)fun fileUpdate(updateRequest: FileUpdateRequest): FileGetResp?
// FileUpdateRequest 示例
val updateRequest = FileUpdateRequest()
updateRequest.driveId = item.driveId!! // 实施更新操作的用户driveId
updateRequest.fileId = item.fileId // 文件的fileId
updateRequest.name = "" // 文件更新后的新名字fun fileDelete(deleteRequest: FileDeleteRequest): FileDeleteResp?
// FileDeleteRequest 示例
val delRequest = FileDeleteRequest()
delRequest.driveId = "" // 实施删除操作的用户driveId
delRequest.fileId = "" // 需要删除文件或文件夹的fileId// 获取文件分片的上传地址
fun fileGetUploadUrl(getUploadUrlRequest: FileGetUploadUrlRequest): FileGetUploadUrlResp?
// 完成文件上传
fun fileComplete(completeRequest: FileCompleteRequest): FileGetResp?
// 获取文件下载地址
fun fileGetDownloadUrl(getDownloadUrlRequest: FileGetDownloadUrlRequest): FileGetDownloadUrlResp?
// 异步任务状态，例如删除包含多个文件的文件夹，此时是一个异步任务，可以通过这个接口获取任务状态
fun getAsyncTask(getAsyncTaskRequest: AsyncTaskRequest): AsyncTaskResp?Demo配置见demo目录中README.md文件