io.github.spring.tools.redis.annotation

注释类型 RedisLock

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
public @interface RedisLock

共享锁配置

版本:

1.0

作者:

fenghu.shi

另请参阅:

RedisLockBuilder

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_INT 默认值
static String	DEFAULT_METHOD 默认方法
static byte	FAULT_NUMBER_DEFAULT 失败返回的默认值
static int	TRY_ONE 只尝试一次

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	fallbackMethod 失败降级方法，当获取所失败时，替代方法，方法签名必须跟当前方法一致
FaultPolicy	faultPolicy 获取所失败执行策略，默认是自动，具体见 FaultPolicy.AUTO
Class<? extends Throwable>	faultThrowableException 获取锁失败抛出的异常，如果定义了异常，则默认
String	key key 值
int	lockedSeconds 锁最长可以持有时间，单位秒，默认 是 ILockWritable.DEFAULT_LOCK_SECONDS
String	rollbackMethod 回调函数，该函数必须是当前对象的公共方法，参数也相同，不需要返回值
Class<? extends Throwable>	rollbackThrowableException 回滚失败抛出的异常，如果不设置，则忽略
String	value 锁定的key，支持变量，#{paramName1} #{paramName2} #{paramName3}，调用 tostring 方法生成，null="" 默认 使用 Method.toString() 方法生成
int	waitTimeoutMills 最长等待时间，单位秒

字段详细资料

DEFAULT_INT

public static final int DEFAULT_INT

默认值

DEFAULT_METHOD

public static final String DEFAULT_METHOD

默认方法

FAULT_NUMBER_DEFAULT

public static final byte FAULT_NUMBER_DEFAULT

失败返回的默认值

TRY_ONE

public static final int TRY_ONE

只尝试一次

元素详细资料

value

@AliasFor(value="key")
public abstract String value

锁定的key，支持变量，#{paramName1} #{paramName2} #{paramName3}，调用 tostring 方法生成，null="" 默认 使用 Method.toString() 方法生成

默认值:

"__default"

key

public abstract String key

key 值

默认值:

"__default"

lockedSeconds

public abstract int lockedSeconds

锁最长可以持有时间，单位秒，默认 是 ILockWritable.DEFAULT_LOCK_SECONDS

默认值:

2147483647

rollbackMethod

public abstract String rollbackMethod

回调函数，该函数必须是当前对象的公共方法，参数也相同，不需要返回值

默认值:

"__default"

fallbackMethod

public abstract String fallbackMethod

失败降级方法，当获取所失败时，替代方法，方法签名必须跟当前方法一致

默认值:

"__default"

faultPolicy

public abstract FaultPolicy faultPolicy

获取所失败执行策略，默认是自动，具体见 FaultPolicy.AUTO

默认值:

io.github.spring.tools.redis.annotation.FaultPolicy.AUTO

waitTimeoutMills

public abstract int waitTimeoutMills

最长等待时间，单位秒

返回:

默认值:

2147483647

faultThrowableException

public abstract Class<? extends Throwable> faultThrowableException

获取锁失败抛出的异常，如果定义了异常，则默认

默认值:

io.github.spring.tools.redis.exception.TimeoutLockException.class

rollbackThrowableException

public abstract Class<? extends Throwable> rollbackThrowableException

回滚失败抛出的异常，如果不设置，则忽略

默认值:

io.github.spring.tools.redis.exception.UnLockFailException.class