三分钟让你学会如何使用 apache-common-pool2 创建自己的资源池

需要 commons-pool2-2.3.jar 包，大家可以去官网下载

1：定义资源对象，即保存在资源池中的资源

public class User {
    //姓名
    private String name;
    //年龄
    private int age;
    //身高
    private String height;

    public User(String name, int age, String height) {
        super();
        this.name = name;
        this.age = age;
        this.height = height;
    }

    @Override
    public String toString() {
        StringBuilder str = new StringBuilder(super.toString());
        str.append(" ");
        str.append("name:" + name);
        str.append(",age:" + age);
        str.append(",height:" + height);
        return str.toString();
    }

}

2：创建一个poolfactory 实现接口 org.apache.commons.pool2.PooledObjectFactory

import org.apache.commons.pool2.PooledObject;
import org.apache.commons.pool2.PooledObjectFactory;
import org.apache.commons.pool2.impl.DefaultPooledObject;

public class LpPoolFactory implements PooledObjectFactory {

/**
 * 功能描述：激活资源对象
 * 
 * 什么时候会调用此方法
 * 1：从资源池中获取资源的时候
 * 2：资源回收线程，回收资源的时候，根据配置的 testWhileIdle 参数，判断 是否执行 factory.activateObject()方法，true 执行，false 不执行
 * @param arg0 
 */
@Override
public void activateObject(PooledObject<User> arg0) throws Exception {
    System.out.println("activate Object");
}

@Override
public void destroyObject(PooledObject<User> arg0) throws Exception {
    System.out.println("destroy Object");
    User user = arg0.getObject();
    user = null;
}

@Override
public PooledObject<User> makeObject() throws Exception {
    System.out.println("make Object");
    User user = new User(Thread.currentThread().getName(), 26, "178cm");
    return new DefaultPooledObject<User>(user);
}

/**
 * 功能描述：钝化资源对象
 * 
 * 什么时候会调用此方法
 * 1：将资源返还给资源池时，调用此方法。
 */
@Override
public void passivateObject(PooledObject<User> arg0) throws Exception {
    System.out.println("passivate Object");
}

/**
 * 功能描述：判断资源对象是否有效，有效返回 true，无效返回 false
 * 
 * 什么时候会调用此方法
 * 1：从资源池中获取资源的时候，参数 testOnBorrow 或者 testOnCreate 中有一个 配置 为 true 时，则调用  factory.validateObject() 方法
 * 2：将资源返还给资源池的时候，参数 testOnReturn，配置为 true 时，调用此方法
 * 3：资源回收线程，回收资源的时候，参数 testWhileIdle，配置为 true 时，调用此方法
 */
@Override
public boolean validateObject(PooledObject<User> arg0) {
    System.out.println("validate Object");
    return true;
}

}

3：对一个资源池来说，应该有一些参数配置，apache-common-pool2的参数配置都在 org.apache.commons.pool2.impl.GenericObjectPoolConfig 中

点击查看

4：创建池，并从池中获取资源对象，使用完后，将资源对象返还给资源池

使用池的第一种方式
//使用默认的 config配置
LpPoolFactory factory = new LpPoolFactory();
GenericObjectPool<User> objectPool = new GenericObjectPool<User>(factory);

使用池的第二种方式
//使用 自己的  config配置
LpPoolFactory factory = new LpPoolFactory();
GenericObjectPoolConfig poolConfig = new GenericObjectPoolConfig();
poolConfig.setMinIdle(2);
GenericObjectPool<User> objectPool = new GenericObjectPool<User>(factory,poolConfig);

测试代码以及测试结果

public static void main(String[] args) throws Exception{
    //工厂
    LpPoolFactory factory = new LpPoolFactory();
    //资源池配置
    GenericObjectPoolConfig poolConfig = new GenericObjectPoolConfig();
    poolConfig.setMinIdle(2);
    //创建资源池
    GenericObjectPool<User> objectPool = new GenericObjectPool<User>(factory,poolConfig);   

    for(int i=0; i<3; i++) {
        Thread.sleep(1000);
        //获取资源对象
        User user = objectPool.borrowObject();
        //将获取的资源对象，返还给资源池
        objectPool.returnObject(user);
        //输出资源对象
        System.out.println(user);
        System.out.println();
    }

}

测试结果
make Object
activate Object
passivate Object
com.lp.User@63f7d32f name:main,age:26,height:178cm

activate Object
passivate Object
com.lp.User@63f7d32f name:main,age:26,height:178cm

activate Object
passivate Object
com.lp.User@63f7d32f name:main,age:26,height:178cm