基于Apache組件分析對(duì)象池原理的實(shí)現(xiàn)案例分析
池塘里養(yǎng)：Object；
一、設(shè)計(jì)與原理
1、基礎(chǔ)案例
首先看一個(gè)基于common-pool2對(duì)象池組件的應(yīng)用案例，主要有工廠類、對(duì)象池、對(duì)象三個(gè)核心角色，以及池化對(duì)象的使用流程：
import org.apache.commons.pool2.BasePooledObjectFactory;
import org.apache.commons.pool2.PooledObject;
import org.apache.commons.pool2.impl.DefaultPooledObject;
import org.apache.commons.pool2.impl.GenericObjectPool;
import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class ObjPool {
public static void main(String[] args) throws Exception {
// 聲明對(duì)象池
DevObjPool devObjPool = new DevObjPool() ;
// 池中借用對(duì)象
DevObj devObj = devObjPool.borrowObject();
System.out.println("Idle="+devObjPool.getNumIdle()+"；Active="+devObjPool.getNumActive());
// 使用對(duì)象
devObj.devObjInfo();
// 歸還給對(duì)象池
devObjPool.returnObject(devObj);
System.out.println("Idle="+devObjPool.getNumIdle()+"；Active="+devObjPool.getNumActive());
// 查看對(duì)象池
System.out.println(devObjPool.listAllObjects());
}
}
/**
* 對(duì)象定義
*/
class DevObj {
private static final Logger logger = LoggerFactory.getLogger(DevObj.class) ;
public DevObj (){
logger.info("build...dev...obj");
}
public void devObjInfo (){
logger.info("dev...obj...info");
}
}
/**
* 對(duì)象工廠
*/
class DevObjFactory extends BasePooledObjectFactory<DevObj> {
@Override
public DevObj create() throws Exception {
// 創(chuàng)建對(duì)象
return new DevObj() ;
}
@Override
public PooledObject<DevObj> wrap(DevObj devObj) {
// 池化對(duì)象
return new DefaultPooledObject<>(devObj);
}
}
/**
* 對(duì)象池
*/
class DevObjPool extends GenericObjectPool<DevObj> {
public DevObjPool() {
super(new DevObjFactory(), new GenericObjectPoolConfig<>());
}
}
案例中對(duì)象是完全自定義的；對(duì)象工廠中則重寫兩個(gè)核心方法：創(chuàng)建和包裝，以此創(chuàng)建池化對(duì)象；對(duì)象池的構(gòu)建依賴定義的對(duì)象工廠，配置采用組件提供的常規(guī)配置類；可以通過調(diào)整對(duì)象實(shí)例化的時(shí)間以及創(chuàng)建對(duì)象的個(gè)數(shù)，初步理解對(duì)象池的原理。
2、接口設(shè)計(jì)
1.1 PooledObjectFactory 接口
- 工廠類，負(fù)責(zé)對(duì)象實(shí)例化，創(chuàng)建、驗(yàn)證、銷毀、狀態(tài)管理等；
- 案例中
BasePooledObjectFactory類則是該接口的基礎(chǔ)實(shí)現(xiàn)；
1.2 ObjectPool 接口
- 對(duì)象池，并且繼承
Closeable接口，管理對(duì)象生命周期，以及活躍和空閑對(duì)象的數(shù)據(jù)信息獲??； - 案例中
GenericObjectPool類是對(duì)于該接口的實(shí)現(xiàn)，并且是可配置化的方式；
1.3 PooledObject 接口
- 池化對(duì)象，基于包裝類被維護(hù)在對(duì)象池中，并且維護(hù)一些附加信息用來跟蹤，例如時(shí)間、狀態(tài)；
- 案例中采用
DefaultPooledObject包裝類，實(shí)現(xiàn)該接口并且線程安全，注意工廠類中的重寫；
3、運(yùn)行原理
通過對(duì)象池獲取對(duì)象，可能是通過工廠新創(chuàng)建的，也可能是空閑的對(duì)象；當(dāng)對(duì)象獲取成功且使用完成后，需要?dú)w還對(duì)象；在案例執(zhí)行過程中，不斷查詢對(duì)象池中空閑和活躍對(duì)象的數(shù)量，用來監(jiān)控池的變化。
二、構(gòu)造分析
1、對(duì)象池
public GenericObjectPool(final PooledObjectFactory<T> factory,final GenericObjectPoolConfig<T> config);
在完整的構(gòu)造方法中，涉及到三個(gè)核心對(duì)象：工廠對(duì)象、配置對(duì)象、雙端阻塞隊(duì)列；通過這幾個(gè)對(duì)象創(chuàng)建一個(gè)新的對(duì)象池；在config中提供了一些簡單的默認(rèn)配置：例如maxTotal、maxIdle、minIdle等，也可以擴(kuò)展自定義配置；
2、雙端隊(duì)列
private final LinkedBlockingDeque<PooledObject<T>> idleObjects;
public GenericObjectPool(final PooledObjectFactory<T> factory,final GenericObjectPoolConfig<T> config) {
idleObjects = new LinkedBlockingDeque<>(config.getFairness());
}LinkedBlockingDeque支持在隊(duì)列的首尾操作元素，例如添加和移除等；操作需要通過主鎖進(jìn)行加鎖，并且基于兩個(gè)狀態(tài)鎖進(jìn)行協(xié)作；
// 隊(duì)首節(jié)點(diǎn) private transient LinkedBlockingDeque.Node<E> first; // 隊(duì)尾節(jié)點(diǎn) private transient LinkedBlockingDeque.Node<E> last; // 主鎖 private final InterruptibleReentrantLock lock; // 非空狀態(tài)鎖 private final Condition notEmpty; // 未滿狀態(tài)鎖 private final Condition notFull;
關(guān)于鏈表和隊(duì)列的特點(diǎn)，在之前的文章中有單獨(dú)分析過，此處的源碼在JDK的容器中也很常見，這里不在贅述，對(duì)象池的整個(gè)構(gòu)造有大致輪廓之后，下面再來細(xì)看對(duì)象的管理邏輯。
三、對(duì)象管理
1、添加對(duì)象
創(chuàng)建一個(gè)新對(duì)象并且放入池中，通常應(yīng)用在需要預(yù)加載的場景中；涉及到兩個(gè)核心操作：工廠創(chuàng)建對(duì)象，對(duì)象池化管理；
public void GenericObjectPool.addObject() throws Exception ;
2、借用對(duì)象
public T GenericObjectPool.borrowObject(final long borrowMaxWaitMillis) throws Exception ;
首先從隊(duì)列中獲取對(duì)象；如果沒有獲取到，調(diào)用工廠創(chuàng)建方法，之后池化管理；對(duì)象獲取之后會(huì)改變狀態(tài)為ALLOCATED使用中；最后經(jīng)過工廠的確認(rèn)，完成對(duì)象獲取動(dòng)作；
3、歸還對(duì)象
public void GenericObjectPool.returnObject(final T obj) ；
歸還對(duì)象的時(shí)候，首先轉(zhuǎn)換為池化對(duì)象和標(biāo)記RETURNING狀態(tài)；經(jīng)過多次校驗(yàn)判斷，如果失敗則銷毀該對(duì)象，并重新維護(hù)對(duì)象池中可用的空閑對(duì)象；最終對(duì)象被標(biāo)記為空閑狀態(tài)，如果不超出最大空閑數(shù)，則對(duì)象被放到隊(duì)列的某一端；
4、對(duì)象狀態(tài)
關(guān)于池化對(duì)象的狀態(tài)在PooledObjectState類中有枚舉和描述，在圖中只是對(duì)部分幾個(gè)狀態(tài)流轉(zhuǎn)做示意，更多細(xì)節(jié)可以參考狀態(tài)類；
可以參考在上述案例中使用到的DefaultPooledObject默認(rèn)池化對(duì)象類中相關(guān)方法，結(jié)合狀態(tài)枚舉，可以理解不同狀態(tài)之間的校驗(yàn)和轉(zhuǎn)換。
四、Redis應(yīng)用
Lettuce作為Redis高級(jí)的客戶端組件，通信層使用Netty組件，并且是線程安全，支持同步和異步模式，支持集群和哨兵模式；作為當(dāng)下項(xiàng)目中常用的配置，其底層對(duì)象池基于common-pool2組件。
1、配置管理
基于如下配置即表示采用Lettuce組件，其中涉及到池的幾個(gè)參數(shù)配置：最小空閑、最大活躍、最大空閑；這里可以對(duì)比GenericObjectPoolConfig中的配置：
spring:
redis:
host: ${REDIS_HOST:127.0.0.1}
lettuce:
pool:
min-idle: 10
max-active: 100
max-idle: 1002、源碼分析
圍繞對(duì)象池的特點(diǎn)，自然去追尋源碼中關(guān)于：配置、工廠、對(duì)象幾個(gè)核心的角色類；從上述配置參數(shù)切入，可以很容易發(fā)現(xiàn)如下幾個(gè)類：
2.1 配置轉(zhuǎn)換
// 連接配置
class LettuceConnectionConfiguration extends RedisConnectionConfiguration {
private static class PoolBuilderFactory {
// 構(gòu)建對(duì)象池配置
private GenericObjectPoolConfig<?> getPoolConfig(RedisProperties.Pool properties) {
GenericObjectPoolConfig<?> config = new GenericObjectPoolConfig<>();
config.setMaxTotal(properties.getMaxActive());
config.setMaxIdle(properties.getMaxIdle());
config.setMinIdle(properties.getMinIdle());
return config;
}
}
}這里將配置文件中Redis的相關(guān)參數(shù)，構(gòu)建到GenericObjectPoolConfig類中，即配置加載過程；
2.2 對(duì)象池構(gòu)造
class LettucePoolingConnectionProvider implements LettuceConnectionProvider {
// 對(duì)象池核心角色
private final GenericObjectPoolConfig poolConfig;
private final BoundedPoolConfig asyncPoolConfig;
private final Map<Class<?>, GenericObjectPool> pools = new ConcurrentHashMap(32);
LettucePoolingConnectionProvider(LettuceConnectionProvider provider, LettucePoolingClientConfiguration config) {
this.poolConfig = clientConfiguration.getPoolConfig();
this.asyncPoolConfig = CommonsPool2ConfigConverter.bounded(this.config);
}
}在構(gòu)造方法中獲取對(duì)象池的配置信息，這里并沒有直接實(shí)例化池對(duì)象，而是采用ConcurrentHashMap容器來動(dòng)態(tài)維護(hù)；
2.3 對(duì)象管理
class LettucePoolingConnectionProvider implements LettuceConnectionProvider {
// 獲取Redis連接
public <T extends StatefulConnection<?, ?>> T getConnection(Class<T> connectionType) {
GenericObjectPool pool = (GenericObjectPool)this.pools.computeIfAbsent();
StatefulConnection<?, ?> connection = (StatefulConnection)pool.borrowObject();
}
// 釋放Redis連接
public void release(StatefulConnection<?, ?> connection) {
GenericObjectPool<StatefulConnection<?, ?>> pool = (GenericObjectPool)this.poolRef.remove(connection);
}
}在獲取池對(duì)象時(shí)，如果不存在則根據(jù)相關(guān)配置創(chuàng)建池對(duì)象，并維護(hù)到Map容器中，然后從池中借用Redis連接對(duì)象；釋放對(duì)象時(shí)首先判斷對(duì)象所屬的池，將對(duì)象歸還到相應(yīng)的池中。
最后總結(jié)，本文從對(duì)象池的一個(gè)簡單案例切入，主要分析common-pool2組件關(guān)于：池、工廠、配置、對(duì)象管理幾個(gè)角色的源碼邏輯，并且參考其在Redis中的實(shí)踐，只是冰山一角，像這種通用型并且應(yīng)用范圍廣的組件，很值得時(shí)常去讀一讀源碼，真的令人驚嘆其鬼斧天工的設(shè)計(jì)。
五、參考源碼
應(yīng)用倉庫：
https://gitee.com/cicadasmile/butte-flyer-parent
組件封裝：
https://gitee.com/cicadasmile/butte-frame-parent
到此這篇關(guān)于基于Apache組件分析對(duì)象池原理的文章就介紹到這了,更多相關(guān)Apache組件分析對(duì)象池原理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
本篇文章給大家詳細(xì)分析了Java并發(fā)編程this逃逸的問題分享，對(duì)此有需要的朋友參考下。2018-02-02
Component和Configuration注解區(qū)別實(shí)例詳解
這篇文章主要為大家介紹了Component和Configuration注解區(qū)別實(shí)例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-11-11
Java?在?Java?8?中提供了一個(gè)新的附加包,稱為?java.util.stream,該包由類、接口和枚舉組成,允許對(duì)元素進(jìn)行函數(shù)式操作,?本文主要介紹了Java中Stream?API的具體使用,感興趣的小伙伴可以了解下2023-11-11
這篇文章主要介紹了Java 程序初始化順序，在Java語言中，當(dāng)實(shí)例化對(duì)象時(shí)，對(duì)象所在類的所有成員變量首先要進(jìn)行初始化，只有當(dāng)所有的類成員完成了初始化之后，才會(huì)調(diào)用對(duì)象所在類的構(gòu)造函數(shù)創(chuàng)建對(duì)象,需要的朋友可以參考一下2022-01-01
Java實(shí)現(xiàn)貪吃蛇游戲(1小時(shí)學(xué)會(huì))
這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)貪吃蛇游戲，1小時(shí)學(xué)會(huì)貪吃蛇游戲，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2020-05-05
Java如何實(shí)現(xiàn)Unicode和中文相互轉(zhuǎn)換
這篇文章主要介紹了Java如何實(shí)現(xiàn)Unicode和中文相互轉(zhuǎn)換問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-01-01
java實(shí)現(xiàn)動(dòng)態(tài)驗(yàn)證碼
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)動(dòng)態(tài)驗(yàn)證碼，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2021-03-03
SpringBoot優(yōu)化連接數(shù)的方法詳解
SpringBoot開發(fā)最大的好處是簡化配置,內(nèi)置了Tomcat,下面這篇文章主要給大家介紹了關(guān)于SpringBoot優(yōu)化連接數(shù)的相關(guān)資料,文中通過實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-06-06
Spring Cloud Feign請(qǐng)求添加headers的實(shí)現(xiàn)方式
這篇文章主要介紹了Spring Cloud Feign請(qǐng)求添加headers的實(shí)現(xiàn)方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-04-04
過濾器通常對(duì)一些web資源進(jìn)行攔截，做完一些處理器再交給下一個(gè)過濾器處理，直到所有的過濾器處理器，再調(diào)用servlet實(shí)例的service方法進(jìn)行處理。本文將通過示例為大家講解Java中過濾器Filter的用法與實(shí)現(xiàn)，需要的可以參考一下2023-02-02