org.feasy.cloud.locks

注释类型 DistributedLock

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

分布式锁注解

从以下版本开始:

2020/5/20

作者:

yangxiaohui

可选元素概要

可选元素

限定符和类型	可选元素和说明
int	argNum 将方法第argNum个参数作为锁
long	leaseTime 锁超时时间。
String	lockName 锁的名称。
String	lockNamePost lockName后缀
String	lockNamePre lockName后缀
LockType	lockType 使用锁的类型。
String	param 获取注解的方法参数列表的某个参数对象的某个属性值来作为lockName。
String	separator 获得锁名时拼接前后缀用到的分隔符
TimeUnit	timeUnit 时间单位。
boolean	tryLock 是否使用尝试锁。
long	waitTime 最长等待时间。

元素详细资料

lockName

public abstract String lockName

锁的名称。 如果lockName可以确定，直接设置该属性。

默认值:

""

lockNamePre

public abstract String lockNamePre

lockName后缀

默认值:

""

lockNamePost

public abstract String lockNamePost

lockName后缀

默认值:

"lock"

separator

public abstract String separator

获得锁名时拼接前后缀用到的分隔符

返回:

默认值:

"."

param

public abstract String param

     获取注解的方法参数列表的某个参数对象的某个属性值来作为lockName。因为有时候lockName是不固定的。
     当param不为空时，可以通过argNum参数来设置具体是参数列表的第几个参数，不设置则默认取第一个。
 

默认值:

""

argNum

public abstract int argNum

将方法第argNum个参数作为锁

默认值:

0

lockType

public abstract LockType lockType

使用锁的类型。 默认：公平锁 即先来先得。

默认值:

org.feasy.cloud.locks.util.LockType.FAIR_LOCK

tryLock

public abstract boolean tryLock

是否使用尝试锁。 如果设置为true即悲观锁，每次获取资源前，先尝试是否能获取锁

默认值:

false

waitTime

public abstract long waitTime

最长等待时间。 该字段只有当tryLock()返回true才有效。

默认值:

30L

leaseTime

public abstract long leaseTime

锁超时时间。 超时时间过后，锁自动释放。 建议： 尽量缩简需要加锁的逻辑。

默认值:

5L

timeUnit

public abstract TimeUnit timeUnit

时间单位。默认为秒。

默认值:

java.util.concurrent.TimeUnit.SECONDS