.net 3.1完成Consul注册

末蓝、 2022-12-21 00:45 134阅读 0赞

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1JhaW55TGlu_size_16_color_FFFFFF_t_70][]

PMC安装:Install-Package Consul

ConsulRegister.cs

using System;
    
    namespace ClientConfig
    {   
            public class ConsulRegister
            {
                /// <summary>
                /// Consul服务注册地址
                /// </summary>
                public string ConsulAddress { get; set; }
                /// <summary>
                /// 当前服务名称，可以多个实例共享
                /// </summary>
                public string ServiceName { get; set; }
                /// <summary>
                /// 当前服务地址[可选，如果Consul帮助类中能获取到，这里可以不配置]
                /// </summary>
                public string ServiceUriHost { get; set; }
                /// <summary>
                /// 当前服务端口号[可选，如果Consul帮助类中能获取到，这里可以不配置]
                /// </summary>
                public string ServiceUriPort { get; set; }
                /// <summary>
                /// 健康检查的地址，当前服务公布出来的一个api接口
                /// </summary>
                public string HealthCheck { get; set; }
            }    
    }

using System;
    using System.Collections.Generic;
    using System.Text;
    
    namespace ClientConfig
    {
        using Consul;
        //using ConsulClientExtension.config;
        using Microsoft.AspNetCore.Builder;
        using Microsoft.AspNetCore.Hosting.Server.Features;
        using Microsoft.AspNetCore.Http.Features;
        using Microsoft.Extensions.Configuration;
        using Microsoft.Extensions.DependencyInjection;
        using Microsoft.Extensions.Hosting;
        using Microsoft.Extensions.Options;
        using System;
        using System.Linq;
    
            /// <summary>
            /// 服务注册
            /// </summary>
            public static class Register
            {
                public static void AddConsul(this IServiceCollection service)
                {
                    //读取服务配置文件
                    try
                    {
                        var config = new ConfigurationBuilder().AddJsonFile("consulconfig.json").Build();
                        service.Configure<ConsulRegister>(config);
                    }
                    catch
                    {
                        throw new Exception("请正确配置consulconfig.json");
                    }
                }
    
                public static IApplicationBuilder UserConsul(this IApplicationBuilder app)
                {
                    //获取服务配置项
                    var serviceOptions = app.ApplicationServices.GetRequiredService<IOptions<ConsulRegister>>().Value;
                    CheckConfig(serviceOptions);
    
                    Tuple<string, string, int> hostinfo = GetHostInfo(serviceOptions, app);
                    // 服务ID，唯一的
                    string serviceId = serviceOptions.ServiceName + Guid.NewGuid().ToString();
                    //节点服务注册对象
                    var registration = new AgentServiceRegistration()
                    {
                        ID = serviceId,
                        Name = serviceOptions.ServiceName,  //对服务分组
                        Address = hostinfo.Item2, //服务地址
                        Port = hostinfo.Item3,
                        Tags = new string[] { }, //标签信息，服务发现的时候可以获取到的，负载均衡策略扩展的
                        Check = new AgentServiceCheck()
                        {
                            DeregisterCriticalServiceAfter = TimeSpan.FromSeconds(7),  //在7秒未连接上服务之后注销关键服务
                            Interval = TimeSpan.FromSeconds(2), //每个2秒发送一次心跳检测
                            Timeout = TimeSpan.FromSeconds(3),  //连接超时时间
                            HTTP = hostinfo.Item1 //   //心跳检测访问的接口地址，需要自己在项目中写好这个接口
                        }
                    };
                    var consulClient = new ConsulClient(configuration =>
                    {
                        //服务注册地址：集群中任意一个地址
                        configuration.Address = new Uri(serviceOptions.ConsulAddress);
                    });
                    //注册到consul
                    consulClient.Agent.ServiceRegister(registration).Wait();
    
                    //获取主机生命周期管理接口
                    var lifetime = app.ApplicationServices.GetRequiredService<IHostApplicationLifetime>();
                    //程序停止的时候取消注册
                    lifetime.ApplicationStopping.Register(() =>
                    {
                        consulClient.Agent.ServiceDeregister(serviceId).Wait();
                    });
    
                    return app;
                }
    
    
                /// <summary>
                /// 获取当前主机的域名和端口
                /// 用IIS启动获取不到。如果获取不到必须保证配置文件配了
                /// 启动的时候指定--Urls才可以获取到；例如 ：dotnet Service_One.dll --Urls "https://localhost:5002"
                /// </summary>
                /// <param name="serviceOptions"></param>
                /// <param name="app"></param>
                /// <returns>
                /// 第一个返回值：健康检查地址（例如：http://127.0.0.1:5001/healthcheck）
                /// 第二个返回值：主机地址(例如：127.0.0.1)
                /// 第三个返回值：端口号(例如：80)
                /// </returns>
                private static Tuple<string, string, int> GetHostInfo(ConsulRegister serviceOptions, IApplicationBuilder app)
                {
                    #region 
                    var features = app.Properties["server.Features"] as FeatureCollection;
                    var address = features.Get<IServerAddressesFeature>().Addresses.FirstOrDefault();
                    string http = null, host = null;
                    int port = 0;
                    if (!string.IsNullOrEmpty(address))
                    {
                        var uri = new Uri(address);// 协议头：uri.Sechema  主机：uri.Host  端口：uri.Port 
                        http = address + serviceOptions.HealthCheck;
                        host = uri.Host;
                        port = uri.Port;
                    }
                    else
                    {
                        http = $"{serviceOptions.ServiceUriHost}:{serviceOptions.ServiceUriPort}{serviceOptions.HealthCheck}";
                        host = serviceOptions.ServiceUriHost;
                        port = Convert.ToInt32(serviceOptions.ServiceUriPort);
                    }
                    if (string.IsNullOrEmpty(host) || port < 1)
                        throw new Exception("Consul配置未能获取到主机信息，请在consulconfig.json文件中配置");
                    Console.WriteLine("健康检查地址：" + http);
                    return Tuple.Create(http, host, port);
                    #endregion
                }
    
                /// <summary>
                /// 检查配置文件
                /// </summary>
                /// <param name="serviceOptions"></param>
                private static void CheckConfig(ConsulRegister serviceOptions)
                {
                    if (serviceOptions == null)
                        throw new Exception("请正确配置consulconfig.json,其中包含ConsulAddress、ServiceName、HealthCheck");
    
                    if (string.IsNullOrEmpty(serviceOptions.ConsulAddress))
                        throw new Exception("请正确配置ConsulAddress");
    
                    if (string.IsNullOrEmpty(serviceOptions.ServiceName))
                        throw new Exception("请正确配置ServiceName");
    
                    if (string.IsNullOrEmpty(serviceOptions.HealthCheck))
                        throw new Exception("请正确配置HealthCheck");
    
                }
            }
        }

