目前官網文檔中的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同時支援同步和非同步使用方式,參考這篇文章:
- 同步方式:基於
async
和await
方式, 非同步編程同步化 - 非同步方式:類似callback的方式,API介面返回Promise,使用
.then()
處理返回結果,使用.catch()
處理錯誤
無論同步方式還是非同步方式中,均使用new OSS()
建立client。
下面分別舉例,先上傳一個檔案,然後立即下載這個檔案:
同步方式
let client = new OSS(...);
async function put () {
try {
let r1 = await.put('object','tmp/file');
console.log('put success: %j', r1);
let r2 = await client.get('object');
console.log('get success: %j', r2);
} catch(e) {
console.error('error: %j', err);
}
}
put();
非同步方式
let client = new OSS(...);
client.put('object', '/tmp/file').then(function (r1) {
console.log('put success: %j', r1);
return client.get('object');
}).then(function (r2) {
console.log('get success: %j', r2);
}).catch(function (err) {
console.error('error: %j', err);
});
安裝
使用Node.js
支援的Node.js版本:
Node.js >= 8.0.0
如果需要在 Node.js < 8 的環境中使用,請使用 ali-oss 4.x版本。
首先使用npm安裝SDK的開發包:
npm install ali-oss
然後在你的程式中使用:
let OSS = require('ali-oss');
let client = new OSS({
region: '<oss region>',
//雲帳號AccessKey有所有API存取權限,建議遵循阿里雲安全最佳實務,部署在服務端使用RAM子帳號或STS,部署在用戶端使用STS。
accessKeyId: '<Your accessKeyId>',
accessKeySecret: '<Your accessKeySecret>',
bucket: '<Your bucket name>'
});
如果使用npm遇到網路問題,可以使用淘寶提供的npm鏡像:cnpm