Apache Commons Pool2 源码分析
Apache Commons Pool2 源码分析
Commons Pool2本质上是”对象池”,即通过一定的规则来维护对象集合的容器;commos-pool2在很多场景中,用来实现”连接池”/”任务worker池”等,大家常用的Jedis pool数据库连接池,也是基于commons-pool2实现.
commons-pool2实现思想非常简单,它主要的作用就是将"对象集合"池化,任何通过pool进行对象存取的操作,都会严格按照"pool配置"(比如池的大小)实时的"建对象"、"阻塞控制"、"销毁对象"等.它在一定程度上,实现了对象集合的管理以及对象的分发.
- 1 :将创建对象的方式,使用工厂模式;
- 2 :通过”pool配置”来约束对象存取的时机;
- 3 :将对象列表保存在队列中(LinkedList)
一、核心对象
在讲述其实现原理前,先提一下其中有几个重要的对象:
- PooledObject(池对象)。
- PooledObjectFactory(池对象工厂)。
- Object Pool(对象池)。
1.1 PooledObject(池对象)
用于封装对象(如:线程、数据库连接、TCP连接),将其包裹成可被池管理的对象。提供了两个默认的池对象实现:
- DefaultPoolObject。用于非软引用的普通对象。
- PooledSoftReference。用于软引用的对象。
在开发连接池、线程池等组件时,需要根据实际情况重载5个方法:startEvictionTest、endEvictionTest、allocate、deallocate和invalidate,用于在不同的场景下修改被包裹对象的内部状态。
PooledObject有多种状态,在不同的环节或经过处理后状态会发生变化:
状态 | 描述 |
---|---|
IDLE | 位于队列中,未使用 |
ALLOCATED | 在使用 |
EVICTION | 位于队列中,当前正在测试,可能会被回收 |
EVICTION_RETURN_TO_HEAD | 不在队列中,当前正在测试,可能会被回收。从池中借出对象时需要从队列出移除并进行测试 |
VALIDATION | 位于队列中,当前正在验证 |
VALIDATION_PREALLOCATION | 不在队列中,当前正在验证。当对象从池中被借出,在配置了testOnBorrow的情况下,对像从队列移除和进行预分配的时候会进行验证 |
VALIDATION_RETURN_TO_HEAD | 不在队列中,正在进行验证。从池中借出对象时,从队列移除对象时会先进行测试。返回到队列头部的时候应该做一次完整的验证 |
INVALID | 回收或验证失败,将销毁 |
ABANDONED | 即将无效 |
RETURN | 返还到池中 |
1.2 PooledObjectFactory(池对象工厂)
定义了操作PooledObject实例生命周期的一些方法,PooledObjectFactory必须实现线程安全。已经有两个抽象工厂:
- BasePooledObjectFactory。
- BaseKeyedPooledObjectFactory。
状态 | 描述 |
---|---|
makeObject | 用于生成一个新的ObjectPool实例 |
activateObject | 每一个钝化(passivated)的ObjectPool实例从池中借出(borrowed)前调用 |
validateObject | 可能用于从池中借出对象时,对处于**(activated)状态的ObjectPool实例进行测试确保它是有效的。也有可能在ObjectPool实例返还池中进行钝化前调用进行测试是否有效。它只对处于**状态的实例调用 |
passivateObject | 当ObjectPool实例返还池中的时候调用 |
destroyObject | 当ObjectPool实例从池中被清理出去丢弃的时候调用(是否根据validateObject的测试结果由具体的实现在而定) |
1.3 Object Pool(对象池)
Object Pool负责管理PooledObject,如:借出对象,返回对象,校验对象,有多少**对象,有多少空闲对象。有三个默认的实现类:
- GenericObjectPool。
- ProsiedObjectPool。
- SoftReferenceObjectPool。
状态 | 描述 |
---|---|
borrowObject | 从池中借出一个对象。要么调用PooledObjectFactory.makeObject方法创建,要么对一个空闲对象使用PooledObjectFactory.activeObject进行**,然后使用PooledObjectFactory.validateObject方法进行验证后再返回 |
returnObject | 将一个对象返还给池。根据约定:对象必须 是使用borrowObject方法从池中借出的 |
invalidateObject | 废弃一个对象。根据约定:对象必须 是使用borrowObject方法从池中借出的。通常在对象发生了异常或其他问题时使用此方法废弃它 |
addObject | 使用工厂创建一个对象,钝化并且将它放入空闲对象池 |
getNumberIdle | 返回池中空闲的对象数量。有可能是池中可供借出对象的近似值。如果这个信息无效,返回一个负数 |
getNumActive | 返回从借出的对象数量。如果这个信息不可用,返回一个负数 |
clear | 清除池中的所有空闲对象,释放其关联的资源(可选)。清除空闲对象必须使用PooledObjectFactory.destroyObject方法 |
close | 关闭池并释放关联的资源 |
二、核心流程
2.1 BorrowObject (借出对象)
下面是GenericObjectPool中borrowObject方法的逻辑实现,有阻塞式和非阻塞式两种获取对象的模式。
2.2 BorrowObject (返回对象)
下面是GenericObjectPool中returnObject方法的逻辑实现,在这里实现的FIFO(先进先出)和LIFO(后进先出)。
推荐阅读
-
commons-logging + log4j源码分析
-
Apache Flink源码分析---JobManager启动流程
-
Apache Commons Pool2 源码分析
-
apache commons pool2: 整体结构
-
apache MINA 源码级分析-[壹]
-
apache MINA 源码级分析-[贰]
-
commons-pool-1.6部分源码分析
-
[Tomcat源码分析] Eclipse中搭建Apache Tomcat源码调试环境
-
源码分析Apache Shiro 加密与登录验证
-
Nginx源码分析 ——Nginx的进程模型 nginx apache nginx php nginx rewrite