Soul 网关使用 - 源码编译和简单使用

关于 Soul API 网关项目

Soul 网关项目是由一群优秀的国内开发者发起的一个异步的、高性能的、响应式的开源网关项目。除了性能高之外，我认为插件话的设计思想是 Soul 最重要的特点，这让 Soul 变得更灵活。
Soul 核心架构图如下：

Soul 核心架构图

本节关注的内容是 soul 的源码编译和入门使用，所以这里只是简单展示 soul 的核心架构图，希望读者能有个直观的感受，暂不对其进行深入讨论。

编译 soul 源码并启动一个单机网关

1、获取源码

git clone https://github.com/yiwenlong/soul.git

因为要对 Soul 项目做贡献，所以我已经把 Soul 项目源码 fork 到我自己的 Github，这里我是从我的个人 Github 检出的代码。

2、编译打包

./mvnw clean package -Dmaven.javadoc.skip=true

我这里的默认打包命令只是选择跳过了 javadoc 的生成，如果想要更快速的执行打包命令，可以在参数后面添加 -Dmaven.test.skip=true 参数。

这一步完成后，在 soul-admin/target 和 soul-bootstrap/target 下会分别生成 soul-admin.jar 和 soul-bootstrap.jar 两个可执行的 jar 包。这两个可执行 jar 包分别对应架构图中的管理控制台和 API 网关部分。

3、启动 soul-admin

启动 soul-admin 前需要确认 Mysql 数据库是否已经安装启动，并使用自己本地环境的 Mysql 数据库的用户明和密码替换到下面命令中。

java -jar ./soul-admin/target/soul-admin.jar \
  --spring.datasource.password='root' \
  --spring.datasource.password='12345' 

这里的配置同样可以在源码 soul-admin 模块的 application.yaml 中设置。

启动成功后，我们可以访问 http://localhost:9095，使用用户名密码 admin/123456 登陆到刚刚启动的管理控制台服务。

Soul 管理控制台界面

4、启动 API 网关

java -jar ./soul-bootstrap/target/soul-bootstrap.jar

API 网关启动成功后，我们在网关的日志中可以看到如下一条日志，说明网关和管理控制台已经建立了 websocket 长链接。

2021-01-15 00:29:11.434  INFO 16453 --- [ocket-connect-1] o.d.s.p.s.d.w.WebsocketSyncDataService   : websocket reconnect is successful.....

我们同样可以在管理控制台的日志中看到如下成功的日志：

2021-01-15 02:43:11.365  INFO 17565 --- [0.0-9095-exec-1] o.d.s.a.l.websocket.WebsocketCollector   : websocket on open successful....

简单使用下 soul 网关

1、转发需求

在使用之前，我在本地简单启动了一个 Nginx 服务，我希望能通过 Soul 网关访问到我的 Nginx 服务（http://localhost:8080）。

2、配置 Selector 和 Rule

登陆到管理控制台，选择 PluginList 下的 divide，点击 Selector 后的 Add 添加如下配置：

Selector 配置

点击 RulesList 后的 Add 添加如下配置：

RuleList 配置

Selector 和 Rule 是 Soul 网关中的两个核心的概念，后面我们会重点讨论并搞清楚它们。

3、访问一下

Soul API 网关的默认端口是 9195，所以这里我们应该访问 http://localhost:9195/baidu 会看到 nginx 的默认界面。

通过 Soul 网关访问 Nginx

参考连接

• Soul 项目 Github 主页：https://github.com/dromara/soul
• Soul 项目中文官方文档：https://dromara.org/zh-cn/docs/soul/soul.html