Ocelot Kubernetes服务发现支持多端口选择的设计与实现

背景介绍

在现代微服务架构中，API网关作为系统入口承担着重要角色。Ocelot作为一款轻量级.NET API网关，其Kubernetes服务发现功能在云原生环境中发挥着关键作用。然而，当Kubernetes服务暴露多个端口时（如同时提供HTTP和HTTPS服务），原有实现存在端口选择不灵活的问题。

问题分析

Kubernetes服务端点(Endpoint)可以定义多个端口，例如：

• HTTP服务使用80端口
• HTTPS服务使用443端口

在Ocelot原有实现中，Kubernetes服务发现提供程序(Kube类)会简单地选择端点定义中的第一个端口作为服务端口。这种硬编码方式导致以下问题：

1. 无法根据实际需求选择特定协议端口
2. 当配置DownstreamScheme为http时，仍可能错误地选择https端口
3. 缺乏灵活性，无法适应复杂部署场景

技术实现方案

架构重构

通过依赖注入和接口隔离原则重构原有实现，主要改进点包括：

1. 引入IKubeServiceBuilder接口

public interface IKubeServiceBuilder
{
    IEnumerable<Service> BuildServices(EndpointsV1 endpoint);
}

2. 将端口选择逻辑解耦到独立服务中

private readonly IKubeServiceBuilder _serviceBuilder;

public Kube(
    KubeRegistryConfiguration config, 
    IOcelotLoggerFactory factory, 
    IKubeApiClient kubeApi,
    IKubeServiceBuilder serviceBuilder)
{
    _serviceBuilder = serviceBuilder;
    // 其他初始化...
}

3. 实现灵活的服务构建逻辑

public async Task<List<Service>> GetAsync()
{
    if (endpoint != null && endpoint.Subsets.Any())
    {
        services.AddRange(_serviceBuilder.BuildServices(endpoint));
    }
    return services;
}

端口选择策略

新实现支持多种端口选择策略：

1. 默认策略：保持向后兼容，选择第一个端口
2. 协议匹配策略：根据DownstreamScheme自动匹配对应端口
3. 名称匹配策略：通过端口名称(如"http"/"https")精确选择
4. 自定义策略：用户可实现自己的IKubeServiceBuilder

使用指南

基础配置

在ocelot.json中配置服务发现：

{
  "DownstreamPathTemplate": "/{url}",
  "DownstreamScheme": "http",
  "UpstreamPathTemplate": "/api/example/{url}",
  "ServiceName": "example-web",
  "UpstreamHttpMethod": ["Get"]
}

高级配置

1. 显式指定端口名称：

{
  "ServiceDiscoveryProvider": {
    "Type": "Kubernetes",
    "PortName": "http" // 指定使用名为http的端口
  }
}

2. 自定义服务构建逻辑：

services.AddSingleton<IKubeServiceBuilder, CustomKubeServiceBuilder>();

最佳实践

1. 在Kubernetes服务定义中明确命名端口：

ports:
- name: http
  port: 80
  protocol: TCP
- name: https
  port: 443
  protocol: TCP

2. 生产环境建议：

• 为HTTP和HTTPS服务创建独立的Kubernetes服务
• 使用服务网格(如Istio)处理协议转换
• 考虑使用Ingress控制器处理TLS终止

3. 性能考量：

• 避免在服务构建逻辑中加入复杂计算
• 考虑实现缓存机制减少Kubernetes API调用

总结

Ocelot对Kubernetes多端口服务的支持增强，使得在云原生环境中部署API网关更加灵活可靠。通过接口抽象和策略模式，开发者可以根据实际需求定制端口选择逻辑，同时保持了与现有配置的兼容性。这一改进特别适合需要同时暴露多种协议端口的复杂微服务场景。