Golang使用etcd构建分布式锁的示例分享_Golang

引言

我们将使用go作为编程语言，并使用etcd作为分布式键值存储。go的并发特性和对分布式系统的出色支持使其成为本教程的理想选择。etcd是一种高度可靠的分布式键值存储，被许多大型系统（如kubernetes）用于配置管理和服务发现。

在本教程结束时，你将能够构建一个分布式锁系统，go开发人员可以使用该系统来管理对其应用程序中共享资源的访问。

环境准备

要学习本教程，你应该具备：

具备go编程语言基础知识
在你的系统上安装etcd或访问etcd服务器
go安装在你的系统上（版本1.13或更高版本）

新建go项目

首先，让我们用必要的依赖项创建一个新的go项目：

$ mkdir distributed-lock && cd distributed-lock
$ go mod init example.com/distributed-lock
$ go get go.etcd.io/etcd/clientv3

这将设置一个新的go项目并下载etcd客户端库。

实现加锁和解锁功能

现在是时候实现lock和unlock函数了。我们将创建名为lock的新文件。首先导入必要的包并定义结构来保存锁信息：

package main

import (
	"context"
	"log"
	"time"

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

type distributedlock struct {
	key        string
	value      string
	leaseid    clientv3.leaseid
	etcdclient *clientv3.client
}

接下来，我们将实现lock函数。该函数将执行以下步骤：

创建具有指定ttl（生存时间）的新租约
将锁键值对存入附带租约的etcd中
如果锁已被占用，则处理错误并重试

func (dl *distributedlock) lock(ctx context.context, ttl int64) error {
	lease, err := dl.etcdclient.grant(ctx, ttl)
	if err != nil {
		return err
	}

	_, err = dl.etcdclient.put(ctx, dl.key, dl.value, clientv3.withlease(lease.id))
	if err != nil {
		return err
	}

	dl.leaseid = lease.id
	log.printf("lock acquired: %s", dl.key)
	return nil
}

ctx context.context：这是 go 语言中用于传递上下文信息的参数，常用于控制操作的超时、取消等情况，比如在分布式环境中协调多个操作的生命周期，确保它们能按照预期执行或者在合适的时候被取消。
ttl int64：代表 “time to live”（存活时间），通常是以秒为单位的时间长度，用于指定分布式锁的有效时长，过了这个时长，锁可能会自动释放，以防止锁被长期占用导致死锁等问题。
这里使用dl.etcdclient再次调用put方法，它的作用是向etcd中写入键值对（key-value）。具体来说，写入的键是dl.key（从代码推测应该是用于标识这个分布式锁的唯一键，是distributedlock结构体中的一个字段），值是dl.value（同样是结构体中的字段，可能是和锁相关的一些其他附属信息等）。
关键的一点是通过clientv3.withlease(lease.id)这个选项将前面申请到的租约的id关联到这个要写入的键值对上，意思是这个键值对的存在时长会受租约的控制，当租约到期（达到ttl设定的时间）时，etcd会自动删除这个键值对，从而实现了分布式锁的自动释放机制。和前面获取租约类似，put操作也可能出错，所以同样进行错误判断，如果err不为空，就返回错误给调用者。

现在，让我们实现unlock函数。该函数将执行以下步骤：

删除etcd中的锁键值对
解除租赁

func (dl *distributedlock) unlock(ctx context.context) error {
	_, err := dl.etcdclient.delete(ctx, dl.key)
	if err != nil {
		return err
	}

	_, err = dl.etcdclient.revoke(ctx, dl.leaseid)
	if err != nil {
		return err
	}

	log.printf("lock released: %s", dl.key)
	return nil
}

测试分布式锁

最后，让我们创建一个简单的测试应用程序来查看分布式锁的实际情况。基本上。go文件，添加以下代码：

package main

import (
	"context"
	"fmt"
	"os"
	"time"

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

func main() {
	endpoints := []string{"localhost:2379"}

	cfg := clientv3.config{
		endpoints:   endpoints,
		dialtimeout: 5 * time.second,
	}

	client, err := clientv3.new(cfg)
	if err != nil {
		fmt.printf("error connecting to etcd: %v", err)
		os.exit(1)
	}
	defer client.close()

	ctx := context.background()
	lockkey := "my-lock"
	lockvalue := "my-value"

	dl := distributedlock{
		key:        lockkey,
		value:      lockvalue,
		etcdclient: client,
	}

	err = dl.lock(ctx, 10)
	if err != nil {
		fmt.printf("error acquiring lock: %v", err)
		os.exit(1)
	}

	// simulate a critical section
	time.sleep(5 * time.second)

	err = dl.unlock(ctx)
	if err != nil {
		fmt.printf("error releasing lock: %v", err)
		os.exit(1)
	}
}

使用以下命令运行测试应用程序：

$ go run main.go

如果一切正常，您应该看到锁在5秒睡眠后被获取和释放。

重构实现失败重试

以下是在原代码基础上添加申请锁失败重试机制的示例代码，在 go 语言中可以使用循环结合退避策略等方式来实现，以下是一种常见的实现思路及代码示例，假设使用了time包来进行时间控制以及添加了适当的错误处理和重试次数限制等逻辑：

package main

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

type distributedlock struct {
    etcdclient *clientv3.client
    key        string
    value      string
    leaseid    clientv3.leaseid
}

func (dl *distributedlock) lock(ctx context.context, ttl int64) error {
    maxretries := 3       // 最大重试次数，可根据实际情况调整
    retrydelay := 1 * time.second // 初始重试间隔时间，可根据实际情况调整
    for retry := 0; retry < maxretries; retry++ {
        lease, err := dl.etcdclient.grant(ctx, ttl)
        if err!= nil {
            if retry == maxretries-1 {
                return fmt.errorf("failed to grant lease after %d retries: %v", maxretries, err)
            }
            // 等待一段时间后重试，这里可以采用退避策略，比如指数退避等，此处简单使用固定间隔
            time.sleep(retrydelay)
            continue
        }

        _, err = dl.etcdclient.put(ctx, dl.key, dl.value, clientv3.withlease(lease.id))
        if err!= nil {
            if retry == maxretries-1 {
                return fmt.errorf("failed to put key-value with lease after %d retries: %v", maxretries, err)
            }
            // 释放本次申请到的租约，避免资源浪费，虽然租约到期也会自动释放，但及时释放更好
            _, _ = dl.etcdclient.revoke(ctx, lease.id)
            time.sleep(retrydelay)
            continue
        }

        dl.leaseid = lease.id
        log.printf("lock acquired: %s", dl.key)
        return nil
    }
    return fmt.errorf("exceeded max retries for lock acquisition")
}

出来重试部分，其他逻辑不变，这里解释第二部分重试逻辑：

当租约申请成功后，尝试将键值对写入etcd并关联租约，若这个操作出现错误（err不为nil），同样有如下处理：
先判断是否达到最大重试次数，如果是，返回带有详细失败信息的error告知调用者设置键值关联租约操作经过多次重试后失败以及具体错误原因。
如果没达到最大重试次数，为了避免已经申请到的租约一直占用资源（虽然租约到期会自动释放，但及时主动释放更合理），调用dl.etcdclient.revoke方法来撤销（释放）刚刚申请到的租约，然后让当前协程暂停执行retrydelay设定的时间间隔后，通过continue进入下一次循环，再次尝试整个申请锁的流程。