首页 > golang > Go操作etcd亲测版
2023
03-05

Go操作etcd亲测版


目录

    一、服务发现

    二、配置中心

    三、分布式锁

    四、为什么用 etcd 而不用ZooKeeper？

        4.1 为什么不选择ZooKeeper？

        4.2 为什么选择etcd？

    五、etcd集群

    5.1 搭建一个3节点集群示例：

    六、Go语言操作etcd

        6.1 安装

        6.2 put和get操作

        6.3 watch操作

        6.4 lease租约

        6.5 keepAlive

        6.6 基于etcd实现分布式锁

        6.7 其他操作


一、服务发现

服务发现要解决的也是分布式系统中最常见的问题之一，即在同一个分布式集群中的进程或服务，要如何才能找到对方并建立连接。本质上来说，服务发现就是想要了解集群中是否有进程在监听 udp 或 tcp 端口，并且通过名字就可以查找和连接。

image.png

二、配置中心

将一些配置信息放到 etcd 上进行集中管理。

这类场景的使用方式通常是这样：应用在启动的时候主动从 etcd 获取一次配置信息，同时，在 etcd 节点上注册一个 Watcher 并等待，以后每次配置有更新的时候，etcd 都会实时通知订阅者，以此达到获取最新配置信息的目的。

三、分布式锁

因为 etcd 使用 Raft 算法保持了数据的强一致性，某次操作存储到集群中的值必然是全局一致的，所以很容易实现分布式锁。锁服务有两种使用方式，一是保持独占，二是控制时序。


    保持独占即所有获取锁的用户最终只有一个可以得到。etcd 为此提供了一套实现分布式锁原子操作 CAS（CompareAndSwap）的 API。通过设置prevExist值，可以保证在多个节点同时去创建某个目录时，只有一个成功。而创建成功的用户就可以认为是获得了锁。


    控制时序，即所有想要获得锁的用户都会被安排执行，但是获得锁的顺序也是全局唯一的，同时决定了执行顺序。etcd 为此也提供了一套 API（自动创建有序键），对一个目录建值时指定为POST动作，这样 etcd 会自动在目录下生成一个当前最大的值为键，存储这个新的值（客户端编号）。同时还可以使用 API 按顺序列出所有当前目录下的键值。此时这些键的值就是客户端的时序，而这些键中存储的值可以是代表客户端的编号。

image.png

四、为什么用 etcd 而不用ZooKeeper？

etcd 实现的这些功能，ZooKeeper都能实现。那么为什么要用 etcd 而非直接使用ZooKeeper呢？

4.1 为什么不选择ZooKeeper？

  1. 部署维护复杂，其使用的Paxos强一致性算法复杂难懂。官方只提供了Java和C两种语言的接口。

  2. 使用Java编写引入大量的依赖。运维人员维护起来比较麻烦。

  3. 最近几年发展缓慢，不如etcd和consul等后起之秀。

4.2 为什么选择etcd？

  1. 简单。使用 Go 语言编写部署简单；支持HTTP/JSON API,使用简单；使用 Raft 算法保证强一致性让用户易于理解。

  2. etcd 默认数据一更新就进行持久化。

  3. etcd 支持 SSL 客户端安全认证。

最后，etcd 作为一个年轻的项目，正在高速迭代和开发中，这既是一个优点，也是一个缺点。优点是它的未来具有无限的可能性，缺点是无法得到大项目长时间使用的检验。然而，目前 CoreOS、Kubernetes和CloudFoundry等知名项目均在生产环境中使用了etcd，所以总的来说，etcd值得你去尝试。

五、etcd集群

etcd 作为一个高可用键值存储系统，天生就是为集群化而设计的。由于 Raft 算法在做决策时需要多数节点的投票，所以 etcd 一般部署集群推荐奇数个节点，推荐的数量为 3、5 或者 7 个节点构成一个集群。

5.1 搭建一个3节点集群示例：

在每个etcd节点指定集群成员，为了区分不同的集群最好同时配置一个独一无二的token。

下面是提前定义好的集群信息，其中n1、n2和n3表示3个不同的etcd节点。

TOKEN=token-01
CLUSTER_STATE=new
CLUSTER=n1=http://10.240.0.17:2380,n2=http://10.240.0.18:2380,n3=http://10.240.0.19:2380

