npm 包 superstatic 使用教程

阅读时长 4 分钟读完

什么是 superstatic

superstatic 是一个基于 Node.js 平台的静态文件服务器。它是利用 express 库构建的,可以提供更加稳定、高效、易于配置的静态文件服务器。

安装 superstatic

使用 npm 进行安装:

使用 superstatic

在本地启动服务器

在终端中进入你的项目根目录,然后执行以下命令:

这将会在本地启动服务器,默认访问端口为 3474。如果你想使用其他端口,可以在启动命令后面指定,如下所示:

配置 superstatic

配置 superstatic 的方式有多种,可以写在 superstatic.json 文件中,也可以直接在命令行中指定。

在 superstatic.json 文件中配置 options

在你的项目根目录下新建 superstatic.json 文件,并添加如下内容:

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

可以看到,我们在 options 中进行了一些配置,如开启了 clean_urls 实现无后缀 URL 访问的跳转,以及开启了调试模式。在 rewrites 中则定义了访问任意路径时都跳转到首页的重定向规则。

使用命令行参数配置

在启动 superstatic 命令后面跟上 options 参数即可向 superstatic 传递选项。

如下例所示:

在命令行中使用 rewrites 参数,则可以添加重定向规则。

如下例所示:

指定本地静态文件夹

如果在本地启动 superstatic 后需要访问特定的文件夹中的静态文件,则需要在启动命令中指定文件夹路径。

如下例所示:

这将会把 public 文件夹作为静态文件根目录,并在访问时给出 public 文件夹中指定的路径。

在 Node.js 项目中使用 superstatic

我们也可以在 Node.js 项目中使用 superstatic。

在项目中安装 superstatic:

在 JavaScript 代码中使用如下所示:

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

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

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

可以看到,我们先引入了 superstatic 包,然后使用 superstatic 方法新建一个服务器对象,其中传递的 config 对象里包含了文件夹路径和重定向规则。

最后再调用 listen 方法启动服务器即可。

总结

superstatic 是一个非常实用的 Node.js 静态文件服务器,不仅功能强大,而且使用起来也非常简单。熟练掌握 superstatic 的使用,有利于前端项目打包后的预览和本地测试,并且可以更好地管理和优化静态资源。

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

纠错
反馈