Ocelot集成Consul实现api网关与服务发现

本文涉及的产品
云原生 API 网关,700元额度,多规格可选
AI 网关免费试用,2900元额度,限量100份
简介: 本文介绍了如何在.NET微服务架构中集成API网关Ocelot和Consul服务发现。首先通过Docker安装并配置Consul,接着在GoodApi项目中实现服务的自动注册与注销,并配置健康检查。然后,通过修改Ocelot的配置文件`ocelot.json`和`Program.cs`,实现基于Consul的服务发现,确保API请求能够正确路由到后端服务。最后,解决了服务解析时可能出现的问题,确保服务的IP地址而非节点名称被正确解析。

前言

没看dotnet微服务之API网关Ocelot的请先看,这篇文章接上面文章

安装consul

#自定义网络,自定义网络可以指定容器IP,这样服务器重启consul集群也可以正常运行。
docker network create --driver bridge --subnet=172.21.0.0/16 --gateway=172.21.0.16 adnc_consul

docker run -d -p 8500:8500 -p 8600:8600 -p 8301:8301 --restart=always --network=adnc_consul --ip 172.21.0.1 --privileged=true --name=consul_server_1  --name consul consul:1.15.4 agent -server -bootstrap -ui -node=consul_server_1 -client='0.0.0.0'

在GoodApi项目中修改Program.cs

先要添加Consul包

再添加Consul注册于注销等相关代码

using Consul;
using System.Linq;
using System.Net;
using System.Net.Sockets;

// 创建Consul客户端
var consulAddress = "http://10.75.174.43:8500";// Environment.GetEnvironmentVariable("CONSUL_ADDRESS"); //10.75.174.43
var consulUri = new Uri(consulAddress);
var client = new ConsulClient(config =>
{
    config.Address = consulUri;
});

// 配置服务的健康检查
var check = new AgentServiceCheck()
{
    HTTP = $"http://{GetLocalIpAddress("InterNetwork").FirstOrDefault()}:8080/health", // 健康检查地址
    Interval = TimeSpan.FromSeconds(10) // 检查间隔
};
var serviceId = "goodapi-1"; // 要注销的服务的ID
// 注册一个服务
var registration = new AgentServiceRegistration()
{
    ID = serviceId,
    Name = "goodapi",
    Address = GetLocalIpAddress("InterNetwork").FirstOrDefault(),
    Port = 8080,
    Check = check
};

await client.Agent.ServiceDeregister(serviceId);
client.Agent.ServiceRegister(registration);

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// Configure the HTTP request pipeline.
//if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.MapControllers();

app.MapGet("/health", async context =>
{
    context.Response.StatusCode = 200;
    await context.Response.WriteAsync("health");
});

app.Run();

// 注销服务

await client.Agent.ServiceDeregister(serviceId);

List<string> GetLocalIpAddress(string netType)
{
    string hostName = Dns.GetHostName();
    IPAddress[] addresses = Dns.GetHostAddresses(hostName);

    var IPList = new List<string>();
    if (netType == string.Empty)
    {
        for (int i = 0; i < addresses.Length; i++)
        {
            IPList.Add(addresses[i].ToString());
        }
    }
    else
    {
        //AddressFamily.InterNetwork = IPv4,
        //AddressFamily.InterNetworkV6= IPv6
        for (int i = 0; i < addresses.Length; i++)
        {
            if (addresses[i].AddressFamily.ToString() == netType)
            {
                IPList.Add(addresses[i].ToString());
            }
        }
    }
    return IPList;
}

加Dockerfile文件

#使用asp.net 6作为基础镜像,起一个别名为base
FROM mcr.microsoft.com/dotnet/aspnet:8.0 AS base
#设置容器的工作目录为/app
WORKDIR /app
#COPY 文件
COPY . /app
ENV ASPNETCORE_ENVIRONMENT Production

#设置时区为东八区
ENV TZ Asia/Shanghai
#启动服务
ENTRYPOINT ["dotnet", "GoodApi.dll"]
# 运行goodapi项目
docker stop goodapi
docker rm -f goodapi
docker build -t goodapi .
docker run --name=goodapi -d -p 8080:8080 --network=adnc_consul goodapi

在OcelotGA中加consul配置与代码

加包Consul,Ocelot.Provider.Consul

改ocelot.json配置

