import java.util.Collection;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.AbstractQueuedSynchronizer;
import java.util.concurrent.locks.Condition;
/**
* Create by ~JH~ on 2018/4/14
*/import java.util.concurrent.TimeUnit;
import java.util.Collection;
/**.
*互相重入是Lock的扩展，和使用synchronized方法的隐式的监测锁有相同的基本行为和语法，
* 但是有扩展的能力
* 可重入锁是自身拥有的，通过线程上次成功的获得锁，但是没有释放他。一个线程调用将会有个成功的lock返回，
* 当这个锁没有被其他线程拥有时，这个方法会立即返回，如果当前线程已经拥有这个锁。
* 可以使用isHeldByCurrentThread和getHoldCount检查。
* 构造函数接受一个可选的公平参数，如果为真，在竞争的情况下，
* 锁支持优先分配给等待时间长的锁。否则这个锁不保证任何接入次序。
* 程序对许多线程使用公平锁，比起使用默认设置的，可能让全部的吞吐量变低，但是
* 会有小部分变量获得锁，并且保证不会饿死。然而，公平锁不保证线程调度上的公平。
* 因此，在其他线程没有执行或没有并发的申请这个锁的时候，
* 许多线程的其中一个线程使用一个公平所可能获得更多成功的时间，
*tryLock在阻塞的时候被推荐使用，更长煎的实在构造函数之前或之后
* <pre> {@code
* class X {
* private final ReentrantLock lock = new ReentrantLock();
* // ...
*
* public void m() {
* lock.lock(); // block until condition holds
* try {
* // ... method body
* } finally {
* lock.unlock()
* }
* }
* }}</pre>
*
*实现Lock接口，定义了很多方法来监测当前锁的状态
*在释放锁的状态下可以反序列化，不管他的序列化时的状态
*这个锁在一个线程里支持最大的递归锁的次数2147483647（2^31-1) 超出就会导致错误。
* @since 1.5
* @author Doug Lea
*/publicclassReentrantLockimplementsLock, java.io.Serializable {privatestaticfinallong serialVersionUID = 7373984872572414699L;
/** Synchronizer providing all implementation mechanics */privatefinal Sync sync;
/**
* 对这个锁的基本同步控制，父类有公平和不公平两种， 使用AbstractQueuedSynchronizer状态
* 代表获得这个锁的数量。
*/abstractstatic class Sync extends AbstractQueuedSynchronizer {
privatestaticfinallong serialVersionUID = -5179523762034025860L;
/**
* Performs {@link Lock#lock}. The main reason for subclassing
* is to allow fast path for nonfair version.
*/abstractvoid lock();
/**
* Performs non-fair tryLock. tryAcquire is implemented in
* subclasses, but both need nonfair try for trylock method.
*/finalboolean nonfairTryAcquire(int acquires) {
final Thread current = Thread.currentThread();
int c = getState();
if (c == 0) {
if (compareAndSetState(0, acquires)) {
setExclusiveOwnerThread(current);
returntrue;
}
}
elseif (current == getExclusiveOwnerThread()) {
int nextc = c + acquires;
if (nextc < 0) // overflowthrownew Error("Maximum lock count exceeded");
setState(nextc);
returntrue;
}
returnfalse;
}
protectedfinalbooleantryRelease(int releases) {
int c = getState() - releases;
if (Thread.currentThread() != getExclusiveOwnerThread())
thrownew IllegalMonitorStateException();
boolean free = false;
if (c == 0) {
free = true;
setExclusiveOwnerThread(null);
}
setState(c);
return free;
}
protectedfinalbooleanisHeldExclusively() {
// While we must in general read state before owner,// we don't need to do so to check if current thread is ownerreturn getExclusiveOwnerThread() == Thread.currentThread();
}
final ConditionObject newCondition() {
returnnew ConditionObject();
}
// Methods relayed from outer classfinal Thread getOwner() {
return getState() == 0 ? null : getExclusiveOwnerThread();
}
finalint getHoldCount() {
return isHeldExclusively() ? getState() : 0;
}
finalboolean isLocked() {
return getState() != 0;
}
/**
* Reconstitutes the instance from a stream (that is, deserializes it).
*/privatevoidreadObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
s.defaultReadObject();
setState(0); // reset to unlocked state
}
}
/**
* Sync object for non-fair locks
*/staticfinal class NonfairSync extends Sync {
privatestaticfinallong serialVersionUID = 7316153563782823691L;
/**
* Performs lock. Try immediate barge, backing up to normal
* acquire on failure.
*/finalvoid lock() {
if (compareAndSetState(0, 1))
setExclusiveOwnerThread(Thread.currentThread());
else
acquire(1);
}
protectedfinalbooleantryAcquire(int acquires) {
return nonfairTryAcquire(acquires);
}
}
/**
* Sync object for fair locks
*/staticfinal class FairSync extends Sync {
privatestaticfinallong serialVersionUID = -3000897897090466540L;
finalvoid lock() {
acquire(1);
}
/**
* Fair version of tryAcquire. Don't grant access unless
* recursive call or no waiters or is first.
*/protectedfinalbooleantryAcquire(int acquires) {
final Thread current = Thread.currentThread();
int c = getState();
if (c == 0) {
if (!hasQueuedPredecessors() &&
compareAndSetState(0, acquires)) {
setExclusiveOwnerThread(current);
returntrue;
}
}
elseif (current == getExclusiveOwnerThread()) {
int nextc = c + acquires;
if (nextc < 0)
thrownew Error("Maximum lock count exceeded");
setState(nextc);
returntrue;
}
returnfalse;
}
}
/**
* Creates an instance of {@code ReentrantLock}.
* This is equivalent to using {@code ReentrantLock(false)}.
*/publicReentrantLock() {
sync = new NonfairSync();
}
/**
* Creates an instance of {@code ReentrantLock} with the
* given fairness policy.
*
* @param fair {@code true} if this lock should use a fair ordering policy
*/publicReentrantLock(boolean fair) {
sync = fair ? new FairSync() : new NonfairSync();
}
/**
* 如果没有其他线程获得该锁，就成功获得锁，将数量设置为1，
* 如果当前线程已经获得该锁，就将增量置为1，立即返回。如果其他线程获得该锁，当前线程调度就变味不可用
* 并且陷入休眠状态，直到获得锁，将数量设置为1.
*/publicvoidlock() {
sync.lock();
}
/**
*获得这个锁，除非当前线程是中断的
*当前线程获得锁，或者其他线程中断了当前线程
*如果当前线程有她的中断状态在进入这个方法的时候，或者在获得索的时候被中断
* 然后中断异常就会被抛出，当前线程的中断状态就会被清除。
*
*这个实现，这个方法是显示的中断点，优先响应正常或者再次获得锁的中断
* @throws InterruptedException if the current thread is interrupted
*/publicvoidlockInterruptibly() throws InterruptedException {
sync.acquireInterruptibly(1);
}
/**
* 只有和其他线程同时调用，如果没有被其他线程获得锁，就获得该锁。
* 即使这个锁使用公平策略，调用tryLock如果这个锁是可用的就会获得锁，
* 即使还有其他线程在等待，这个行为在一些确定的环境中会很有用，
* 即使他破坏了公平，如果你想遵守这个公平的规则，你可以使用tryLock（0，TimeUnit.SECONDS)，
* 这个几乎是公平的，他也会检测中断。
* <p>If the current thread already holds this lock then the hold
* count is incremented by one and the method returns {@code true}.
*
* <p>If the lock is held by another thread then this method will return
* immediately with the value {@code false}.
*
* @return {@code true} if the lock was free and was acquired by the
* current thread, or the lock was already held by the current
* thread; and {@code false} otherwise
*/publicbooleantryLock() {
return sync.nonfairTryAcquire(1);
}
/**
* Acquires the lock if it is not held by another thread within the given
* waiting time and the current thread has not been
* {@linkplain Thread#interrupt interrupted}.
*
* <p>Acquires the lock if it is not held by another thread and returns
* immediately with the value {@code true}, setting the lock hold count
* to one. If this lock has been set to use a fair ordering policy then
* an available lock <em>will not</em> be acquired if any other threads
* are waiting for the lock. This is in contrast to the {@link #tryLock()}
* method. If you want a timed {@code tryLock} that does permit barging on
* a fair lock then combine the timed and un-timed forms together:
*
* <pre> {@code
* if (lock.tryLock() ||
* lock.tryLock(timeout, unit)) {
* ...
* }}</pre>
*
* <p>If the current thread
* already holds this lock then the hold count is incremented by one and
* the method returns {@code true}.
*
* <p>If the lock is held by another thread then the
* current thread becomes disabled for thread scheduling
* purposes and lies dormant until one of three things happens:
*
* <ul>
*
* <li>The lock is acquired by the current thread; or
*
* <li>Some other thread {@linkplain Thread#interrupt interrupts}
* the current thread; or
*
* <li>The specified waiting time elapses
*
* </ul>
*
* <p>If the lock is acquired then the value {@code true} is returned and
* the lock hold count is set to one.
*
* <p>If the current thread:
*
* <ul>
*
* <li>has its interrupted status set on entry to this method; or
*
* <li>is {@linkplain Thread#interrupt interrupted} while
* acquiring the lock,
*
* </ul>
* then {@link InterruptedException} is thrown and the current thread's
* interrupted status is cleared.
*
* <p>If the specified waiting time elapses then the value {@code false}
* is returned. If the time is less than or equal to zero, the method
* will not wait at all.
*
* <p>In this implementation, as this method is an explicit
* interruption point, preference is given to responding to the
* interrupt over normal or reentrant acquisition of the lock, and
* over reporting the elapse of the waiting time.
*
* @param timeout the time to wait for the lock
* @param unit the time unit of the timeout argument
* @return {@code true} if the lock was free and was acquired by the
* current thread, or the lock was already held by the current
* thread; and {@code false} if the waiting time elapsed before
* the lock could be acquired
* @throws InterruptedException if the current thread is interrupted
* @throws NullPointerException if the time unit is null
*/publicbooleantryLock(long timeout, TimeUnit unit)
throws InterruptedException {
return sync.tryAcquireNanos(1, unit.toNanos(timeout));
}
/**
*如果当前线程拥有这个锁，然后count就会减小，如果count=0，
* 这个锁就被释放，如果当前线程没有该锁，就抛出异常
* @throws IllegalMonitorStateException if the current thread does not
* hold this lock
*/publicvoidunlock() {
sync.release(1);
}
/**
* Returns a {@link Condition} instance for use with this
* {@link Lock} instance.
*
* <p>The returned {@link Condition} instance supports the same
* usages as do the {@link Object} monitor methods ({@link
* Object#wait() wait}, {@link Object#notify notify}, and {@link
* Object#notifyAll notifyAll}) when used with the built-in
* monitor lock.
*
* <ul>
*
* <li>If this lock is not held when any of the {@link Condition}
* {@linkplain Condition#await() waiting} or {@linkplain
* Condition#signal signalling} methods are called, then an {@link
* IllegalMonitorStateException} is thrown.
*
* <li>When the condition {@linkplain Condition#await() waiting}
* methods are called the lock is released and, before they
* return, the lock is reacquired and the lock hold count restored
* to what it was when the method was called.
*
* <li>If a thread is {@linkplain Thread#interrupt interrupted}
* while waiting then the wait will terminate, an {@link
* InterruptedException} will be thrown, and the thread's
* interrupted status will be cleared.
*
* <li> Waiting threads are signalled in FIFO order.
*
*从等待方法返回的线程是和线程初始化获得锁的顺序一样的，正是默认的，不被指定，但是对于公平锁，
* 支持线程更长时间的等待。
* </ul>
*
* @return the Condition object
*/public Condition newCondition() {
return sync.newCondition();
}
/**
*查询当前线程拥有的锁的数量
*一个线程每个锁操作都拥有一个锁行为，他不与释放锁匹配。
*主要是测试和debug使用，例如一段代码不应该在拥有这个锁的时候进入这个锁，我们可以使用这个来断言。
* <pre> {@code
* class X {
* ReentrantLock lock = new ReentrantLock();
* // ...
* public void m() {
* assert lock.getHoldCount() == 0;
* lock.lock();
* try {
* // ... method body
* } finally {
* lock.unlock();
* }
* }
* }}</pre>
*
* 当前线程拥有的这个锁的数量，如果没有获得就返回0.
*/publicintgetHoldCount() {
return sync.getHoldCount();
}
/**
* Queries if this lock is held by the current thread.
*
* <p>Analogous to the {@link Thread#holdsLock(Object)} method for
* built-in monitor locks, this method is typically used for
* debugging and testing. For example, a method that should only be
* called while a lock is held can assert that this is the case:
*
* <pre> {@code
* class X {
* ReentrantLock lock = new ReentrantLock();
* // ...
*
* public void m() {
* assert lock.isHeldByCurrentThread();
* // ... method body
* }
* }}</pre>
*
*可以用来确定一个可重入锁被使用在一个不可重入的操作中。
* <pre> {@code
* class X {
* ReentrantLock lock = new ReentrantLock();
* // ...
*
* public void m() {
* assert !lock.isHeldByCurrentThread();
* lock.lock();
* try {
* // ... method body
* } finally {
* lock.unlock();
* }
* }
* }}</pre>
*
* @return {@code true} if current thread holds this lock and
* {@code false} otherwise
*/publicbooleanisHeldByCurrentThread() {
return sync.isHeldExclusively();
}
/**
*查询这个锁是否被任何线程拥有，这个方法是为监控系统设计的，不是同步方法
* @return {@code true} if any thread holds this lock and
* {@code false} otherwise
*/publicbooleanisLocked() {
return sync.isLocked();
}
/**
* Returns {@code true} if this lock has fairness set true.
*
* @return {@code true} if this lock has fairness set true
*/publicfinalbooleanisFair() {
return sync instanceof FairSync;
}
/**
* Returns the thread that currently owns this lock, or
* {@code null} if not owned. When this method is called by a
* thread that is not the owner, the return value reflects a
* best-effort approximation of current lock status. For example,
* the owner may be momentarily {@code null} even if there are
* threads trying to acquire the lock but have not yet done so.
* This method is designed to facilitate construction of
* subclasses that provide more extensive lock monitoring
* facilities.
* 返回当前拥有这个锁的线程，或者null，
* 这个返回值以最大努力反映当前线程的锁状态，例如这拥有者可能是暂时的为空，
* 即使有现成尝试获取锁，但是还没有做，这个方法就被设计成方便的构造父类提供了更多
* 扩展的锁监控工具
*
* @return the owner, or {@code null} if not owned
*/protected Thread getOwner() {
return sync.getOwner();
}
/**
*查询是否有线程正在等待获取这个锁，在任何时候都可能取消，
* 返回true不保证任何其他线程将来会获得锁，这个方法主要是设计来监控系统状态
* @return {@code true} if there may be other threads waiting to
* acquire the lock
*/publicfinalbooleanhasQueuedThreads() {
return sync.hasQueuedThreads();
}
/**
* Queries whether the given thread is waiting to acquire this
* lock. Note that because cancellations may occur at any time, a
* {@code true} return does not guarantee that this thread
* will ever acquire this lock. This method is designed primarily for use
* in monitoring of the system state.
*
* @param thread the thread
* @return {@code true} if the given thread is queued waiting for this lock
* @throws NullPointerException if the thread is null
*/publicfinalbooleanhasQueuedThread(Thread thread) {
return sync.isQueued(thread);
}
/**
* Returns an estimate of the number of threads waiting to
* acquire this lock. The value is only an estimate because the number of
* threads may change dynamically while this method traverses
* internal data structures. This method is designed for use in
* monitoring of the system state, not for synchronization
* control.
*这个返回的值是一个估计值，因为线程数量可能动态改变
* @return the estimated number of threads waiting for this lock
*/publicfinalintgetQueueLength() {
return sync.getQueueLength();
}
/**
* Returns a collection containing threads that may be waiting to
* acquire this lock. Because the actual set of threads may change
* dynamically while constructing this result, the returned
* collection is only a best-effort estimate. The elements of the
* returned collection are in no particular order. This method is
* designed to facilitate construction of subclasses that provide
* more extensive monitoring facilities.
*
* @return the collection of threads
*/protected Collection<Thread> getQueuedThreads() {
return sync.getQueuedThreads();
}
/**
* Queries whether any threads are waiting on the given condition
* associated with this lock. Note that because timeouts and
* interrupts may occur at any time, a {@code true} return does
* not guarantee that a future {@code signal} will awaken any
* threads. This method is designed primarily for use in
* monitoring of the system state.
*
* @param condition the condition
* @return {@code true} if there are any waiting threads
* @throws IllegalMonitorStateException if this lock is not held
* @throws IllegalArgumentException if the given condition is
* not associated with this lock
* @throws NullPointerException if the condition is null
*/publicbooleanhasWaiters(Condition condition) {
if (condition == null)
thrownew NullPointerException();
if (!(condition instanceof AbstractQueuedSynchronizer.ConditionObject))
thrownew IllegalArgumentException("not owner");
return sync.hasWaiters((AbstractQueuedSynchronizer.ConditionObject)condition);
}
/**
* Returns an estimate of the number of threads waiting on the
* given condition associated with this lock. Note that because
* timeouts and interrupts may occur at any time, the estimate
* serves only as an upper bound on the actual number of waiters.
* This method is designed for use in monitoring of the system
* state, not for synchronization control.
*
* @param condition the condition
* @return the estimated number of waiting threads
* @throws IllegalMonitorStateException if this lock is not held
* @throws IllegalArgumentException if the given condition is
* not associated with this lock
* @throws NullPointerException if the condition is null
*/publicintgetWaitQueueLength(Condition condition) {
if (condition == null)
thrownew NullPointerException();
if (!(condition instanceof AbstractQueuedSynchronizer.ConditionObject))
thrownew IllegalArgumentException("not owner");
return sync.getWaitQueueLength((AbstractQueuedSynchronizer.ConditionObject)condition);
}
/**
* Returns a collection containing those threads that may be
* waiting on the given condition associated with this lock.
* Because the actual set of threads may change dynamically while
* constructing this result, the returned collection is only a
* best-effort estimate. The elements of the returned collection
* are in no particular order. This method is designed to
* facilitate construction of subclasses that provide more
* extensive condition monitoring facilities.
*
* @param condition the condition
* @return the collection of threads
* @throws IllegalMonitorStateException if this lock is not held
* @throws IllegalArgumentException if the given condition is
* not associated with this lock
* @throws NullPointerException if the condition is null
*/protected Collection<Thread> getWaitingThreads(Condition condition) {
if (condition == null)
thrownew NullPointerException();
if (!(condition instanceof AbstractQueuedSynchronizer.ConditionObject))
thrownew IllegalArgumentException("not owner");
return sync.getWaitingThreads((AbstractQueuedSynchronizer.ConditionObject)condition);
}
/**
* Returns a string identifying this lock, as well as its lock state.
* The state, in brackets, includes either the String {@code "Unlocked"}
* or the String {@code "Locked by"} followed by the
* {@linkplain Thread#getName name} of the owning thread.
*
* @return a string identifying this lock, as well as its lock state
*/public String toString() {
Thread o = sync.getOwner();
returnsuper.toString() + ((o == null) ?
"[Unlocked]" :
"[Locked by thread " + o.getName() + "]");
}
}
扫一扫
347
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
