JarCastingSpring DistributeLock
1. Description
This is a distribute lock with spring. Lock key support spel. Default implement is Redis.
DistributeLock:
maven
<dependency>
<groupId>com.github.blackshadowwalker.spring</groupId>
<artifactId>spring-distributelock</artifactId>
<version>1.1.0</version>
</dependency>
public @interface DistributeLock {
/**
* The lock Name, if empty the value is `targetClass.getName() + "#" + method.getName()`.
*
* @return
*/
String value() default "";
/**
* Lock key (Spel), if empty keyGenerator will be work.
*/
String key() default "";
/**
* The error msg if get lock failed(new LockException(errMsg))
* if empty will not throw LockException, just return false;
* @return
*/
String errMsg() default "Failed Get Lock";
/**
* Timeout when getLock (seconds)
*
* @return
*/
long timeout() default 20;
/**
* key expire time (seconds) if gt; 0
*
* @return key expire time in seconds
*/
long expire() default -1;
/**
* auto unlock , if false please set expire > 0
* @return
*/
boolean autoUnLock() default true;
}
public @interface DistributeLocks {
DistributeLock[] value();
}
2. Usage
2.1 config
spring xml config
<bean id="lockManager" class="com.github.blackshadowwalker.spring.distributelock.redis.RedisLockManager"
p:lockPrefix="${lock.prefix}"
p:cacheLock="false"
p:redisTemplate-ref="stringRedisTemplate" />
<aop:aspectj-autoproxy proxy-target-class="false"/>
<bean class="com.github.blackshadowwalker.spring.distributelock.interceptor.LockAspectSupport" p:lockManager-ref="lockManager" />
2.2 define lock annotation
e.g:
DistributeLock
@DistributeLock(value = "updateUserStatus", key = "#userId", timeout = 10, expire = 60, errMsg = "更新失败，请刷新重试")
public Integer updateUserStatus(Long userId, Integer status) throws Exception {
...
return ...;
}
DistributeLocks
@DistributeLocks({
@DistributeLock(value = "KEY1", key = "#userId", timeout = 10, expire = 60, errorCode = "401", errMsg = "更新失败，请刷新重试"),
@DistributeLock(value = "KEY2", key = "#status", timeout = 10, expire = 60, errorCode = "402", errMsg = "更新失败，请刷新重试")
})
public Integer updateUserStatus(Long userId, Integer status) throws Exception {
...
return ...;
}