Browser.js范围下载

如果仅需要文件中的部分数据,您可以使用范围下载,下载指定范围内的数据。

注意事项

  • 当您使用webpackbrowserify等打包工具时,请通过npm install ali-oss的方式安装Browser.js SDK。

  • 通过浏览器访问OSS时涉及跨域请求,如果未设置跨域规则,浏览器会拒绝跨域访问请求。如果您希望通过浏览器可以正常访问OSS,需要通过OSS设置跨域规则。具体操作,请参见准备工作

  • 由于Browser.js SDK通常在浏览器环境下使用,为避免暴露阿里云账号访问密钥(AccessKey IDAccessKey Secret),强烈建议您使用临时访问凭证的方式执行OSS相关操作。

    临时访问凭证包括临时访问密钥(AccessKey IDAccessKey Secret)和安全令牌(SecurityToken)。获取临时访问凭证的具体操作,请参见授权访问

示例代码

以下代码用于范围下载:

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <title>Document</title>
</head>

<body>
  <button id='download'>下载</button>
  <!--导入SDK文件-->
  <script type="text/javascript" src="https://gosspublic.alicdn.com/aliyun-oss-sdk-6.18.0.min.js"></script>
  <script type="text/javascript">    
    const client = new OSS({
      // yourRegion填写Bucket所在地域。以华东1(杭州)为例,yourRegion填写为oss-cn-hangzhou。
      region: 'yourRegion',
      authorizationV4: true,
      // 从STS服务获取的临时访问密钥(AccessKey ID和AccessKey Secret)。
      accessKeyId: 'yourAccessKeyId',
      accessKeySecret: 'yourAccessKeySecret',
      // 从STS服务获取的安全令牌(SecurityToken)。
      stsToken: 'yourSecurityToken',
      // 填写Bucket名称,例如examplebucket。
      bucket: "examplebucket",
    });

    // 获取DOM。
    const download = document.getElementById('download')
    // 对于大小为1000字节的文件,正常的字节范围为0~999。
    // 如果指定的范围无效(比如开始或结束位置的指定值为负数,或指定值大于文件大小),则下载整个文件。
    const start = 0, end = 999
    // 监听按钮。
    download.addEventListener('click', () => {
      client.get('example.txt',{
        headers: {          
          Range: `bytes=${start}-${end}`,
        },
      }).then(r => {
        // 将返回的数据通过Blob的形式转为可下载的Object。
        const newBlob = new Blob([r.content], { type: r.res.headers['content-type'] });
        // 创建标签。
        const link = document.createElement('a')
        // 将标签绑定href属性。
        link.href = window.URL.createObjectURL(newBlob)
        // 指定下载后的本地文件名称。
        link.download = 'example.txt'
        // 下载Object。
        link.click()
        // 移除绑定的URL。
        window.URL.revokeObjectURL(link.href)
      })
    })

  </script>
</body>

</html>

相关文档

  • 关于范围下载的完整示例代码,请参见GitHub示例

  • 关于范围下载的API接口说明,请参见GetObject