在n1这台机器上执行以下命令来启动etcd：

etcd --data-dir=data.etcd --name n1 
	--initial-advertise-peer-urls http://10.240.0.17:2380 --listen-peer-urls http://10.240.0.17:2380 
	--advertise-client-urls http://10.240.0.17:2379 --listen-client-urls http://10.240.0.17:2379 
	--initial-cluster ${CLUSTER} 
	--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

在n2这台机器上执行以下命令启动etcd：

etcd --data-dir=data.etcd --name n2 
	--initial-advertise-peer-urls http://10.240.0.18:2380 --listen-peer-urls http://10.240.0.18:2380 
	--advertise-client-urls http://10.240.0.18:2379 --listen-client-urls http://10.240.0.18:2379 
	--initial-cluster ${CLUSTER} 
	--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

在n3这台机器上执行以下命令启动etcd：

etcd --data-dir=data.etcd --name n3 
	--initial-advertise-peer-urls http://10.240.0.19:2380 --listen-peer-urls http://10.240.0.19:2380 
	--advertise-client-urls http://10.240.0.19:2379 --listen-client-urls http://10.240.0.19:2379 
	--initial-cluster ${CLUSTER} 
	--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

etcd 官网提供了一个可以公网访问的 etcd 存储地址。你可以通过如下命令得到 etcd 服务的目录，并把它作为-discovery参数使用。

curl https://discovery.etcd.io/new?size=3
https://discovery.etcd.io/a81b5818e67a6ea83e9d4daea5ecbc92

# grab this token
TOKEN=token-01
CLUSTER_STATE=new
DISCOVERY=https://discovery.etcd.io/a81b5818e67a6ea83e9d4daea5ecbc92


etcd --data-dir=data.etcd --name n1 
	--initial-advertise-peer-urls http://10.240.0.17:2380 --listen-peer-urls http://10.240.0.17:2380 
	--advertise-client-urls http://10.240.0.17:2379 --listen-client-urls http://10.240.0.17:2379 
	--discovery ${DISCOVERY} 
	--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}


etcd --data-dir=data.etcd --name n2 
	--initial-advertise-peer-urls http://10.240.0.18:2380 --listen-peer-urls http://10.240.0.18:2380 
	--advertise-client-urls http://10.240.0.18:2379 --listen-client-urls http://10.240.0.18:2379 
	--discovery ${DISCOVERY} 
	--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}


etcd --data-dir=data.etcd --name n3 
	--initial-advertise-peer-urls http://10.240.0.19:2380 --listen-peer-urls http://10.240.0.19:2380 
	--advertise-client-urls http://10.240.0.19:2379 --listen-client-urls http:/10.240.0.19:2379 
	--discovery ${DISCOVERY} 
	--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

到此etcd集群就搭建起来了，可以使用etcdctl来连接etcd。

export ETCDCTL_API=3
HOST_1=10.240.0.17
HOST_2=10.240.0.18
HOST_3=10.240.0.19
ENDPOINTS=$HOST_1:2379,$HOST_2:2379,$HOST_3:2379

etcdctl --endpoints=$ENDPOINTS member list

六、Go语言操作etcd

这里使用官方的etcd/clientv3包来连接etcd并进行相关操作。

6.1 安装

go get go.etcd.io/etcd/client/v3

网上很多例子都写 go.etcd.io/etcd/client  或者 go.etcd.io/etcd/clientv3  ,目测这个client目录中已经没有v3了，还是用 go get go.etcd.io/etcd/client/v3 靠谱

import (
	"go.etcd.io/etcd/clientv3"  //失败
)
 
import (
	"go.etcd.io/etcd/client/v3" // 成功
)


6.2 put和get操作

put命令用来设置键值对数据，get命令用来根据key获取值。

package main

import (
   "context"
   "fmt"
   "time"

   clientv3 "go.etcd.io/etcd/client/v3"
)

// etcd client put/get demo
// go get go.etcd.io/etcd/client/v3
// 网上很多例子都写 go.etcd.io/etcd/client ,目测这个client目录中已经没有v3了，还是用 go get go.etcd.io/etcd/client/v3 靠谱

