.NET服务发现(Microsoft.Extensions.ServiceDiscovery)集成Consul

用户军魂

随着Aspire发布preview5的发布,Microsoft.Extensions.ServiceDiscovery随之更新,
服务注册发现这个属于老掉牙的话题解决什么问题就不赘述了,这里主要讲讲Microsoft.Extensions.ServiceDiscovery(preview5)以及如何扩展其他的中间件的发现集成 .
Microsoft.Extensions.ServiceDiscovery官方默认提供的Config,DNS,YARP三种Provider,使用也比较简单 :

1. builder.Services.AddServiceDiscovery();
3. builder.Services.AddHttpClient<CatalogServiceClient>(static client =>
4.     {
5.         client.BaseAddress = new("http://todo");
6.     });
8. builder.Services.ConfigureHttpClientDefaults(static http =>
9. {
10.     // 全局对HttpClient启用服务发现
11.     http.UseServiceDiscovery();
12. });

复制代码

然后 appsettings.json 为名为 todo 的服务配置终结点：

1.   "Services": {
2.     "todo": {
3.       "http": [
4.         "http://localhost:5124"
5.       ]
6.     }
7.   }

复制代码

然后使用服务发现:

1. #region 模拟服务端的todo接口:
2. var sampleTodos = new Todo[] {
3.     new(1, "Walk the dog"),
4.     new(2, "Do the dishes", DateOnly.FromDateTime(DateTime.Now)),
5.     new(3, "Do the laundry", DateOnly.FromDateTime(DateTime.Now.AddDays(1))),
6.     new(4, "Clean the bathroom"),
7.     new(5, "Clean the car", DateOnly.FromDateTime(DateTime.Now.AddDays(2)))
8. };
10. var todosApi = app.MapGroup("/todos");
11. todosApi.MapGet("/", () => sampleTodos);
12. todosApi.MapGet("/{id}", (int id) =>
13.     sampleTodos.FirstOrDefault(a => a.Id == id) is { } todo
14.         ? Results.Ok(todo)
15.         : Results.NotFound());
16. #endregion
18. public record Todo(int Id, string? Title, DateOnly? DueBy = null, bool IsComplete = false);
20. [JsonSerializable(typeof(Todo[]))]
21. internal partial class AppJsonSerializerContext : JsonSerializerContext
22. {
23. }
25. #region 测试服务发现和负载
27. app.MapGet("/test", async (IHttpClientFactory clientFactory) =>
28. {
29.     //这里服务发现将自动解析配置文件中的服务
30.     var client = clientFactory.CreateClient("todo");
31.     var response = await client.GetAsync("/todos");
32.     var todos = await response.Content.ReadAsStringAsync();
33.     return Results.Content(todos, contentType: "application/json");
34. });
36. #endregion

复制代码

运行程序后将会发现成功执行:

当然对于这样写死配置的服务发现一点都不灵活,因此应运而生了 YARP和DNS这些Provider, 目前服务注册发现使用Consul的还是挺多的,当然还有很多其他的轮子就不赘述了,这里我们来扩展一个Consul的服务发现Provider :
实现核心接口IServiceEndPointProvider

1. internal class ConsulServiceEndPointProvider(ServiceEndPointQuery query, IConsulClient consulClient, ILogger logger)
2.         : IServiceEndPointProvider, IHostNameFeature
3.     {
4.         const string Name = "Consul";
5.         private readonly string _serviceName = query.ServiceName;
6.         private readonly IConsulClient _consulClient = consulClient;
7.         private readonly ILogger _logger = logger;
9.         public string HostName => query.ServiceName;
11. #pragma warning disable CA1816 // Dispose 方法应调用 SuppressFinalize
12.         public ValueTask DisposeAsync() => default;
14.         public async ValueTask PopulateAsync(IServiceEndPointBuilder endPoints, CancellationToken cancellationToken)
15.         {
16.             var flag = ServiceNameParts.TryParse(_serviceName, out var serviceNameParts);
17.             var sum = 0;
18.             if (flag)
19.             {
20.                 var queryResult = await _consulClient.Health.Service(serviceNameParts.Host, string.Empty, true, cancellationToken);
21.                 foreach (var serviceEntry in queryResult.Response)
22.                 {
23.                     var address = $"{serviceEntry.Service.Address}:{serviceEntry.Service.Port}";
24.                     var isEndpoint = ServiceNameParts.TryCreateEndPoint(address, out var endPoint);
25.                     if (isEndpoint)
26.                     {
27.                         ++sum;
28.                         var serviceEndPoint = ServiceEndPoint.Create(endPoint!);
29.                         serviceEndPoint.Features.Set<IServiceEndPointProvider>(this);
30.                         serviceEndPoint.Features.Set<IHostNameFeature>(this);
31.                         endPoints.EndPoints.Add(serviceEndPoint);
32.                         _logger.LogInformation($"ConsulServiceEndPointProvider Found Service {_serviceName}:{address}");
33.                     }
34.                 }
35.             }
37.             if (sum == 0)
38.             {
39.                 _logger.LogWarning($"No ConsulServiceEndPointProvider were found for service '{_serviceName}' ('{HostName}').");
40.             }
41.         }
43.         /// <inheritdoc/>
44.         public override string ToString() => Name;
45.     }

复制代码

实现 IServiceEndPointProviderFactory:

1. internal class ConsulServiceEndPointProviderFactory(IConsulClient consulClient, ILogger<ConsulServiceEndPointProviderFactory> logger) : IServiceEndPointProviderFactory
2.     {
3.         private readonly IConsulClient _consulClient = consulClient;
4.         private readonly ILogger<ConsulServiceEndPointProviderFactory> _logger = logger;
6.         public bool TryCreateProvider(ServiceEndPointQuery query, [NotNullWhen(true)] out IServiceEndPointProvider? resolver)
7.         {
8.             resolver = new ConsulServiceEndPointProvider(query, _consulClient, _logger);
9.             return true;
10.         }
11.     }

复制代码

接着扩展一下IServiceCollection

1. public static IServiceCollection AddConsulServiceEndpointProvider(this IServiceCollection services)
2. {
3.         services.AddServiceDiscoveryCore();
4.         services.AddSingleton<IServiceEndPointProviderFactory, ConsulServiceEndPointProviderFactory>();
5.         return services;
6. }

复制代码

最后添加一行代码 :

1. // 使用Microsoft.Extensions.ServiceDiscovery实现负载均衡
2. builder.Services.AddServiceDiscovery()
3.     .AddConfigurationServiceEndPointResolver() //config
4.     .AddConsulServiceEndpointProvider(); //consul

复制代码

下面是Consul中注册完成的服务:

然后我们请求 ./test 调用服务,观察调试日志,成功了!

完整的代码:
https://github.com/vipwan/Biwen.Microsoft.Extensions.ServiceDiscovery.Consul
当然你也可以直接使用nuget引用 Biwen.Microsoft.Extensions.ServiceDiscovery.Consul 我已经发布到了nuget上 , 最后因为Aspire还在不停的迭代所以Biwen.Microsoft.Extensions.ServiceDiscovery.Consul后面还会存在一些变化, 前面的几个早期版本我都做了适配以最新的为准

来源:https://www.cnblogs.com/vipwan/p/18129361
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！