更新记录

1.0.0（2025-06-24）

新增OBS对象存储API，支持获取上传下载进度，断点续传； 适配安卓、iOS、鸿蒙Next

平台兼容性

uni-app

uni-app x

@[TOC](华为云对象存储OBS 支持安卓/iOS/鸿蒙UTS组件)

介绍

华为云对象存储（OBS）组件，支持安卓、iOS、鸿蒙Next的UTS组件。 除了支持基础的文件上传下载之外，还支持了上传下载的进度获取，大文件上传下载的断点续传。 API概览：SDK初始化、创建存储桶、列举存储桶、存储桶是否存在、列举桶内对象、删除桶内对象、文件上传(可获取上传进度)、大文件上传(可断点续传)、文件下载(可获取下载进度)、大文件下载(可断点续传)、关闭Obs服务

下载APK体验DEMO

使用前须知

• 请确认您已经熟悉OBS的基本概念，如桶（Bucket）、对象（Object）、访问密钥（AK和SK）等。
• 使用OBS客户端进行接口调用操作完成后，没有错误回调，则表明返回值有效；如果success返回false，则说明操作失败，此时应可从异常处理中获取错误信息
• 当前各区域特性开放不一致，部分特性只在部分区域开放，使用过程中如果接口HTTP状态码为405，请确认该区域是否支持该功能特性

  vue代码调用示例

<template>
    <view>
        <page-head :title="title"></page-head>
        <scroll-view>
            <view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testOpenClient">初始化配置</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testCreateBucket">创建存储桶</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testListBuckets">列举存储桶</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testDeleteBucket">删除存储桶</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testHeadBucket">存储桶是否存在</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testListObjects">列举桶内对象</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testDeleteObject">删除桶内对象</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testUploadFile">文件上传(可获取上传进度)</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testUploadMultipartFile">大文件上传(可断点续传)</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testDownloadFile">文件下载(可获取下载进度)</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testDownloadMultipartFile">大文件下载(可断点续传)</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">
                    <button @tap="testCloseClient">关闭Obs服务</button>
                </view>
                <view class="uni-padding-wrap uni-common-mt">

                </view>
            </view> 
        </scroll-view>  

    </view>
</template>