func main() {
   cli, err := clientv3.New(clientv3.Config{
      Endpoints:   []string{"127.0.0.1:2379"},
      DialTimeout: 5 * time.Second,
   })
   if err != nil {
      // handle error!
      fmt.Printf("connect to etcd failed, err:%vn", err)
      return
   }
   defer cli.Close()
   key := "test"
   value := "testvalue2"
   // put
   ctx, cancel := context.WithTimeout(context.Background(), time.Second)
   _, err = cli.Put(ctx, key, value)
   cancel()
   if err != nil {
      fmt.Printf("put to etcd failed, err:%vn", err)
      return
   }
   // get
   ctx, cancel = context.WithTimeout(context.Background(), time.Second)
   resp, err := cli.Get(ctx, key)
   cancel()
   if err != nil {
      fmt.Printf("get from etcd failed, err:%vn", err)
      return
   }
   for _, ev := range resp.Kvs {
      fmt.Printf("%s:%s", ev.Key, ev.Value)
   }
}

6.3 watch操作

watch用来获取未来更改的通知。

package main

import (
   "context"
   "fmt"
   "time"

   clientv3 "go.etcd.io/etcd/client/v3"
)

// go get go.etcd.io/etcd/client/v3
// 网上很多例子都写 go.etcd.io/etcd/client ,目测这个client目录中已经没有v3了，还是用 go get go.etcd.io/etcd/client/v3 靠谱

func main() {
   cli, err := clientv3.New(clientv3.Config{
      Endpoints:   []string{"127.0.0.1:2379"},
      DialTimeout: 5 * time.Second,
   })
   if err != nil {
      // handle error!
      fmt.Printf("connect to etcd failed, err:%vn", err)
      return
   }
   defer cli.Close()
   key := "test"
   // watch key:q1mi change
   rch := cli.Watch(context.Background(), key)
   for wresp := range rch {
      for _, ev := range wresp.Events {
         fmt.Printf("Type: %s Key:%s Value:%s", ev.Type, ev.Kv.Key, ev.Kv.Value)
      }
   }
}

将上面的代码保存编译执行，此时程序就会等待etcd中test这个key的变化。

例如：我们打开终端执行以下命令修改、删除、设置q1mi这个key。

./etcdctl put test testvalue
OK

./etcdctl deltest 
1

./etcdctl put test testvalue2
OK

上面的程序都能收到如下通知。

connect to etcd success
Type: PUT Key:test Value:testvalue
Type: DELETE Key:test Value:
Type: PUT Key:test Value:testvalue2

6.4 lease租约 提供了以下功能：

    Grant：分配一个租约

    Revoke：释放一个租约

    TimeToLive：获取剩余TTL时间

    leases：列举出所有etcd中的租约

    KeepAlive：自动定时的续约某个租约

    KeepAliveOnce：为某个租约续约一次

    Close：释放当前客户端建立的所有租约

package main

import (
   "context"
   "fmt"
   "log"
   "time"

   clientv3 "go.etcd.io/etcd/client/v3"
)

// go get go.etcd.io/etcd/client/v3
// 网上很多例子都写 go.etcd.io/etcd/client ,目测这个client目录中已经没有v3了，还是用 go get go.etcd.io/etcd/client/v3 靠谱

func main() {
   cli, err := clientv3.New(clientv3.Config{
      Endpoints:   []string{"127.0.0.1:2379"},
      DialTimeout: 5 * time.Second,
   })
   if err != nil {
      // handle error!
      fmt.Printf("connect to etcd failed, err:%vn", err)
      return
   }
   fmt.Println("connect to etcd success")
   defer cli.Close()
   // 创建一个5秒的租约
   resp, err := cli.Grant(context.TODO(), 5)
   if err != nil {
      log.Fatal(err)
   }
   key := "test"
   value := "testvalue"
   // 会先创建一个key=test value=testvalue 的键值对，5秒钟之后, test 这个key就会被移除
   _, err = cli.Put(context.TODO(), key, value, clientv3.WithLease(resp.ID))
   if err != nil {
      log.Fatal(err)
   }
}

6.5 keepAlive

这里主要使用的是grant.ID，有一种情况是如果在put之前Lease已经过期了，那么这个put就会返回error。这时需要再过期时间之内，为其续约

package main

import (
   "context"
   "fmt"
   "log"
   "time"

   clientv3 "go.etcd.io/etcd/client/v3"
)

