基于Zuul与Eureka元数据过滤服务 如何排除Ribbon调用的master实例

Spring Cloud Ribbon原生提供了ServerListFilter扩展点，可以自定义逻辑过滤从Eureka拉取到的服务实例，具体实现步骤如下：

1. 标记master节点 #

首先要让过滤逻辑能识别master实例，推荐通过Eureka元数据打标记，在master节点的application.yml/application.properties中添加配置：

eureka:
  instance:
    metadata-map:
      node-type: master # 普通节点可以不配该字段，或者配置为normal

如果是容器部署，也可以直接通过环境变量EUREKA_INSTANCE_METADATA_MAP_NODE_TYPE=master注入标记，无需修改代码重新打包。

2. 自定义过滤规则 #

实现Ribbon的服务列表过滤器，剔除标记为master的实例：

import com.netflix.loadbalancer.Server;
import com.netflix.loadbalancer.ZoneAffinityServerListFilter;
import org.springframework.cloud.netflix.ribbon.EurekaServerIntrospector;
import javax.annotation.Resource;
import java.util.List;
import java.util.stream.Collectors;

public class MasterNodeExcludeFilter extends ZoneAffinityServerListFilter<Server> {

    @Resource
    private EurekaServerIntrospector eurekaServerIntrospector;

    @Override
    public List<Server> getFilteredListOfServers(List<Server> servers) {
        // 先执行Ribbon默认的区域亲和性过滤
        List<Server> defaultFilteredServers = super.getFilteredListOfServers(servers);
        // 剔除master节点
        return defaultFilteredServers.stream()
                .filter(server -> {
                    String nodeType = eurekaServerIntrospector.getMetadata(server).get("node-type");
                    return !"master".equals(nodeType);
                })
                .collect(Collectors.toList());
    }
}

如果master节点有固定的IP、hostname或者实例ID特征，也可以直接在filter中匹配对应特征过滤，无需给节点打元数据。

3. 注册过滤器生效 #

根据你的需求选择生效范围：

• 全局生效：对所有服务的Ribbon请求都过滤master节点，直接将过滤器注册为Spring Bean即可

@Configuration
public class GlobalRibbonConfig {
    @Bean
    public ServerListFilter<Server> masterNodeExcludeFilter() {
        return new MasterNodeExcludeFilter();
    }
}

• 指定服务生效：仅过滤存在master节点的目标服务，其他服务不受影响

// 启动类或全局配置类上加该注解，name替换为你的目标服务的serviceId
@Configuration
@RibbonClient(name = "target-service-id", configuration = CustomRibbonConfig.class)
public class TargetServiceRibbonConfig {
}

// 自定义Ribbon配置类，不要加@Configuration注解，避免被Spring全局扫描到
public class CustomRibbonConfig {
    @Bean
    public ServerListFilter<Server> masterNodeExcludeFilter() {
        return new MasterNodeExcludeFilter();
    }
}

配置完成后重启Zuul网关即可生效，可通过Zuul转发日志或者业务节点的访问日志验证请求不会落到master节点。

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