Go 使用 consul 做服务发现之工作原理

见解分享

2023-10-01 23:00:37

Consul 介绍

Consul 是 Hashicorp 公司推出的一款开源服务发现和配置管理工具。它可以帮助您轻松地管理分布式系统中的服务，并为这些服务提供服务发现、健康检查、Key/Value 存储和 DNS 等功能。

Consul 的工作原理是通过在分布式系统中选举出一个 leader 节点，然后由 leader 节点负责管理服务注册、服务发现、健康检查等操作。其他节点则作为 follower 节点，从 leader 节点同步服务信息。

Go 使用 Consul 做服务发现

在 Go 中使用 Consul 做服务发现非常简单，只需要引入 Consul 的 Go 库即可。Consul 的 Go 库提供了丰富的 API，可以帮助您轻松地管理服务注册、服务发现、健康检查等操作。

服务注册

首先，需要将服务注册到 Consul 中。可以使用 Consul 的 Register() 方法来注册服务。Register() 方法需要提供服务名称、服务地址、服务端口和健康检查地址等信息。

import (
	"fmt"
	"time"

	"github.com/hashicorp/consul/api"
)

func main() {
	// 创建 Consul 客户机
	client, err := api.NewClient(api.DefaultConfig())
	if err != nil {
		fmt.Println("创建 Consul 客户机失败:", err)
		return
	}

	// 注册服务
	registration := &api.AgentServiceRegistration{
		ID:      "service-1",
		Name:    "service-1",
		Address: "127.0.0.1",
		Port:    8080,
		Tags:    []string{"v1", "beta"},
		Check: &api.AgentServiceCheck{
			// 每 5 秒检查一次服务是否健康
			Interval: "5s",
			// 检查超时时间为 10 秒
			Timeout: "10s",
			// 健康检查地址
			HTTP: "http://127.0.0.1:8080/health",
		},
	}
	err = client.Agent().ServiceRegister(registration)
	if err != nil {
		fmt.Println("服务注册失败:", err)
		return
	}

	// 等待 10 秒，确保服务注册成功
	time.Sleep(10 * time.Second)

	// 注销服务
	err = client.Agent().ServiceDeregister("service-1")
	if err != nil {
		fmt.Println("服务注销失败:", err)
		return
	}
}

服务发现

服务注册成功后，就可以通过 Consul 来发现服务了。可以使用 Consul 的 Lookup() 方法来查找服务。Lookup() 方法需要提供服务名称和版本等信息。

import (
	"fmt"
	"time"

	"github.com/hashicorp/consul/api"
)

func main() {
	// 创建 Consul 客户机
	client, err := api.NewClient(api.DefaultConfig())
	if err != nil {
		fmt.Println("创建 Consul 客户机失败:", err)
		return
	}

	// 查找服务
	services, err := client.Agent().ServicesWithFilter("service-1 && v1")
	if err != nil {
		fmt.Println("查找服务失败:", err)
		return
	}

	// 等待 10 秒，确保服务发现成功
	time.Sleep(10 * time.Second)

	// 打印服务信息
	for _, service := range services {
		fmt.Println("服务名称:", service.Service)
		fmt.Println("服务地址:", service.Address)
		fmt.Println("服务端口:", service.Port)
		fmt.Println("服务健康状态:", service.Checks.AggregatedStatus())
	}
}

健康检查

Consul 还提供了健康检查功能。可以通过 Consul 的 Health() 方法来检查服务是否健康。Health() 方法需要提供服务名称和服务地址等信息。

import (
	"fmt"
	"time"

	"github.com/hashicorp/consul/api"
)

func main() {
	// 创建 Consul 客户机
	client, err := api.NewClient(api.DefaultConfig())
	if err != nil {
		fmt.Println("创建 Consul 客户机失败:", err)
		return
	}

	// 检查服务健康状态
	status, err := client.Health().Service("service-1", "127.0.0.1:8080")
	if err != nil {
		fmt.Println("检查服务健康状态失败:", err)
		return
	}

	// 等待 10 秒，确保健康检查成功
	time.Sleep(10 * time.Second)

	// 打印服务健康状态
	fmt.Println("服务健康状态:", status.Status)
}