consul服务注册与发现（go）-学习笔记

于 2025-04-08 22:11:41 发布
阅读量663 收藏 3
点赞数 1
CC 4.0 BY-SA版权
文章标签： consul golang 学习
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hongyuyahei/article/details/147077100

参考博客

1、服务实例接口与默认实现

type ServiceInstance interface {

	// 获取服务实例的唯一ID
	GetInstanceId() string

	// 获取服务ID
	GetServiceId() string

	// 获取服务实例的主机名或IP地址
	GetHost() string

	// 获取服务实例的端口号
	GetPort() int

	// 判断服务实例是否使用HTTPS
	IsSecure() bool

	// 获取服务实例的元数据(键值对形式)
	GetMetadata() map[string]string
}

type DefaultServiceInstance struct {
	InstanceId string
	ServiceId  string
	Host       string
	Port       int
	Secure     bool
	Metadata   map[string]string
}

// 构造函数
func NewDefaultServiceInstance(serviceId string, host string, port int, secure bool,
	metadata map[string]string, instanceId string) (*DefaultServiceInstance, error) {

	// 如果没有传入 IP 则获取一下，这个方法在多网卡的情况下，并不好用
	if len(host) == 0 {
		localIP, err := util.GetLocalIP()
		if err != nil {
			return nil, err
		}
		host = localIP
	}
	//若instanceId为空，自动生成“服务ID-时间戳-随机数（1000-9999）”
	if len(instanceId) == 0 {
		instanceId = serviceId + "-" + strconv.FormatInt(time.Now().Unix(), 10) + "-" + strconv.Itoa(rand.Intn(9000)+1000)
	}

	return &DefaultServiceInstance{InstanceId: instanceId, ServiceId: serviceId, Host: host, Port: port, Secure: secure, Metadata: metadata}, nil
}

func (serviceInstance DefaultServiceInstance) GetInstanceId() string {
	return serviceInstance.InstanceId
}

func (serviceInstance DefaultServiceInstance) GetServiceId() string {
	return serviceInstance.ServiceId
}

func (serviceInstance DefaultServiceInstance) GetHost() string {
	return serviceInstance.Host
}

func (serviceInstance DefaultServiceInstance) GetPort() int {
	return serviceInstance.Port
}

func (serviceInstance DefaultServiceInstance) IsSecure() bool {
	return serviceInstance.Secure
}

func (serviceInstance DefaultServiceInstance) GetMetadata() map[string]string {
	return serviceInstance.Metadata
}

2、定义服务注册和剔除的方法

type ServiceRegistry interface {
	Register(serviceInstance cloud.ServiceInstance) bool

	Deregister()
}

具体实现：

import (
	"errors"
	"fmt"
	"github.com/hashicorp/consul/api"
	"strconv"
	"unsafe"
)

type consulServiceRegistry struct {
	// 服务实例缓存（服务ID->实例ID->实例）
	serviceInstances     map[string]map[string]cloud.ServiceInstance
	//Consul客户端
	client               api.Client
	//当前本地服务实例
	localServiceInstance cloud.ServiceInstance
}

func (c consulServiceRegistry) Register(serviceInstance cloud.ServiceInstance) bool {
	// 创建注册到consul的服务到
	registration := new(api.AgentServiceRegistration)
	registration.ID = serviceInstance.GetInstanceId()
	registration.Name = serviceInstance.GetServiceId()
	registration.Port = serviceInstance.GetPort()
	var tags []string
	if serviceInstance.IsSecure() {
		tags = append(tags, "secure=true")
	} else {
		tags = append(tags, "secure=false")
	}
	if serviceInstance.GetMetadata() != nil {
		var tags []string
		for key, value := range serviceInstance.GetMetadata() {
			tags = append(tags, key+"="+value)
		}
		registration.Tags = tags
	}
	registration.Tags = tags

	registration.Address = serviceInstance.GetHost()

	// 增加consul健康检查回调函数
	check := new(api.AgentServiceCheck)

	schema := "http"
	if serviceInstance.IsSecure() {
		schema = "https"
	}
	check.HTTP = fmt.Sprintf("%s://%s:%d/actuator/health", schema, registration.Address, registration.Port)
	check.Timeout = "5s"
	check.Interval = "5s"
	check.DeregisterCriticalServiceAfter = "20s" // 故障检查失败30s后 consul自动将注册服务删除
	registration.Check = check

	// 注册服务到consul
	err := c.client.Agent().ServiceRegister(registration)
	if err != nil {
		fmt.Println(err)
		return false
	}
	//初始化服务实例缓存结构
	//若未初始化，服务ID-实例ID-实例
	if c.serviceInstances == nil {
		c.serviceInstances = map[string]map[string]cloud.ServiceInstance{}
	}
	//获取特定服务的实例集合
	//从外层map中查询该服务ID对应的内层map
	services := c.serviceInstances[serviceInstance.GetServiceId()]
	//初始化空实例集合
	//处理首次注册情况，创建新的内层map，用处存储该服务的实例集合
	if services == nil {
		services = map[string]cloud.ServiceInstance{}
	}
	//添加当前实例到集合
	services[serviceInstance.GetInstanceId()] = serviceInstance

	//更新外层缓存	
	//确保外层map中服务ID对应内层map是最新版本	c.serviceInstances[serviceInstance.GetServiceId()] = services
	//记录当前实例
	c.localServiceInstance = serviceInstance

	return true
}

