全部产品
阿里云办公

安装

更新时间:2018-07-19 11:50:32

SDK安装

目前官网文档中的demo都是基于SDK 6.X,版本低于6.X的可参考 5.X开发文档, 升级6.X请移步升级文档

要求

  • 开通阿里云OSS服务,如果您还没不了解阿里云OSS服务,请登录OSS产品主页了解。

  • 创建AccessKeyId和AccessKeySecret,由于云账号AccessKey有所有API访问权限,建议遵循阿里云安全最佳实践。如果部署在服务端可以使用RAM子账号或STS来进行API访问或日常运维管控操作,如果部署在客户端请使用STS方式来进行API访问。详情请参见访问控制

环境要求

OSS NodeJS SDK基于Node.js环境构建。

使用方式

OSS NodeJS SDK同时支持同步和异步的使用方式,参考这篇文章

  • 同步方式:基于asyncawait方式, 异步编程同步化
  • 异步方式:类似callback的方式,API接口返回Promise,使用.then()处理返回结果,使用.catch()处理错误

无论同步方式还是异步方式中,均使用new OSS()创建client。

下面分别举例,先上传一个文件,然后立即下载这个文件:

同步方式

  1. let client = new OSS(...);
  2. async function put () {
  3. try {
  4. let r1 = await.put('object','tmp/file');
  5. console.log('put success: %j', r1);
  6. let r2 = await client.get('object');
  7. console.log('get success: %j', r2);
  8. } catch(e) {
  9. console.error('error: %j', err);
  10. }
  11. }
  12. put();

异步方式

  1. let client = new OSS(...);
  2. client.put('object', '/tmp/file').then(function (r1) {
  3. console.log('put success: %j', r1);
  4. return client.get('object');
  5. }).then(function (r2) {
  6. console.log('get success: %j', r2);
  7. }).catch(function (err) {
  8. console.error('error: %j', err);
  9. });

安装

使用Node.js

支持的Node.js版本:

Node.js >= 8.0.0
如果需要在 Node.js < 8 的环境中使用,请使用 ali-oss 4.x版本。

首先使用npm安装SDK的开发包:

  1. npm install ali-oss

然后在你的程序中使用:

  1. let OSS = require('ali-oss');
  2. let client = new OSS({
  3. region: '<oss region>',
  4. //云账号AccessKey有所有API访问权限,建议遵循阿里云安全最佳实践,部署在服务端使用RAM子账号或STS,部署在客户端使用STS。
  5. accessKeyId: '<Your accessKeyId>',
  6. accessKeySecret: '<Your accessKeySecret>',
  7. bucket: '<Your bucket name>'
  8. });

如果使用npm遇到网络问题,可以使用淘宝提供的npm镜像:cnpm

本文导读目录