文档

Browser.js管理文件元数据

更新时间:

对象存储OSS存储的文件(Object)信息包含Key、Data和Object Meta。Object Meta是对文件的属性描述,包括HTTP标准属性(HTTP Header)和用户自定义元数据(User Meta)两种。您可以通过设置HTTP标准属性来自定义HTTP请求的策略,例如文件(Object)缓存策略、强制下载策略等。您还可以通过设置用户自定义元数据来标识Object的用途或属性等。

注意事项

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

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

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

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

示例代码

以下代码用于上传文件时指定元数据,并在文件上传后更新和查看文件元数据。

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

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

<body>
  <button id='upload'>上传</button>
  <button id='update'>修改元数据</button>
  <button id='check'>查看元数据</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',
       // 从STS服务获取的临时访问密钥(AccessKey ID和AccessKey Secret)。
       accessKeyId: 'yourAccessKeyId',
       accessKeySecret: 'yourAccessKeySecret',
       // 从STS服务获取的安全令牌(SecurityToken)。
       stsToken: 'yourSecurityToken',
       // 填写Bucket名称,例如examplebucket。
       bucket: "examplebucket",
     });

    const upload = document.getElementById('upload')
    const update = document.getElementById('update')
    const check = document.getElementById('check')

    // 指定待上传的文件内容。
    const file = new Blob(['examplecontent'])
    // 指定上传至Bucket中的Object名称。
    const fileName = 'exampleobject.txt'

    // 上传文件。
    upload.addEventListener('click', () => {
     client.put(fileName, file, {
        // 指定自定义元数据。单个文件可以有多个元数据,但总大小不能超过8 KB。
        meta: {
          year: 2020,
          people: 'eliot'
        }
      }).then(r => console.log(r))
    })

    // 修改元数据。
    update.addEventListener('click', () => {
      client.putMeta(fileName, {
        year: 2021,
        people: 'evan'
      }
      ).then(r => {
        console.log(r)
      })
    })
    // 查看元数据。
    check.addEventListener('click', () => {
      // 根据以上代码配置的元数据,您需要在Bucket跨域规则的暴露Headers配置项中添加x-oss-meta-year,否则console打印的meta为null。
      client.head(fileName).then(m => console.log(m))
    })

  </script>
</body>

</html>

相关文档

  • 关于管理文件元数据的完整示例代码,请参见GitHub示例

  • 关于上传文件时设置或修改文件元数据的API接口说明,请参见PutObject

  • 关于查看文件元数据的API接口说明,请参见HeadObject

  • 本页导读 (1)