SpringCloud：Spring Cloud Gateway中如何配置LoadBalancer

太过爱你忘了你带给我的痛 2023-07-04 15:55 119阅读 0赞

要在Spring-Cloud-Gateway中配置LoadBalancer，需要用到spring-cloud-starter-netflix-ribbon，因此需要将它引入。

pom.xml：

> <properties>  
>     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>  
>     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>  
>     <java.version>1.8</java.version>  
>     <spring-cloud.version>2.2.1.RELEASE</spring-cloud.version>  
> </properties>
> 
> <parent>  
>     <groupId>org.springframework.boot</groupId>  
>     <artifactId>spring-boot-starter-parent</artifactId>  
>     <version>2.2.1.RELEASE</version>  
>     <relativePath />  
> </parent>
> 
> <dependencies>  
>     <dependency>  
>         <groupId>org.springframework.boot</groupId>  
>         <artifactId>spring-boot-starter</artifactId>  
>     </dependency>  
>     <dependency>  
>         <groupId>org.springframework.boot</groupId>  
>         <artifactId>spring-boot-starter-webflux</artifactId>  
>     </dependency>  
>     <dependency>  
>         <groupId>org.springframework.boot</groupId>  
>         <artifactId>spring-boot-starter-actuator</artifactId>  
>     </dependency>
> 
>     <dependency>  
>         <groupId>org.springframework.cloud</groupId>  
>         <artifactId>spring-cloud-starter</artifactId>  
>         <version>$\{spring-cloud.version\}</version>  
>     </dependency>  
>     <dependency>  
>         <groupId>org.springframework.cloud</groupId>  
>         <artifactId>spring-cloud-starter-gateway</artifactId>  
>         <version>$\{spring-cloud.version\}</version>  
>     </dependency>  
>     <dependency>  
>         <groupId>org.springframework.cloud</groupId>  
>         <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>  
>         <version>$\{spring-cloud.version\}</version>  
>     </dependency>
> 
> </dependencies>

java代码：

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class AppBoot {
    	
    	public static void main(String[] args) {
    		SpringApplication.run(AppBoot.class, args);
    	}
    }

application.properties：

> server.port=8080  
> spring.application.name=gateway\_server
> 
>  \# default true  
> management.endpoint.gateway.enabled=true  
> management.endpoints.web.exposure.include=\*
> 
> logging.level.org.springframework.cloud.gateway=TRACE
> 
>  \# default true  
> ribbon.eureka.enabled=false
> 
>  \# default true  
> spring.cloud.loadbalancer.ribbon.enabled=true  
>  \# default false  
> spring.cloud.gateway.actuator.verbose.enabled=true
> 
> \#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#  
> spring.cloud.gateway.routes\[0\].id=my\_route  
> spring.cloud.gateway.routes\[0\].uri=lb://my-load-balanced-service  
> spring.cloud.gateway.routes\[0\].predicates\[0\]=Path=/test/\*\*
> 
> my-load-balanced-service.ribbon.listOfServers=localhost:9090, 127.0.0.1:9090  
> my-load-balanced-service.ribbon.NFLoadBalancerRuleClassName=com.netflix.loadbalancer.RoundRobinRule

或者application.yaml：

> server:  
>   port: 8080
> 
> spring:  
>   application:  
>     name: gateway\_server
> 
> spring:  
>   cloud:  
>     gateway:  
>       routes:  
>         - id: my\_route  
>           uri: lb://my-load-balanced-service  
>           predicates:  
>             - Path=/test/\*\*
> 
> my-load-balanced-service:  
>   ribbon:  
>     listOfServers: localhost:9090, 127.0.0.1:9090  
>     NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RoundRobinRule

可以从com.netflix.client.config.CommonClientConfigKey这类中找到其它可配置的参数。

**注意：lb://后面的<clientName>一定不要使用下划线，即不要使用比如：my\_load\_balanced\_service这种形式，否则LoadBanancer不会起作用。**

NFLoadBalancerRuleClassName中可以配置的值：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25ldHllYXhp_size_16_color_FFFFFF_t_70][]

其它可配置项：

> <clientName>.ribbon.NFLoadBalancerClassName: ILoadBalancer  
> <clientName>.ribbon.NFLoadBalancerRuleClassName: IRule  
> <clientName>.ribbon.NFLoadBalancerPingClassName: IPing  
> <clientName>.ribbon.NIWSServerListClassName: ServerList  
> <clientName>.ribbon.NIWSServerListFilterClassName: ServerListFilter

