|
1 | 1 | package com.central.common.lock;
|
2 | 2 |
|
| 3 | +import java.util.concurrent.TimeUnit; |
| 4 | + |
3 | 5 | /**
|
4 | 6 | * 分布式锁顶级接口
|
5 |
| - * 例如: |
6 |
| - * RETRY_TIMES=100,SLEEP_MILLIS=100 |
7 |
| - * RETRY_TIMES * SLEEP_MILLIS = 10000 意味着如果一直获取不了锁,最长会等待10秒后抛超时异常 |
8 | 7 | *
|
9 | 8 | * @author zlt
|
10 | 9 | * @date 2018/5/29 14:12
|
| 10 | + * <p> |
| 11 | + * Blog: https://zlt2000.gitee.io |
| 12 | + * Github: https://github.com/zlt2000 |
11 | 13 | */
|
12 | 14 | public interface DistributedLock {
|
13 |
| - |
14 |
| - /** |
15 |
| - * 默认超时时间 |
16 |
| - */ |
17 |
| - long TIMEOUT_MILLIS = 5000; |
18 |
| - |
19 |
| - /** |
20 |
| - * 重试次数 |
21 |
| - */ |
22 |
| - int RETRY_TIMES = 100; |
23 |
| - |
24 |
| - /** |
25 |
| - * 每次重试后等待的时间 |
26 |
| - */ |
27 |
| - long SLEEP_MILLIS = 100; |
28 |
| - |
29 |
| - /** |
30 |
| - * 获取锁 |
31 |
| - * |
32 |
| - * @param key key |
33 |
| - * @return 成功/失败 |
34 |
| - */ |
35 |
| - boolean lock(String key); |
36 |
| - |
37 |
| - /** |
38 |
| - * 获取锁 |
39 |
| - * |
40 |
| - * @param key key |
41 |
| - * @param retryTimes 重试次数 |
42 |
| - * @return 成功/失败 |
43 |
| - */ |
44 |
| - boolean lock(String key, int retryTimes); |
45 |
| - |
46 |
| - /** |
47 |
| - * 获取锁 |
48 |
| - * |
49 |
| - * @param key key |
50 |
| - * @param retryTimes 重试次数 |
51 |
| - * @param sleepMillis 获取锁失败的重试间隔 |
52 |
| - * @return 成功/失败 |
53 |
| - */ |
54 |
| - boolean lock(String key, int retryTimes, long sleepMillis); |
55 |
| - |
56 |
| - /** |
57 |
| - * 获取锁 |
58 |
| - * |
59 |
| - * @param key key |
60 |
| - * @param expire 获取锁超时时间 |
61 |
| - * @return 成功/失败 |
62 |
| - */ |
63 |
| - boolean lock(String key, long expire); |
64 |
| - |
65 | 15 | /**
|
66 |
| - * 获取锁 |
67 |
| - * |
68 |
| - * @param key key |
69 |
| - * @param expire 获取锁超时时间 |
70 |
| - * @param retryTimes 重试次数 |
71 |
| - * @return 成功/失败 |
| 16 | + * 获取锁,如果获取不成功则一直等待直到lock被获取 |
| 17 | + * @param key 锁的key |
| 18 | + * @param leaseTime 加锁的时间,超过这个时间后锁便自动解锁; |
| 19 | + * 如果leaseTime为-1,则保持锁定直到显式解锁 |
| 20 | + * @param unit {@code leaseTime} 参数的时间单位 |
| 21 | + * @param isFair 是否公平锁 |
| 22 | + * @return 锁对象 |
72 | 23 | */
|
73 |
| - boolean lock(String key, long expire, int retryTimes); |
| 24 | + Object lock(String key, long leaseTime, TimeUnit unit, boolean isFair) throws Exception; |
| 25 | + Object lock(String key, long leaseTime, TimeUnit unit) throws Exception; |
| 26 | + Object lock(String key, boolean isFair) throws Exception; |
| 27 | + Object lock(String key) throws Exception; |
74 | 28 |
|
75 | 29 | /**
|
76 |
| - * 获取锁 |
77 |
| - * |
78 |
| - * @param key key |
79 |
| - * @param expire 获取锁超时时间 |
80 |
| - * @param retryTimes 重试次数 |
81 |
| - * @param sleepMillis 获取锁失败的重试间隔 |
82 |
| - * @return 成功/失败 |
| 30 | + * 尝试获取锁,如果锁不可用则等待最多waitTime时间后放弃 |
| 31 | + * @param key 锁的key |
| 32 | + * @param waitTime 获取锁的最大尝试时间(单位毫秒) |
| 33 | + * @param leaseTime 加锁的时间,超过这个时间后锁便自动解锁; |
| 34 | + * 如果leaseTime为-1,则保持锁定直到显式解锁 |
| 35 | + * @param unit {@code waitTime} 和 {@code leaseTime} 参数的时间单位 |
| 36 | + * @return 锁对象,如果获取锁失败则为null |
83 | 37 | */
|
84 |
| - boolean lock(String key, long expire, int retryTimes, long sleepMillis); |
| 38 | + Object tryLock(String key, long waitTime, long leaseTime, TimeUnit unit, boolean isFair) throws Exception; |
| 39 | + Object tryLock(String key, long waitTime, long leaseTime, TimeUnit unit) throws Exception; |
| 40 | + Object tryLock(String key, long waitTime, TimeUnit unit, boolean isFair) throws Exception; |
| 41 | + Object tryLock(String key, long waitTime, TimeUnit unit) throws Exception; |
85 | 42 |
|
86 | 43 | /**
|
87 | 44 | * 释放锁
|
88 |
| - * |
89 |
| - * @param key key值 |
90 |
| - * @return 释放结果 |
| 45 | + * @param lock 锁对象 |
91 | 46 | */
|
92 |
| - boolean releaseLock(String key); |
| 47 | + void unlock(Object lock) throws Exception; |
93 | 48 | }
|
0 commit comments