// deregister a service
func (c consulServiceRegistry) Deregister() {
	//检查服务实例缓存是否初始化
	if c.serviceInstances == nil {
		return
	}
	//从缓存中获取当前服务ID对应的实例集合（实例ID->实例对象）
	services := c.serviceInstances[c.localServiceInstance.GetServiceId()]
	//检查实例集合是否存在
	if services == nil {
		return
	}
	//从本地缓存移除当前实例
	delete(services, c.localServiceInstance.GetInstanceId())
	//清空服务记录
	if len(services) == 0 {
		delete(c.serviceInstances, c.localServiceInstance.GetServiceId())
	}
	//从Consul注销服务
	_ = c.client.Agent().ServiceDeregister(c.localServiceInstance.GetInstanceId())
	//重置当前实例记录
	c.localServiceInstance = nil
}

// new a consulServiceRegistry instance
// token is optional
func NewConsulServiceRegistry(host string, port int, token string) (*consulServiceRegistry, error) {
	if len(host) < 3 {
		return nil, errors.New("check host")
	}

	if port <= 0 || port > 65535 {
		return nil, errors.New("check port, port should between 1 and 65535")
	}

	config := api.DefaultConfig()
	config.Address = host + ":" + strconv.Itoa(port)
	config.Token = token
	client, err := api.NewClient(config)
	if err != nil {
		return nil, err
	}

	return &consulServiceRegistry{client: *client}, nil
}

在这里插入图片描述
测试用例：

func TestConsulServiceRegistry(t *testing.T) {
	//初始化Consul注册中心客户端
	host := "127.0.0.1"
	port := 8500
	registryDiscoveryClient, _ := extension.NewConsulServiceRegistry(host, port, "")
	//获取本地IP地址
	ip, err := util.GetLocalIP()
	if err != nil {
		t.Error(err)
	}
	//创建服务实例信息
	serviceInstanceInfo, _ := cloud.NewDefaultServiceInstance("go-user-server", "", 8090,
		false, map[string]string{"user":"zyn"}, "")

//注册服务实例
registryDiscoveryClient.Register(serviceInstanceInfo)

	r := gin.Default()
	// 健康检测接口，其实只要是 200 就认为成功了
	r.GET("/actuator/health", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})
	err = r.Run(":8090")
	if err != nil{
		registryDiscoveryClient.Deregister()
	}
}

3、服务发现

  • 获取所有的服务列表
  • 获取指定的服务的所有实例信息

接口定义：

type DiscoveryClient interface {
	
	/**
	 * Gets all ServiceInstances associated with a particular serviceId.
	 * @param serviceId The serviceId to query.
	 * @return A List of ServiceInstance.
	 */
	GetInstances(serviceId string) ([]cloud.ServiceInstance, error)

	/**
	 * @return All known service IDs.
	 */
	GetServices() ([]string, error)
}

具体实现：

type consulServiceRegistry struct {
	serviceInstances     map[string]map[string]cloud.ServiceInstance
	client               api.Client
	localServiceInstance cloud.ServiceInstance
}

func (c consulServiceRegistry) GetInstances(serviceId string) ([]cloud.ServiceInstance, error) {
	//查询指定服务
	catalogService, _, _ := c.client.Catalog().Service(serviceId, "", nil)
	//若查询到服务实例
	if len(catalogService) > 0 {
		//转换Consul数据到标准格式
		result := make([]cloud.ServiceInstance, len(catalogService))
		for index, sever := range catalogService {
			s := cloud.DefaultServiceInstance{
				InstanceId: sever.ServiceID,
				ServiceId:  sever.ServiceName,
				Host:       sever.Address,
				Port:       sever.ServicePort,
				Metadata:   sever.ServiceMeta,
			}
			result[index] = s
		}
		return result, nil
	}
	return nil, nil
}
//返回服务名称列表
func (c consulServiceRegistry) GetServices() ([]string, error) {
	//查询所有服务
	services, _, _ := c.client.Catalog().Services(nil)
	result := make([]string, unsafe.Sizeof(services))
	index := 0
	for serviceName, _ := range services {
		result[index] = serviceName
		index++
	}
	return result, nil
}

