npm包 https-service-legacy 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

在前端开发中，我们经常需要使用一些外部的库或者工具来提升我们开发的效率和品质。其中，npm 是很多前端开发者经常使用的一个包管理器。而本文要介绍的是一个可以快速搭建本地 HTTPS 服务器的 npm 包，即 https-service-legacy。

本文将会围绕这个 npm 包来详细讲解其使用方法，包括如何安装、如何配合开发使用以及常见问题的解决方法。

安装

安装 https-service-legacy 很简单，只需要在命令行中输入以下命令：

npm install https-service-legacy --save-dev

其中， --save-dev 参数是为了将该包安装到开发环境中，同时也会更新 package.json 文件中的 devDependencies 字段。

使用方法

基本使用

安装完成后，我们可以在项目的根目录中创建一个 server.js 文件，并输入如下代码：

const httpsService = require('https-service-legacy');

httpsService.createServer({
  root: './public',
  port: 8080,
  enableStatic: true
});

该代码会创建一个 HTTPS 服务器，并将静态资源目录设置为 ./public，并监听 8080 端口。如果没有启用静态资源服务，访问地址为 https://localhost:8080。启用静态资源服务后，可以通过以下地址访问：

https://localhost:8080/index.html (返回 ./public/index.html)
https://localhost:8080/css/style.css (返回 ./public/css/style.css)
https://localhost:8080/js/app.js (返回 ./public/js/app.js)
...

HTTPS 配置

默认情况下，HTTPS 证书会在运行时自动创建。虽然这种方法很方便，但由于证书不是由受信任的颁发机构签名的，因此会受到浏览器的警告。要避免这种情况，可以使用自己的证书。

首先，需要将证书文件存储在服务器项目的根目录中。然后，在创建服务器时配置证书选项，如下所示：

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

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

---------------------------
  ----- -----------
  ----- -----
  ------------- -----
  -------
---展开代码

这是在使用自己的证书时的配置方法，其中 key 和 cert 分别指定了证书的键和证书文件的路径。

回调函数

可以通过回调函数获得服务器实例，然后在使用诸如 WebSockets 等协议时使用它。示例代码如下：

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

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

---------------------------
  ----- -----------
  ----- -----
  ------------- -----
  -------
-- ------------- -- -
  -- --------------
  ------------------ ---------- --------------------------------
  
  -- --------------------
---展开代码

高级选项

在创建服务器时，还可以设置其他高级选项，例如：

httpsService.createServer(options, [callback])：创建 HTTPS 服务器，其中 options 参数是一个对象，包含以下可用属性：
- root (string) - 静态文件服务器的根目录。默认值为 .(当前目录)。
- port (number) - 要监听的 HTTP 端口。默认值为 3000。
- options (object) - 一个包含 cert 和 key 属性的对象，用于提供 HTTPS 服务。如果没有提供，则 HTTPS 服务将使用自签名证书。
- enableStatic (boolean) - 启用或禁用静态文件服务器。默认值为 false。
- staticOptions (object) - 静态文件服务器的选项。有关可用选项，请参见 https://github.com/expressjs/serve-static#options。
- proxyHandlers (array) - 一个包含代理配置的数组。有关可用选项，请参见 https://github.com/http-party/node-http-proxy#options。
- httpsServerOptions (object) - 传递给 https.createServer() 函数的选项。
httpsService.createProxy(options)：创建 HTTP 代理服务器，其中 options 参数是一个对象，包含以下可用属性：
- proxy (object) - 目标服务器选项，用于代理请求的选项。有关更多信息，请参见 https://github.com/http-party/node-http-proxy#options。
- port (number) - 要监听的 HTTP 端口。默认值为 5050。

常见问题

本地 HTTPS 证书报错

当使用本地 HTTPS 证书时，可能会遇到浏览器的警告或错误提示。这是因为证书没有由受信任的颁发机构签署。要避免此问题，请在证书中添加一个信任颁发机构或使用自己的证书。

无法访问静态资源

如果无法访问静态资源，请确保在服务创建时已启用了 enableStatic 选项，并且需要确保指定的静态资源目录 root 参数是正确的。它应该是一个相对于服务器脚本运行的当前工作目录的路径。

端口被占用

在启动服务器时，可能会遇到端口被占用的情况。此时，只需更改端口号即可。如果您不确定端口号是否已被占用，请使用以下命令来查找端口号：

sudo lsof -i :<端口号>

结论

https-service-legacy 是一个方便快捷的 npm 包，它可以帮助我们快速搭建本地 HTTPS 服务器。通过本文的介绍，您已经了解了它的基本使用方法，同时也了解了如何根据需要配置 HTTPS 和回调函数等高级选项，以及如何解决常见问题。相信在将来的前端开发工作中，这个 npm 包将会为您提供好用的服务。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6005672481e8991b448e39be

npm包 https-service-legacy 使用教程

前言

安装