soul 网关源码解析

一.soul网关引入的依赖分析

从上图可以看到我红线划分五个依赖区域

1.soul-common包:这里不是很重要,我们大概看一下他的作用就好了

从上图中可以看出,这个包里主要定义了一个常量,枚举类,配置类,自定义的DTO对象

2.soul-metrics这些依赖包主要是监控暴露出来的代码,这里也不是很重要,先略过

3.最重要的就是插件部分 soul-plugin依赖包,这里包含了你项目中会用到的插件源码

4.websocket和sync部分依赖包: 主要是网关和soul后台管理系统同步配置信息的

5.soul-web包也很重要,里面是soul网关的请求入口类,和一些拦截器,配置信息类.

二.请求流程:

可以看到exchange里面包含着request信息和response信息.

plugins插件里面会告诉你需要执行的有多少个插件

1.首先请求会到SoulWebHandler类里面的execute方法中

public Mono<Void> execute(final ServerWebExchange exchange) {return Mono.defer(() -> {//循环执行插件if (this.index < plugins.size()) {SoulPlugin plugin = plugins.get(this.index++);//判断插件是否跳过执行Boolean skip = plugin.skip(exchange);if (skip) {return this.execute(exchange);}//调用插件执行逻辑return plugin.execute(exchange, this);}return Mono.empty();});}

2.执行插件代码

可以看到spring cloud项目一共需要执行10个插件,其中3,4,7是我自定义的插件

3.GlobalPlugin插件:

 @Overridepublic Mono<Void> execute(final ServerWebExchange exchange, final SoulPluginChain chain) {final ServerHttpRequest request = exchange.getRequest();final HttpHeaders headers = request.getHeaders();final String upgrade = headers.getFirst("Upgrade");SoulContext soulContext;//判断是否是websocket同步的配置请求if (StringUtils.isBlank(upgrade) || !"websocket".equals(upgrade)) {//正常请求需要构建soulContextsoulContext = builder.build(exchange);} else {final MultiValueMap<String, String> queryParams = request.getQueryParams();soulContext = transformMap(queryParams);}exchange.getAttributes().put(Constants.CONTEXT, soulContext);return chain.execute(exchange);}

继续看DefaultSoulContextBuilder类中的build方法

 public SoulContext build(final ServerWebExchange exchange) {ServerHttpRequest request = exchange.getRequest();String path = request.getURI().getPath();//根据请求的路径匹配到配置的元数据MetaData metaData = MetaDataCache.getInstance().obtain(path);if (Objects.nonNull(metaData) && metaData.getEnabled()) {exchange.getAttributes().put(Constants.META_DATA, metaData);}//构建本次请求的SoulContext上下文对象return Optional.ofNullable(metaData).map(e -> decoratorMap.get(e.getRpcType())).orElse(decoratorMap.get(RpcTypeEnum.HTTP.getName())).decorator(buildDefault(request), metaData);}

4.spring cloud plugin插件

 protected Mono<Void> doExecute(final ServerWebExchange exchange, final SoulPluginChain chain, final SelectorData selector, final RuleData rule) {if (Objects.isNull(rule)) {return Mono.empty();} else {SoulContext soulContext = (SoulContext)exchange.getAttribute("context");assert soulContext != null;//取出后台管理系统配置的选择器规则对象SpringCloudRuleHandle ruleHandle = (SpringCloudRuleHandle)GsonUtils.getInstance().fromJson(rule.getHandle(), SpringCloudRuleHandle.class);//取出后台管理系统配置的选择器对象SpringCloudSelectorHandle selectorHandle = (SpringCloudSelectorHandle)GsonUtils.getInstance().fromJson(selector.getHandle(), SpringCloudSelectorHandle.class);if (!StringUtils.isBlank(selectorHandle.getServiceId()) && !StringUtils.isBlank(ruleHandle.getPath())) {//调用spring cloud ribbon对象从eureka注册中心获取注册服务实例ServiceInstance serviceInstance = this.loadBalancer.choose(selectorHandle.getServiceId());if (Objects.isNull(serviceInstance)) {Object error = SoulResultWrap.error(SoulResultEnum.SPRINGCLOUD_SERVICEID_IS_ERROR.getCode(), SoulResultEnum.SPRINGCLOUD_SERVICEID_IS_ERROR.getMsg(), (Object)null);return WebFluxResultUtils.result(exchange, error);} else {//根据服务实例负载均衡获取真正的请求服务的URL信息URI uri = this.loadBalancer.reconstructURI(serviceInstance, URI.create(soulContext.getRealUrl()));//构建真正的请求URL,这里有BUG,需要注意String realURL = this.buildRealURL(uri.toASCIIString(), exchange.getRequest().getURI().getQuery());exchange.getAttributes().put("httpUrl", realURL);exchange.getAttributes().put("httpTimeOut", ruleHandle.getTimeout());return chain.execute(exchange);}} else {Object error = SoulResultWrap.error(SoulResultEnum.CANNOT_CONFIG_SPRINGCLOUD_SERVICEID.getCode(), SoulResultEnum.CANNOT_CONFIG_SPRINGCLOUD_SERVICEID.getMsg(), (Object)null);return WebFluxResultUtils.result(exchange, error);}}}

5.webClientPlugin插件

 @Overridepublic Mono<Void> execute(final ServerWebExchange exchange, final SoulPluginChain chain) {final SoulContext soulContext = exchange.getAttribute(Constants.CONTEXT);assert soulContext != null;String urlPath = exchange.getAttribute(Constants.HTTP_URL);if (StringUtils.isEmpty(urlPath)) {Object error = SoulResultWrap.error(SoulResultEnum.CANNOT_FIND_URL.getCode(), SoulResultEnum.CANNOT_FIND_URL.getMsg(), null);return WebFluxResultUtils.result(exchange, error);}//获取后台管理系统配置的超时时间long timeout = (long) Optional.ofNullable(exchange.getAttribute(Constants.HTTP_TIME_OUT)).orElse(3000L);//重试时间int retryTimes = (int) Optional.ofNullable(exchange.getAttribute(Constants.HTTP_RETRY)).orElse(0);log.info("The request urlPath is {}, retryTimes is {}", urlPath, retryTimes);HttpMethod method = HttpMethod.valueOf(exchange.getRequest().getMethodValue());WebClient.RequestBodySpec requestBodySpec = webClient.method(method).uri(urlPath);//构建request的handlereturn handleRequestBody(requestBodySpec, exchange, timeout, retryTimes, chain);}

6.插件中主要介绍上面三个插件,经过插件后,就进入reactor.netty.http.client 进行异步调用下游服务接口.具体的源码信息在reactor-netty里面.本章节就不进行介绍了

soul 网关源码解析相关推荐

Soul网关源码解析目录
Soul网关源码解析目录 Soul网关源码解析文章列表对用Java写的高性能网关:Soul,进行一波学习和研究,下面是相关的文章记录掘金了解与初步运行 Soul网关源码解析(一) 概览 ...
Soul网关源码解析（二）代理Http请求
如何读开源项目:对着文档跑demo,对着demo看代码,懂一点就开始试,有问题了问社区. 文章目录今日目标: 一.从官方文档开始 1.接入说明: 2.网关需要引入代理插件 3.Http 服务接入网关 ...
Soul网关源码解析（三）代理Dubbo服务
文章目录目标一.使用 soul 代理 dubbo 服务 1.dubbo 服务接入网关 1.1 springboot 项目接入方式 1.2 spring 项目接入方式 2.配置 dubbo 插件 3 ...
soul网关源码解析-环境搭建
项目功能简介支持各种语言(http协议),支持 dubbo,springcloud协议. 插件化设计思想,插件热插拔,易扩展. 灵活的流量筛选,能满足各种流量控制. 内置丰富的插件支持,鉴权,限流, ...
Soul网关源码阅读（八）路由匹配初探
Soul网关源码阅读(八)路由匹配初探简介今日看看路由的匹配相关代码,查看HTTP的DividePlugin匹配示例运行使用HTTP的示例,运行Soul-Admin,Sou ...
Soul网关源码阅读（七）限流插件初探
Soul网关源码阅读(七)限流插件初探简介前面的文章中对处理流程探索的差不多了,今天来探索下限流插件:resilience4j 示例运行环境配置启动下MySQL和redis d ...
Soul 网关源码阅读（六）Sofa请求处理概览
Soul 网关源码阅读(六)Sofa请求处理概览简介今天来探索一下Sofa请求处理流程,看看和前面的HTTP.Dubbo有什么异同 Sofa示例运行 PS:如果请求加上参数运行不成功,请更 ...
Soul网关源码阅读（十）自定义简单插件编写
Soul网关源码阅读(十)自定义简单插件编写简介综合前面所分析的插件处理流程相关知识,此次我们来编写自定义的插件:统计请求在插件链中的经历时长编写准备首先我们先探究一下,一个P ...
Soul网关源码阅读（九）插件配置加载初探
Soul网关源码阅读(九)插件配置加载初探简介今日来探索一下插件的初始化,及相关的配置的加载源码Debug 插件初始化首先来到我们非常熟悉的插件链调用的类: SoulWebHa ...

soul 网关源码解析

soul 网关源码解析相关推荐

最新文章

热门文章