.net core Consul 做服务发现

.Net Core Consul服务发现

流程概述

本文将介绍如何在.Net Core项目中使用Consul作为服务发现的工具。Consul是一个开源的服务网格解决方案，可以用于服务发现、配置和分布式一致性。下面是整个流程的概述：

步骤 描述 步骤 1 安装和配置Consul 步骤 2 创建.Net Core项目 步骤 3 添加NuGet包依赖 步骤 4 配置Consul选项 步骤 5 实现服务发现功能

步骤详解

步骤 1：安装和配置Consul

首先，你需要安装和配置Consul。你可以从Consul的官方网站（

步骤 2：创建.Net Core项目

在Visual Studio或者你喜欢的IDE中创建一个新的.Net Core项目。可以使用dotnet new命令行工具或者IDE提供的模板来创建项目。

步骤 3：添加NuGet包依赖

在你的.Net Core项目中，你需要添加一些NuGet包依赖来与Consul进行交互。在项目的.csproj文件中添加以下依赖项：

<ItemGroup>
    <PackageReference Include="Consul" Version="0.7.2" />
</ItemGroup>

这里我们使用Consul的0.7.2版本作为示例。

步骤 4：配置Consul选项

在appsettings.json或者appsettings.Development.json中添加Consul的配置选项：

"Consul": {
    "ServiceName": "YourServiceName",
    "ConsulAddress": "http://localhost:8500"
}

• ServiceName是你的服务名称，你可以根据自己的项目来设置；
• ConsulAddress是Consul服务器的地址，这里使用的是本地地址。

同时，在Startup.cs文件中添加Consul的配置：

using Microsoft.Extensions.DependencyInjection;
using Consul;

public void ConfigureServices(IServiceCollection services)
{
    // ...

    services.AddSingleton<IConsulClient>(p => new ConsulClient(consulConfig =>
    {
        var address = Configuration.GetSection("Consul:ConsulAddress").Value;
        consulConfig.Address = new Uri(address);
    }));

    services.AddSingleton<IHostedService, ConsulHostedService>();
}

这里我们使用IConsulClient来与Consul进行交互，并将其注册到依赖注入容器中。

步骤 5：实现服务发现功能

最后，我们需要在启动过程中注册服务到Consul，并在需要使用服务的地方进行服务发现。

首先，在ConsulHostedService.cs文件中实现Consul的注册逻辑：

using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;
using Consul;

public class ConsulHostedService : IHostedService
{
    private readonly IConsulClient _consulClient;
    private readonly IWebHostEnvironment _env;
    private readonly string _serviceName;

    public ConsulHostedService(IConsulClient consulClient, IWebHostEnvironment env, IConfiguration configuration)
    {
        _consulClient = consulClient;
        _env = env;
        _serviceName = configuration.GetSection("Consul:ServiceName").Value;
    }

    public async Task StartAsync(CancellationToken cancellationToken)
    {
        if (!_env.IsDevelopment())
        {
            var serviceId = $"{_serviceName}-{Guid.NewGuid()}";
            var serviceAddress = _env.ContentRootAddress();

            var registration = new AgentServiceRegistration()
            {
                ID = serviceId,
                Name = _serviceName,
                Address = serviceAddress,
                Port = _env.GetWebServerPort(),
                Tags = new string[] { "api" },
                Check = new AgentServiceCheck()
                {
                    HTTP = $"{serviceAddress}/health",
                    Interval = TimeSpan.FromSeconds(10),
                    Timeout = TimeSpan.FromSeconds(5),
                    DeregisterCriticalServiceAfter = TimeSpan.FromSeconds(60),
                }
            };

            await _consulClient.Agent.ServiceRegister(registration, cancellationToken);
        }
    }

    public async Task StopAsync(CancellationToken cancellationToken)
    {
        if (!_env.IsDevelopment())
        {
            var serviceId = $"{_serviceName}-{Guid.NewGuid()}";
            await _consulClient.Agent.ServiceDeregister(serviceId, cancellationToken);
        }
    }
}

上述代码中，我们