下表中列出了Spring Cloud Netflix为Ribbon提供的默认值：

<table style="width:616px;"> 
 <tbody> 
  <tr> 
   <td>Bean Type</td> 
   <td>Bean Name</td> 
   <td>Class Name</td> 
  </tr> 
  <tr> 
   <td><code>IClientConfig</code></td> 
   <td><code>ribbonClientConfig</code></td> 
   <td><code>DefaultClientConfigImpl</code></td> 
  </tr> 
  <tr> 
   <td><code>IRule</code></td> 
   <td><code>ribbonRule</code></td> 
   <td><code>ZoneAvoidanceRule</code></td> 
  </tr> 
  <tr> 
   <td><code>IPing</code></td> 
   <td><code>ribbonPing</code></td> 
   <td><code>DummyPing</code></td> 
  </tr> 
  <tr> 
   <td><code>ServerList&lt;Server&gt;</code></td> 
   <td><code>ribbonServerList</code></td> 
   <td><code>ConfigurationBasedServerList</code></td> 
  </tr> 
  <tr> 
   <td><code>ServerListFilter&lt;Server&gt;</code></td> 
   <td><code>ribbonServerListFilter</code></td> 
   <td><code>ZonePreferenceServerListFilter</code></td> 
  </tr> 
  <tr> 
   <td><code>ILoadBalancer</code></td> 
   <td><code>ribbonLoadBalancer</code></td> 
   <td><code>ZoneAwareLoadBalancer</code></td> 
  </tr> 
  <tr> 
   <td><code>ServerListUpdater</code></td> 
   <td><code>ribbonServerListUpdater</code></td> 
   <td><code>PollingServerListUpdater</code></td> 
  </tr> 
 </tbody> 
</table>

如果创建了以上类型的一个bean，并将它们放入使用了`@RibbonClient`的一个配置中，默认值将会被覆盖。

完成以上工作后，通过访问比如：http://127.0.0.1:8080/test/test.jsp，LoadBalancer就会将请求转发到http://127.0.0.1:9090/test/test.jsp，或http://localhost:9090/test/test.jsp

**参考文档**

Spring Cloud Gateway：The LoadBalancerClient Filter  
[https://cloud.spring.io/spring-cloud-gateway/reference/html/\#the-loadbalancerclient-filter][https_cloud.spring.io_spring-cloud-gateway_reference_html_the-loadbalancerclient-filter]

Spring Cloud Netflix： Client Side Load Balancer: Ribbon  
[https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.2.1.RELEASE/reference/html/\#spring-cloud-ribbon][https_cloud.spring.io_spring-cloud-static_spring-cloud-netflix_2.2.1.RELEASE_reference_html_spring-cloud-ribbon]

Working with load balancers  
[https://github.com/Netflix/ribbon/wiki/Working-with-load-balancers\#components-of-load-balancer][https_github.com_Netflix_ribbon_wiki_Working-with-load-balancers_components-of-load-balancer]

Client Side Load Balancing with Ribbon and Spring Cloud  
[https://spring.io/guides/gs/client-side-load-balancing/][https_spring.io_guides_gs_client-side-load-balancing]

spring-cloud-gateway负载普通web项目  
[https://www.cnblogs.com/bener/p/10638814.html][https_www.cnblogs.com_bener_p_10638814.html]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25ldHllYXhp_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200212220904172.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25ldHllYXhp,size_16,color_FFFFFF,t_70
[https_cloud.spring.io_spring-cloud-gateway_reference_html_the-loadbalancerclient-filter]: https://cloud.spring.io/spring-cloud-gateway/reference/html/#the-loadbalancerclient-filter
[https_cloud.spring.io_spring-cloud-static_spring-cloud-netflix_2.2.1.RELEASE_reference_html_spring-cloud-ribbon]: https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.2.1.RELEASE/reference/html/#spring-cloud-ribbon
[https_github.com_Netflix_ribbon_wiki_Working-with-load-balancers_components-of-load-balancer]: https://github.com/Netflix/ribbon/wiki/Working-with-load-balancers#components-of-load-balancer
[https_spring.io_guides_gs_client-side-load-balancing]: https://spring.io/guides/gs/client-side-load-balancing/
[https_www.cnblogs.com_bener_p_10638814.html]: https://www.cnblogs.com/bener/p/10638814.html