consultconfig.json:

{
      "ConsulAddress": "http://127.0.0.1:8500", //Consul服务注册地址
      "ServiceName": "Serivce_One", //当前服务名称，可以多个实例共享
      "ServiceUriHost": "https://localhost", //当前服务地址
      "ServiceUriPort": "44323", //当前服务地址
      "HealthCheck": "/api/health/check" //健康检查的地址，当前服务公布出来的一个api接口
    }

Startup.cs

using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Threading.Tasks;
    using Microsoft.AspNetCore.Builder;
    using Microsoft.AspNetCore.Hosting;
    using Microsoft.AspNetCore.Mvc;
    using Microsoft.Extensions.Configuration;
    using Microsoft.Extensions.DependencyInjection;
    using Microsoft.Extensions.Hosting;
    using Microsoft.Extensions.Logging;
    
    using ClientConfig;
    using Microsoft.Extensions.Options;
    
    namespace Service_One
    {
        public class Startup
        {
            public Startup(IConfiguration configuration)
            {
                Configuration = configuration;
            }
    
            public IConfiguration Configuration { get; }
    
            // This method gets called by the runtime. Use this method to add services to the container.
            public void ConfigureServices(IServiceCollection services)
            {
                services.AddControllers();
    
                services.AddHealthChecks();
                services.AddConsul();
            }
    
            // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
            public void Configure(IApplicationBuilder app, IWebHostEnvironment env,IOptions<ConsulRegister> serviceOptions)
            {
    
                app.UseHealthChecks(serviceOptions.Value.HealthCheck);
                app.UserConsul();
    
                if (env.IsDevelopment())
                {
                    app.UseDeveloperExceptionPage();
                }
    
                app.UseRouting();
    
                app.UseAuthorization();
    
                app.UseEndpoints(endpoints =>
                {
                    endpoints.MapControllers();
                });
            }
        }
    }

HealthController.cs:

using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Threading.Tasks;
    using Microsoft.AspNetCore.Mvc;
    
    // For more information on enabling Web API for empty projects, visit https://go.microsoft.com/fwlink/?LinkID=397860
    
    namespace Service_One.Controllers
    {
        [Route("api/[controller]")]
        [ApiController]
        public class HealthController : ControllerBase
        {
            // GET: api/<HealthController>
            [HttpGet]
            public IActionResult check()
            {
                Console.WriteLine("check");
                return Ok("check");
            }
    
            // GET api/<HealthController>/5
            [HttpGet("{id}")]
            public string Get(int id)
            {
                return "value";
            }
    
            // POST api/<HealthController>
            [HttpPost]
            public void Post([FromBody] string value)
            {
            }
    
            // PUT api/<HealthController>/5
            [HttpPut("{id}")]
            public void Put(int id, [FromBody] string value)
            {
            }
    
            // DELETE api/<HealthController>/5
            [HttpDelete("{id}")]
            public void Delete(int id)
            {
            }
        }
    }

**开启两个Service\_One服务**

dotnet Service\_One.dll --Urls "https://localhost:5001"

dotnet Service\_One.dll --Urls "https://localhost:5002"

![78fbdb1e89c85152104573da8c89e9e3.png][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1JhaW55TGlu_size_16_color_FFFFFF_t_70]: /images/20221120/9a5896ac7c6c4aa6905a2712f382a11b.png
[78fbdb1e89c85152104573da8c89e9e3.png]: /images/20221120/4ac432d080b5454b84f01a2beb8e32cb.png