Golang中Consul服务注册与发现完整指南

Consul基础与环境准备

Consul是一个开源的服务网格解决方案，核心功能包括服务注册、服务发现和健康检查。在典型的部署结构中，consul agent分为Server和Client角色：Server负责集群状态维护与数据持久化，Client则主要转发请求给Server。为了简化演示，本文将采用单节点Server模式启动Consul，适用于开发及中小型测试场景。

在实际生产环境的Docker部署中，需注意区分宿主机IP与容器内网IP。若使用127.0.0.1或localhost作为心跳上报地址，会导致Consul Server无法正确访问客户端的健康检查端口，因为请求会进入容器内部而非指向宿主业务进程。

第1步：安装Docker

确保服务器环境（如CentOS 8）已安装Docker引擎。可使用脚本一键安装：

curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun
systemctl start docker

第2步：启动Consul Server容器

拉取官方镜像并以Server模式启动，开启Web UI界面以便监控。关键参数设置如下：

• -e CONSUL_BIND_INTERFACE='eth0'：指定绑定网卡接口，自动解析真实IP。
• --name=consul1：容器命名。
• -v ~/consul:/consul/data：挂载数据卷，防止重启丢失状态。

完整启动命令：

docker pull consul
docker run -d -p 8500:8500 -v ~/consul:/consul/data \
-e CONSUL_BIND_INTERFACE='eth0' \
--name=consul1 consul agent -server -bootstrap -ui -client='0.0.0.0'

启动成功后，通过浏览器访问 <你的CVM_IP>:8500 即可看到Consul Dashboard界面：

Golang服务注册与监控

接下来，我们将创建一个Golang项目，将本地服务注册到Consul中，并配置相应的健康检查机制。当健康检查失败时，Consul会将该实例从DNS或API查询结果中剔除，从而实现故障隔离。

准备工作

初始化项目并引入Consul官方API库：

mkdir consul_demo && cd consul_demo
go mod init consul_demo
go get -u github.com/hashicorp/consul/api
touch main.go

第3步：实现TCP健康检查注册

首先介绍最基础的TCP层健康检查。只要服务监听的端口可达，即视为健康。需要注意，由于Consul运行在容器中，Service的地址必须填写宿主机的真实IP（如ifconfig查得的eth0 IP），而非127.0.0.1。

package main

import (
	"bufio"
	"fmt"
	"net"

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

// 定义服务发现配置结构体
type DiscoveryConfig struct {
	ID      string
	Name    string
	Tags    []string
	Port    int
	Address string // 注意：此处应为宿主机IP，非127.0.0.1
}

var consulAddress = "127.0.0.1:8500" // Consul Agent地址

func RegisterService(dis DiscoveryConfig) error {
	// 1. 初始化Consul Client
	config := consulapi.DefaultConfig()
	config.Address = consulAddress
	client, err := consulapi.NewClient(config)
	if err != nil {
		fmt.Printf("create consul client : %v\n", err.Error())
		return err
	}

	// 2. 构建服务注册对象
	registration := &consulapi.AgentServiceRegistration{
		ID:      dis.ID,
		Name:    dis.Name,
		Port:    dis.Port,
		Tags:    dis.Tags,
		Address: dis.Address,
	}

	// 3. 配置TCP健康检查
	check := &consulapi.AgentServiceCheck{}
	// 格式为 ip:port
	check.TCP = fmt.Sprintf("%s:%d", registration.Address, registration.Port)
	check.Timeout = "5s"
	check.Interval = "5s"
	// 实例异常超过60秒未恢复，自动取消注册
	check.DeregisterCriticalServiceAfter = "60s"
	registration.Check = check

	// 4. 执行注册
	if err := client.Agent().ServiceRegister(registration); err != nil {
		fmt.Printf("register to consul error: %v\n", err.Error())
		return err
	}
	fmt.Println("Service registered successfully")
	return nil
}

// 模拟一个TCP监听服务
func startTcp() {
	ls, err := net.Listen("tcp", ":10111")
	if err != nil {
		fmt.Printf("start tcp listener error: %v\n", err.Error())
		return
	}
	for {
		conn, err := ls.Accept()
		if err != nil {
			continue
		}
		go func(conn net.Conn) {
			_, _ = bufio.NewWriter(conn).WriteString("hello consul")
			conn.Close()
		}(conn)
	}
}

func main() {
	ch := make(chan error)

	// 配置服务信息
	dis := DiscoveryConfig{
		ID:      "9527",
		Name:    "main_service",
		Tags:    []string{"a", "b"},
		Port:    10111,
		Address: "192.168.0.124", // 请替换为你的局域网真实IP
	}

	// 启动TCP监听协程
	go startTcp()

	// 向Consul注册服务
	RegisterService(dis)

	// 阻塞主线程
	<-ch
}

运行上述代码后，回到Consul Web控制台刷新页面，你将看到新注册的实例及其健康状态：

第4步：实现HTTP健康检查（可选）

如果应用是Web服务，使用HTTP Check更为常见。只需将检查方式改为HTTP协议，并确保路由返回2xx状态码即可。

修改注册逻辑中的Check部分：

check := &consulapi.AgentServiceCheck{}
check.HTTP = fmt.Sprintf("http://%s:%d/", registration.Address, registration.Port)

并在应用中启动HTTP服务器：

import "net/http"

func startHttp() {
	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte("ok"))
	})
	// 端口需与注册时的Port一致
	log.Fatal(http.ListenAndServe(":10111", nil))
}

配置完成后，同样可在Dashboard中看到对应的健康指标：

服务发现实战

服务调用方无需手动维护IP列表，只需根据服务名称（Service Name）向Consul发起查询，即可获取当前存活且健康的后端实例。consul/api SDK提供了现成的Health Service API，我们只需构造参数即可。

package main

import (
	"fmt"
	"testing"

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

// Discovery 根据服务名称获取所有健康实例
func Discovery(serviceName string) []*consulapi.ServiceEntry {
	config := consulapi.DefaultConfig()
	config.Address = "127.0.0.1:8500"
	client, err := consulapi.NewClient(config)
	if err != nil {
		fmt.Printf("consul client error: %v\n", err)
		return nil
	}

	// 使用 Health().Service() 方法
	// serviceName: 服务名
	// tags: 过滤标签 (空字符串表示不过滤)
	// passingOnly: true表示只返回健康(Passing)状态的实例
	service, _, err := client.Health().Service(serviceName, "", true, nil)
	if err != nil {
		fmt.Printf("service discovery error: %v\n", err)
		return nil
	}
	return service
}

func TestDiscoveryFromConsul(t *testing.T) {
	t.Log("Starting discovery...")
	instances := Discovery("main_service")

	for i, inst := range instances {
		t.Logf("[%d] Node: %s, Address: %s, Port: %d\n",
			i,
			inst.Node.Node,
			inst.Service.Address,
			inst.Service.Port,
		)
	}
}

运行go test后，输出结果将包含具体的节点信息和端口号，证明通过Consul成功定位到了后端服务的真实连接地址，随后可直接在业务逻辑中使用这些信息进行RPC或HTTP调用。

以上就是Golang集成Consul实现服务注册与发现的详细内容。掌握了基础操作后，您可以进一步探索Consul的高级特性，如K/V配置管理、多数据中心同步等。更多关于微服务架构与Go开发的技术资料，欢迎持续关注本站相关文章！