[框架系列]-[通用lock框架]集成及具体配置使用

<dependency>

???<groupId>com.ty</groupId>

???<artifactId>ty-framework-lock-starter</artifactId>

???<version>0.2.9</version>

</dependency>

application:

??lock:

????enable:?true

spring:

??redis:

????database:?3

????cluster:

??????nodes:?192.168.xx.xxx:6479,192.168.xx.xxx:6479,192.168.xx.xxx:6479

????password:?12345678

application.lock.enable=true

#redis集群版配置示例，其他版本配置具体见Spring redis相关配置

spring.redis.database=3

spring.redis.cluster.nodes=192.168.xx.xxx:6479,192.168.xx.xxx:6479,192.168.xx.xxx:6479

spring.redis.password=12345678

enable

是否开启

Boolean.FALSE

使用需开启此配置

implementer

lock厂商实现类型

LockImplementer.REDIS

redis实现

type

lock 的类型

LockType.Reentrant

keys

自定义业务key（支持SpingEL）

无

注解

系统会按照${name}:${key1}:...:${keyN}:${@LockKey1}:...:${@LockKeyN}的方式拼接，作为lock的key

特殊的：当name，keys以及注解@LockKey都为空时，系统默认使用方法的全限定类名作为key（不推荐使用此方式）

name

锁的名称

无

注解

系统会按照${name}:${key1}:...:${keyN}:${@LockKey1}:...:${@LockKeyN}的方式拼接，作为lock的key

特殊的：当name，keys以及注解@LockKey都为空时，系统默认使用方法的全限定类名作为key（不推荐使用此方式）

supportTransaction

是否支持上下文感知

Boolean.TRUE

withLocalCache

是否支持本地lock二级缓存

Boolean.FALSE

transactionStrategy

仅开启supportTransaction生效

LockTransactionStrategy.WARMING

打warm日志

waitTime

等待时间

2s

leaseTime

等待时间

60s

此参数在Lock官方定义中不生效，可通过自定义LockAdapter使用该参数。redis实现中默认此参数不生效（自动续期机制），如方言需使用此参数参考：cn.techwolf.blue.usl.framework.lock.factory.support.RedissonLockAdapterFactory

lockFailStrategy

加锁失败的处理策略

FailOnLockStrategy.FAIL_FAST

快速失败

exceptionOnLockStrategy

加锁异常的处理策略

ExceptionOnLockStrategy.THROW_EXCEPTION

抛出异常

releaseTimeoutStrategy

释放锁时异常的处理策略

ReleaseTimeoutStrategy.FAIL_FAST

快速失败

exceptionClass

获取锁失败时，报错的异常类型

LockException

获取锁失败时，报错的异常类型
1.仅当LockFailStrategy.FAIL_FAST或者ReleaseTimeoutStrategy.FAIL_FAST 生效 此处设置二者都会生效
2.优先级：注解exceptionClass>lockConfig exceptionClass>系统默认
3.示例：cn.techwolf.blue.usl.framework.common.exception.FrameworkException
4.注意：必须是RuntimeException的子类

exceptionMsg

获取锁失败时，报错的错误信息

Failed to acquire Lock(%s) with timeout(%d ms)

仅当LockFailStrategy.FAIL_FAST或者ReleaseTimeoutStrategy.FAIL_FAST生效此处设置二者都会生效
优先级：注解exceptionClass>lockConfig exceptionClass>系统默认

此方式与lockFailStrategy中的CUSTOM不同点在于：此方式可对方法具体参数做定制化的处理策略，
后者更适合做全局的默认处理

customReleaseTimeout
Strategy

用户指定，定义的方法参数需要和注解所在的方法参数保持一致

此方式与releaseTimeoutStrategy中的CUSTOM不同点在于：此方式可对方法具体参数做定制化的处理策略，后者更适合做全局的默认处理

@Autowired

LockRegistry lockRegistry;

public?void?testApi()?throws?Exception {

????Lock lock = lockRegistry.obtain("aaa");

????try?{

????????boolean?b = lock.tryLock(2, TimeUnit.SECONDS);

????????if?(b){

????????????//do your business code

????????}

????}finally?{

????????lock.unlock();

????}

}

@Lock(waitTime =?10, keys = {"#param"}, timeUnit = TimeUnit.SECONDS, lockFailStrategy = FailOnLockStrategy.FAIL_FAST)

@Transactional

public?String getValue(String param)?throws?Exception {

????if?("sleep".equals(param)) {//线程休眠或者断点阻塞，达到一直占用锁的测试效果

????????Thread.sleep(100?*?10);

????}

????return?"success";

}

@Lock(keys = {"#userId"})

public?String getValue(String userId,?@LockKey?Integer id)?throws?Exception {

????Thread.sleep(60?*?10);

????return?"success";

}

@FailFastLock(keys = {"#user.id"})

public?String getValueWithFailFastLock(User user) {

????try?{

????????Thread.sleep(1000);

????}?catch?(InterruptedException e) {

????????e.printStackTrace();

????}

????return?"success";

}

@LocalLock(keys = {"#user.id"})

public?String getValueWithLocalLock(User user) {

????try?{

????????Thread.sleep(1000);

????}?catch?(InterruptedException e) {

????????e.printStackTrace();

????}

????return?"success";

}

@Lock(name =?"foo-service", waitTime =?1, exceptionClass =?"techwolf.blue.usl.framework.springboot.lock.test.customer.exception.CustomerException",exceptionMsg =?"我是注解自定义异常信息")

public?void?foo10() {

????try?{

????????log.info("acquire lock");

????????TimeUnit.SECONDS.sleep(2);

????}?catch?(InterruptedException e) {

????????e.printStackTrace();

????}

}

@Lock(name =?"foo-service",waitTime =?2,customLockFailStrategy =?"customLockTimeout")

public?String foo4(String foo, String bar) {

????try?{

????????TimeUnit.SECONDS.sleep(2);

????????log.info("acquire lock");

????}?catch?(InterruptedException e) {

????????e.printStackTrace();

????}

????return?"foo4";

}

private?String customLockTimeout(String foo, String bar) {

????return?"custom foo:"?+ foo +?" bar:"?+ bar;

}