管理檔案 - Object Storage Service

一個Bucket下可能有非常多的檔案，SDK提供一系列的介面方便使用者管理檔案。

查看所有檔案

通過list來列出當前Bucket下的所有檔案。主要的參數如下：

prefix 指定只列出符合特定首碼的檔案
marker 指定只列出檔案名大於marker之後的檔案
delimiter 用於獲取檔案的公共首碼
max-keys 用於指定最多返回的檔案個數

let OSS = require('ali-oss');
let client = new OSS({
  region: '<Your region>',
  accessKeyId: '<Your AccessKeyId>',
  accessKeySecret: '<Your AccessKeySecret>',
  bucket: 'Your bucket name'
});
async function list () {
  try {
      // 不帶任何參數，預設最多返回1000個檔案
    let result = await client.list();
    console.log(result);
  // 根據nextMarker繼續列出檔案
    if (result.isTruncated) {
      let result = await client.list({
        marker: result.nextMarker
      });
    }
  // 列出首碼為'my-'的檔案
  let result = await client.list({
     prefix: 'my-'
  });
  console.log(result);
  // 列出首碼為'my-'且在'my-object'之後的檔案
  let result = await client.list({
     prefix: 'my-',
     marker: 'my-object'
  });
  console.log(result);
  } catch (e) {
    console.log(e);
  }
}
list();

模擬目錄結構

OSS是基於對象的儲存服務，沒有目錄的概念。儲存在一個Bucket中所有檔案都是通過檔案的key唯一標識，並沒有層級的結構。這種結構可以讓OSS的儲存非常高效，但是使用者管理檔案時希望能夠像傳統的檔案系統一樣把檔案分門別類放到不同的“目錄”下面。通過OSS提供的“公共首碼”的功能，也可以很方便地模擬目錄結構。公共首碼的概念請參考列出Object。

假設Bucket中已有如下檔案：

foo/x
foo/y
foo/bar/a
foo/bar/b
foo/hello/C/1
foo/hello/C/2
...
foo/hello/C/9999

接下來我們實現一個函數叫listDir，列出指定目錄下的檔案和子目錄：

let OSS = require('ali-oss');
let client = new OSS({
  region: '<Your region>',
  accessKeyId: '<Your AccessKeyId>',
  accessKeySecret: '<Your AccessKeySecret>',
  bucket: 'Your bucket name'
});
async function listDir(dir)
  let result = await client.list({
    prefix: dir,
    delimiter: '/'
  });
  result.prefixes.forEach(function (subDir) {
    console.log('SubDir: %s', subDir);
  });
  result.objects.forEach(function (obj) {
    console.log(Object: %s', obj.name);
  });
end

運行結果如下：

> await listDir('foo/')
=> SubDir: foo/bar/
   SubDir: foo/hello/
   Object: foo/x
   Object: foo/y
> await listDir('foo/bar/')
=> Object: foo/bar/a
   Object: foo/bar/b
> await listDir('foo/hello/C/')
=> Object: foo/hello/C/1
   Object: foo/hello/C/2
   ...
   Object: foo/hello/C/9999

檔案元資訊

向OSS上傳檔案時，除了檔案內容，還可以指定檔案的一些屬性資訊，稱為“元資訊”。這些資訊在上傳時與檔案一起儲存，在下載時與檔案一起返回。

因為檔案元資訊在上傳/下載時是附在HTTP Headers中， HTTP協議規定不能包含複雜字元。因此元資訊只能是簡單的ASCII可見字元，不能包含換行。 所有元資訊的總大小不能超過8KB。

使用put，putStream和multipartUpload時都可以通過指定meta參數來指定檔案的元資訊：

let OSS = require('ali-oss')
let client = new OSS({
  region: '<Your region>',
  accessKeyId: '<Your AccessKeyId>',
  accessKeySecret: '<Your AccessKeySecret>',
  bucket: 'Your bucket name'
});
async function put () {
  try {
    let result = await client.put('object-key', 'local-file', {
    meta: {
      year: 2016,
      people: 'mary'
    }
  });
  console.log(result);
  } catch (e) {
    console.log(e);
  }
}
put();

通過putMeta介面來更新檔案元資訊：

let OSS = require('ali-oss')
let client = new OSS({
  region: '<Your region>',
  accessKeyId: '<Your AccessKeyId>',
  accessKeySecret: '<Your AccessKeySecret>',
  bucket: 'Your bucket name'
});
async function putMeta () {
  try {
    let result = await client.putMeta('object-key', {
    meta: {
      year: 2015,
      people: 'mary'
    }
  });
  console.log(result);
  } catch (e) {
    console.log(e);
  }
}
putMeta();

拷貝檔案

使用copy拷貝一個檔案。拷貝可以發生在下面兩種情況：

同一個Bucket
兩個不同Bucket，但是它們在同一個region，此時的源Object名字應為’/bucket/object’的形式

另外，拷貝時對檔案元資訊的處理有兩種選擇：

如果沒有指定meta參數，則與源檔案相同，即拷貝源檔案的元資訊
如果指定了meta參數，則使用新的元資訊覆蓋源檔案的資訊

let OSS = require('ali-oss')
let client = new OSS({
  region: '<Your region>',
  accessKeyId: '<Your AccessKeyId>',
  accessKeySecret: '<Your AccessKeySecret>',
  bucket: 'Your bucket name'
});
async function copy () {
  try {
     // 兩個Bucket之間拷貝
    let result = await client.copy('to', '/from-bucket/from');
    console.log(result);
    // 拷貝元資訊
    let result = await client.copy('to', 'from');
    console.log(result);
    // 覆蓋元資訊
    let result = await client.copy('to', 'from', {
      meta: {
        year: 2015,
        people: 'mary'
      }
    });
    console.log(result);
  } catch (e) {
    console.log(e);
  }
}

刪除檔案

通過delete來刪除某個檔案：

let OSS = require('ali-oss')
let client = new OSS({
  region: '<Your region>',
  accessKeyId: '<Your AccessKeyId>',
  accessKeySecret: '<Your AccessKeySecret>',
  bucket: 'Your bucket name'
});
async function delete () {
  try {
    let result = yield client.delete('object-key');
    console.log(result);
  } catch (e) {
    console.log(e);
  }
}
delete();

大量刪除檔案

通過deleteMulti來刪除一批檔案，使用者可以通過quiet參數來指定是否返回刪除的結果：

let OSS = require('ali-oss')
let client = new OSS({
  region: '<Your region>',
  accessKeyId: '<Your AccessKeyId>',
  accessKeySecret: '<Your AccessKeySecret>',
  bucket: 'Your bucket name'
});
async function deleteMulti () {
  try {
    let result = await client.deleteMulti(['obj-1', 'obj-2', 'obj-3']);
    console.log(result);
    let result = await client.deleteMulti(['obj-1', 'obj-2', 'obj-3'], {
    quiet: true
  });
    console.log(result);
  } catch (e) {
    console.log(e);
  }
}
deleteMulti();