什么是 egg-obs?
egg-obs 是基于 egg.js 框架封装的一个 OBS (Object Storage Service) 服务插件。OBS 是一种在线以及离线数据存储服务,它可以容纳海量的结构化和非结构化数据,支持 RESTful 形式的 API 操作。
安装 egg-obs
安装 egg-obs 比较简单,可以通过 npm 命令进行安装
$ npm install egg-obs --save
然后再在你的项目的 config/plugin.js
文件中进行配置
exports.obs = { enable: true, package: 'egg-obs', };
egg-obs 基本使用
在使用 egg-obs 之前,请先到 华为云控制台, 创建一个 OBS 存储桶,并获取 AccessKeyId 和 SecretAccessKey 作为鉴权凭证。然后在你的项目中进行如下配置:
// config/config.default.js exports.obs = { accessKeyId: 'your access key id', secretAccessKey: 'your secret access key', endpoint: 'your endpoint', // obs 的访问地址 bucket: 'your bucket name', region: 'your bucket region', // 如 cn-north-1 等 };
egg-obs 内置了 OBS 的访问 SDK,并返回了 client
实例。你可以在你的 Controller,Service,Middleware 中通过 app.obs.client
来进行操作。以下是一些常用的 API 演示:
上传文件
-- -------------------- ---- ------- -- --------------------- ----- ---------- - -------------------------- ----- ------------- ------- ---------- - ----- ----- - ----- - ---- --- - - ----- ----- ---- - ------------------------- ----- ------- - ----------- --- ----- --- - ---- - ----- --------------------------- ------ - ----- ----- - ------------------- ---- ---- -- --- ----- --------- ------ -------------- ----- ---- -- --- ------ --------- - -------- - ----- ---------- - ---- - -
下载文件
-- -------------------- ---- ------- -- --------------------- ----- ---------- - -------------------------- ----- ------------- ------- ---------- - ----- ----- - ----- - ---- --- - - ----- ----- ------- - ----------- --- ----- --- - ---- - ----- ---------------------------- - ----- ----- - ------------------- --- ---- ---- --- ----- --------- ------ -------------- ---- ---- ---- --- ------ --------- - ----------------------- -------------- -------- - ----- ---------- - ---- - -
删除文件
-- -------------------- ---- ------- -- --------------------- ----- ---------- - -------------------------- ----- ------------- ------- ---------- - ----- ----- - ----- - ---- --- - - ----- ----- ------- - ----------- --- - ----- ------------------------------- - ----- ----- - ------------------- ------ ---- ---- --- ----- --------- ------ -------------- ------- ---- ---- --- ------ --------- - -------- - ------- ---- ---------- - ---- - -
总结
通过这篇文章,我们介绍了 egg-obs 的基本使用和实例操作。希望通过这篇文章的介绍,能够对各位读者有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60067357890c4f7277583d26