下载文件(Object)时,可以指定一个或多个限定条件。满足限定条件则下载,条件不满足则返回错误且不会触发下载行为。

注意事项

  • 当您使用webpack或browserify等打包工具时,请通过npm install ali-oss的方式安装Browser.js SDK。
  • 由于Browser.js SDK通常在浏览器环境下使用,为避免暴露阿里云账号访问密钥(AccessKey ID和AccessKey Secret),强烈建议您使用临时访问凭证的方式执行OSS相关操作。

    搭建STS服务的具体操作请参见开发指南中的使用STS临时访问凭证访问OSS。您可以通过调用STS服务的AssumeRole接口或者使用各语言STS SDK来获取临时访问凭证。临时访问凭证包括临时访问密钥(AccessKey ID和AccessKey Secret)和安全令牌(SecurityToken)。

示例代码

以下代码用于限定条件下载:

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

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

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

    const download = document.getElementById('download')
    const upload = document.getElementById('upload')

    // 上传文件。  
    upload.addEventListener('click', () => {
      // 指定待上传的文件内容。
      const file = new Blob(['examplecontent'])
      // 指定待上传文件的完整路径,例如exampledir/exampleobject.txt。
      const fileName = 'exampledir/exampleobject.txt'
      const result = client.put(fileName, file).then(r => console.log(r))
    })

    // 下载文件。
    download.addEventListener('click', () => {
      // 指定待下载的字节范围。
      const start = 1, end = 5
      client.get('exampledir/exampleobject.txt', {
        headers: {
          // 在请求头If-Modified-Since中指定时间,如果指定的时间早于文件实际修改时间,则下载文件。如果指定的时间等于或者晚于文件实际修改时间,则返回304 Not Modified。
          "If-Modified-Since": new Date("1970-01-01").toGMTString()
          // 在请求头If-Unmodified-Since中指定时间,如果指定的时间等于或者晚于文件实际修改时间,则下载文件。如果指定的时间早于文件实际修改时间,则返回412 Precondition Failed。
          //"If-Unmodified-Since": new Date(1970-01-01).toGMTString()
          // 在请求头If-Match中传入ETag,如果传入的ETag和文件的ETag匹配,则下载文件。如果传入的ETag和文件的ETag不匹配,则返回412 Precondition Failed。
          //"If-Match": '5B3C1A2E0563E1B002CC607C****'
          // 在请求头If-None-Match中传入ETag,如果传入的ETag和文件的ETag不匹配,则下载文件。如果传入的ETag和文件的ETag匹配,则返回304 Not Modified。
          //"If-None-Match": '5B3C1A2E0563E1B002CC607C****'
        },
      }).then(r => {
        if (r.content.length > 0) {                
          const newBlob = new Blob([r.content], { type: r.res.headers['content-type'] });
          const link = document.createElement('a')
          link.href = window.URL.createObjectURL(newBlob)
          link.download = 'foo.txt'
          link.click()
          window.URL.revokeObjectURL(link.href)
        } else {
          console.log('错误码', r.res.status)
          console.log('没有符合条件的下载项')
        }
      })
    })

  </script>
</body>

</html>

相关文档

  • 关于限定条件下载的完整示例代码,请参见GitHub示例
  • 关于限定条件下载的API接口说明,请参见GetObject