// etcd client put/get demo
// go get go.etcd.io/etcd/client/v3
// 网上很多例子都写 go.etcd.io/etcd/client ,目测这个client目录中已经没有v3了，还是用 go get go.etcd.io/etcd/client/v3 靠谱

func main() {
   cli, err := clientv3.New(clientv3.Config{
      Endpoints:   []string{"127.0.0.1:2379"},
      DialTimeout: 5 * time.Second,
   })
   if err != nil {
      // handle error!
      fmt.Printf("connect to etcd failed, err:%vn", err)
      return
   }
   fmt.Println("connect to etcd success")
   defer cli.Close()
   // 创建一个5秒的租约
   resp, err := cli.Grant(context.TODO(), 5)
   if err != nil {
      log.Fatal(err)
   }
   key := "test"
   value := "testvalue"
   // 会先创建一个key=test value=testvalue 的键值对，5秒钟之后, test 这个key就会被移除
   _, err = cli.Put(context.TODO(), key, value, clientv3.WithLease(resp.ID))
   if err != nil {
      log.Fatal(err)
   }

   // the key will be kept forever
   ch, kaerr := cli.KeepAlive(context.TODO(), resp.ID)
   if kaerr != nil {
      log.Fatal(kaerr)
   }
   for {
      ka := <-ch
      fmt.Println("ttl:", ka.TTL)
   }
}

输出

connect to etcd success
ttl: 5
ttl: 5
ttl: 5
ttl: 5
ttl: 5
ttl: 5
ttl: 5
ttl: 5
ttl: 5

6.6 基于etcd实现分布式锁

go.etcd.io/etcd/clientv3/concurrency在etcd之上实现并发操作，如分布式锁、屏障和选举。

导入该包：

import "go.etcd.io/etcd/clientv3/concurrency"

基于etcd实现的分布式锁示例：

package main

import (
   "context"
   "fmt"
   clientv3 "go.etcd.io/etcd/client/v3"
   "go.etcd.io/etcd/client/v3/concurrency"
   "log"
   "time"
)

// go get go.etcd.io/etcd/client/v3
// 网上很多例子都写 go.etcd.io/etcd/client ,目测这个client目录中已经没有v3了，还是用 go get go.etcd.io/etcd/client/v3 靠谱

func main() {
   cli, err := clientv3.New(clientv3.Config{
      Endpoints:   []string{"127.0.0.1:2379"},
      DialTimeout: 5 * time.Second,
   })
   if err != nil {
      // handle error!
      fmt.Printf("connect to etcd failed, err:%vn", err)
      return
   }
   fmt.Println("connect to etcd success")
   defer cli.Close()
   // 创建两个单独的会话用来演示锁竞争
   s1, err := concurrency.NewSession(cli, concurrency.WithTTL(30))
   if err != nil {
      log.Fatal(err)
   }
   defer s1.Close()
   m1 := concurrency.NewMutex(s1, "/my-lock/")

   s2, err := concurrency.NewSession(cli)
   if err != nil {
      log.Fatal(err)
   }
   defer s2.Close()
   m2 := concurrency.NewMutex(s2, "/my-lock/")

   // 会话s1获取锁
   if err := m1.Lock(context.TODO()); err != nil {
      log.Fatal(err)
   }
   fmt.Println("acquired lock for s1")

   m2Locked := make(chan struct{})
   go func() {
      fmt.Println("m2 go")
      defer close(m2Locked)
      fmt.Println("m2 go2")
      // 等待直到会话s1释放了/my-lock/的锁
      if err := m2.Lock(context.TODO()); err != nil {
         fmt.Println("m2 go err", err)
      }
      fmt.Println("m2 go3")
   }()

   if err := m1.Unlock(context.TODO()); err != nil {
      log.Fatal(err)
   }
   fmt.Println("released lock for s1")

   xx := <-m2Locked
   fmt.Println("acquired lock for s2", xx)
}

输出：

connect to etcd success
acquired lock for s1
m2 go
m2 go2
released lock for s1
m2 go3
acquired lock for s2 {}

查看文档了解更多

6.7 其他操作

其他操作请查看etcd/client/v3官方文档。


注意事项

以上例子都是用到  go.etcd.io/etcd/client/v3 并非 go.etcd.io/etcd/clientv3

作者：admin
admin
PHP面试网 站点 QQ交谈

您可能还会对这些文章感兴趣！

《本文》有 0 条评论

留下一个回复