com.landawn.abacus.pool.GenericKeyedObjectPool Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of abacus-common Show documentation
Show all versions of abacus-common Show documentation
A general programming library in Java/Android. It's easy to learn and simple to use with concise and powerful APIs.
/*
* Copyright (C) 2015 HaiYang Li
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.landawn.abacus.pool;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Map;
import java.util.PriorityQueue;
import java.util.Queue;
import java.util.Set;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import com.landawn.abacus.util.ClassUtil;
import com.landawn.abacus.util.ExceptionUtil;
import com.landawn.abacus.util.N;
import com.landawn.abacus.util.Objectory;
/**
*
* @author Haiyang Li
* @param the key type
* @param
* @since 0.8
*/
public class GenericKeyedObjectPool extends AbstractPool implements KeyedObjectPool {
private static final long serialVersionUID = 2208516321399679864L;
private final long maxMemorySize;
private final KeyedObjectPool.MemoryMeasure memoryMeasure;
private volatile long usedMemorySize = 0;
final Map pool;
final Comparator> cmp;
ScheduledFuture scheduleFuture;
protected GenericKeyedObjectPool(int capacity, long evictDelay, EvictionPolicy evictionPolicy) {
this(capacity, evictDelay, evictionPolicy, 0, null);
}
protected GenericKeyedObjectPool(int capacity, long evictDelay, EvictionPolicy evictionPolicy, long maxMemorySize,
KeyedObjectPool.MemoryMeasure memoryMeasure) {
this(capacity, evictDelay, evictionPolicy, true, DEFAULT_BALANCE_FACTOR, maxMemorySize, memoryMeasure);
}
protected GenericKeyedObjectPool(int capacity, long evictDelay, EvictionPolicy evictionPolicy, boolean autoBalance, float balanceFactor) {
this(capacity, evictDelay, evictionPolicy, autoBalance, balanceFactor, 0, null);
}
protected GenericKeyedObjectPool(int capacity, long evictDelay, EvictionPolicy evictionPolicy, boolean autoBalance, float balanceFactor, long maxMemorySize,
KeyedObjectPool.MemoryMeasure memoryMeasure) {
super(capacity, evictDelay, evictionPolicy, autoBalance, balanceFactor);
this.maxMemorySize = maxMemorySize;
this.memoryMeasure = memoryMeasure;
this.pool = new HashMap<>((capacity > 1000) ? 1000 : capacity);
switch (this.evictionPolicy) {
case LAST_ACCESS_TIME:
cmp = (o1, o2) -> Long.compare(o1.getValue().activityPrint().getLastAccessTime(), o2.getValue().activityPrint().getLastAccessTime());
break;
case ACCESS_COUNT:
cmp = (o1, o2) -> Long.compare(o1.getValue().activityPrint().getAccessCount(), o2.getValue().activityPrint().getAccessCount());
break;
case EXPIRATION_TIME:
cmp = (o1, o2) -> Long.compare(o1.getValue().activityPrint().getExpirationTime(), o2.getValue().activityPrint().getExpirationTime());
break;
default:
throw new RuntimeException("Unsupproted eviction policy: " + evictionPolicy.name());
}
if (evictDelay > 0) {
final Runnable evictTask = () -> {
// Evict from the pool
try {
evict();
} catch (Exception e) {
// ignore
if (logger.isWarnEnabled()) {
logger.warn(ExceptionUtil.getErrorMessage(e, true));
}
}
};
scheduleFuture = scheduledExecutor.scheduleWithFixedDelay(evictTask, evictDelay, evictDelay, TimeUnit.MILLISECONDS);
}
}
/**
*
* @param key
* @param e
* @return true, if successful
*/
@Override
public boolean put(K key, E e) {
assertNotClosed();
if (key == null || e == null) {
throw new NullPointerException();
}
if (e.activityPrint().isExpired()) {
return false;
}
putCount.incrementAndGet();
lock.lock();
try {
if (pool.size() >= capacity || usedMemorySize > maxMemorySize) {
if (autoBalance) {
vacate();
} else {
return false;
}
}
final long memorySize = memoryMeasure == null ? 0 : memoryMeasure.sizeOf(key, e);
if (memoryMeasure != null && memorySize > maxMemorySize - usedMemorySize) {
// ignore.
return false;
} else {
E oldValue = pool.put(key, e);
if (oldValue != null) {
destroy(key, oldValue);
}
if (memoryMeasure != null) {
usedMemorySize += memorySize; //NOSONAR
}
notEmpty.signal();
return true;
}
} finally {
lock.unlock();
}
}
/**
*
* @param key
* @param e
* @param autoDestroyOnFailedToPut
* @return true, if successful
*/
@Override
public boolean put(K key, E e, boolean autoDestroyOnFailedToPut) {
boolean sucess = false;
try {
sucess = put(key, e);
} finally {
if (autoDestroyOnFailedToPut && !sucess && e != null) {
e.destroy();
}
}
return sucess;
}
/**
*
* @param key
* @return
*/
@Override
public E get(K key) {
assertNotClosed();
E e = null;
lock.lock();
try {
e = pool.get(key);
if (e != null) {
ActivityPrint activityPrint = e.activityPrint();
activityPrint.updateLastAccessTime();
activityPrint.updateAccessCount();
hitCount.incrementAndGet();
} else {
missCount.incrementAndGet();
}
return e;
} finally {
lock.unlock();
}
}
/**
*
* @param key
* @return
*/
@Override
public E remove(K key) {
assertNotClosed();
E e = null;
lock.lock();
try {
e = pool.remove(key);
if (e != null) {
ActivityPrint activityPrint = e.activityPrint();
activityPrint.updateLastAccessTime();
activityPrint.updateAccessCount();
if (memoryMeasure != null) {
usedMemorySize -= memoryMeasure.sizeOf(key, e); //NOSONAR
}
notFull.signal();
}
return e;
} finally {
lock.unlock();
}
}
/**
*
* @param key
* @return
*/
@Override
public E peek(K key) {
assertNotClosed();
lock.lock();
try {
return pool.get(key);
} finally {
lock.unlock();
}
}
/**
*
* @param key
* @return true, if successful
*/
@Override
public boolean containsKey(K key) {
assertNotClosed();
lock.lock();
try {
return pool.containsKey(key);
} finally {
lock.unlock();
}
}
/**
*
* @param e
* @return true, if successful
*/
@Override
public boolean containsValue(E e) {
assertNotClosed();
lock.lock();
try {
return pool.containsValue(e);
} finally {
lock.unlock();
}
}
/**
*
*
* @return
*/
@Override
public Set keySet() {
assertNotClosed();
lock.lock();
try {
return N.newHashSet(pool.keySet());
} finally {
lock.unlock();
}
}
/**
*
*
* @return
*/
@Override
public Collection values() {
assertNotClosed();
lock.lock();
try {
return new ArrayList<>(pool.values());
} finally {
lock.unlock();
}
}
/**
* Clear.
*/
@Override
public void clear() {
assertNotClosed();
removeAll();
}
/**
* Close.
*/
@Override
public void close() {
if (isClosed) {
return;
}
isClosed = true;
try {
if (scheduleFuture != null) {
scheduleFuture.cancel(true);
}
} finally {
removeAll();
}
}
/**
* Vacate.
*/
@Override
public void vacate() {
assertNotClosed();
lock.lock();
try {
vacate((int) (pool.size() * balanceFactor));
notFull.signalAll();
} finally {
lock.unlock();
}
}
/**
*
*
* @return
*/
@Override
public int size() {
// assertNotClosed();
return pool.size();
}
/**
*
*
* @return
*/
@Override
public int hashCode() {
return pool.hashCode();
}
/**
*
* @param obj
* @return true, if successful
*/
@Override
@SuppressWarnings("unchecked")
public boolean equals(Object obj) {
return this == obj || (obj instanceof GenericKeyedObjectPool && N.equals(((GenericKeyedObjectPool) obj).pool, pool));
}
/**
*
*
* @return
*/
@Override
public String toString() {
return pool.toString();
}
/**
*
* @param vacationNumber
*/
protected void vacate(int vacationNumber) {
int size = pool.size();
if (vacationNumber >= size) {
destroyAll(new HashMap<>(pool));
pool.clear();
} else {
final Queue> heap = new PriorityQueue<>(vacationNumber, cmp);
for (Map.Entry entry : pool.entrySet()) {
if (heap.size() < vacationNumber) {
heap.offer(entry);
} else if (cmp.compare(entry, heap.peek()) < 0) {
heap.poll();
heap.offer(entry);
}
}
final Map removingObjects = N.newHashMap(heap.size());
for (Map.Entry entry : heap) {
pool.remove(entry.getKey());
removingObjects.put(entry.getKey(), entry.getValue());
}
destroyAll(removingObjects);
}
}
/**
* scan the object pool to find the idle object which inactive time greater than permitted the inactive time for it
* or it's time out.
*
*/
@SuppressWarnings("null")
protected void evict() {
lock.lock();
Map removingObjects = null;
try {
for (Map.Entry entry : pool.entrySet()) {
if (entry.getValue().activityPrint().isExpired()) {
if (removingObjects == null) {
removingObjects = Objectory.createMap();
}
removingObjects.put(entry.getKey(), entry.getValue());
}
}
if (N.notNullOrEmpty(removingObjects)) {
for (K key : removingObjects.keySet()) {
pool.remove(key);
}
destroyAll(removingObjects);
notFull.signalAll();
}
} finally {
lock.unlock();
Objectory.recycle(removingObjects);
}
}
/**
*
* @param key
* @param value
*/
protected void destroy(K key, E value) {
evictionCount.incrementAndGet();
if (value != null) {
if (logger.isInfoEnabled()) {
logger.info("Destroying cached object " + ClassUtil.getSimpleClassName(value.getClass()) + " with activity print: " + value.activityPrint());
}
if (memoryMeasure != null) {
usedMemorySize -= memoryMeasure.sizeOf(key, value); //NOSONAR
}
try {
value.destroy();
} catch (Exception e) {
if (logger.isWarnEnabled()) {
logger.warn(ExceptionUtil.getErrorMessage(e, true));
}
}
}
}
/**
*
* @param map
*/
protected void destroyAll(Map map) {
if (N.notNullOrEmpty(map)) {
for (Map.Entry entry : map.entrySet()) {
destroy(entry.getKey(), entry.getValue());
}
}
}
/**
* Removes the all.
*/
private void removeAll() {
lock.lock();
try {
destroyAll(new HashMap<>(pool));
pool.clear();
notFull.signalAll();
} finally {
lock.unlock();
}
}
/**
*
* @param os
* @throws IOException Signals that an I/O exception has occurred.
*/
private void writeObject(java.io.ObjectOutputStream os) throws java.io.IOException {
lock.lock();
try {
os.defaultWriteObject();
} finally {
lock.unlock();
}
}
/**
*
* @param is
* @throws IOException Signals that an I/O exception has occurred.
* @throws ClassNotFoundException the class not found exception
*/
private void readObject(java.io.ObjectInputStream is) throws java.io.IOException, ClassNotFoundException {
lock.lock();
try {
is.defaultReadObject();
} finally {
lock.unlock();
}
}
}