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/targetsoul-bootstrap/target 下会分别生成 soul-admin.jarsoul-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

参考连接

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,029评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,238评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,576评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,214评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,324评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,392评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,416评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,196评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,631评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,919评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,090评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,767评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,410评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,090评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,328评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,952评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,979评论 2 351

推荐阅读更多精彩内容