npm 包 @adobe/fastly-native-promises 使用教程

阅读时长 7 分钟读完

在前端开发领域中,使用 npm 包管理器是非常常见的做法。而 @adobe/fastly-native-promises 是一个非常实用的 npm 包,它提供了与 Fastly CDN 原生 API 交互的 Promise 风格的封装,使得我们可以更加便捷地进行 CDN 的配置和管理。在本文中,我们将详细介绍如何使用这个 npm 包进行 Fastly CDN 操作。

安装

首先,我们需要在项目中安装这个 npm 包。我们可以使用 npm 或者 yarn 进行安装:

或者

安装完成后,我们需要引入该包:

快速入门

在我们对 @adobe/fastly-native-promises 进行更加详细的介绍之前,我们先来看一个简单的示例,以便快速了解该 npm 包的使用。

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

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

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

上述代码首先创建了一个 FastlyNative 的实例对象,然后调用它的 listServices 方法,该方法返回我们当前账号下的所有服务列表,并打印出来。

配置

在使用 @adobe/fastly-native-promises 时,我们需要先进行配置。该 npm 包提供了以下三种配置方式:

  • 通过 constructor 参数传入,例如:
  • 通过环境变量传入,例如:
  • 通过 Fastly API token 环境变量传入,例如:

其中,第三种方式是最为安全的方式,推荐使用。

API

@adobe/fastly-native-promises 包中提供了丰富的 API 供我们使用,包括但不限于以下几种做法:

  • listServices: 获取服务列表
  • getService: 获取指定服务的详细信息
  • createService: 创建服务
  • updateService: 更新服务
  • deleteService: 删除服务
  • listVersions: 获取指定服务的版本列表
  • getVersion: 获取指定服务的指定版本信息
  • createVersion: 创建指定服务的指定版本
  • activateVersion: 激活指定服务的指定版本
  • cloneVersion: 克隆指定服务的指定版本
  • deleteVersion: 删除指定服务的指定版本
  • listDomains: 获取指定服务的域名列表
  • getDomain: 获取指定服务的指定域名信息
  • createDomain: 创建指定服务的新域名
  • updateDomain: 更新指定服务的指定域名
  • deleteDomain: 删除指定服务的指定域名

这些 API 能够帮助我们快速方便地进行 Fastly CDN 相关操作,大大提高了我们的开发效率。

示例

下面,我们通过一段详细的示例,来演示如何使用 @adobe/fastly-native-promises 进行 Fastly CDN 的管理。

假设我们现在有一个需要在 Fastly CDN 上进行分发的静态网站。我们需要完成以下步骤:

  1. 创建一个 Fastly 服务(通过服务,我们能够为静态网站创建一个用于分发的 CDN 实例)
  2. 添加一个自定义的 Fastly 域名(我们需要将网站的 CNAME 指向 Fastly 分配的域名,以便让 CDN 能够将请求转发到我们的源站)
  3. 创建一个 Fastly 缓存规则,以控制 CDN 在哪些情况下缓存网站资源
  4. 进行本地测试,检查静态网站是否能够成功通过 Fastly CDN 进行分发

下面是示例代码,以供参考。请注意,我们在实际代码中需要将 Fastly API key 配置到环境变量中,或者使用其他更加安全的方式进行配置。

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

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

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

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

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

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

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

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

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

总结

通过使用 @adobe/fastly-native-promises,我们可以更加便捷地进行 Fastly CDN 的配置和管理。在本文中,我们详细介绍了该 npm 包的安装、配置、API 和使用,以及一个具有实际意义的示例。相信通过这些内容的学习,我们将能够更好地理解和运用 Fastly CDN 相关知识。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/adobe-fastly-native-promises