全部产品
Search
文档中心

对象存储 OSS:Browser.js上传回调

更新时间:Nov 12, 2024

您只需要在发送给OSS的请求中携带相应的Callback参数,即可在完成文件(Object)上传时提供回调(Callback)给应用服务器。

说明

callback的构建支持发送callbackSNI等设置,详细信息可参见Callback

注意事项

  • 当您使用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)。获取临时访问凭证的具体操作,请参见授权访问

示例代码

以下代码用于上传回调:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Document</title>
  </head>

  <body>
    <button id="submit">上传回调</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",
        authorizationV4: true,
        // 从STS服务获取的临时访问密钥(AccessKey ID和AccessKey Secret)。
        accessKeyId: "yourAccessKeyId",
        accessKeySecret: "yourAccessKeySecret",
        // 从STS服务获取的安全令牌(SecurityToken)。
        stsToken: "yourSecurityToken",
        // 填写Bucket名称,例如examplebucket。
        bucket: "examplebucket",
      });

      const options = {
        callback: {
          // 设置回调请求的服务器地址,且要求必须为公网地址。
          url: "http://examplebucket.aliyuncs.com:23450",
          // 设置回调请求消息头中Host的值,即您的服务器配置的Host值。
          // host: 'yourHost',
          // 设置发起回调时请求body的值。
          body: "bucket=${bucket}&object=${object}&etag=${etag}&size=${size}&mimeType=${mimeType}&imageInfo.height=${imageInfo.height}&imageInfo.width=${imageInfo.width}&imageInfo.format=${imageInfo.format}&var1=${x:var1}&var2=${x:var2}",
          // 设置发起回调请求的Content-Type。
          // contentType: 'application/x-www-form-urlencoded',
          // 客户端发起回调请求时,OSS是否向通过callbackUrl指定的回源地址发送服务器名称指示SNI(Server Name Indication)
          callbackSNI: true,
          // 设置发起回调请求的自定义参数。
          customValue: {
            var1: "value1",
            var2: "value2",
          },
        },
      };
      // 获取DOM。
      const submit = document.getElementById("submit");
      // 上传回调。
      submit.addEventListener("click", () => {
        client
          .put("example.txt", new Blob(["Hello World"]), options)
          .then((r) => console.log(r));
      });
    </script>
  </body>
</html>

相关文档

关于上传回调的API接口说明,请参见Callback