如何使用Browser.js SDK预览和下载文件 - 对象存储 OSS

在浏览器中使用signatureUrl方法生成用于预览或下载的文件URL。您可以通过HTML中<a>标签的download属性、Web API中的window.open等方式使用获取的文件URL。

注意事项

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

获取文件的预览URL

以下代码用于获取examplebucket中exampleobject.txt文件的预览URL。

说明

如果您要直接在浏览器中预览文件，请设置文件HTTP头中的Content-Disposition为inline并使用Bucket绑定的自定义域名进行访问。具体操作，请分别参见设置文件元信息和使用自定义域名。

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

  <body>
    <!--导入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（杭州）为例，Region填写为oss-cn-hangzhou。
        region: "yourRegion",
        authorizationV4: true,
        // 从STS服务获取的临时访问密钥（AccessKey ID和AccessKey Secret）。
        accessKeyId: "yourAccessKeyId",
        accessKeySecret: "yourAccessKeySecret",
        // 从STS服务获取的安全令牌（SecurityToken）。
        stsToken: "yoursecurityToken",
        // 填写Bucket名称。
        bucket: "examplebucket",
      });
      
      // 填写Object完整路径。Object完整路径中不能包含Bucket名称。
      const url = client.signatureUrl("example.jpg", {
        // 如果您希望生成的签名URL可以应用图片样式的效果，您可以通过process参数指定样式，格式为style/样式名称。
        // process: "style/imagestyle",
      });
      console.log(url);

      // 设置URL的有效时长。单位为秒。如果不设置有效时长，则默认为1800。
      // url = client.signatureUrl('example.jpg', {expires: 3600});
      // console.log(url);
    </script>
  </body>
</html>

获取文件的下载URL

以下代码用于获取examplebucket中exampleobject.txt文件的下载URL。URL的有效时长默认为1800秒。

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

  <body>
    <!--导入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（杭州）为例，Region填写为oss-cn-hangzhou。
        region: "yourRegion",
        authorizationV4: true,
        // 从STS服务获取的临时访问密钥（AccessKey ID和AccessKey Secret）。
        accessKeyId: "yourAccessKeyId",
        accessKeySecret: "yourAccessKeySecret",
        // 从STS服务获取的安全令牌（SecurityToken）。
        stsToken: "yoursecurityToken",
        // 填写Bucket名称。
        bucket: "examplebucket",
      });

      // 配置响应头实现通过URL访问时自动下载文件，并设置下载后的文件名。
      const filename = "examplefile.txt";
      const response = {
        "content-disposition": `attachment; filename=${encodeURIComponent(
          filename
        )}`,
      };
      // 填写Object完整路径。Object完整路径中不能包含Bucket名称。
      const url = client.signatureUrl("exampleobject.txt", { response });
      console.log(url);
    </script>
  </body>
</html>