jedis-lock

https://github.com/kaidul/jedis-lock/blob/master/README.md
package com.github.jedis.lock;

import java.util.Arrays;
import java.util.UUID;

import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisCluster;
import redis.clients.jedis.JedisCommands;

/**

  • @author Alois Belaska

  • @author kaidul
    */
    public class JedisLock<T extends JedisCommands> {

    /**

    • Lua script which allows for an atomic delete on the lock only
    • if it is owned by the lock. This prevents locks stealing from others.
      */
      private final static String DELETE_IF_OWNED_LUA_SNIPPET =
      "if redis.call('get', KEYS[1]) == ARGV[1] then " +
      "return redis.call('del', KEYS[1]) " +
      "else " +
      "return 0 " +
      "end";

    private static final int ONE_SECOND = 1000;

    public static final int DEFAULT_EXPIRY_TIME_MILLIS = Integer.getInteger("com.github.jedis.lock.expiry.millis", 60 * ONE_SECOND);
    public static final int DEFAULT_ACQUIRE_TIMEOUT_MILLIS = Integer.getInteger("com.github.jedis.lock.acquiry.millis", 10 * ONE_SECOND);
    public static final int DEFAULT_ACQUIRY_RESOLUTION_MILLIS = Integer.getInteger("com.github.jedis.lock.acquiry.resolution.millis", 100);

    private final T jedis;

    private final String lockKey;

    private final int lockExpiryInMillis;
    private final int acquiryTimeoutInMillis;
    private final UUID lockUUID;

    private boolean isLocked;

/**
 * Detailed constructor with default acquire timeout 10000 msecs and lock
 * expiration of 60000 msecs.
 * 
 * @param jedis
 *            Jedis or JedisCluster instance
 * @param lockKey
 *            lock key (ex. account:1, ...)
 */
public JedisLock(T jedis, String lockKey) {
    this(jedis, lockKey, DEFAULT_ACQUIRE_TIMEOUT_MILLIS, DEFAULT_EXPIRY_TIME_MILLIS);
}

/**
 * Detailed constructor with default lock expiration of 60000 msecs.
 * 
 * @param jedis
 *            Jedis or JedisCluster instance
 * @param lockKey
 *            lock key (ex. account:1, ...)
 * @param acquireTimeoutMillis
 *            acquire timeout in milliseconds (default: 10000 msecs)
 */
public JedisLock(T jedis, String lockKey, int acquireTimeoutMillis) {
    this(jedis, lockKey, acquireTimeoutMillis, DEFAULT_EXPIRY_TIME_MILLIS);
}

/**
 * Detailed constructor.
 * 
 * @param jedis
 *            Jedis or JedisCluster instance
 * @param lockKey
 *            lock key (ex. account:1, ...)
 * @param acquireTimeoutMillis
 *            acquire timeout in milliseconds (default: 10000 msecs)
 * @param expiryTimeMillis
 *            lock expiration in milliseconds (default: 60000 msecs)
 */
public JedisLock(T jedis, String lockKey, int acquireTimeoutMillis, int expiryTimeMillis) {
    this(jedis, lockKey, acquireTimeoutMillis, expiryTimeMillis, UUID.randomUUID());
}

/**
 * Detailed constructor.
 * 
 * @param jedis
 *            Jedis or JedisCluster instance
 * @param lockKey
 *            lock key (ex. account:1, ...)
 * @param acquireTimeoutMillis
 *            acquire timeout in milliseconds (default: 10000 msecs)
 * @param expiryTimeMillis
 *            lock expiration in milliseconds (default: 60000 msecs)
 * @param uuid
 *            unique identification of this lock
 */
public JedisLock(T jedis, String lockKey, int acquireTimeoutMillis, int expiryTimeMillis, UUID uuid) {
    this.jedis = jedis;
    this.lockKey = lockKey;
    this.acquiryTimeoutInMillis = acquireTimeoutMillis;
    this.lockExpiryInMillis = expiryTimeMillis+1;
    this.lockUUID = uuid;
    this.isLocked = false;
}

/**
 * @return lock uuid
 */
public UUID getLockUUID() {
    return lockUUID;
}

/**
 * @return lock key
 */
public String getLockKey() {
    return lockKey;
}

/**
 * Acquire lock.
 * 
 * @return true if lock is acquired, false acquire timeout
 * @throws InterruptedException
 *             in case of thread interruption
 */
public synchronized boolean acquire() throws InterruptedException {
    return acquire(jedis);
}

/**
 * Acquire lock.
 * 
 * @param jedis
 *            Jedis or JedisCluster instance
 * @return true if lock is acquired, false acquire timeout
 * @throws InterruptedException
 *             in case of thread interruption
 */
protected synchronized boolean acquire(T jedis) throws InterruptedException {
    if(isLocked()) {
        return renew();
    }
    int timeout = acquiryTimeoutInMillis;
    while (timeout >= 0) {
        if ("OK".equals(jedis.set(lockKey, lockUUID.toString(), "NX", "PX", lockExpiryInMillis))) {
            return this.isLocked = true;
        }
        timeout -= DEFAULT_ACQUIRY_RESOLUTION_MILLIS;
        Thread.sleep(DEFAULT_ACQUIRY_RESOLUTION_MILLIS);
    }

    return false;
}

/**
 * Renew lock.
 * 
 * @return false if lock is not currently owned
 *         false if lock is currently owned by remote owner
 *         true otherwise
 * @throws InterruptedException
 *             in case of thread interruption
 */
public synchronized boolean renew() throws InterruptedException {
    if(!isLocked() || isRemoteLocked()) {
      return false;
    }
    int timeout = acquiryTimeoutInMillis;
    while (timeout >= 0) {
        if ("OK".equals(jedis.set(lockKey, lockUUID.toString(), "XX", "PX", lockExpiryInMillis))) {
            return true;
        }
        timeout -= DEFAULT_ACQUIRY_RESOLUTION_MILLIS;
        Thread.sleep(DEFAULT_ACQUIRY_RESOLUTION_MILLIS);
    }
    
    return false;
}

/**
 * Acquired lock release.
 */
public synchronized void release() {
    release(jedis);
}

/**
 * Acquired lock release.
 * @param jedis
 *            Jedis or JedisCluster instance
 */
protected synchronized void release(T jedis) {
    if (isLocked()) {
        if(jedis instanceof Jedis) {
            ((Jedis) jedis).eval(DELETE_IF_OWNED_LUA_SNIPPET, Arrays.asList(lockKey), Arrays.asList(lockUUID.toString()));
        }
        else if(jedis instanceof JedisCluster) {
            ((JedisCluster) jedis).eval(DELETE_IF_OWNED_LUA_SNIPPET, Arrays.asList(lockKey), Arrays.asList(lockUUID.toString()));
        }
        this.isLocked = false;
    }
}

/**
 * Check if owns the lock
 * @return  true if lock owned
 */
public synchronized boolean isLocked() {
    return this.isLocked;
}

/**
 * Check if the lock is owned by remote owner
 * @return  true if lock owned
 */
public synchronized boolean isRemoteLocked() {
    if(this.isLocked()) {
        return false;
    }
    if(jedis.get(lockKey) == null) {
        return false;
    }
    return true;
}

}

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,108评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,699评论 1 296
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,812评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,236评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,583评论 3 288
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,739评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,957评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,704评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,447评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,643评论 2 249
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,133评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,486评论 3 256
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,151评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,108评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,889评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,782评论 2 277
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,681评论 2 272

推荐阅读更多精彩内容