作者:Hai Xiang \
来自:https://www.cnblogs.com/haixi...

对象池顾名思义就是寄存对象的池,与咱们常听到的线程池、数据库连接池、http连接池等一样,都是典型的池化设计思维。

对象池的长处就是能够集中管理池中对象,缩小频繁创立和销毁长期应用的对象,从而晋升复用性,以节约资源的耗费,能够无效防止频繁为对象分配内存和开释堆中内存,进而加重jvm垃圾收集器的累赘,防止内存抖动。

Apache Common Pool2 是Apache提供的一个通用对象池技术实现,能够不便定制化本人须要的对象池,赫赫有名的 Redis 客户端 Jedis 外部连接池就是基于它来实现的。

外围接口

Apache Common Pool2 的外围外部类如下:

  • ObjectPool:对象池接口,对象池实体,取用对象的中央
    • 对象的提供与偿还(工厂来操作):borrowObject returnObject
    • 创建对象(应用工厂来创立):addObject
    • 销毁对象(应用工厂来销毁):invalidateObject
    • 池中闲暇对象数量、被应用对象数量:getNumActive getNumIdle
  • PooledObject:被包装的对象,是池中的对象,除了对象自身之外蕴含了创立工夫、上次被调用工夫等泛滥信息
  • PooledObjectFactory:对象工厂,治理对象的生命周期,提供了对象创立、销毁、验证、钝化、激活等一系列性能
  • BaseObjectPoolConfig:提供一些必要的配置,例如闲暇队列是否先进先出、工厂创建对象前是否须要测试、对象从对象池取出时是否测试等根底属性,GenericObjectPoolConfig继承了本类做了默认配置,咱们在理论应用中继承它即可,能够联合业务状况扩大对象池配置,例如数据库连接池线程前缀、字符串池长度或名称规定等
  • KeyedObjectPool<K,V>:键值对模式的对象池接口,应用场景很少
  • KeyedPooledObjectFactory<K,V>:同上,为键值对对象池治理对象的工厂

池对象的状态

查看源码PooledObjectState枚举下列出了池对象所有可能处于的状态。

public enum PooledObjectState {    //在闲暇队列中,还未被应用    IDLE,    //应用中    ALLOCATED,    //在闲暇队列中,以后正在测试是否满足被驱赶的条件    EVICTION,      //不在闲暇队列中,目前正在测试是否可能被驱赶。因为在测试过程中,试图借用对象,并将其从队列中删除。    //回收测试实现后,它应该被返回到队列的头部。    EVICTION_RETURN_TO_HEAD,      //在队列中,正在被校验    VALIDATION,      //不在队列中,以后正在验证。该对象在验证时被借用,因为配置了testOnBorrow,    //所以将其从队列中删除并事后调配。一旦验证实现,就应该调配它。    VALIDATION_PREALLOCATED,      //不在队列中,以后正在验证。在之前测试是否将该对象从队列中移除时,曾尝试借用该对象。    //一旦验证实现,它应该被返回到队列的头部。    VALIDATION_RETURN_TO_HEAD,      //有效状态(如驱赶测试或验证),并将/已被销毁    INVALID,      //断定为有效,将会被设置为废除    ABANDONED,      //正在应用结束,返回池中    RETURNING}

状态了解

