Soul 网关源码分析(二)divide, rewrite 插件
在上一节里我们编译好了 Soul 网关的源码,今天我们从rewrite插件开始学习如何对服务进行代理并重写路径。
首先我们用Python写一个简单的Flask应用:
from flask import Flask
app = Flask(__name__)
@app.route('/foo/bar/')
def hello_world():
return 'Hello World!'
if __name__ == '__main__':
app.run()
启动服务后,我们可以看到现在设置的路径为:
http://127.0.0.1:5000/foo/bar/
尝试使用 curl 访问对应的接口:
OK,服务正常。
我们在 soul-admin 选择 rewrite 插件,点击添加选择器:
在弹出的对话框中输入:
点击确认后,通过 Chrome debug 可以捕获到前端发起的三个请求,分别是:
- /selector
- /selector?pluginId=3¤tPage=1&pageSize=12
- /rule?currentPage=1&pageSize=12&selectorId=1350069791219036160
我们追踪到对应的源码可以看到:
/**
* query Selectors.
*
* @param pluginId plugin id.
* @param currentPage current page.
* @param pageSize page size.
* @return {@linkplain SoulAdminResult}
*/
@GetMapping("")
public SoulAdminResult querySelectors(final String pluginId, final Integer currentPage, final Integer pageSize) {
CommonPager<SelectorVO> commonPager = selectorService.listByPage(new SelectorQuery(pluginId, new PageParameter(currentPage, pageSize)));
return SoulAdminResult.success(SoulResultMessage.QUERY_SUCCESS, commonPager);
}
前两个请求其实是在加载我们右侧的选择器,现在我们没有创建选择器,所以什么也没有。
而 /rule 这个请求是在查询现有的规则列表。
点击右侧的“创建选择器”按钮来创建选择器:
创建好选择器后,由于我们仅仅是把选择器的数据存放在了 数据库中(根据你配置可能在 MySQL 或 H2里),我们如果需要他即时生效需要点击同步自定义rewrite。
接口调用路径是
http://localhost:9095/plugin/syncPluginData/3
返回 "sync success",我们再次切换到源码:
发现 soul-admin 用到了Spring 中的 ApplicationEventPublisher,在如下路径的类中,我们也找到了soul-admin处理这些时间的逻辑:
org/dromara/soul/admin/listener/DataChangedEventDispatcher.java
刚刚我们应该是通过点击按钮触发了 "onPluginChanged" 这个事件,可以看到,根据我们所配置的数据同步侧录额,soul 提供了三种实现方式:
-
WebSocket
在 WebsocketDataChangedListener 中调用 onPluginChanged 方法来向 SoulBootstrapApplication 发送JSON序列化后的消息。 -
Nacos
如果配置 Nacos 进行同步,则是通过 ConfigService 来发送消息。@Override public void onPluginChanged(final List<PluginData> changed, final DataEventTypeEnum eventType) { updatePluginMap(getConfig(PLUGIN_DATA_ID)); switch (eventType) { case DELETE: changed.forEach(plugin -> PLUGIN_MAP.remove(plugin.getName())); break; case REFRESH: case MYSELF: Set<String> set = new HashSet<>(PLUGIN_MAP.keySet()); changed.forEach(plugin -> { set.remove(plugin.getName()); PLUGIN_MAP.put(plugin.getName(), plugin); }); PLUGIN_MAP.keySet().removeAll(set); break; default: changed.forEach(plugin -> PLUGIN_MAP.put(plugin.getName(), plugin)); break; } publishConfig(PLUGIN_DATA_ID, PLUGIN_MAP); }
-
ZooKeeper
通过节点同步数据。@Override public void onPluginChanged(final List<PluginData> changed, final DataEventTypeEnum eventType) { for (PluginData data : changed) { final String pluginPath = ZkPathConstants.buildPluginPath(data.getName()); // delete if (eventType == DataEventTypeEnum.DELETE) { deleteZkPathRecursive(pluginPath); final String selectorParentPath = ZkPathConstants.buildSelectorParentPath(data.getName()); deleteZkPathRecursive(selectorParentPath); final String ruleParentPath = ZkPathConstants.buildRuleParentPath(data.getName()); deleteZkPathRecursive(ruleParentPath); continue; } //create or update upsertZkNode(pluginPath, data); } }
可以通过对指定接口发起 POST 请求来注册其他语言的服务:
{
"appName": "xxx", //应用名称 必填
"context": "/xxx", //请求前缀 必填
"path": "xxx", //路径需要唯一 必填
"pathDesc": "xxx", //路径描述
"rpcType": "http", //rpc类型 必填
"host": "xxx", //服务host 必填
"port": xxx, //服务端口 必填
"ruleName": "xxx", //可以同path一样 必填
"enabled": "true", //是否开启
"registerMetaData": "true" //是否需要注册元数据
}
请求地址:http://{ip}:{port}/soul-client/springmvc-register 请自行输入soul-admin 的 IP 和 PORT
在 postman 或其他工具中成功注册服务:
但我们发现并不能直接通过 soul 来代理我们的 flask 服务:
➜ ~ curl http://localhost:9195
{"code":-107,"message":"Can not find selector, please check your configuration!","data":null}%
仔细查看文档后,发现需要先设置 Divide 插件并添加对应的selector。
配置完成后可以看到 divide 插件成功选取到了 我们配置的 test1 selector,但是我们的请求
curl http://localhost:9195/foo/bar/
被解析成了 http://127.0.0.1:5000/bar/,一定是什么地方出了问题。
再看看源码
我们发现 在 org/dromara/soul/plugin/divide/DividePlugin.java 这个类中 buildRealURL 会将我们的 “/foo” 识别为 module,然后把“/bar” 识别为真实的request path,所以导致了刚刚的问题。
再次尝试在前面加一层,成功了。
➜ ~ curl http://localhost:9195/1/foo/bar/
Hello World!%