服务已注册至JHipster Registry但网关无法路由请求

问题描述 #

我的所有服务均已注册到jhipster-registry，具体如下图所示：

从上图可见，Canoja服务与Gateway都已在服务注册中心完成注册。根据官方文档的说明：

网关会自动代理所有发往微服务的请求，路由依据为微服务的应用名称：例如当微服务app1完成注册后，即可通过网关的/services/app1 URL访问该服务。

我原本预期网关会自动拉取对应服务的API，但实际这些API无法通过网关访问，情况如下图所示：

请问该问题是什么原因导致，应当如何排查解决？

按以下优先级从高到低逐步排查即可，覆盖绝大多数常见场景：

1. 核对服务注册基础配置 #

• 检查Canoja微服务配置文件中的spring.application.name值：网关自动路由统一使用全小写的服务名做路径匹配，不管配置里写的是Canoja还是CANOJA，实际访问路径都必须是/services/canoja/**，大小写不匹配会直接返回404，这是最常见的低级错误。
• 确认网关和Canoja服务连接的是同一个jhipster-registry实例：核对两边配置的注册中心地址、端口、认证信息完全一致，避免多注册中心实例出现脑裂，导致两边控制台都显示"已注册"，但实际根本不在同一个服务发现集群里。

2. 校验网关实际加载的路由规则 #

• 直接访问网关的actuator路由端点http://<网关IP>:<网关端口>/management/gateway/routes，查看返回的路由列表中是否存在Canoja服务对应的路由条目，正常条目会匹配/services/canoja/**路径，转发目标为Canoja服务的负载均衡地址。
  • 如果路由列表里根本没有Canoja的条目：先查Canoja服务注册时的元数据，是否被自定义规则标记为不允许网关代理；再看注册中心里Canoja实例的健康状态，不健康的实例会被网关自动剔除，不会加入路由列表。
  • 如果路由条目存在但访问失败：继续往下排查。
• 核对访问路径格式：所有经过网关代理的微服务请求，必须严格遵循/services/[小写服务名]/[微服务原生接口路径]的格式，别漏写/services/前缀，也不要额外拼接多余路径段。
• 检查网关权限拦截规则：如果开了认证鉴权，确认/services/canoja/**路径已经加入对应访问规则，未放行的请求会被直接拦截返回401/403，表现和接口不存在一模一样，很容易误判。

3. 排查微服务自身配置问题 #

• 先绕过网关直接访问Canoja服务的接口，确认服务本身运行正常、接口可正常响应，先排除服务自身启动失败、接口逻辑报错的问题。
• 检查Canoja服务是否配置了自定义server.servlet.context-path：如果给微服务单独设置了上下文根（比如/canoja-api），通过网关访问时必须把这段路径补上，完整路径为/services/canoja/canoja-api/[接口路径]，漏写必404。
• 检查跨域配置冲突：如果是前端调用报跨域错误，别直接判定为路由失效，JHipster默认由网关统一处理跨域逻辑，微服务端不要重复配置跨域响应头，否则会出现重复Origin头，直接被浏览器拦截。

4. 部署场景特殊坑点 #

• 容器化部署（Docker/K8s）场景：检查服务注册到注册中心的IP地址是否是网关可通达的地址，容器默认注册的内部网桥IP无法被跨容器访问时，会出现路由存在但请求超时/连接失败的问题，需要配置eureka.instance.prefer-ip-address: true，同时指定服务注册IP为集群内/宿主机可路由的IP。
• 版本兼容性问题：保证网关和所有微服务的JHipster、Spring Cloud、Spring Boot版本完全对齐，大版本不一致会导致服务发现、路由转发逻辑不兼容，莫名其妙出现代理失效的问题。

内容的提问来源于stack exchange，提问作者lenikhilsingh