{"id":23921911,"url":"https://github.com/cheerego/go-redisson","last_synced_at":"2025-04-11T23:21:38.455Z","repository":{"id":37717570,"uuid":"489365713","full_name":"cheerego/go-redisson","owner":"cheerego","description":"a redisson like distributed redis lock, support watchdog、reentrant lock, implement by go","archived":false,"fork":false,"pushed_at":"2022-07-04T13:31:08.000Z","size":34,"stargazers_count":48,"open_issues_count":5,"forks_count":12,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T19:11:22.078Z","etag":null,"topics":["distributed-locks","go","golang","lock","redis","redisson","watchdog"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cheerego.png","metadata":{"files":{"readme":"README-zh.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-05-06T13:29:48.000Z","updated_at":"2025-03-07T02:33:02.000Z","dependencies_parsed_at":"2022-09-16T06:13:25.072Z","dependency_job_id":null,"html_url":"https://github.com/cheerego/go-redisson","commit_stats":null,"previous_names":["cheerego/godisson"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheerego%2Fgo-redisson","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheerego%2Fgo-redisson/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheerego%2Fgo-redisson/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheerego%2Fgo-redisson/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cheerego","download_url":"https://codeload.github.com/cheerego/go-redisson/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248493044,"owners_count":21113189,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["distributed-locks","go","golang","lock","redis","redisson","watchdog"],"created_at":"2025-01-05T16:47:20.947Z","updated_at":"2025-04-11T23:21:38.427Z","avatar_url":"https://github.com/cheerego.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## go-redisson \n\n一个借鉴 redisson 用 go 实现的 Redis 分布式锁的库。\n\n## 安装\n\n```shell\ngo get github.com/cheerego/go-redisson\n```\n\n\n## 支持锁类型\n\n* Mutex [示例](#Mutex) 特性：\n  * 互斥锁 (X Lock)。 \n  * 和 go 标准库 sync.Mutex 用起来差不多。 \n  * 不支持可重入。 \n  * 支持 WatchDog。\n\n* RLock[示例](#RLock) 特性：\n  * 互斥可重入锁。 \n  * 和 redisson 使用起来差不多。 \n  * 支持同一个协程重复加锁。\n  * 支持 WatchDog。\n\n## 特性\n\n* tryLock，if waitTime \u003e 0, wait `waitTime` milliseconds to try to obtain lock by while true and redis pub sub.\n* watchdog, if leaseTime = -1, start a time.Ticker(defaultWatchDogTime / 3) to renew lock expiration time.\n\n## 配置 \n\n### WatchDogTimeout\n\n```go\ng := godisson.NewGodisson(rdb, godisson.WithWatchDogTimeout(30*time.Second))\n```\n\n\n## 示例\n\n\n### Mutex\n\n```go\npackage main\n\nimport (\n  \"github.com/cheerego/go-redisson\"\n  \"github.com/go-redis/redis/v8\"\n  \"github.com/pkg/errors\"\n  \"log\"\n  \"time\"\n)\n\nfunc main() {\n\n  // create redis client\n  rdb := redis.NewClient(\u0026redis.Options{\n    Addr:     \"localhost:6379\",\n    Password: \"\", // no password set\n    DB:       0,  // use default DB\n  })\n  defer rdb.Close()\n\n  g := godisson.NewGodisson(rdb, godisson.WithWatchDogTimeout(30*time.Second))\n\n  test1(g)\n  test2(g)\n}\n\n// can't obtain lock in a same goroutine\nfunc test1(g *godisson.Godisson) {\n  m1 := g.NewMutex(\"godisson\")\n  m2 := g.NewMutex(\"godisson\")\n\n  err := m1.TryLock(-1, 20000)\n  if errors.Is(err, godisson.ErrLockNotObtained) {\n    log.Println(\"can't obtained lock\")\n  } else if err != nil {\n    log.Fatalln(err)\n  }\n  defer m1.Unlock()\n\n  // because waitTime = -1, waitTime \u003c 0, try once, will return ErrLockNotObtained\n  err = m2.TryLock(-1, 20000)\n  if errors.Is(err, godisson.ErrLockNotObtained) {\n    log.Println(\"m2 must not obtained lock\")\n  } else if err != nil {\n    log.Fatalln(err)\n  }\n  time.Sleep(10 * time.Second)\n}\n\nfunc test2(g *godisson.Godisson) {\n  m1 := g.NewMutex(\"godisson\")\n  m2 := g.NewMutex(\"godisson\")\n\n  go func() {\n    err := m1.TryLock(-1, 20000)\n    if errors.Is(err, godisson.ErrLockNotObtained) {\n      log.Println(\"can't obtained lock\")\n    } else if err != nil {\n      log.Fatalln(err)\n    }\n    time.Sleep(10 * time.Second)\n    m1.Unlock()\n  }()\n\n  // waitTime \u003e 0, after 10 milliseconds will obtain the lock\n  go func() {\n    time.Sleep(1 * time.Second)\n\n    err := m2.TryLock(15000, 20000)\n    if errors.Is(err, godisson.ErrLockNotObtained) {\n      log.Println(\"m2 must not obtained lock\")\n    } else if err != nil {\n      log.Fatalln(err)\n    }\n    time.Sleep(10 * time.Second)\n\n    m2.Unlock()\n  }()\n  time.Sleep(20 * time.Second)\n\n}\n\n\n```\n\n\n### RLock\n```go\npackage main\n\nimport (\n  \"github.com/cheerego/go-redisson\"\n  \"github.com/go-redis/redis/v8\"\n  \"log\"\n  \"time\"\n)\n\nfunc main() {\n\n  // create redis client\n  rdb := redis.NewClient(\u0026redis.Options{\n    Addr:     \"localhost:6379\",\n    Password: \"\", // no password set\n    DB:       0,  // use default DB\n  })\n  defer rdb.Close()\n\n  g := godisson.NewGodisson(rdb, godisson.WithWatchDogTimeout(30*time.Second))\n\n  // lock with watchdog without retry\n  lock := g.NewRLock(\"godisson\")\n\n  err := lock.Lock()\n  if err == godisson.ErrLockNotObtained {\n    log.Println(\"Could not obtain lock\")\n  } else if err != nil {\n    log.Fatalln(err)\n  }\n  defer lock.Unlock()\n\n  // lock with retry、watchdog\n  // leaseTime value is -1, enable watchdog\n  lock2 := g.NewRLock(\"godission-try-watchdog\")\n\n  err = lock2.TryLock(20000, -1)\n  if err == godisson.ErrLockNotObtained {\n    log.Println(\"Could not obtain lock\")\n  } else if err != nil {\n    log.Fatalln(err)\n  }\n  time.Sleep(10 * time.Second)\n  defer lock.Unlock()\n}\n\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheerego%2Fgo-redisson","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheerego%2Fgo-redisson","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheerego%2Fgo-redisson/lists"}