diff --git a/doc/docs/_sidebar.md b/doc/docs/_sidebar.md index e91439dd..cfcd1a1a 100644 --- a/doc/docs/_sidebar.md +++ b/doc/docs/_sidebar.md @@ -1,31 +1,32 @@ -* [首页](/?t=1566381652549) +* [首页](/?t=1566472188469) * 开发文档 - * [快速体验](files/10010_快速体验.md?t=1566381652551) - * [项目接入到SOP](files/10011_项目接入到SOP.md?t=1566381652568) - * [新增接口](files/10020_新增接口.md?t=1566381652568) - * [业务参数校验](files/10030_业务参数校验.md?t=1566381652568) - * [错误处理](files/10040_错误处理.md?t=1566381652568) - * [编写文档](files/10041_编写文档.md?t=1566381652568) - * [接口交互详解](files/10050_接口交互详解.md?t=1566381652568) - * [easyopen支持](files/10070_easyopen支持.md?t=1566381652568) - * [使用签名校验工具](files/10080_使用签名校验工具.md?t=1566381652568) - * [ISV管理](files/10085_ISV管理.md?t=1566381652569) - * [自定义路由](files/10086_自定义路由.md?t=1566381652569) - * [自定义返回结果](files/10087_自定义返回结果.md?t=1566381652569) - * [自定义过滤器](files/10088_自定义过滤器.md?t=1566381652569) - * [路由授权](files/10090_路由授权.md?t=1566381652569) - * [接口限流](files/10092_接口限流.md?t=1566381652569) - * [监控日志](files/10093_监控日志.md?t=1566381652569) - * [SDK开发](files/10095_SDK开发.md?t=1566381652569) - * [使用SpringCloudGateway](files/10096_使用SpringCloudGateway.md?t=1566381652569) - * [应用授权](files/10097_应用授权.md?t=1566381652569) - * [传统web开发](files/10100_传统web开发.md?t=1566381652569) - * [文件上传](files/10104_文件上传.md?t=1566381652570) - * [配置Sleuth链路追踪](files/10109_配置Sleuth链路追踪.md?t=1566381652570) - * [预发布灰度发布](files/10110_预发布灰度发布.md?t=1566381652570) - * [动态修改请求参数](files/10111_动态修改请求参数.md?t=1566381652570) + * [快速体验](files/10010_快速体验.md?t=1566472188474) + * [项目接入到SOP](files/10011_项目接入到SOP.md?t=1566472188490) + * [新增接口](files/10020_新增接口.md?t=1566472188490) + * [业务参数校验](files/10030_业务参数校验.md?t=1566472188490) + * [错误处理](files/10040_错误处理.md?t=1566472188490) + * [编写文档](files/10041_编写文档.md?t=1566472188490) + * [接口交互详解](files/10050_接口交互详解.md?t=1566472188491) + * [easyopen支持](files/10070_easyopen支持.md?t=1566472188491) + * [使用签名校验工具](files/10080_使用签名校验工具.md?t=1566472188491) + * [ISV管理](files/10085_ISV管理.md?t=1566472188491) + * [自定义路由](files/10086_自定义路由.md?t=1566472188491) + * [自定义返回结果](files/10087_自定义返回结果.md?t=1566472188491) + * [自定义过滤器](files/10088_自定义过滤器.md?t=1566472188491) + * [路由授权](files/10090_路由授权.md?t=1566472188491) + * [接口限流](files/10092_接口限流.md?t=1566472188491) + * [监控日志](files/10093_监控日志.md?t=1566472188491) + * [SDK开发](files/10095_SDK开发.md?t=1566472188492) + * [使用SpringCloudGateway](files/10096_使用SpringCloudGateway.md?t=1566472188492) + * [应用授权](files/10097_应用授权.md?t=1566472188492) + * [传统web开发](files/10100_传统web开发.md?t=1566472188492) + * [文件上传](files/10104_文件上传.md?t=1566472188492) + * [配置Sleuth链路追踪](files/10109_配置Sleuth链路追踪.md?t=1566472188492) + * [预发布灰度发布](files/10110_预发布灰度发布.md?t=1566472188492) + * [动态修改请求参数](files/10111_动态修改请求参数.md?t=1566472188492) * 原理分析 - * [原理分析之@ApiMapping](files/90010_原理分析之@ApiMapping.md?t=1566381652570) - * [原理分析之如何路由](files/90012_原理分析之如何路由.md?t=1566381652570) - * [原理分析之文档归纳](files/90013_原理分析之文档归纳.md?t=1566381652570) - * [常见问题](files/90100_常见问题.md?t=1566381652570) + * [原理分析之@ApiMapping](files/90010_原理分析之@ApiMapping.md?t=1566472188492) + * [原理分析之如何存储路由](files/90011_原理分析之如何存储路由.md?t=1566472188492) + * [原理分析之如何路由](files/90012_原理分析之如何路由.md?t=1566472188492) + * [原理分析之文档归纳](files/90013_原理分析之文档归纳.md?t=1566472188492) + * [常见问题](files/90100_常见问题.md?t=1566472188492) diff --git a/doc/docs/files/10050_接口交互详解.md b/doc/docs/files/10050_接口交互详解.md index c6fc06c2..9140a145 100644 --- a/doc/docs/files/10050_接口交互详解.md +++ b/doc/docs/files/10050_接口交互详解.md @@ -47,7 +47,7 @@ member.register.total.get 会员服务.注册模块.注册总数.获取 整个SOP的架构如下图所示： -![SOP架构图](https://images.gitee.com/uploads/images/2019/0309/093312_8afb4789_332975.png "sop.png") +![架构图](https://images.gitee.com/uploads/images/2019/0821/201531_0f605f7c_332975.png "sop2.png") - 完整请求路线 diff --git a/doc/docs/files/90011_原理分析之如何存储路由.md b/doc/docs/files/90011_原理分析之如何存储路由.md new file mode 100644 index 00000000..7bb00f6d --- /dev/null +++ b/doc/docs/files/90011_原理分析之如何存储路由.md @@ -0,0 +1,63 @@ +# 原理分析之如何存储路由 + +SOP基于spring cloud，因此会涉及到网关路由。但是开发者不用去配置文件定义路由的隐射关系，SOP自动帮你解决了这个问题。 + +## 获取路由信息 + +首先明确一点，路由信息由各微服务提供，因此网关需要从注册中心获取各微服务实例，这个通过nacos提供的`watch`来实现。 +当有新的微服务加入时，Nacos会触发一个事件推送，详见`NacosWatch.java`类 + +```java +this.publisher.publishEvent(new HeartbeatEvent(this, this.nacosWatchIndex.getAndIncrement())); +``` + +因此，只要注册了`HeartbeatEvent`事件就能随时感知到微服务实例的变化。如何注册呢，config类实现`ApplicationListener`接口即可。 + +```java +public class AbstractConfiguration implements ApplicationContextAware, ApplicationListener { + /** + * nacos事件监听，每次微服务变化会触发这个方法 + * @see org.springframework.cloud.alibaba.nacos.discovery.NacosWatch NacosWatch + * @param heartbeatEvent + */ + @Override + public void onApplicationEvent(HeartbeatEvent heartbeatEvent) { + ...这里加载路由信息 + } +} +``` + +然后，每个微服务提供一个restful接口，接口地址为：`http://ip:port/sop/routes`，用来返回自身路由信息。网关请求这个接口用来获取路由信息。 + +加载路由伪代码如下： + +```java +public void onApplicationEvent(HeartbeatEvent heartbeatEvent) { + // 获取nacos中的服务实例列表 + List allInstances = namingService.getAllInstances(serviceName); + for(Instance instance : allInstances) { + // 微服务提供的接口 + String url = "http://" + instance.getIp + ":" + instance.getPort + "/sop/routes"; + ResponseEntity responseEntity = restTemplate.getForEntity(url, String.class); + if (responseEntity.getStatusCode() == HttpStatus.OK) { + // 返回来的路由信息 + String body = responseEntity.getBody(); + ...加载路由到本地 + } + } +} +``` + +完整代码可参看`com.gitee.sop.gatewaycommon.manager.ServiceRoutesLoader.java` + +路由的存储方式是一个Map，key为路由id，即接口名+版本号。 + +```java +/** + * key：nameVersion + */ +private Map nameVersionTargetRouteMap; +``` + +因为客户端调用接口都会传递一个接口名和版本号，因此通过这两个字段能够很快查询出路由信息，进行路由转发操作。 + diff --git a/sop-common/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/manager/ServiceRoutesLoader.java b/sop-common/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/manager/ServiceRoutesLoader.java index 09ffe468..8299b5fa 100644 --- a/sop-common/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/manager/ServiceRoutesLoader.java +++ b/sop-common/sop-gateway-common/src/main/java/com/gitee/sop/gatewaycommon/manager/ServiceRoutesLoader.java @@ -112,7 +112,6 @@ public class ServiceRoutesLoader { log.error("nacos推送失败，serviceId:{}, instance:{}",serviceName, instance); } }); - } } }