oss-js-upload

0.6.0 • Public • Published

oss-js-upload

目前不再维护

请使用 https://help.aliyun.com/document_detail/32069.html

简介

支持在在浏览器端直接上传文件到阿里云 OSS.

注意, 从 0.2.0 版本开始, 将基于 aliyun sdk js 开发. 请注意 demo.html 中的变化.

目前已经支持:

  • ie10及以上 ie 浏览器, 以及其他主流浏览器(还未全面测试)
  • 支持使用阿里云 STS 临时 Token
  • 支持文件上传 md5 校验, 保证调用的安全性.
  • 文件分块上传, 上传文件大小理论上无限制
  • 文件上传进度

使用

配置 OSS

需要先配置 oss bucket 的 cors. 在开发/调试时, 可以做如下配置

  • 将 "来源", "Allowed Header" 配置为 *
  • 将 "Method" 全部勾选
  • 如果需要进行文件分块上传, 需要将 "Expose Header" 配置为 etag 和 x-oss-request-id

调试通过后, 根据需要最小化相关配置

配置 RAM

从安全角度出发, 阿里云 sts 服务停掉了 getFederation 接口, 建议使用新的, 更安全的 assumeRole 接口. 原先正在使用 getFederation 接口 的用户可以继续使用, 但是建议更新到 assumeRole 接口.

配置方法一

使用 RAM 的 Open API 进行配置,也需要先在控制台开通 RAM 服务。

  • 打开本代码中的 setupRAM.js
  • 在阿里云控制台中找到自己账号的 id 并填入
  • 将自己的根 AccessKey 和 AccessSecret 填入
  • node setupRAM.js
  • 如果创建成功, 会打印出 assumeRole 所需的 accessKeyId, accessKeySecret 和 roleARN, 记录下来

配置方法二

在阿里云 RAM 控制台也可以进行配置, 但是目前 RAM 控制台处于公测阶段, 需要申请公测资格, 因此推荐使用方法一

  • 打开 RAM 控制台
  • 新建一个用户
  • 为用户添加 AliyunSTSAssumeRoleAccess 权限
  • 为用户创建一对 AK, 记录下这个 AK, 控制台不会为你保存
  • 新建一个角色
  • 为角色添加 AliyunOSSFullAccess 权限, 记录下角色 ARN

安装

你可以通过如下两种方式中任意一种引入本项目:

1.bower

$ bower install oss-js-upload --save

2.直接下载

  1. 下载本项目最新的 Release
  2. 下载依赖 aliyun-sdk
  3. 通过 <script src=""></script> 标签引入文件,注意将依赖放在前面
<script src="/path/to/aliyun-sdk/aliyun-sdk.min.js"></script>
<script src="/path/to/oss-js-upload.js"></script>

使用 demo (需要 Node.js 环境)

  • 打开 demoServer.js 填入上面记录下来的 accessKeyId, secretAccessKey, accountId, roleARN 和 resource
  • 打开 demo.html 填入 bucket 和 endpoint 参数, 其他参数根据需要进行配置
  • 执行 npm install,安装 demo 依赖
  • 执行 node demoServer.js
  • 然后在浏览器中打开 http://localhost:3000/demo.html

在 demo.html 和 demoServer.js 中对各个参数都有详细说明

关于 stsToken

将文件上传到 oss 需要进行鉴权, 使用阿里云的 acessKey 和 keySecret 虽然可以成功上传但是会将你 accessKey 和 keySecret 暴露在浏览器端, 因此 不推荐使用, 强烈建议使用 STS token 进行鉴权. aliyunCredential 和 stsToken 必须提供一个, 如果同时提供, 将会使用 stsToken.

阿里云sts 文档 http://docs.aliyun.com/#/pub/ram/sts-user-guide/intro

获取 stsToken

stsToken 需要在自己的服务器上生成, 并传递给 oss-js-upload 如果你使用 nodejs 做服务器, 可以使用 aliyun nodejs sdk 获取 stsToken , 示例见 demoServer.js 如果你使用其他语言, 需要使用对应的 sdk 来获取 stsToken

Readme

Keywords

none

Package Sidebar

Install

npm i oss-js-upload

Weekly Downloads

0

Version

0.6.0

License

MIT

Last publish

Collaborators

  • chylvina