pglock v0.2.1

https://github.com/myyrakle/pglock
여러 노드에 걸쳐서 사용할 분산 락이 필요했는데, Redis를 굳이 추가해서 붙이기는 싫어서 PostgreSQL 기반으로 범용적인 구현체를 하나 만들어봤다.

사용법은 간단하다.
일단 모듈을 설치한다.

go get github.com/myyrakle/pglock@v0.2.1

그리고 이런 식으로 클라이언트 초기화해서 쓰면 된다.

그럼 저 intiailze 과정에서 lock 테이블을 자동으로 만든다.

생성되는 테이블의 이름은 옵션 LockTableName을 통해 커스텀할 수 있다.
기본값은 그냥 lock이다.

XLock

XLock은 동시에 하나만 점유할 수 있는 분산 락 구현이다.

동작 원리 자체는 Mutex와 다를 바 없다.
동시에 하나의 사용자만 동일한 Lock을 점유할 수 있고, Lock 점유에 실패할 경우 내부적으로 TryXLock 루프를 돌면서 블럭한다.

아래는 간단한 예제다. 고루틴을 5개 띄워서 Lock을 경쟁한다.

package main

import (
	"context"
	"fmt"
	"log"
	"sync"

	"github.com/myyrakle/pglock"
)

func main() {
	lockClient := pglock.NewLockClient(pglock.LockClientOptions{
		DatabaseURL: "postgres://postgres@localhost:5432/postgres?sslmode=disable",
	})
	if err := lockClient.Initialize(); err != nil {
		log.Fatal(err)
	}

	ctx := context.Background()

	wg := sync.WaitGroup{}

	for i := 0; i < 5; i++ {
		wg.Add(1)
		go func(i int) {
			defer wg.Done()
			log.Printf("Goroutine %d: Attempting to acquire lock...", i)
			_, err := lockClient.XLock(ctx, pglock.XLockParams{
				Name:       "test_lock",
				LockID:     fmt.Sprintf("test_lock_%d", i),
				TTLSeconds: 60,
			})
			if err != nil {
				log.Printf("Goroutine %d: Failed to acquire lock: %v", i, err)
				return
			}
			log.Printf("Goroutine %d: Lock acquired!", i)

			// Simulate some work with the lock held
			// time.Sleep(2 * time.Second)

			if _, err := lockClient.Unlock(ctx, pglock.UnlockParams{
				Name:   "test_lock",
				LockID: fmt.Sprintf("test_lock_%d", i),
			}); err != nil {
				log.Printf("Goroutine %d: Failed to release lock: %v", i, err)
				return
			}
			log.Printf("Goroutine %d: Lock released!", i)
		}(i)
	}

	wg.Wait()
	log.Println("All goroutines have finished.")

}

실제로도 실행해보면 Lock을 기반으로 오와 열을 맞추면서 동작하게 된다.

유의할 부분은 Unlock과 TTL이다.
항상 Unlock까지 책임져서 마무리해줘야 하고, 혹시나 Lock을 잡은채로 죽어버릴 경우를 대비해서 TTL 플래그도 있다. TTL이 지나면 Lock이 남아있더라도 풀린 것으로 간주하고 재진입이 된다.

SLock

SLock - Shared Lock은 좀 더 유연한 버전의 구현체다.
동시에 접근 가능한 리소스를 원하는대로 조정할 수 있다. 세마포어와 비슷하다.
전반적인 사용법이나 원리는 XLock과 다르지 않으나, 동시 접근 수를 지정할 수 있다는 것이 다르다.

-1로 설정하면 무제한으로 들어올 수 있고, 저렇게 2를 넣으면 최대 2개의 사용자가 Lock을 동시에 잡을 수 있다.

그래서 저대로 실행하면

최대 2개까지만 들어왔다가 대기하는 것을 볼 수 있다.

그리고 XLock과 SLock은 상호배타적이다.
SLock을 잡은 상태에서는 XLock이 들어올 수 없고, XLock을 잡은 상태에서도 SLock이 들어올 수 없다.

기능 정리나 최적화 좀 하고, 우선순위 락도 구현해둘까 싶다.