• gomicro使用Consul做服务发现的方法和原理


    go-micro v4默认使用mdns做服务发现。不过也支持采用其它的服务发现中间件,因为多年来一直使用Consul做服务发现,为了方便和其它服务集成,所以还是选择了Consul。这篇文章将介绍go-micro使用Consul做服务发现的方法。关于Consul的使用方式请参考我的另一篇文章:使用Consul做服务发现的若干姿势

    安装Consul

    如果你已经安装Consul,或者对Consul很熟悉了,按照自己的方式处理Consul就行了。

    这里提供一个通过docker快速安装Consul的方式,当然前提是你得安装了docker。

    执行命令:

    docker run --name consul1 -p 8500:8500 -p 8300:8300 -p 8301:8301 -p 8302:8302  -d consul:latest
    

    这会在docker容器中启动一个最新版本的Consul服务,并将相关端口开放给主机。

    安装Consul插件

    使用Consul作为服务注册和服务发现,需要先安装go-micro的consul插件:

    go get github.com/go-micro/plugins/v4/registry/consul
    

    服务端使用Consul

    服务注册

    为了使用Consul做服务注册,需要为go-micro server显式的指定Consul Registry。直接看代码吧:

    func main() {
    
    	registry := consul.NewRegistry()
    
    	rpcServer := server.NewServer(
    		server.Name("registry-consul.service"),
    		server.Address("0.0.0.0:8001"),
    		server.Registry(registry),
    	)
    
    	proto.RegisterHelloHandler(rpcServer, &Hello{})
    
    	service := micro.NewService(
    		micro.Server(rpcServer),
    	)
    
    	service.Init()
    
    	// Run server
    	if err := service.Run(); err != nil {
    		log.Fatal(err)
    	}
    }
    

    通过 consul.NewRegistry() 创建一个Consul 注册中心,然后使用 server.NewServer 创建Server的时候把它设置进去;同时我们需要指定服务的名称,这里设置的是 registry-consul.service;另外这里不使用随机端口,指定了一个服务的监听地址。这样基本就OK了。

    img

    这里并没有指定Consul的连接地址,因为按照推荐的Consul部署方式,服务所在机器或者容器中应该部署一个Consul的客户端,程序可以直接通过 127.0.0.1:8500 访问到它。如果要显示指定,可以在NewRegistry时设置:

    	registry := consul.NewRegistry(
    		registry.Addrs("127.0.0.1:8500"),
    	)
    

    注册过程

    通过一张图来看一下,go-micro注册服务到Consul时都做了什么。

    img

    服务注册关键是实现两个动作:

    1、注册: rpcServer启动的时候,会调用到自身的Register方法,Register方法会调用consul插件的Register方法,然后调用到consul自身SDK提供的Agent.ServiceRegister方法,将服务注册到Consul中。注册的服务名称就是NewServer时的server.Name。

    2、健康上报: 即刷新TTL,服务注册成功后,会启动一个定时器定时调用consul插件的Register方法,这个方法内部判断服务注册过,则会调用consul自身SDK提供的Agent.PassTTL方法,刷新Consul中对应服务的TTL。

    健康检查

    go-micro服务的健康状态是通过TTL维护的,服务需要定时去刷新TTL,如果TTL超过指定的时间没有被刷新,则服务会被认为是不健康的。默认情况下有三个设置会涉及到TTL,还是先来看代码:

    registry := consul.NewRegistry()
    
    	regCheckFunc := func(ctx context.Context) error {
    		fmt.Println(time.Now().Format("2006-01-02 15:04:05") + " do register check")
    		if 1+1 == 2 {
    			return nil
    		}
    		return errors.New("this not earth")
    	}
    
    	rpcServer := server.NewServer(
    		server.Name("registry-consul.service"),
    		server.Address("0.0.0.0:8001"),
    		server.Registry(registry),
    		server.RegisterCheck(regCheckFunc),
    		server.RegisterInterval(10*time.Second),
    		server.RegisterTTL(20*time.Second),
    	)
    
    	proto.RegisterHelloHandler(rpcServer, &Hello{})
    
    	service := micro.NewService(
    		micro.Server(rpcServer),
    	)
    
    	//service.Init()
    
    	if err := service.Run(); err != nil {
    		log.Fatal(err)
    	}
    

    关于这三个设置,这里简单介绍下:

    1、server.RegisterCheck(regCheckFunc) 服务刷新TTL之前,会调用一个函数检查服务的状态,这个函数的返回值是error类型。默认的函数不进行任何检查,直接返回nil,代表服务状态正常;我们可以自己写一个函数,进行一些检查逻辑,比如是否要下线维护。如果返回的error不是nil,go-micro会尝试在Consul中注销服务,则调用方将不会再访问到这个服务节点。

    2、server.RegisterInterval(10*time.Second) 这个设置指定程序去刷新TLL的频率。

    3、server.RegisterTTL(20*time.Second) 这个设置指定TTL的生存周期,如果超过这个时间没有刷新TTL,则Consul会认为服务是不健康。

    另外需要注意不要使用service.Init(),因为这里边会覆盖 RegisterIntervalRegisterTTL 的设置,除非你不关心这两个参数。关于这个问题可以参考:https://github.com/asim/go-micro/issues/2488

    客户端使用Consul

    调用服务

    为了使用Consul做服务发现,需要为go-micro service显式的指定Consul Registry。还是直接看代码:

    	registry := consul.NewRegistry()
    
    	service := micro.NewService(
    		micro.Client(client.NewClient()),
    		micro.Registry(registry),
    	)
    
    	service.Init()
    	client := proto.NewHelloService("registry-consul.service", service.Client())
    
    	rsp, err := client.Say(context.TODO(), &proto.SayRequest{Name: "BOSSMA"})
    	if err != nil {
    		fmt.Println(err)
    	}
    
    	fmt.Println(rsp)
    

    代码很简单,指定consul作为服务发现组件后,调用服务的时候传递的服务名称就会使用consul进行解析,获取到IP、端口后,再进行实际调用。

    发现过程

    还是先来看张图,从调用 XXXService 的方法 YYY 开始:

    consul发现过程

    整个过程分为两个大的步骤,第一步获取要调用服务的地址,第二步通过http请求调用服务。我们重点看第一步通过Consul获取服务这块。

    首先进入一个Selector,就是选择器的意思。Selector首先看缓存中有没有缓存请求服务的地址信息,如果没有就去Consul查询,查询到之后再通过指定的选择策略选出来一个地址,用于后续http请求。这里默认的选择策略是随机选择,比如查询到这个服务有三个部署节点,随机策略会随机返回其中某一个地址。

    除了随机策略,go-micro还提供了一个轮询策略,这时候需要自己创建一个Selector:

    	registry := consul.NewRegistry()
    	selector := selector.NewSelector(
    		selector.SetStrategy(selector.RoundRobin),
    		selector.Registry(registry),
    	)
    
    	service := micro.NewService(
    		micro.Client(client.NewClient()),
    		micro.Selector(selector),
    		//micro.Registry(registry),
    	)
    

    另外从上面的示意图中,我们可以看到Selector调用了Registry,所以这里创建Selector的时候,我们把Registry设置了进去,然后再把创建的Selector设置到Service中。其实还有另一种方式,把设置Registry放到设置Selector后边,同样可以把Registry注册到Selector中,但是这样比较隐晦,还需要注意设置顺序,我不推荐。不过如果在Selector之外需要使用Registry的时候,还是需要使用micro.Registry(registry)进行注册,这个例子中并没有相关场景。

    效果展示

    先启动服务端,然后启动客户端,截图如下:

    img


    以上就是本文的主要内容,如有错漏欢迎反馈。

    演示代码已上传到Github:https://github.com/bosima/go-demo/tree/main/go-micro-registry-consul

    收获更多架构知识,请关注微信公众号 萤火架构。原创内容,转载请注明出处。
    扫描二维码关注公众号

  • 相关阅读:
    基于kafka-net实现的可以长链接的消息生产者
    Windows服务安装、卸载、启动和关闭的管理器
    基于Confluent.Kafka实现的KafkaConsumer消费者类和KafkaProducer消息生产者类型
    [转]C#中HttpClient使用注意:预热与长连接
    基于Confluent.Kafka实现的Kafka客户端操作类使用详解
    [转载]RabbitMQ消息可靠性分析
    ASP.NET Core3.1 MVC 添加验证规则
    asp.net core 3.1 webapi接口参数有时间类型取不到值得问题
    asp.net core 3.1 引用的元包dll版本兼容性问题解决方案
    Python安装和环境配置
  • 原文地址:https://www.cnblogs.com/bossma/p/16188603.html
Copyright © 2020-2023  润新知