自定义负载均衡策略

本文介绍如何对 org.apache.shenyu.loadbalancer.spi.LoadBalancer 进行自定义扩展。

  • 新建一个工程，引入如下依赖：
  1. <dependencies>
  2.     <dependency>
  3.         <groupId>org.apache.shenyu</groupId>
  4.         <artifactId>shenyu-plugin-base</artifactId>
  5.         <version>${project.version}</version>
  6.     </dependency>
  7. </dependencies>
  • 新增一个类 CustomLoadBalancer，继承org.apache.shenyu.loadbalancer.spi.AbstractLoadBalancer。
  1. public class CustomLoadBalancer extends AbstractLoadBalancer {
  4.     @Override
  5.     public Upstream doSelect(final List<Upstream> upstreamList, final String ip) {
  6.         // 自定义负载均衡实现逻辑
  7.     }
  8. }
  • 在工程的META-INF/services目录创建 org.apache.shenyu.loadbalancer.spi.LoadBalancer文件中添加如下内容：
  1. ${spi name}=${custom class path}

${spi name}表示spi的名称，${custom class path}表示该类的全限定名。比如：

  1. custom=xxx.xxx.xxx.CustomLoadBalancer

  • 将工程打包，拷贝到网关 (bootstrap-bin) 的 lib 或 ext-lib 目录。

  • 在Apache ShenYu网关管理系统 —> 基础配置 —> 字典管理， 找到字典编码为 LOAD_BALANCE，新增一条数据，注意字典名称要为: ${spi name}，图中的示例是custom。

自定义负载均衡策略 - 图1

字典类型：loadBalance；

字典编码：LOAD_BALANCE；

字典名称：${spi name}，填写自定义spi的名称；

字典值：使用时，下拉框的值，不要和现有的重复；

字典描述或备注信息：描述信息；

排序： 排序；

  • 在添加选择器或规则时，就可以使用自定义的匹配方式：

自定义负载均衡策略 - 图2