io.github.spring.tools.redis.capable

接口 ILock

所有超级接口:

AutoCloseable, ILockTemplate, Lock

所有已知子接口:

IRedisLock

所有已知实现类:

AbsLockDecorator, DefaultRedisLock, ReentrantLockDecorator

public interface ILock
extends Lock, AutoCloseable, ILockTemplate

Redis 锁 基础服务接口定义

定义了Redis 锁对外暴露的服务接口，支持 try-with-resource

版本:

1.0.0

作者:

Fenghu.Shi

另请参阅:

Lock, AutoCloseable, ILockTemplate

方法概要

限定符和类型	方法和说明
default void	close() try-with-resource close
default <T> T	execute(IDoCallback<T> callback, IDoCallback<T> faultCallback, IDoCallback<T> rollback, int time, TimeUnit unit) 执行需要锁的函数
String	getKey() 获取锁的key
int	getLockSeconds() 需要锁定的时间
RedisLockReleaseStatus	getReleaseStatus() 获取 释放 状态
int	getSleepMaxMills() 获取最大休眠时间
int	getSleepMinMills() 获取最小休眠时间，毫秒
int	getSpinTimes() 获取自旋次数
RedisLockStatus	getStatus() 获取所的状态
boolean	interrupted() 取消当前锁，只对 NEW 状态可用
default boolean	isFinished() 流程结束
default boolean	isLocked() 是否 以获取锁
default boolean	isRollback() 是否需要 回滚, status=RedisLockStatus.LOCKED && releaseStatus=RedisLockReleaseStatus.FAIL 时返回true
default void	lock() 锁定，此方法不支持
default void	lockInterruptibly() 可重复线程锁，不支持
default Condition	newCondition() 此方法不支持

从接口继承的方法 java.util.concurrent.locks.Lock

tryLock, tryLock, unlock

从接口继承的方法 io.github.spring.tools.redis.capable.ILockTemplate

execute, execute, execute, execute, execute

方法详细资料

getStatus

RedisLockStatus getStatus()

获取所的状态

返回:

当前状态

getReleaseStatus

RedisLockReleaseStatus getReleaseStatus()

获取 释放 状态

返回:

当期那状态

getSleepMinMills

int getSleepMinMills()

获取最小休眠时间，毫秒

返回:

getSleepMaxMills

int getSleepMaxMills()

获取最大休眠时间

返回:

getSpinTimes

int getSpinTimes()

获取自旋次数

返回:

getKey

String getKey()

获取锁的key

返回:

当前 key

getLockSeconds

int getLockSeconds()

需要锁定的时间

返回:

当前设置的 时间

isFinished

default boolean isFinished()

流程结束

返回:

是否结束

isLocked

default boolean isLocked()

是否 以获取锁

返回:

是否锁定

isRollback

default boolean isRollback()

是否需要 回滚, status=RedisLockStatus.LOCKED && releaseStatus=RedisLockReleaseStatus.FAIL 时返回true

返回:

结果

interrupted

boolean interrupted()

取消当前锁，只对 NEW 状态可用

返回:

是否取消成功

execute

default <T> T execute(IDoCallback<T> callback,
                      IDoCallback<T> faultCallback,
                      IDoCallback<T> rollback,
                      int time,
                      TimeUnit unit)
               throws TimeoutLockException,
                      Throwable

执行需要锁的函数

指定者:

execute 在接口中 ILockTemplate

类型参数:

T - 返回值类型

参数:

callback - 获取锁成功执行的函数

faultCallback - 获取所失败后降级参数，=null 时，获取失败将抛出 SharedLockTimeoutException

rollback - 释放资源失败回退操作

time - 等待时间

unit - 时间单位

返回:

返回数据

抛出:

TimeoutLockException - 超时异常

Throwable - 其他业务异常

close

default void close()
            throws Exception

try-with-resource close

指定者:

close 在接口中 AutoCloseable

抛出:

Exception - 关闭失败异常

newCondition

default Condition newCondition()

此方法不支持

指定者:

newCondition 在接口中 Lock

返回:

条件

lock

default void lock()

锁定，此方法不支持

指定者:

lock 在接口中 Lock

lockInterruptibly

default void lockInterruptibly()
                        throws InterruptedException

可重复线程锁，不支持

指定者:

lockInterruptibly 在接口中 Lock

抛出:

InterruptedException