// new a consulServiceRegistry instance
// token is optional
func NewConsulServiceRegistry(host string, port int, token string) (*consulServiceRegistry, error) {
	if len(host) < 3 {
		return nil, errors.New("check host")
	}

	if port <= 0 || port > 65535 {
		return nil, errors.New("check port, port should between 1 and 65535")
	}

	config := api.DefaultConfig()
	config.Address = host + ":" + strconv.Itoa(port)
	config.Token = token
	client, err := api.NewClient(config)
	if err != nil {
		return nil, err
	}

	return &consulServiceRegistry{client: *client}, nil
}

测试用例：

func TestConsulServiceDiscovery(t *testing.T) {
	host := "127.0.0.1"
	port := 8500
	token := ""
	registryDiscoveryClient, err := extension.NewConsulServiceRegistry(host, port, token)
	if err != nil {
		panic(err)
	}

	t.Log(registryDiscoveryClient.GetServices())

	t.Log(registryDiscoveryClient.GetInstances("go-user-server"))
}

结果：

consul_service_registry_test.go:57: [consul go-user-server      ] <nil>

consul_service_registry_test.go:59: [{go-user-server-1602590661-56179 go-user-server 127.0.0.1 8090 false map[user:zyn]}] <nil>
【Consul】构建高效的服务治理体系：基于Golang实现Consul服务的注册、注销、修改、监控注册的服务变化、实时同步服务信息机制
寸铁的博客
04-06 2942
【Consul】基于Golang实现Consul服务的注册、注销、修改、监控注册的服务变化、实时同步服务信息机制 寸铁手把手带你实现Consul服务的注册、注销、修改、监控服务变化，实时同步长轮询信息机制！
go微服务系列(七)：consul给微服务添加服务注册与发现
阿白，
06-19 2227
微服务架构按业务划分微服务的特点，使得原本聚合了大量业务模块的单体应用被划分为众多的微服务。而大量微服务的出现，势必会带来运维管理上的巨大挑战，于是服务注册与发现这类自动化策略应运而生。但是引入服务注册与发现就可能引入额外技术栈，增加系统总体的复杂性，比如会引入中心化的服务注册与发现中心这类基础组件。在本课时，我们将基于 Consul 给微服务添加服务注册与发现的能力。首先，我们会基于 Kubernetes 搭建一个接近生产环境的 Consul 集群；接着再基于搭建好的 Consul 集群，为我们的微服务添
【Go】十五、分布式系统、Consul服务注册发现、Nacos配置中心搭建
weixin_41365204的博客
09-11 1663
传统开发方式的痛点：我们的服务分为很多种：用户服务、商品服务、订单服务等，若我们一个成熟的体系内，新添加一个服务，会变得十分的繁琐与困难当我们的负载较大时，如果选择添加机器的方式来减轻负载，那么增加的机器需要修改很多配置文件甚至代码，这样的重新部署会导致一系列的问题。此时，选用注册中心即可对这些问题有系统性的解决：用户服务-web、用户服务-srv、商品服务-web、商品服务1-srv、商品服务2-srv… 都需要注册到注册中心中，也就是说，具有一个注册中心，其管控着所有的服务。
Golang consul 服务注册与发现
ALakers的博客
08-10 967
下载运行consul： consul下载地址：https://www.consul.io/downloads 命令行运行： consul.exe agent -dev 服务注册： package main import ( "fmt" "github.com/go-basic/uuid" consulapi "github.com/hashicorp/consul/api" "net/http" ) const ( consulAddress = "127.0.0.1:8500" loca
golang学习笔记19——golang做服务发现与注册的深度剖析
最新发布
GoppViper的博客
09-13 1456
在 Go 语言的微服务开发中，服务发现与注册是至关重要的环节。通过解决注册中心的高可用性、服务实例的健康检查、服务发现的实时性以及负载均衡等问题，可以构建更加稳定、高效的微服务架构。关注我看更多有意思的文章哦！👉👉。
SpringCloud微服务架构之注册中心 | Consul、Nacos
yehongzhi1994的博客
09-26 1905
介绍SpringCloud注册中心，包括Consul，Nacos。
五、SpringCloud学习笔记之Consul服务注册与发现
qq_41231318的博客
07-30 271
Consul服务注册与发现 Consul简介 Consul是一套开源的分布式服务发现和配置管理系统，由HashiCorp公司使用Go语言开发。 提供了微服务系统中的服务治理、配置中心、控制总线等功能，这些功能每一个都可以根据需要单独使用，也可以一起使用构建全方位的服务网络，总之，Consul提供了一种完整的服务网格解决方案。 具有很多优点：包括：基于raft协议，比较简洁。支持健康检查，同时支持HTTP和DNS协议 支持跨数据中心的WAN集群 提供图形界面，跨平台，支持windows、linux、mac 服
「go-micro」学习笔记——服务发现
zd398900463的博客
10-29 800
consul / etcd / mdns服务发现consulconsul 特色consul 架构图consul 应用场景consul 教材etcdetcd 特色etcd 架构图etcd 应用场景etcd 教材 服务发现 服务发现(Service Discovery)要解决的是分布式系统中最常见的问题之一，即在同一个分布式集群中的进程或服务如何才能找到对方并建立连接。从本质上说，服务发现就是要了解集群中是否有进程在监听upd或者tcp端口，并且通过名字就可以进行查找和链接。 consul consul 是
python eureka服务发现_python与consul 实现gRPC服务注册-发现
weixin_39729784的博客
12-22 361
背景通过对gRPC的介绍我们知道，当正常启动服务后，我们只需要知道ip，port就可以进行gRPC的连接。可以想到，这种方式并不适合用于线上环境，因为这样直连的话就失去了扩展性，当需要多机部署的时候，就无法在线上环境直接使用，而且当线上项目连接的那台服务器宕了的话，整个项目也会出错，这并不是我们想要的结果。于是,我们需要一个服务注册与发现的机制。也就是说当我们的rpc服务启动的时候注册到另一个服务...
go学习笔记:使用 consul 做服务发现和配置共享
dz45693的专栏
01-17 1617
使用consul，其主要有四大特性： 1. 服务发现：利用服务注册，服务发现功能来实现服务治理。 2. 健康检查：利用consul注册的检查检查函数或脚本来判断服务是否健康，若服务不存在则从注册中心移除该服务，减少故障服务请求。 3. k/v数据存储：存储kv数据，可以作为服务配置中心来使用。 4. 多数据中心：可以建立多个consul集群通过inter网络进行互联，进一步保证数据可用性。 通过docker安装consul docker pull consul:latest //运行单机 do
详解golang consul-grpc 服务注册与发现
09-20
主要介绍了详解golang consul-grpc 服务注册与发现，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
Consul服务注册与发现
qq_45905724的博客
02-20 890
Consul是一套开源的分布式服务发现和配置管理系统，由HashiCorp公司用Go语言开发。提供了微服务系统中的服务治理、配置中心、控制总线等功能，这些功能中的每一个都可以根据需要单独使用，也可以一起使用以构建全方位的服务网格，总之Consul提供了一种完整的服务网格解决方案。
【云原生】Docker容器服务更新与发现之consul
qq_62462797的博客
11-28 1200
服务注册与发现是微服务架构中不可或缺的重要组件。起初服务都是单节点的，不保障高可用性，也不考虑服务的压力承载，服务之间调用单纯的通过接口访问。直到后来出现了多个节点的分布式架构，起初的解决手段是在服务前端负载均衡，这样前端必须要知道所有后端服务的网络位置，并配置在配置文件中。这里就会有几个问题：●如果需要调用后端服务A-N，就需要配置N个服务的网络位置，配置很麻烦●后端服务的网络位置变化，都需要改变每个调用者的配置既然有这些问题，那么服务注册与发现就是解决这些问题的。
Golang深入浅出之-Go语言中的服务注册与发现机制
zevjay的博客
05-04 703
服务注册与发现是微服务架构中的重要组件，它允许服务实例在启动时向注册中心注册自己，同时其他服务能够动态地发现并调用这些已注册的服务。在Go语言生态中，这一机制的实现尤为关键，本文将深入浅出地探讨其原理、常见问题、易错点及解决方案，并提供代码示例。
golang微服务 使用Consul进行服务注册与服务发现
qq_62906402的博客
06-22 436
上述代码是对grpc服务层进行注册，对于web层来说，它和grpc服务层的区别在于，其健康检查可以直接配置一个接收"/health"的路由，处理这个请求时返回200的状态，这样就可以轻松的完成健康检查。下面是对注册服务封装成一个工具类。如果一个服务注册进了conusl的话，我们就可以通过服务名从consul中获取到对应的服务。
3.服务注册与发现-go操作consul（HTTP服务的注册与发现）
apple_56973763的博客
12-04 332
package main import ( "fmt" "github.com/hashicorp/consul/api" ) func Register(address string, port int, name string, tags []string, id string) error { cfg := api.DefaultConfig() cfg.Address = "192.168.1.103:8500" client, err := api.NewClient(cfg)
go-consul实战
qzcsu的博客
03-06 1867
consul 安装，命令使用，go-consul 服务注册与发现
GO微服务开发中consul注册中心使用详解
weixin_63603830的博客
08-28 722
很多初学者在刚刚接触微服务时对服务注册中心了解较少，本文详细介绍什么是consul以及consul怎么用
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值