{
   
  "Routes": [
    {
   
      "UseServiceDiscovery": true,
      "UpstreamPathTemplate": "/good/{everything}",
      "UpstreamHttpMethod": [ "Get" ],
      "DownstreamPathTemplate": "/{everything}",
      "DownstreamScheme": "http",
      "ServiceName": "goodapi",
      "LoadBalancerOptions": {
   
        "Type": "LeastConnection"
      }
    },
    {
   
      "UseServiceDiscovery": true,
      "UpstreamPathTemplate": "/order/{everything}",
      "UpstreamHttpMethod": [ "Get" ],
      "DownstreamPathTemplate": "/{everything}",
      "DownstreamScheme": "http",
      "ServiceName": "orderapi",
      "LoadBalancerOptions": {
   
        "Type": "LeastConnection"
      }
    }
  ],
  "GlobalConfiguration": {
   
    "BaseUrl": "http://gw.wxy.ink",
    "ServiceDiscoveryProvider": {
   
      "Scheme": "http",
      "Host": "10.75.174.43", // 这里是您Consul的地址
      "Port": 8500, // Consul的端口
      "Type": "Consul"
    }
  }
}

修改Program.cs

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Ocelot.DependencyInjection;
using Ocelot.Middleware;
using Ocelot.Provider.Consul;
using System;
using System.Collections.Generic;
using System.Net;

using Consul;
using OcelotGA;

// 创建Consul客户端
var consulAddress = "http://10.75.174.43:8500";// Environment.GetEnvironmentVariable("CONSUL_ADDRESS"); //10.75.174.43
var consulUri = new Uri(consulAddress);
var client = new ConsulClient(config =>
{
   
    config.Address = consulUri;
});

// 配置服务的健康检查
var check = new AgentServiceCheck()
{
   
    HTTP = $"http://{GetLocalIpAddress("InterNetwork").FirstOrDefault()}:8080/health", // 健康检查地址
    Interval = TimeSpan.FromSeconds(10) // 检查间隔
};
var serviceId = "gw-1"; // 要注销的服务的ID
// 注册一个服务
var registration = new AgentServiceRegistration()
{
   
    ID = serviceId,
    Name = "gw",
    Address = GetLocalIpAddress("InterNetwork").FirstOrDefault(),
    Port = 8080,
    //Check = check
};

await client.Agent.ServiceDeregister(serviceId);
client.Agent.ServiceRegister(registration);

var builder = WebApplication.CreateBuilder(args);

builder.Configuration.AddJsonFile("ocelot.json", optional: false, reloadOnChange: true);

builder.Services.AddOcelot().AddConsul<MyConsulServiceBuilder>(); //这里要注意MyConsulServiceBuilder

var app = builder.Build();

app.UseOcelot().Wait();

app.UseRouting();

app.MapGet("/Health", async context =>
{
   
    context.Response.StatusCode = 200;
    await context.Response.WriteAsync("Health");
});

app.Run();

// 注销服务

await client.Agent.ServiceDeregister(serviceId);

List<string> GetLocalIpAddress(string netType)
{
   
    string hostName = Dns.GetHostName();
    IPAddress[] addresses = Dns.GetHostAddresses(hostName);

    var IPList = new List<string>();
    if (netType == string.Empty)
    {
   
        for (int i = 0; i < addresses.Length; i++)
        {
   
            IPList.Add(addresses[i].ToString());
        }
    }
    else
    {
   
        //AddressFamily.InterNetwork = IPv4,
        //AddressFamily.InterNetworkV6= IPv6
        for (int i = 0; i < addresses.Length; i++)
        {
   
            if (addresses[i].AddressFamily.ToString() == netType)
            {
   
                IPList.Add(addresses[i].ToString());
            }
        }
    }
    return IPList;
}

添加MyConsulServiceBuilder.cs

using Consul;
using Ocelot.Logging;
using Ocelot.Provider.Consul;
using Ocelot.Provider.Consul.Interfaces;

namespace OcelotGA
{
   
    public class MyConsulServiceBuilder : DefaultConsulServiceBuilder
    {
   
        public MyConsulServiceBuilder(IHttpContextAccessor contextAccessor, IConsulClientFactory clientFactory, IOcelotLoggerFactory loggerFactory)
            : base(contextAccessor, clientFactory, loggerFactory) {
    }

        // I want to use the agent service IP address as the downstream hostname
        protected override string GetDownstreamHost(ServiceEntry entry, Node node)
            => entry.Service.Address;
    }
}

运行网关项目

我们访问gw.wxy.ink/good/health

爬坑记录

Program.cs中的

builder.Services.AddOcelot().AddConsul<MyConsulServiceBuilder>(); //这里要注意MyConsulServiceBuilder
若为
builder.Services.AddOcelot().AddConsul();

则会出现下面问题

服务解析出来是node的名称,而非服务的IP

解决方法:Service Discovery — Ocelot Gateway 23.4 documentation

