基于Apache组件分析对象池原理的实现案例分析

池塘里养:Object;

一、设计与原理

1、基础案例

首先看一个基于common-pool2对象池组件的应用案例,主要有工厂类、对象池、对象三个核心角色,以及池化对象的使用流程:

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 {
        // 声明对象池
        DevObjPool devObjPool = new DevObjPool() ;
        // 池中借用对象
        DevObj devObj = devObjPool.borrowObject();
        System.out.println("Idle="+devObjPool.getNumIdle()+";Active="+devObjPool.getNumActive());
        // 使用对象
        devObj.devObjInfo();
        // 归还给对象池
        devObjPool.returnObject(devObj);
        System.out.println("Idle="+devObjPool.getNumIdle()+";Active="+devObjPool.getNumActive());
        // 查看对象池
        System.out.println(devObjPool.listAllObjects());
    }
}
/**
 * 对象定义
 */
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");
    }
}
/**
 * 对象工厂
 */
class DevObjFactory extends BasePooledObjectFactory<DevObj> {
    @Override
    public DevObj create() throws Exception {
        // 创建对象
        return new DevObj() ;
    }
    @Override
    public PooledObject<DevObj> wrap(DevObj devObj) {
        // 池化对象
        return new DefaultPooledObject<>(devObj);
    }
}
/**
 * 对象池
 */
class DevObjPool extends GenericObjectPool<DevObj> {
    public DevObjPool() {
        super(new DevObjFactory(), new GenericObjectPoolConfig<>());
    }
}

案例中对象是完全自定义的;对象工厂中则重写两个核心方法:创建和包装,以此创建池化对象;对象池的构建依赖定义的对象工厂,配置采用组件提供的常规配置类;可以通过调整对象实例化的时间以及创建对象的个数,初步理解对象池的原理。

2、接口设计

1.1 PooledObjectFactory 接口

  • 工厂类,负责对象实例化,创建、验证、销毁、状态管理等;
  • 案例中BasePooledObjectFactory类则是该接口的基础实现;

1.2 ObjectPool 接口

  • 对象池,并且继承Closeable接口,管理对象生命周期,以及活跃和空闲对象的数据信息获取;
  • 案例中GenericObjectPool类是对于该接口的实现,并且是可配置化的方式;

1.3 PooledObject 接口

  • 池化对象,基于包装类被维护在对象池中,并且维护一些附加信息用来跟踪,例如时间、状态;
  • 案例中采用DefaultPooledObject包装类,实现该接口并且线程安全,注意工厂类中的重写;

3、运行原理

基于Apache组件分析对象池原理的实现案例分析

通过对象池获取对象,可能是通过工厂新创建的,也可能是空闲的对象;当对象获取成功且使用完成后,需要归还对象;在案例执行过程中,不断查询对象池中空闲和活跃对象的数量,用来监控池的变化。

二、构造分析

1、对象池

public GenericObjectPool(final PooledObjectFactory<T> factory,final GenericObjectPoolConfig<T> config);

在完整的构造方法中,涉及到三个核心对象:工厂对象、配置对象、双端阻塞队列;通过这几个对象创建一个新的对象池;在config中提供了一些简单的默认配置:例如maxTotal、maxIdle、minIdle等,也可以扩展自定义配置;

2、双端队列

private final LinkedBlockingDeque<PooledObject<T>> idleObjects;
public GenericObjectPool(final PooledObjectFactory<T> factory,final GenericObjectPoolConfig<T> config) {
    idleObjects = new LinkedBlockingDeque<>(config.getFairness());
}

LinkedBlockingDeque支持在队列的首尾操作元素,例如添加和移除等;操作需要通过主锁进行加锁,并且基于两个状态锁进行协作;

// 队首节点
private transient LinkedBlockingDeque.Node<E> first;
// 队尾节点
private transient LinkedBlockingDeque.Node<E> last;
// 主锁
private final InterruptibleReentrantLock lock;
// 非空状态锁
private final Condition notEmpty;
// 未满状态锁
private final Condition notFull;

