npm 包 ci-storage 使用教程

阅读时长 6 分钟读完

简介

ci-storage 是一个 Node.js 的开源模块,用于将 JSON 数据存储到云端。该模块使用 Azure Blob 存储 实现了数据的持久化存储,并且提供了简单的 API,方便在前端或后端使用。

在本篇文章中,我们将介绍 ci-storage 的使用方法和一些注意事项,并通过示例代码演示其在前端中的具体应用。

安装

使用 npm 可以很方便地安装 ci-storage 模块:

配置

在使用 ci-storage 之前,你需要在 Azure 上创建一个存储账户,并且获取对应的连接字符串。可以按照官方指南完成这一步骤。

创建成功后,通过以下方式来配置 ci-storage

-- -------------------- ---- -------
----- - ----------- - - ----------------------

----- ------ - -
  ------------ ------------------------------
  ----------- -----------------------------
  -------------- ------------------------
--

----- ------- - --- --------------------

上述配置项中,accountNameaccountKey 分别是你的存储账户的名称和连接字符串中的键值对,containerName 是你需要将数据存储的容器名称。

API

ci-storage 模块提供了以下 API:

  • get(key: string): Promise<object>:根据指定的键名获取云端存储的 JSON 数据。如果指定的键名不存在,返回值为 null
  • set(key: string, value: object): Promise<void>:将指定的 JSON 数据存储到云端。
  • delete(key: string): Promise<void>:删除指定键名的数据。

使用

在前端使用

在前端中,我们需要先将 ci-storage 模块在后端进行打包,并将打包后的文件引入到前端中:

-- -------------------- ---- -------
--------- -----
----- ----------
  ------
    ----- ----------------
    ----------------- ------------
  -------
  ------
    ------- --------------------------------------
    --------
      ----- ------ - -
        ------------ ------------------------------
        ----------- -----------------------------
        -------------- ------------------------
      --

      ----- ------- - --- --------------------

      ----- -------- ------ -
        -- --------
        ----- ------------------- - -- -- -- -- -- ------- ---

        -- ----------
        ----- ---- - ----- --------------------

        ------------------  -- - -- -- -- -- -- ------- -

        -- ------
        ----- -----------------------
      -

      -------
    ---------
  -------
-------

如上述代码所示,我们需要在前端中通过引入 ci-storage 模块并使用其中的 API 完成数据的存储、获取和删除操作。

在后端使用

在后端中,使用 ci-storage 也同样简单:

-- -------------------- ---- -------
----- - ----------- - - ----------------------

----- ------ - -
  ------------ ------------------------------
  ----------- -----------------------------
  -------------- ------------------------
--

----- ------- - --- --------------------

----- -------- ------ -
  -- --------
  ----- ------------------- - -- -- -- -- -- ------- ---

  -- ----------
  ----- ---- - ----- --------------------

  ------------------  -- - -- -- -- -- -- ------- -

  -- ------
  ----- -----------------------
-

-------

跟前端中的使用方法相同,我们需要在后端中也先进行配置,然后使用其中的 API 完成数据的存储、获取和删除操作。

注意事项

在使用 ci-storage 模块时,需要注意以下事项:

  • ci-storage 模块使用 Azure Blob 存储实现数据的持久化存储。因此在使用 ci-storage 时需要对 Azure Blob 存储有一定的了解。
  • 如果存储的数据量较大,可能会影响存储账户的计费。请注意限制存储的数据量,以避免不必要的费用产生。
  • ci-storage 模块是开源的,但并不保证数据的安全性。请勿将敏感数据直接存储到云端,以免造成意外损失。

结论

在本篇文章中,我们介绍了 ci-storage 模块的使用方法和注意事项,以及在前端中的具体应用。如果你需要在项目中实现持久化存储功能,ci-storage 可以是一个不错的选择。

代码示例:https://github.com/ci-group/ci-storage-example

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056cdc81e8991b448e68bd

纠错
反馈