<script>

    import { openClient,closeClient,createBucket,listBuckets,deleteBucket,headBucket,listObjects,deleteObject,uploadFile,uploadMultipartFile,downloadFile,downloadMultipartFile } from "@/uni_modules/cz-hwobs";

    export default {
        data() {
            return {
                title:"华为云OBS 示例"
            }
        },
        methods: {
            testOpenClient(){
                let res = openClient({
                    accessKey:"你的accessKey",
                    secretKey:"你的secretKey",
                    endPoint:"你的endPoint，例如：obs.cn-east-5.myhuaweicloud.com",
                    enableLog:true,
                    androidConfig:{maxErrorRetry:5,connectionTimeout:60},
                    iosConfig:{timeoutIntervalForCommand:100,timeoutIntervalForDownload:100,timeoutIntervalForUpload:100},
                    harmonyConfig:{Timeout:300},
                    });
                this.showToast(`初始化配置：${JSON.stringify(res)}`); 
            },
            testCreateBucket(){
                let self = this;
                createBucket({
                    bucketName:"test.android2",
                    location:"cn-east-5",
                    completeListener(res) {
                        self.showToast(`创建桶：${JSON.stringify(res)}`);
                    }
                });
            },
            testListBuckets(){
                let self = this;
                listBuckets({
                    completeListener(res) {
                        self.showToast(`列举桶：${JSON.stringify(res)}`);
                    }
                });
            },
            testDeleteBucket(){
                let self = this;
                deleteBucket({
                    bucketName:"test.android2",
                    completeListener(res) {
                        self.showToast(`删除桶：${JSON.stringify(res)}`);
                    }
                });
            },
            testHeadBucket(){
                let self = this;
                let res = headBucket({
                    bucketName:"test.android2",
                    completeListener(res) {
                        self.showToast(`桶是否存在：${JSON.stringify(res)}`);
                    } 
                });
            },
            testListObjects(){
                let self = this;
                listObjects({
                    bucketName:"test.android1",
                    completeListener(res) {
                        self.showToast(`列举桶内对象：${JSON.stringify(res)}`);
                    }
                });
            },
            testDeleteObject(){
                let self = this;
                let res = deleteObject({
                    bucketName:"test.android2",
                    objectKey:"1255122560-origin-IMG_0002.JPG",
                    completeListener(res) {
                        self.showToast(`删除桶内对象：${JSON.stringify(res)}`);
                    }
                });
            },
            testUploadFile(){
                let self = this;
                uni.chooseImage({
                    count:1,
                    sourceType:['album'],
                    sizeType:['original'],
                    success(images) {
                        console.log(`选择的文件：${JSON.stringify(images)}`);
                        let res = uploadFile({
                            bucketName:"test.android1",
                            objectkey: images.tempFiles[0].path.split('/').pop(),
                            path:images.tempFiles[0].path,
                            expires:1,
                            progressInterval:100*1024,
                            progressListener(status) {
                                console.log(`文件上传进度监听 ${status.transferPercentage} ${status.newlyTransferredBytes} ${status.transferredBytes} ${status.totalBytes}`);
                            },
                            completeListener(res) {
                                self.showToast(`上传文件结果：${JSON.stringify(res)}`);
                            }
                        });
                    },
                    fail(error) {
                        self.showToast(`选择文件失败：${JSON.stringify(error)}`);
                    }
                })
            },
            testUploadMultipartFile(){
                let self = this;
                uni.chooseVideo({
                    sourceType:['album'],
                    compressed:false,
                    success(video) {
                        console.log(`选择的文件：${video.tempFilePath}`);
                        uploadMultipartFile({
                            bucketName:"test.android1",
                            objectkey: video.tempFilePath.split('/').pop(),
                            path:video.tempFilePath,
                            enableCheckpoint:true,
                            taskNum:5,
                            partSize:10 * 1024 * 1024,
                            progressInterval:500*1024,
                            progressListener(status) {
                                console.log(`文件上传进度监听 ${status.transferPercentage}`);
                            },
                            completeListener(res) {
                                self.showToast(`上传文件结果：${JSON.stringify(res)}`);
                            }
                        });
                    },
                    fail(error) {
                        self.showToast(`选择文件失败：${JSON.stringify(error)}`);
                    }
                })
            },
            testDownloadFile(){
                let self = this;
                let name = `${Date.now()}.jpg`;
                downloadFile({
                    bucketName:"test.android1",
                    objectkey:"1748853027606.jpeg",
                    savePath:`/storage/emulated/0/Android/data/uni.app.UNID5A0BCC/files/Download/${name}`,
                    // savePath:`/Users/bill/Library/Developer/CoreSimulator/Devices/F719E191-2F58-41B8-918A-7A3A31976C90/data/Containers/Data/Application/8650EE45-01A9-4965-9068-06AC87FEC1C4/Documents/Pandora/apps/HBuilder/data/${name}`,
                    // savePath:`/data/storage/el2/base/haps/entry/cache/${name}`,
                    progressInterval:500*1024,
                    progressListener(status) {
                        console.log(`文件下载进度监听 ${status.transferPercentage}`);
                    },
                    completeListener(res) {
                        self.showToast(`下载文件结果：${JSON.stringify(res)}`);
                    }
                });
            },
            testDownloadMultipartFile(){
                let self = this;
                let name = `${Date.now()}.mp4`;
                downloadMultipartFile({
                    bucketName:"test.android1",
                    objectkey:"Screenrecorder-2025-05-08-17-40-09-363.mp4",
                    // savePath:`/data/storage/el2/base/haps/entry/cache/${name}`,
                    savePath:`/storage/emulated/0/Android/data/uni.app.UNID5A0BCC/files/Download/${name}`,
                    enableCheckpoint:true,
                    progressInterval:500*1024,
                    taskNum:5,
                    partSize:10 * 1024 * 1024,
                    progressListener(status) {
                        console.log(`文件下载进度监听 ${status.transferPercentage}`);
                    },
                    completeListener(res) {
                        self.showToast(`下载文件结果：${JSON.stringify(res)}`);
                    }
                });
            },
            testCloseClient(){
                closeClient();
            },
            showToast(msg){
                if(msg == ''){
                    uni.showToast({
                        icon:'none',
                        title:'未获取到相关信息'
                    })
                } else {
                    uni.showToast({
                        icon:'none',
                        title: msg
                    })
                }
            }
        }
    }
</script>

<style>

</style>

权限说明

安卓

<uses-permission android:name="android.permission.INTERNET" /> 
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" /> 
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> 
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.GET_TOP_ACTIVITY_INFO" />

iOS

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict> 

鸿蒙 Next

{
   "name": "ohos.permission.INTERNET",
}

API调用说明

初始化配置（openClient）

创建桶（createBucket）

桶是OBS全局命名空间，相当于数据的容器、文件系统的根目录，可以存储若干对象。

列举桶（listBuckets）

删除桶（deleteBucket）

桶是否存在（headBucket）

列举桶内对象（listObjects）

删除桶内对象（deleteObject）

文件上传-可获取上传进度（uploadFile）

大文件上传-可断点续传（uploadMultipartFile）

文件下载-可获取下载进度（downloadFile）

大文件下载-可断点续传（downloadMultipartFile）

关闭OBS服务（closeClient）

异常处理

组件无自定义错误码，SDK错误码请参考如下文档处理：

• 安卓-OBS服务端错误码
• 安卓-SDK自定义异常
• iOS-OBS服务端错误码
• iOS-SDK自定义异常
• 鸿蒙-HTTP状态码
• 鸿蒙-OBS服务端错误码
• 鸿蒙-SDK公共结果对象