解决springcloud集成nacos 使用lb 无效

背景

最近在搭建微服务框架，在搭建gateway 的时候 使用nacos做注册中心，在通过网关调用的时候发下一个奇怪的问题，网关可以路由http地址，不能路由lb 的地址，路由lb 就报503。下面记录一下解决的方式。

组件版本

spring-boot-dependencies：2.6.13
spring-cloud-alibaba-dependencies：2021.0.5.0
spring-cloud-dependencies：2021.0.5

分析

先看一下gateway 配置文件信息

server:
  port: 8088
spring:
  application:
    name: api-gateway
  cloud:
    #网关配置
    gateway:
      #路由配置
      routes:
        - id: order_route       #路由唯一标识
          uri: http://localhost:8090
#          uri: lb://order-service
          predicates:    # 断言规则
            - Path=/order-service/**
          filters:
            - StripPrefix=1 
      # 放路径访问不到 返回404
   #   loadbalancer:
   #     use404: true
        
    # nacos 地址
    nacos:
      server-addr: 192.168.57.101:8848
      discovery:
        namespace: public
        

当url 使用的是http://localhost:8090 时，请求接口成功。

当使用lb://order-service 时 ，接口请求就抛出503 异常

一开始我以为order服务没有注册到nacos上，去查看了一下nacos 发现服务是注册成功的。且网关和order服务也都注册到同一个namespace下且是同一个分组，不可能拿不到order服务的信息的。

为啥http 可以 lb 就不可以呢，难道spring-cloud-starter-gateway 这个配置中没有使用本地负载均衡吗。
想到这里，决定看一下服务启动时从spring-cloud-starter-gateway这个包都自动装载了哪些配置。

解决步骤

第一步：

在External libraries 中找到gateway的依赖包如下图

找到spring.factories 文件并打开，发现跟负载均衡有关系的配置类有GatewayNoLoadBalancerClientAutoConfiguration和GatewayReactiveLoadBalancerClientAutoConfiguration
这两个配置类。根据名称可以知道
GatewayNoLoadBalancerClientAutoConfiguration 是不支持负载均衡客户端的自动配置类。
而GatewayReactiveLoadBalancerClientAutoConfiguration 是支持负载均衡客户端配置类。

分别查看一下这两个配置类

GatewayNoLoadBalancerClientAutoConfiguration 代码如下

可以看出这个配置类就干了一个事，向容器中注入一个NoLoadBalancerClientFilter过滤器。该过滤器的过滤方法就是当发现url 中配置的是lb 约束 时抛出NotFoundException异常。
查看创建异常方法

以为with404 这个参数从配置文件中配置的，默认值是false。所以该方法会抛出503异常。

GatewayReactiveLoadBalancerClientAutoConfiguration代码如下

查看可以得知在spring-cloud-starter-gateway jar包中缺少LoadBalancerAutoConfiguration和LoadBalancerClientFactory，所以GatewayReactiveLoadBalancerClientAutoConfiguration就不会被加载，更不会注入ReactiveLoadBalancerClientFilter bean。
所以spring-cloud-starter-gateway jar 包中只会有NoLoadBalancerClientFilter 不支持负载均衡。
所以问题就定位到了，是因为缺少LoadBalancerAutoConfiguration和LoadBalancerClientFactory 导致ReactiveLoadBalancerClientFilter 不能注入到容器中。所以只要将包含LoadBalancerClientFactory 的jar包添加到pom 文件中即可。
通过查询官网文档，得知使用负载均衡需要依赖

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>

添加以上依赖，重新编译，启动程序，执行请求成功。完美解决问题！

参考资料

spring cloud 官网文档

总结：

通过查看spring-cloud-starter-gateway jar中的自动配置类的源码。得知，该jar包中是不支持负载均衡的，需要引入spring-cloud-starter-loadbalancer 来支持。