apache commons pool2: 整体结构

程序员文章站 2022-06-21 18:21:57

...

简介

在以往的一些工作中总接触到一个池的概念。这些池包括有线程池，对象池和连接池等。从池本身的概念来说，它是将一系列的资源事先准备好放在一个地方，等需要的时候直接拿过去用。而用完之后再放回来。和我们平常的需要使用资源再创建的方式相比，这种池的方式节省了创建和销毁资源的这么一个过程。所以说，对于一些比较比较稀缺的资源或者创建和销毁影响系统性能的资源，采用池的方式可以有效的提高整体性能。最近一段时间正好要用到一些数据库连接池等东西，趁这个时机把一些相关的部分好好的学习总结一下。如前面提到的，我们使用到的典型的线程池有jdk里的ExecutorService相关的一系列工具类（在这篇文章里有阐述），而一些典型的数据库连接池有cp03和dbcp。最近用到了dbcp，而它主要是基于commons-pool实现的，所以我们先从commons-pool2开始吧。

整体结构分析

在正式分析commons-pool2的结构开始，我们设想一下，如果我们自己来设计一个object pool的话，我们该怎么来做呢？

首先一个，我们从直接使用的角度来说，肯定需要一个ObjectPool对象，它负责保存我们需要访问的对象，我们把这个对象用完之后就返还给它。更细化一点的考虑的话，我们在使用前需要根据配置事先创建一些对象，后面需要使用的时候直接取就可以了。然后我们需要能够知道pool里面有多少可以用的对象。还有一个就是对象在被使用前是一个类似于初始化的状态，而使用完之后可能是另外的一个状态，既然我们希望对象能够被复用，在返回到pool里的时候可能还需要做一些重置的工作。

除了这些以外，如果我们考虑对象的创建。我们可以将创建对象的职责给pool，这样pool同时既要管理对象的存取和回收又要管对象的创建和状态设置等。这有点像一个图书馆的管理员，他既要管借还书，还要管怎么造纸印书。这样想来，似乎管的职责有点多了。我们也可以将对象的创建单独分离处理作为一个factory来做。

其实，通过前面的这些讨论，我们几乎也能创建一个像模像样的pool。如果结合commons-pool2的详细设计，我们会发现它的设计思路和我们也是基本上一致的。它主要由3个大的部分组成：

ObjectPool：专门实现对象存取和状态管理的池实现。我们直接操作的线程池就是定义在这里。值得注意的一点是这里定义的只是怎么来获取以及释放对象等操作，至于具体对象是怎么创建的，一般都通过独立的一个PooledObjectFactory来操心了。

PooledObject：这是commons-pools里比较有意思的一个类族。是对需要放到池里对象的一个包装类。添加了一些附加的信息，比如说状态信息，创建时间，**时间，关闭时间等。这些添加的信息方便pool来管理和实现一些特定的操作。

PooledObjectFactory：如我们前面所讨论的，管理具体对象的状态，比如创建，初始化，验证对象状态和销毁对象。

通过我们的这些讨论，他们这三者就构成了一个object pool的基本框架。他们的关系可以用如下的一个图来描述：

apache commons pool2: 整体结构

用一句话来概括他们整体的关系就是factory创建需要放入pool的对象，经过PooledObject包装一下就可以上架了。

有一个地方需要注意一下，虽然我们这里将它划分成3个主要的部分，从更精确的细节来看，每一个类族里都有一些不同的实现，这里我们再针对每一类族做一个大体的介绍。

ObjectPool类族

ObjectPool类族包含了以ObjectPool为代表的一系列pool，其中最主要的两类就是ObjectPool和KeyedObjectPool，他们分别针对普通的pool和以名值对映射的pool。和他们相关的整体几个类结构如下图：

apache commons pool2: 整体结构

从前面的图里头我们可以看到，真正定义的接口就是ObjectPool和KeyedObjectPool，具体的实现里有GenericObjectPool, GenericKeyedObjectPool和SoftReferenceObjectPool。不管是哪一种他们都引用了PooledObject。这里我们不详细分析具体实现的代码，我们先就前面的设想来验证一下他们的整体思路。既然是ObjectPool，那它就应该管borrowObject, returnObject之类的了。是不是呢？我们先看看ObjectPool这一块的代码：

