Apache common pool 用法

pangxia75

Apache Common Pool的使用
http://commons.apache.org/pool/examples.html
<!--[if !supportEmptyParas]--> <!--[endif]-->
Apache CommonPool包括很多已经实现的Pool，常用的Pool有GenericObjectPool，GenericKeyedObjectPool。本文主要讲述如何使用以上两种Pool，其它的用法相似。使用Common Pool需求到Apache网站下载commons-pool.jar和commons-collections.jar两个包。
一．GenericObjectPool类
       GenericObjectPool类在rg.apache.commons.pool.impl包中，构造函数如下：

public GenericObjectPool(org.apache.commons.pool.PoolableObjectFactory ,
                        int ,byte ,long , boolean ,boolean )
        由构造函数的定义可以看出，要想使用GenericObjectPool，必须要实现PoolableObjectFactory接口。然后，利用GenericObjectPool的方法获得Pool中的实例。    
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !supportLists]-->

１．           实现PoolableObjectFactory接口
实现PoolableObjectFactory接口，需实现以下方法。其中makeObject在创建实例时调用，通过自定义代码生成并返回需求的实例，activateObject方法在从Pool中拿出一个实例的同时调用，passivateObject方法在实例返还给Pool时调用。

public class MyPoolableObjectFactory implements PoolableObjectFactory {
    //创建对象实例。同时可以分配这个对象适用的资源。
public Object makeObject() throws Exception {
         Connection con = getConnection();
     renturn con;
}
// 销毁对象，实际上提供了释放对象占用资源的接口。
public void destroyObject(Object obj) throws Exception {
     System.out.println("destory Object");
}
//查询对象有效性，这个方法一般在 activateObject 方法执行后调用
public boolean validateObject(Object obj) {
     return true;
}
// 激活一个对象。
public void activateObject(Object obj) throws Exception {
    System.out.println("active object");
}
//挂起一个对象
public void passivateObject(Object obj) throws Exception {
     System.out.println("return object");
}
}
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !supportLists]-->

2.    使用GenericObjectPool
实现PoolableObjectFactory接口后，可以直接使用GenericObjectPool构造函数获得其实例，代码如下：
org.apache.commons.pool.PoolableObjectFactory    factory = new MyPoolableObjectFactory();
GenericObjectPool   pool= new GenericObjectPool(factory, 100,GenericObjectPool.WHEN_EXHAUSTED_BLOCK, 100, true, true);
其中，第一个100为最大激活数，第二个为最大等待数。
<!--[if !supportEmptyParas]--> <!--[endif]-->
2.1.GenericObjectPool参数设置
       GenericObjectPool有几个重要的参数：最大激活数(maxActive)，最大等待数(maxWait)，最大空闲数(maxIdle)，最大空闲时间(maxIdleTime)等。
A). 最大激活数－在Pool中注册，并且正在使用的实例数。调用pool.setMaxActive()方法设置。
B). 最大等待数－在Pool中注册，等待获取实例的申请数。调用pool.setMaxWait()方法设置。
C). 最大空闲数－在Pool中注册，并且正处于空闲状态的实例数。调用pool.setMaxIdle()方法设置
D). 最大空闲时间－在Pool中，实例空闲的最长时间。调用pool.setMinEvictableIdleTimeMillis(maxIdleTime)及pool. setTimeBetweenEvictionRunsMillis(maxIdleTime)方法共同设置。
<!--[if !supportEmptyParas]--> <!--[endif]-->
2.2.Pool中实例的操作
       Pool中实例的操作，主要包括实例的获取及实例的返还。使用完实例之后，需及时返还，否则实例还是处理激活状态，不能为被后面的申请重复利用。
A).实例的获取使用pool.borrowObject()方法
B).实例返还使用pool.returnObject(con)方法,其中con为pool中获取的实例。
<!--[if !supportEmptyParas]--> <!--[endif]-->
二．GenericKeyedObjectPool类
       GenericKeyedObjectPool类在rg.apache.commons.pool.impl包中，构造函数如下：

public GenericObjectPool(org.apache.commons.pool.KeyedPoolableObjectFactory ,
                        int ,byte ,long , boolean ,boolean )
        由构造函数的定义可以看出，要想使用GenericKeyedObjectPool，必须要实现KeyedPoolableObjectFactory接口。然后，利用GenericKeyedObjectPool的方法获得Pool中的实例。    
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !supportLists]-->

１.实现KeyedPoolableObjectFactory接口
实现KeyedPoolableObjectFactory接口，需实现以下方法。其中makeObject在创建实例时调用，通过自定义代码生成并返回需求的实例，注意要以一个形参为key创建；activateObject方法在从Pool中拿出一个实例的同时调用，passivateObject方法在实例返还给Pool时调用。要实现的方法比PoolableObjectFactory要实现的方法都多了一个参数key。

public class MyKeyedPoolableObjectFactory implements KeyedPoolableObjectFactory {
    //创建对象实例。同时可以分配这个对象适用的资源。
public Object makeObject(Object key) throws Exception {
         Connection con = getConnection(key);
     renturn con;
}
// 销毁对象，实际上提供了释放对象占用资源的接口。
public void destroyObject(Object key, Object obj) throws Exception {
     System.out.println("destory Object");
}
//查询对象有效性，这个方法一般在 activateObject 方法执行后调用
public boolean validateObject(Object key, Object obj) {
     return true;
}
// 激活一个对象。
public void activateObject(Object key, Object obj) throws Exception {
    System.out.println("active object");
}
//挂起一个对象
public void passivateObject(Object key, Object obj) throws Exception {
     System.out.println("return object");
}
}
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !supportLists]-->


２．使用GenericKeyedObjectPool
实现KeyedPoolableObjectFactory接口后，可以直接使用GenericKeyedObjectPool构造函数获得其实例，代码如下：
org.apache.commons.pool.KeyedPoolableObjectFactory factory = new MyKeyedPoolableObjectFactory();
GenericKeyedObjectPool pool= new GenericKeyedObjectPool(factory, 100,GenericObjectPool.WHEN_EXHAUSTED_BLOCK, 100, true, true);
其中，第一个100为最大激活数，第二个为最大等待数。
<!--[if !supportEmptyParas]--> <!--[endif]-->
2.1.GenericKeyedObjectPool参数设置
       GenericKeyedObjectPool参数设置与GenericObjectPool类似。
<!--[if !supportEmptyParas]--> <!--[endif]-->
2.2.Pool中实例的操作
       Pool中实例的操作，主要包括实例的获取及实例的返还。使用完实例之后，需及时返还，否则实例还是处理激活状态，不能为被后面的申请重复利用。带key的Pool的操作方法，也相应的都加了参数key。
A).实例的获取使用pool.borrowObject(Object key)方法
B).实例返还使用pool.returnObject(Object key,Object con)方法,其中con为pool中获取的实例。