BLZ_npm_package

sdk介绍

blz_oss_upload是基于aliyun（"ali-oss": "^6.23.0"）的oss上传sdk的自主开发，sdk支持普通文件上传，分片文件上传，文件上传进度显示，中途取消文件上传等等主要上传功能。

文件上传权限和文件上传目录、地址等相关介绍

因阿里云oss上传涉及到权限校验，sdk需要配置阿里云的accessKeyId和accessKeySecret，本sdk内部已经集成了权限校验的接口调用，当然用户也可以在sdk外部获取权限相关参数直接传入到sdk内部。

sdk内部集成权限接口调用方式

import { OSSClient } from 'blz_oss_upload';

this.ossUploader = new OSSClient({
  uploadFileInfo,
  version,
  catalog,
  token,
  permissionUrl,
  getProcress:(progressNum) => {
        console.log('分片上传进度',progressNum) ;
  },
  callback: ({ res: { requestUrls }, status }) => {
    console.log('oss上传成功返回oss地址',requestUrls);
    console.log(status);

  },
});

this.ossUploader.getClientOSSAccess();

• ossUploader: 为sdk内部封装的oss上传类，取消上传时需要对其进行操作；
• uploadFileInfo: 为上传文件信息，包含上传文件名称、上传文件大小、上传文件路径、上传文件类型、上传文件md5值、上传文件分片数、上传文件分片大小等信息；
• version: 为上传文件版本信息字符串，可以用来区分oss上传地域是国内还是国外，0开头表示国内，1开头表示国外；为null则默认使用国内oss上传地址；
• catalog: 为上传文件目录字符串，上传文件目录为空则默认使用根目录；
• token: 为调用获取accessKeyId和accessKeySecret的接口调用token；
• permissionUrl: 为调用获取accessKeyId和accessKeySecret的接口调用地址；
• getProcress: 为上传文件进度回调函数，上传文件进度回调函数会返回上传进度百分比；
• callback: 为上传文件回调函数，上传文件回调函数会返回上传文件结果，上传文件结果为上传文件成功与否以及上传文件成功与否的状态码；

permissionUrl 权限接口字段结构

{
    "bucketName": "blzoss-usa-test",
    "endpoint": "oss-accelerate.aliyuncs.com",
    "AccessKeyId": "xxxx",
    "AccessKeySecret": "xxxxx",
    "domain": "https://blzoss-usa-test.oss-accelerate.aliyuncs.com/",
    "Expiration": "2026-04-07T09:25:24Z",
    "rootPath": "test",
    "region": "oss-us-east-1"
}

 bucketName 必要字段，对应oss中bucket名称
 AccessKeyId 必要字段，对应oss中accessKeyId
 AccessKeySecret 必要字段，对应oss中accessKeySecret
 domain 必要字段，对应oss中endpoint
 stsToken 必要字段，对应oss中SecurityToken
 region 必要字段，对应oss中region

sdk调用方式（不含权限接口调用）

this.ossUploader = new OSSClient({
  bucketName,
  AccessKeyId,
  AccessKeySecret,
  SecurityToken,
  domain,
  region,
  fileUrl,
  uploadFileInfo,
  getProcress:(progressNum) => {
        console.log('分片上传进度',progressNum) ;
  },
  callback: ({ res: { requestUrls }, status }) => {
    console.log('oss上传成功返回oss地址',requestUrls);
    console.log(status);

  },
});
this.ossUploader.clientOSSUpload();


fileUrl 为上传文件地址

sdk取消上传方式

this.ossUploader.cancelUpload();