在前端项目开发中，代理服务器是一个非常常见的使用场景。通过代理服务器，我们可以实现让前端请求到自己本机以外的服务器，让前端请求到自己本机以外的 API 接口，方便我们的项目开发并且提升项目的灵活度。在这里，我们介绍一下 npm 包 gentle-proxy-synchronized 的使用教程，帮助开发者更好地了解这个代理服务器。
什么是 gentle-proxy-synchronized？
gentle-proxy-synchronized 是一个简单的、易于配置和使用的代理服务器。它使用 Node.js 构建，可以用于 proxy http、https、websocket等请求。它支持本地和远程代理模式，并支持代理授权、跨站资源共享（CORS）等功能。此外，它还支持代理缓存和 HTTP 缓存。
安装 gentle-proxy-synchronized
使用 npm 安装 gentle-proxy-synchronized ，只需要在终端中输入以下命令：
npm install gentle-proxy-synchronized -g
-g 表示可以全局使用该 npm 包。
使用 gentle-proxy-synchronized
命令使用
安装完成后，可以在终端中输入以下命令启动代理服务器：
$ gentle-proxy-synchronized
启动参数：
-p, --port 指定代理服务器监听的端口，默认是 8080
-c, --config 指定配置文件的路径
接下来可以通过代理服务器访问需要代理的服务，例如我们需要代理一个本地的网站，可以访问：
http://127.0.0.1:8080/
这里的 8080 是代理服务器监听的端口号，可以在启动时指定端口号。
代理配置
代理配置可以通过配置文件来实现，配置文件必须是 JSON 格式的。JSON 文件中可以包含以下选项：
target：要代理的目标 URL 地址。
changeOrigin：是否改变请求来源，设置为 true 表示使用代理服务器的 HOST 作为请求来源。
auth：代理授权信息，可以为用户名密码，例如：
{
"target": "http://localhost:3000",
"auth": "username:password"
}- ws：是否代理 websocket 请求，设置为 true 表示代理 websocket。
例如，我们在当前目录创建一个叫做 proxy-config.json 的 JSON 文件，文件内容如下：
-- -------------------- ---- -------
-
-
--------- ------------------------
--------------- ----
--
-
--------- ------------------------
--------------- ----
-
-运行代理服务器指定配置文件路径：
gentle-proxy-synchronized -c ./proxy-config.json
这里指定了配置文件路径，代理服务器会把配置中定义的 target 代理请求到对应的服务器上。
代码使用
在代码中使用 gentle-proxy-synchronized，只需先安装该模块并在代码中引用即可。以下是一个简单的例子，可以将它保存在 demo.js 文件中，并通过 node 运行在本地：
-- -------------------- ---- -------
----- ----------- - -------------------------------------
-------------
----- -----
------ -
-
------- ------------------------
--
-
------- ----------------------------
----- -------
-
-
-- -- -- -
------------------ ------ --- ------- -- ---- -------
---在该例子中，引入了 gentle-proxy-synchronized，然后定义了一个代理端口是 3000 的服务器，并且配置了两个代理，一个代理的目标是 localhost:8080，另一个代理的目标是 localhost:3001/api。将这个文件运行在 node 上，即可启动代理服务器。
总结
gentle-proxy-synchronized 是一个简单、易于使用的代理服务器，可以通过命令行或者代码来使用。它支持多种代理协议，并且可以进行缓存和授权管理。通过 gentle-proxy-synchronized，开发者可以方便地访问外部 API，进而实现全面的前端功能开发。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005667581e8991b448e28b1