utils:redis锁恢复TryLockWithContext方法

Author: keepchen

utils/redislock.go

@@ -27,6 +27,16 @@ type IRedisLocker interface {
 	//
 	// 该方法会立即返回锁定成功与否的结果
 	TryLock(key string) bool
+	// TryLockWithContext redis锁-尝试上锁
+	//
+	// using SetNX
+	//
+	// 与之对应的是使用 Unlock 或 UnlockWithContext 解锁
+	//
+	// # Note
+	//
+	// 该方法会立即返回锁定成功与否的结果
+	TryLockWithContext(ctx context.Context, key string) bool
 	// Lock redis锁-上锁
 	//
 	// using SetNX
@@ -110,6 +120,19 @@ func (rl redisLockerImpl) TryLock(key string) bool {
 	ctx, cancel := context.WithTimeout(context.Background(), redisExecuteTimeout)
 	defer cancel()
 
+	return rl.TryLockWithContext(ctx, key)
+}
+
+// TryLockWithContext redis锁-尝试上锁
+//
+// using SetNX
+//
+// 与之对应的是使用 Unlock 或 UnlockWithContext 解锁
+//
+// # Note
+//
+// 该方法会立即返回锁定成功与否的结果
+func (rl redisLockerImpl) TryLockWithContext(ctx context.Context, key string) bool {
 	lockOk, _ := rl.client.SetNX(ctx, key, lockerValue(), lockTTL).Result()
 
 	//锁定成功，开始执行自动续期
@@ -187,7 +210,7 @@ func (rl redisLockerImpl) Lock(ctx context.Context, key string) {
 			for {
 				select {
 				case <-ticker.C:
-					if ok, redisErr := rl.client.ExpireXX(innerCtx, key, lockTTL).Result(); !ok || redisErr != nil {
+					if expOk, expErr := rl.client.ExpireXX(innerCtx, key, lockTTL).Result(); !expOk || expErr != nil {
 						break LOOP
 					}
 				case <-cancelChan:

utils/redislock_test.go

@@ -17,6 +17,14 @@ func TestRedisLockerImplLockerValue(t *testing.T) {
 }
 
 func TestRedisLockPanic(t *testing.T) {
+	t.Run("RedisLockPanic-Init-Panic", func(t *testing.T) {
+		if redis.GetInstance() == nil && redis.GetClusterInstance() == nil {
+			assert.Panics(t, func() {
+				t.Log(RedisLocker())
+			})
+		}
+	})
+	
 	t.Run("RedisLockPanic-Lock", func(t *testing.T) {
 		if redis.GetInstance() == nil && redis.GetClusterInstance() == nil {
 			assert.Panics(t, func() {
@@ -31,7 +39,16 @@ func TestRedisLockPanic(t *testing.T) {
 	t.Run("RedisLockPanic-TryLock", func(t *testing.T) {
 		if redis.GetInstance() == nil && redis.GetClusterInstance() == nil {
 			assert.Panics(t, func() {
-				key := "go-sail-redisLocker-Lock"
+				key := "go-sail-redisLocker-TryLock"
+				RedisLocker().TryLock(key)
+			})
+		}
+	})
+
+	t.Run("RedisLockPanic-TryLockWithContext", func(t *testing.T) {
+		if redis.GetInstance() == nil && redis.GetClusterInstance() == nil {
+			assert.Panics(t, func() {
+				key := "go-sail-redisLocker-TryLockWithContext"
 				RedisLocker().TryLock(key)
 			})
 		}
@@ -40,7 +57,7 @@ func TestRedisLockPanic(t *testing.T) {
 	t.Run("RedisLockPanic-UnlockWithContext", func(t *testing.T) {
 		if redis.GetInstance() == nil && redis.GetClusterInstance() == nil {
 			assert.Panics(t, func() {
-				key := "go-sail-redisLocker-Lock"
+				key := "go-sail-redisLocker-UnlockWithContext"
 				ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
 				defer cancel()
 				RedisLocker().UnlockWithContext(ctx, key)
@@ -88,7 +105,7 @@ func TestRedisLock(t *testing.T) {
 	})
 
 	t.Run("Unlock-WithContext", func(t *testing.T) {
-		key := "go-sail-redisLocker-Unlock"
+		key := "go-sail-redisLocker-UnlockWithContext"
 		t.Log(RedisLocker().TryLock(key))
 		ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
 		defer cancel()
@@ -148,7 +165,7 @@ func TestRedisClusterLock(t *testing.T) {
 	})
 
 	t.Run("Unlock-WithContext", func(t *testing.T) {
-		key := "go-sail-redisLocker-Unlock"
+		key := "go-sail-redisLocker-UnlockWithContext"
 		t.Log(RedisLocker().TryLock(key))
 		ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
 		defer cancel()