public interface ObjectPool<T> {
    T borrowObject() throws Exception, NoSuchElementException,
            IllegalStateException;

    void returnObject(T obj) throws Exception;

    void invalidateObject(T obj) throws Exception;

    void addObject() throws Exception, IllegalStateException,
            UnsupportedOperationException;

    int getNumIdle();

    int getNumActive();

    void clear() throws Exception, UnsupportedOperationException;

    void close();
}

这部分的代码很简单直接，主要就是包含了一个pool需要的基本操作功能，比如从pool里取对象的borrowObject，返回对象到pool里的returnObject，还有一些查找里面可用对象数量以及管理pool的方法。这里的clear方法是用来清空里面处于idle状态的对象，而close方法则用来关闭整个pool。他们两者的一个典型差别就是clear之后里面没有可以用的对象了，我们需要再创建一些对象放进去。而close之后则连pool都访问不了了。

与ObjectPool对象的一个是KeyedObjectPool，它的操作方法基本上和ObjectPool一样，唯一的差别是它是基于key来操作的，所以所有相关的borrowObject, returnObject等操作都要提供key参数。

PooledObject类族

如前所述，PooledObject主要是对需要被加入到pool里的对象提供一个包装，方便来查看或者统计一些对象信息，比如某个对象创建的时间，空闲时间以及活跃时间等。下面是PooledObject相关的类关系图：

apache commons pool2: 整体结构

既然是一个简单的包装，我们就来看看具体需要访问的一些方法。如下是PooledObject里的基本方法定义：

public interface PooledObject<T> extends Comparable<PooledObject<T>> {

    T getObject();

    long getCreateTime();

    long getActiveTimeMillis();

    long getIdleTimeMillis();

    long getLastBorrowTime();

    long getLastReturnTime();

    long getLastUsedTime();

    @Override
    int compareTo(PooledObject<T> other);

    @Override
    boolean equals(Object obj);

    @Override
    int hashCode();

    @Override
    String toString();

    boolean startEvictionTest();

    boolean endEvictionTest(Deque<PooledObject<T>> idleQueue);

    boolean allocate();

    boolean deallocate();

    void invalidate();

    void setLogAbandoned(boolean logAbandoned);

    void use();

    void printStackTrace(PrintWriter writer);

    PooledObjectState getState();

    void markAbandoned();

    void markReturning();
}

这里列出的一大堆方法其实就是标注了各种操作，很多都是PooledObject本身实现加上去的。

ok，有了前面这些管理对象和包装对象的东西，我们再来看看具*造和销毁对象的部分。

PooledObjectFactory

在commons-pool2里，我们专门抽象出来一个创建和销毁对象的接口,PooledObjectFactory。而具体对象的创建则由用户自定义实现。在本身的源代码里只有一个简单的抽象类BasePooledObjectFactory实现。我们来看看这个接口定义的方法：

public interface PooledObjectFactory<T> {

  PooledObject<T> makeObject() throws Exception;

  void destroyObject(PooledObject<T> p) throws Exception;

  boolean validateObject(PooledObject<T> p);

  void activateObject(PooledObject<T> p) throws Exception;

  void passivateObject(PooledObject<T> p) throws Exception;
}

makeObject和destroyObject则分别用于创建销毁对象，很简单。而validateObject用于在每次创建对象放入到pool里或者从pool里取对象出来的时候验证是否对象合法。至于activeObject和passivateObject比较有意思。在这里给对象定义了一系列的状态。这里的设计假定所有在pool里可以被立马拿出去用的对象是一个idle状态，在拿到之后要用activateObject方法来**一下。而对象要返回给pool的时候则要用passivateObject方法将它钝化。

和ObjectPool相对应的，PooledObjectFactory也有一个相应的KeyedPooledObjectFactory，他们的区别也一样，一个是基于key来操作一个不是。