关于链表和队列的特点,在之前的文章中有单独分析过,此处的源码在JDK的容器中也很常见,这里不在赘述,对象池的整个构造有大致轮廓之后,下面再来细看对象的管理逻辑。

三、对象管理

1、添加对象

创建一个新对象并且放入池中,通常应用在需要预加载的场景中;涉及到两个核心操作:工厂创建对象,对象池化管理;

public void GenericObjectPool.addObject() throws Exception ;

2、借用对象

public T GenericObjectPool.borrowObject(final long borrowMaxWaitMillis) throws Exception ;

基于Apache组件分析对象池原理的实现案例分析

首先从队列中获取对象;如果没有获取到,调用工厂创建方法,之后池化管理;对象获取之后会改变状态为ALLOCATED使用中;最后经过工厂的确认,完成对象获取动作;

3、归还对象

public void GenericObjectPool.returnObject(final T obj) ;

基于Apache组件分析对象池原理的实现案例分析

归还对象的时候,首先转换为池化对象和标记RETURNING状态;经过多次校验判断,如果失败则销毁该对象,并重新维护对象池中可用的空闲对象;最终对象被标记为空闲状态,如果不超出最大空闲数,则对象被放到队列的某一端;

4、对象状态

关于池化对象的状态在PooledObjectState类中有枚举和描述,在图中只是对部分几个状态流转做示意,更多细节可以参考状态类;

基于Apache组件分析对象池原理的实现案例分析

可以参考在上述案例中使用到的DefaultPooledObject默认池化对象类中相关方法,结合状态枚举,可以理解不同状态之间的校验和转换。

四、Redis应用

Lettuce作为Redis高级的客户端组件,通信层使用Netty组件,并且是线程安全,支持同步和异步模式,支持集群和哨兵模式;作为当下项目中常用的配置,其底层对象池基于common-pool2组件。

1、配置管理

基于如下配置即表示采用Lettuce组件,其中涉及到池的几个参数配置:最小空闲、最大活跃、最大空闲;这里可以对比GenericObjectPoolConfig中的配置:

spring:
  redis:
    host: ${REDIS_HOST:127.0.0.1}
    lettuce:
      pool:
        min-idle: 10
        max-active: 100
        max-idle: 100

2、源码分析

围绕对象池的特点,自然去追寻源码中关于:配置、工厂、对象几个核心的角色类;从上述配置参数切入,可以很容易发现如下几个类:

基于Apache组件分析对象池原理的实现案例分析

2.1 配置转换

// 连接配置
class LettuceConnectionConfiguration extends RedisConnectionConfiguration {
    private static class PoolBuilderFactory {
        // 构建对象池配置
        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的相关参数,构建到GenericObjectPoolConfig类中,即配置加载过程;

2.2 对象池构造

class LettucePoolingConnectionProvider implements LettuceConnectionProvider {
    // 对象池核心角色
    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);
    }
}

在构造方法中获取对象池的配置信息,这里并没有直接实例化池对象,而是采用ConcurrentHashMap容器来动态维护;

2.3 对象管理

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);
    }
}

在获取池对象时,如果不存在则根据相关配置创建池对象,并维护到Map容器中,然后从池中借用Redis连接对象;释放对象时首先判断对象所属的池,将对象归还到相应的池中。

最后总结,本文从对象池的一个简单案例切入,主要分析common-pool2组件关于:池、工厂、配置、对象管理几个角色的源码逻辑,并且参考其在Redis中的实践,只是冰山一角,像这种通用型并且应用范围广的组件,很值得时常去读一读源码,真的令人惊叹其鬼斧天工的设计。

五、参考源码

应用仓库:
https://gitee.com/cicadasmile/butte-flyer-parent

组件封装:
https://gitee.com/cicadasmile/butte-frame-parent

到此这篇关于基于Apache组件分析对象池原理的文章就介绍到这了,更多相关Apache组件分析对象池原理内容请搜索aitechtogether.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持aitechtogether.com!

共计人评分,平均

到目前为止还没有投票!成为第一位评论此文章。

(0)
青葱年少的头像青葱年少普通用户
上一篇 2023年5月3日 下午7:34
下一篇 2023年5月3日

相关推荐

此站出售,如需请站内私信或者邮箱!