  • abandoned :被借出后,长时间未被应用则被标记为该状态。如代码所示,当该对象处于ALLOCATED状态,即被借出应用中,间隔上次被应用的工夫超过了设置的getRemoveAbandonedTimeout则被标记为废除。
private void removeAbandoned(final AbandonedConfig abandonedConfig) {            // Generate a list of abandoned objects to remove            final long now = System.currentTimeMillis();            final long timeout =                    now - (abandonedConfig.getRemoveAbandonedTimeout() * 1000L);            final ArrayList<PooledObject<T>> remove = new ArrayList<>();            final Iterator<PooledObject<T>> it = allObjects.values().iterator();            while (it.hasNext()) {                final PooledObject<T> pooledObject = it.next();                synchronized (pooledObject) {                    if (pooledObject.getState() == PooledObjectState.ALLOCATED &&                            pooledObject.getLastUsedTime() <= timeout) {                        pooledObject.markAbandoned();                        remove.add(pooledObject);                    }                }            }

流程了解

1.对象实在是存储在哪里?

private PooledObject<T> create() throws Exception {        .....        final PooledObject<T> p;        try {            p = factory.makeObject();        .....        allObjects.put(new IdentityWrapper<>(p.getObject()), p);        return p; }

咱们查看allObjects,所有对象都存储于ConcurrentHashMap,除了被杀掉的对象。

/*     * All of the objects currently associated with this pool in any state. It     * excludes objects that have been destroyed. The size of     * {@link #allObjects} will always be less than or equal to {@link     * #_maxActive}. Map keys are pooled objects, values are the PooledObject     * wrappers used internally by the pool.     */    private final Map<IdentityWrapper<T>, PooledObject<T>> allObjects =        new ConcurrentHashMap<>();

2.取用对象的逻辑归纳如下

  • 首先依据AbandonedConfig配置判断是否取用对象前执行清理操作
  • 再从idleObject中尝试获取对象,获取不到就创立新的对象
    • 判断blockWhenExhausted是否设置为true,(这个配置的意思是当对象池的active状态的对象数量曾经达到最大值maxinum时是否进行阻塞直到有闲暇对象)
    • 是的话依照设置的borrowMaxWaitMillis属性期待可用对象
  • 有可用对象后调用工厂的factory.activateObject办法激活对象
  • getTestOnBorrow设置为true时,调用factory.validateObject(p)对对象进行校验,通过校验后执行下一步
  • 调用updateStatsBorrow办法,在对象被胜利借出后更新一些统计项,例如返回对象池的对象个数等
//....private final LinkedBlockingDeque<PooledObject<T>> idleObjects;//....public T borrowObject(final long borrowMaxWaitMillis) throws Exception {    assertOpen();    final AbandonedConfig ac = this.abandonedConfig;    if (ac != null && ac.getRemoveAbandonedOnBorrow() &&            (getNumIdle() < 2) &&            (getNumActive() > getMaxTotal() - 3) ) {        removeAbandoned(ac);    }    PooledObject<T> p = null;    // Get local copy of current config so it is consistent for entire    // method execution    final boolean blockWhenExhausted = getBlockWhenExhausted();    boolean create;    final long waitTime = System.currentTimeMillis();    while (p == null) {        create = false;        p = idleObjects.pollFirst();        if (p == null) {            p = create();            if (p != null) {                create = true;            }        }        if (blockWhenExhausted) {            if (p == null) {                if (borrowMaxWaitMillis < 0) {                    p = idleObjects.takeFirst();                } else {                    p = idleObjects.pollFirst(borrowMaxWaitMillis,                            TimeUnit.MILLISECONDS);                }            }            if (p == null) {                throw new NoSuchElementException(                        "Timeout waiting for idle object");            }        } else {            if (p == null) {                throw new NoSuchElementException("Pool exhausted");            }        }        if (!p.allocate()) {            p = null;        }        if (p != null) {            try {                factory.activateObject(p);            } catch (final Exception e) {                try {                    destroy(p, DestroyMode.NORMAL);                } catch (final Exception e1) {                    // Ignore - activation failure is more important                }                p = null;                if (create) {                    final NoSuchElementException nsee = new NoSuchElementException(                            "Unable to activate object");                    nsee.initCause(e);                    throw nsee;                }            }            if (p != null && getTestOnBorrow()) {                boolean validate = false;                Throwable validationThrowable = null;                try {                    validate = factory.validateObject(p);                } catch (final Throwable t) {                    PoolUtils.checkRethrow(t);                    validationThrowable = t;                }                if (!validate) {                    try {                        destroy(p, DestroyMode.NORMAL);                        destroyedByBorrowValidationCount.incrementAndGet();                    } catch (final Exception e) {                        // Ignore - validation failure is more important                    }                    p = null;                    if (create) {                        final NoSuchElementException nsee = new NoSuchElementException(                                "Unable to validate object");                        nsee.initCause(validationThrowable);                        throw nsee;                    }                }            }        }    }    updateStatsBorrow(p, System.currentTimeMillis() - waitTime);    return p.getObject();}

3.工厂的passivateObject(PooledObject<T> p)passivateObject(PooledObject<T> p)即对象的激活和钝化办法有什么用?

如图在对象应用完被返回对象池时,如果校验失败间接销毁,如果校验通过须要先钝化对象再存入闲暇队列。至于激活对象的办法在上述取用对象时也会先激活再被取出。因而咱们能够发现处于闲暇和应用中的对象他们除了状态不统一,咱们也能够通过激活和钝化的形式在他们之间减少新的差别,例如咱们要做一个Elasticsearch连接池,每个对象就是一个带有ip和端口的连贯实例,很显然拜访es集群是多个不同的ip,所以每次拜访的ip不肯定雷同,咱们则能够在激活操作为对象赋值ip和端口,钝化操作中将ip和端口归为默认值或者空,这样流程更为规范。

public void returnObject(final T obj) {    final PooledObject<T> p = allObjects.get(new IdentityWrapper<>(obj));        //....    //校验失败间接销毁 return            //...    try {        factory.passivateObject(p);    } catch (final Exception e1) {        swallowException(e1);        try {            destroy(p, DestroyMode.NORMAL);        } catch (final Exception e) {            swallowException(e);        }        try {            ensureIdle(1, false);        } catch (final Exception e) {            swallowException(e);        }        updateStatsReturn(activeTime);        return;    }        //......        //返回闲暇队列}

对象池相干配置项

对象池提供了许多配置项,在咱们应用的GenericObjectPool默认根底对象池中能够通过构造方法传参传入GenericObjectPoolConfig,当然咱们也能够看GenericObjectPoolConfig底层实现的根底类BaseObjectPoolConfig,具体蕴含如下配置:

  • maxTotal:对象池中最大应用数量,默认为8
  • maxIdle:对象中闲暇对象最大数量,默认为8
  • minIdle:对象池中闲暇对象最小数量,默认为8
  • lifo:当去获取对象池中的闲暇实例时,是否须要遵循后进先出的准则,默认为true
  • blockWhenExhausted:当对象池处于exhausted状态,即可用实例为空时,是否阻塞来获取实例的线程,默认 true
  • fairness:当对象池处于exhausted状态,即可用实例为空时,大量线程在同时阻塞期待获取可用的实例,fairness配置来管制是否启用偏心锁算法,即先到先得,默认为false。这一项的前提是blockWhenExhausted配置为true
  • maxWaitMillis:最大阻塞工夫,当对象池处于exhausted状态,即可用实例为空时,大量线程在同时阻塞期待获取可用的实例,如果阻塞工夫超过了maxWaitMillis将会抛出异样。当此值为正数时,代表无限期阻塞直到可用。默认为-1
  • testOnCreate:创建对象前是否校验(即调用工厂的validateObject()办法),如果测验失败,那么borrowObject()返回将失败,默认为false
  • testOnBorrow:取用对象前是否测验,默认为false
  • testOnReturn:返回对象池前是否测验,即调用工厂的returnObject(),若测验失败会销毁对象而不是返回池中,默认为false
  • timeBetweenEvictionRunsMillis:驱赶周期,默认为-1代表不进行驱赶测试
  • testWhileIdle:处于idle队列中即闲置的对象是否被驱赶器进行驱赶验证,当该对象上次运行工夫距以后超过了setTimeBetweenEvictionRunsMillis(long))设置的值,将会被驱赶验证,调用validateObject()办法,若验证胜利,对象将会销毁。默认为false

应用步骤

  1. 创立工厂类:通过继承BaseGenericObjectPool或者实现根底接口PooledObjectFactory,并依照业务需要重写对象的创立、销毁、校验、激活、钝化办法,其中销毁多为连贯的敞开、置空等。
  2. 创立池:通过继承GenericObjectPool或者实现根底接口ObjectPool,倡议应用前者,它为咱们提供了闲暇对象驱赶检测机制(行将闲暇队列中长时间未应用的对象销毁,升高内存占用),以及提供了很多对象的根本信息,例如对象最初被应用的工夫、应用对象前是否测验等。
  3. 创立池相干配置(可选):通过继承GenericObjectPoolConfig或者继承BaseObjectPoolConfig,来减少对线程池的配置管制,倡议应用前者,它为咱们实现了根本办法,只须要本人增加须要的属性即可。
  4. 创立包装类(可选):即要存在于对象池中的对象,在理论对象之外增加许多根底属性,便于理解对象池中对象的实时状态。

注意事项

咱们尽管应用了默认实现,然而也应该结合实际生产状况进行优化,不能应用了线程池而性能却更低了。在应用中咱们应留神以下事项:

  • 要为对象池设置闲暇队列最大最小值,默认最大最小值,默认最大为8往往不能满足需要
private volatile int maxIdle = GenericObjectPoolConfig.DEFAULT_MAX_IDLE;private volatile int minIdle = GenericObjectPoolConfig.DEFAULT_MIN_IDLE;public static final int DEFAULT_MAX_IDLE = 8;public static final int DEFAULT_MIN_IDLE = 0;
  • 对象池设置maxWaitMillis属性,即取用对象最大等待时间
  • 应用完对象及时开释对象,将对象返回池中,特地是产生了异样也要通过try..chatch..finally的形式确保开释,防止占用资源

咱们开展讲讲注意事项,首先为什么要设置maxWaitMillis,咱们取用对象应用的如下办法

public T borrowObject() throws Exception {    return borrowObject(getMaxWaitMillis());}

能够看到默认的最大等待时间为-1L

private volatile long maxWaitMillis =    BaseObjectPoolConfig.DEFAULT_MAX_WAIT_MILLIS;//....public static final long DEFAULT_MAX_WAIT_MILLIS = -1L;

咱们再来查看取用对象逻辑,blockWhenExhausted默认为true,意思是当池中不存在闲暇对象时,又来取用对象,线程将会被阻塞直到有新的可用对象。从上咱们得悉-1L将会执行idleObjects.takeFirst()

public T borrowObject(final long borrowMaxWaitMillis) throws Exception {    //.......    final boolean blockWhenExhausted = getBlockWhenExhausted();    boolean create;    final long waitTime = System.currentTimeMillis();    while (p == null) {      //.......        if (blockWhenExhausted) {            if (p == null) {                if (borrowMaxWaitMillis < 0) {                    p = idleObjects.takeFirst();                } else {                    p = idleObjects.pollFirst(borrowMaxWaitMillis,                            TimeUnit.MILLISECONDS);                }            }        }    }}

如下,阻塞队列将会始终阻塞,直到有了闲暇对象才进行阻塞,这样的设定将会在吞吐进步时造成大面积阻塞影响

public E takeFirst() throws InterruptedException {    lock.lock();    try {        E x;        while ( (x = unlinkFirst()) == null) {            notEmpty.await();        }        return x;    } finally {        lock.unlock();    }}

还有一个注意事项就是要记得回收资源,即调用public void returnObject(final T obj)办法,起因不言而喻,对象池对咱们是否应用完了对象是无感知的,须要咱们调用该办法回收对象,特地是产生异样也要保障回收,因而最佳实际如下:

try{   item = pool.borrowObject(); } catch(Exception e) {   log.error("...."); } finally {   pool.returnObject(item); }

实例应用

实例1:实现一个简略的字符串池

创立字符串工厂

package com.anqi.demo.demopool2.pool.fac;import org.apache.commons.pool2.BasePooledObjectFactory;import org.apache.commons.pool2.PooledObject;import org.apache.commons.pool2.impl.DefaultPooledObject;/** * 字符串池工厂 */public class StringPoolFac extends BasePooledObjectFactory<String> {    public StringPoolFac() {        super();    }    @Override    public String create() throws Exception {        return "str-val-";    }    @Override    public PooledObject<String> wrap(String s) {        return new DefaultPooledObject<>(s);    }    @Override    public void destroyObject(PooledObject<String> p) throws Exception {    }    @Override    public boolean validateObject(PooledObject<String> p) {        return super.validateObject(p);    }    @Override    public void activateObject(PooledObject<String> p) throws Exception {        super.activateObject(p);    }    @Override    public void passivateObject(PooledObject<String> p) throws Exception {        super.passivateObject(p);    }}

创立字符串池

package com.anqi.demo.demopool2.pool;import org.apache.commons.pool2.PooledObjectFactory;import org.apache.commons.pool2.impl.GenericObjectPool;import org.apache.commons.pool2.impl.GenericObjectPoolConfig;/** * 字符串池 */public class StringPool extends GenericObjectPool<String> {    public StringPool(PooledObjectFactory<String> factory) {        super(factory);    }    public StringPool(PooledObjectFactory<String> factory, GenericObjectPoolConfig<String> config) {        super(factory, config);    }}

测试主类

首先咱们咱们设置setMaxTotal为2,即最多有两个对象被取出应用,设置setMaxWaitMillis为3S,即最多被阻塞3S,咱们循环取用3次,并不开释资源

import com.anqi.demo.demopool2.pool.fac.StringPoolFac;import org.apache.commons.pool2.impl.GenericObjectPoolConfig;import org.slf4j.Logger;import org.slf4j.LoggerFactory;public class StringPoolTest {    private static final Logger LOG = LoggerFactory.getLogger(StringPoolTest.class);    public static void main(String[] args) {        StringPoolFac fac = new StringPoolFac();        GenericObjectPoolConfig<String> config = new GenericObjectPoolConfig<>();        config.setMaxTotal(2);        config.setMinIdle(1);        config.setMaxWaitMillis(3000);        StringPool pool = new StringPool(fac, config);        for (int i = 0; i < 3; i++) {            String s = "";            try {                s = pool.borrowObject();                LOG.info("str:{}", s);            } catch (Exception e) {                e.printStackTrace();            } finally {//                if (!s.equals("")) {//                    pool.returnObject(s);//                }            }        }    }}

后果如下,在两次胜利调用之后,阻塞3S,接着程序报错进行。这是因为可用资源最多为2,若不开释将会无资源可用,新来的调用者会被阻塞3S,之后报错取用失败。

16:18:42.499 [main] INFO com.anqi.demo.demopool2.pool.StringPoolTest - str:str-val-16:18:42.505 [main] INFO com.anqi.demo.demopool2.pool.StringPoolTest - str:str-val-java.util.NoSuchElementException: Timeout waiting for idle object

咱们放开正文,开释资源后失去失常执行后果

16:20:52.384 [main] INFO com.anqi.demo.demopool2.pool.StringPoolTest - str:str-val-16:20:52.388 [main] INFO com.anqi.demo.demopool2.pool.StringPoolTest - str:str-val-16:20:52.388 [main] INFO com.anqi.demo.demopool2.pool.StringPoolTest - str:str-val-

近期热文举荐:

1.1,000+ 道 Java面试题及答案整顿(2021最新版)

2.别在再满屏的 if/ else 了,试试策略模式,真香!!

3.卧槽!Java 中的 xx ≠ null 是什么新语法?

4.Spring Boot 2.5 重磅公布,光明模式太炸了!

5.《Java开发手册(嵩山版)》最新公布,速速下载!

感觉不错,别忘了顺手点赞+转发哦!