就是说默认的DefaultConsulServiceBuilder会这样处理

protected virtual string GetDownstreamHost(ServiceEntry entry, Node node)
    => node != null ? node.Name : entry.Service.Address;

而我们需要的是

protected override string GetDownstreamHost(ServiceEntry entry, Node node)
        => entry.Service.Address;

作者

吴晓阳(手机:13736969112微信同号)

目录
相关文章
|
3月前
|
监控 前端开发 安全
如何集成第三方支付API到电商网站
在电商网站中,集成第三方支付API是确保交易安全、提升用户体验的关键步骤。本文详细介绍了从选择支付提供商到上线监控的全流程,涵盖代码示例与实用建议,助您高效实现支付功能。
130 0
|
6月前
|
人工智能 API 开发工具
GitHub官方开源MCP服务!GitHub MCP Server:无缝集成GitHub API,实现Git流程完全自动化
GitHub MCP Server是基于Model Context Protocol的服务器工具,提供与GitHub API的无缝集成,支持自动化处理问题、Pull Request和仓库管理等功能。
1140 2
GitHub官方开源MCP服务!GitHub MCP Server:无缝集成GitHub API,实现Git流程完全自动化
|
8月前
|
SQL 人工智能 关系型数据库
Flink CDC YAML:面向数据集成的 API 设计
本文整理自阿里云智能集团 Flink PMC Member & Committer 徐榜江(雪尽)在 FFA 2024 分论坛的分享,涵盖四大主题:Flink CDC、YAML API、Transform + AI 和 Community。文章详细介绍了 Flink CDC 的发展历程及其优势,特别是 YAML API 的设计与实现,以及如何通过 Transform 和 AI 模型集成提升数据处理能力。最后,分享了社区动态和未来规划,欢迎更多开发者加入开源社区,共同推动 Flink CDC 的发展。
640 12
Flink CDC YAML:面向数据集成的 API 设计
|
7月前
|
SQL 人工智能 关系型数据库
Flink CDC YAML:面向数据集成的 API 设计
Flink CDC YAML:面向数据集成的 API 设计
212 5
|
9月前
|
人工智能 自然语言处理 API
百聆:集成Deepseek API及语音技术的开源AI语音对话助手,实时交互延迟低至800ms
百聆是一款开源的AI语音对话助手,结合ASR、VAD、LLM和TTS技术,提供低延迟、高质量的语音对话体验,适用于边缘设备和低资源环境。
2708 5
百聆:集成Deepseek API及语音技术的开源AI语音对话助手,实时交互延迟低至800ms
|
9月前
|
人工智能 JSON 安全
DeepSeek Engineer:集成 DeepSeek API 的开源 AI 编程助手,支持文件读取、编辑并生成结构化响应
DeepSeek Engineer 是一款开源AI编程助手,通过命令行界面处理用户对话并生成结构化JSON,支持文件操作和代码生成。
1236 6
DeepSeek Engineer:集成 DeepSeek API 的开源 AI 编程助手,支持文件读取、编辑并生成结构化响应
|
11月前
|
负载均衡 监控 API
dotnet微服务之API网关Ocelot
Ocelot 是一个基于 .NET 的 API 网关,适用于微服务架构。本文介绍了如何创建一个 Web API 项目并使用 Ocelot 进行 API 请求路由、负载均衡等。通过配置 `ocelot.json` 和修改 `Program.cs`,实现对 `GoodApi` 和 `OrderApi` 两个项目的路由管理。最终,通过访问 `https://localhost:7122/good/Hello` 和 `https://localhost:7122/order/Hello` 验证配置成功。
186 1
dotnet微服务之API网关Ocelot
|
12月前
|
IDE API 开发工具
沉浸式集成阿里云 OpenAPI|Alibaba Cloud API Toolkit for VS Code
Alibaba Cloud API Toolkit for VSCode 是集成了 OpenAPI 开发者门户多项功能的 VSCode 插件,开发者可以通过这个插件方便地查找API文档、进行API调试、插入SDK代码,并配置基础环境设置。我们的目标是缩短开发者在门户和IDE之间的频繁切换,实现API信息和开发流程的无缝结合,让开发者的工作变得更加高效和紧密。
沉浸式集成阿里云 OpenAPI|Alibaba Cloud API Toolkit for VS Code
|
12月前
|
开发框架 .NET API
Windows Forms应用程序中集成一个ASP.NET API服务
Windows Forms应用程序中集成一个ASP.NET API服务
204 9
|
12月前
|
存储 数据可视化 JavaScript
可视化集成API接口请求+变量绑定+源码输出
可视化集成API接口请求+变量绑定+源码输出
272 4