app.myoss.cloud.cache.lock

Interface LockService

All Known Implementing Classes:

RedisLockServiceImpl

public interface LockService

缓存锁服务接口

Since:

2018年5月9日 下午5:01:14

Author:

Jerry.Chen

Method Summary

Modifier and Type	Method and Description
boolean	executeByLock(Serializable key, int expireTime, LockFunction callback) 如果获取锁成功，则执行 callback.onLockSuccess() 如果获取锁失败，则执行 callback.onLockFailed()
<T> T	executeByLock(Serializable key, int expireTime, LockFunctionGeneric<T> callback) 如果获取锁成功，则执行 callback.onLockSuccess() 如果获取锁失败，则执行 callback.onLockFailed()
<T> T	executeByLock(Serializable key, int expireTime, LockFunctionGenericWithArgs<T> callback, Object... args) 如果获取锁成功，则执行 callback.onLockSuccess() 如果获取锁失败，则执行 callback.onLockFailed()
boolean	executeByLock(Serializable key, int expireTime, LockFunctionWithArgs callback, Object... args) 如果获取锁成功，则执行 callback.onLockSuccess() 如果获取锁失败，则执行 callback.onLockFailed()
boolean	getLock(Serializable key, int expireTime) 获取锁
boolean	getLock(Serializable key, int expireTime, TimeUnit timeUnit) 获取锁
boolean	releaseLock(Serializable key) 释放锁
static void	sleep(long milliseconds) 模拟Thread.sleep(long)，规避 SonarQube 会扫描 Thread.sleep 代码。

Method Detail

sleep

static void sleep(long milliseconds)

模拟Thread.sleep(long)，规避 SonarQube 会扫描 Thread.sleep 代码。

Using Thread.sleep in a test is just generally a bad idea. It creates brittle tests that can fail unpredictably depending on environment ("Passes on my machine!") or load.

也可以使用 TimeUnit.sleep(long) 去替代 Thread.sleep 代码

Parameters:

milliseconds - 等待的毫秒时间

getLock

boolean getLock(Serializable key,
                int expireTime,
                TimeUnit timeUnit)

获取锁

Parameters:

key - 锁的名字

expireTime - 锁的过期时间

timeUnit - 缓存锁的时间单位

Returns:

true：获取到锁，false：没有获取到锁

getLock

boolean getLock(Serializable key,
                int expireTime)

获取锁

Parameters:

key - 锁的名字

expireTime - 锁的过期时间

Returns:

true：获取到锁，false：没有获取到锁

releaseLock

boolean releaseLock(Serializable key)

释放锁

Parameters:

key - 锁的名字

Returns:

true：释放锁成功，false：释放锁失败

executeByLock

boolean executeByLock(Serializable key,
                      int expireTime,
                      LockFunction callback)

如果获取锁成功，则执行 callback.onLockSuccess() 如果获取锁失败，则执行 callback.onLockFailed()

Parameters:

key - 锁的名字

expireTime - 锁的过期时间

callback - 回调函数

Returns:

true：获取到锁，false：没有获取到锁

executeByLock

boolean executeByLock(Serializable key,
                      int expireTime,
                      LockFunctionWithArgs callback,
                      Object... args)

如果获取锁成功，则执行 callback.onLockSuccess() 如果获取锁失败，则执行 callback.onLockFailed()

Parameters:

key - 锁的名字

expireTime - 锁的过期时间

callback - 回调函数

args - 回调函数的入参

Returns:

true：获取到锁，false：没有获取到锁

executeByLock

<T> T executeByLock(Serializable key,
                    int expireTime,
                    LockFunctionGeneric<T> callback)

如果获取锁成功，则执行 callback.onLockSuccess() 如果获取锁失败，则执行 callback.onLockFailed()

Type Parameters:

T - 回调函数返回的泛型

Parameters:

key - 锁的名字

expireTime - 锁的过期时间

callback - 回调函数

Returns:

回调函数返回的结果

executeByLock

<T> T executeByLock(Serializable key,
                    int expireTime,
                    LockFunctionGenericWithArgs<T> callback,
                    Object... args)

如果获取锁成功，则执行 callback.onLockSuccess() 如果获取锁失败，则执行 callback.onLockFailed()

Type Parameters:

T - 回调函数返回的泛型

Parameters:

key - 锁的名字

expireTime - 锁的过期时间

callback - 回调函数

args - 回调函数的入参

Returns:

回调函数返回的结果