云存储是由云服务提供商提供的一种存储方式,可以解决代码部署时需要共享数据和文件的问题。Google Cloud Storage (GCS) 是一种高可靠性和获得性的云存储解决方案。npm 上有一个 GCS 工具包叫做 cloud-config-toolkit-gc-storage,提供了一些实用的函数和工具,帮助开发者操作 GCS。本文将介绍如何使用该工具包。
安装
使用 npm 安装 cloud-config-toolkit-gc-storage:
npm install cloud-config-toolkit-gc-storage
初始化
引入 cloud-config-toolkit-gc-storage。
const gcs = require('cloud-config-toolkit-gc-storage')
在使用之前,您需要通过 Google Cloud Platform Console(GCP 控制台)创建并下载一个 GCP 凭据/密钥文件,以获得存储区访问范围。 然后,使用以下代码初始化 cloud-config-toolkit-gc-storage,以确保访问权限。
// 导入 Google Cloud Storage Node.js 客户端库和 Storage 实例: const {Storage} = require('@google-cloud/storage'); const storage = new Storage({ projectId: 'YOUR_PROJECT_ID', keyFilename: '/path/to/keyfile.json' }); // 使用 init 函数初始化 cloud-config-toolkit-gc-storage const GCS = gcs.init(storage);
更详细的说明:
projectId
:是您的项目 ID。在 GCP 控制台的管理设置->设置 中查看或设置。keyFilename
:是您的凭据文件的绝对路径或相对路径。这个凭据文件是由 GCP 创建并下载的 JSON 文件,其中包含一个项目 ID、一个 OAuth2 客户端 ID 和密钥,以及其他元数据。
现在 GCS 就可以使用了。
API 使用
使用 cloud-config-toolkit-gc-storage 提供的 API,您可以做到以下一些事情:
- 上传文件
- 下载文件
- 删除文件
- 遍历桶中的文件
上传文件
上传文件示例:
-- -------------------- ---- ------- ----- -------- ------------ - ----- ---------- - ------------ ----- -------- - ----- ----------------------------- ----- -------- - --------------------- -- ------ ----- ----------- - ---------------------- -- ------ ----- -------------------------- --------- ------------- ------------------------ -------- -- ----------------- - -------------
下载文件
下载文件示例:
-- -------------------- ---- ------- ----- -------- -------------- - ----- ---------- - ------------ ----- -------- - ---------------------- -- ------ ----- ----------- - --------------------- -- ------ ----- ---------------------------- --------- ------------- ------------------------ ---------- -- ------------------ - ---------------
删除文件
删除文件示例:
async function deleteFile() { const bucketName = 'my-bucket'; const filename = 'remote/path/to/file'; // 远端文件路径 await GCS.deleteFile(bucketName, filename); console.log(`${filename} deleted from ${bucketName}.`); } deleteFile();
遍历桶中的文件
遍历桶中的文件示例:
async function listFiles(bucketName) { const [files] = await GCS.listFiles(bucketName); console.log('Files:'); files.forEach(file => { console.log(file.name); }); } listFiles('my-bucket');
更多 API 详情可以参考官方文档。
结论
这是一个非常详细的物联网平台的 npm 包 cloud-config-toolkit-gc-storage 使用教程。我希望您能够从中学到很多,并开始自己的云存储之旅。我们可以看到,cloud-config-toolkit-gc-storage 为我们完成了 GCS 的许多工作,代码更简单,方便开发者使用。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065f70238a385564ab6732