proxool user guide

User Guide 将帮你在java应用中使用proxool

Quick Start

1.如果你的应用是直接jdbc方式连接数据库.你只需要改变少量的代码就可以应用proxool.例如:

原来的代码:

 1.Connection connection = null;
 2.try {
 3.  Class.forName("org.hsqldb.jdbcDriver");
 4.  try {
 5.    connection = DriverManager.getConnection("jdbc:hsqldb:test");
 6.  } catch (SQLException e) {
 7.    LOG.error("Problem getting connection", e);
 8.  }
 9.  
10.  if (connection != null) {
11.    LOG.info("Got connection :)");
12.  } else {
13.    LOG.error("Didn't get connection, which probably means that no Driver accepted the URL");
14.  }
15.  
16.} catch (ClassNotFoundException e) {
17.  LOG.error("Couldn't find driver", e);
18.} finally {
19.  try {
20.    // Check to see we actually got a connection before we
21.    // attempt to close it.
22.    if (connection != null) {
23.      connection.close();
24.    }
25.  } catch (SQLException e) {
26.    LOG.error("Problem closing connection", e);
27.  }
28.}

改变后的代码:

.Connection connection = null;
 2.try {
 3.  Class.forName("org.logicalcobwebs.proxool.ProxoolDriver");
 4.  try {
 5.    connection = DriverManager.getConnection("proxool.example:org.hsqldb.jdbcDriver:jdbc:hsqldb:test");
 6.  } catch (SQLException e) {
 7.    LOG.error("Problem getting connection", e);
 8.  }
 9.  
10.  if (connection != null) {
11.    LOG.info("Got connection :)");
12.  } else {
13.    LOG.error("Didn't get connection, which probably means that no Driver accepted the URL");
14.  }
15.  
16.} catch (ClassNotFoundException e) {
17.  LOG.error("Couldn't find driver", e);
18.} finally {
19.  try {
20.    // Check to see we actually got a connection before we
21.    // attempt to close it.
22.    if (connection != null) {
23.      connection.close();
24.    }
25.  } catch (SQLException e) {
26.    LOG.error("Problem closing connection", e);
27.  }
28.}

原来代码的3-5行发生了改变.其中,我们可能对proxool.example:org.hsqldb.jdbcDriver:jdbc:hsqldb:test这段比较有兴趣.

example: 是这个连接池的别名.这是一个你将要引用这个proxool的唯一的标签.

"org.hsqldb.jdbcDriver":这是你的数据库的原始驱动.

"jdbc:hsqldb:test":这个是你的访问你的数据库的url

2. 如果你显式的在启动的时候配置proxool的话,调用会更加简单.配置proxool有很多中方法.如果你已经完成了配置,你仅仅需要proxool的别名就可以了.

For example:

1.Connection connection = null;
 2.try {
 4.  try {
 5.    connection = DriverManager.getConnection("proxool.example");
 6.  } catch (SQLException e) {
 7.    LOG.error("Problem getting connection", e);
 8.  }

Properties

下面是全部的属性列表:

fatal-sql-exception: 它是一个逗号分割的信息片段.当一个SQL异常发生时,他的异常信息将与这个信息片段进行比较.如果在片段中存在,那么这个异常将被认为是个致命错误(Fatal SQL Exception ).这种情况下,数据库连接将要被放弃.无论发生什么,这个异常将会被重掷以提供给消费者.用户最好自己配置一个不同的异常来抛出.

fatal-sql-exception-wrapper-class:正如上面所说,你最好配置一个不同的异常来重掷.利用这个属性,用户可以包装SQLException,使他变成另外一个异常.这个异常或者继承SQLException或者继承字RuntimeException.proxool自带了2个实现:'org.logicalcobwebs.proxool.FatalSQLException' 和'org.logicalcobwebs.proxool.FatalRuntimeException' .后者更合适.

house-keeping-sleep-time: house keeper 保留线程处于睡眠状态的最长时间,house keeper 的职责就是检查各个连接的状态,并判断是否需要销毁或者创建.

house-keeping-test-sql:  如果发现了空闲的数据库连接.house keeper 将会用这个语句来测试.这个语句最好非常快的被执行.如果没有定义,测试过程将会被忽略。

injectable-connection-interface: 允许proxool实现被代理的connection对象的方法.

injectable-statement-interface: 允许proxool实现被代理的Statement 对象方法.

injectable-prepared-statement-interface: 允许proxool实现被代理的PreparedStatement 对象方法.

injectable-callable-statement-interface: 允许proxool实现被代理的CallableStatement 对象方法.

jmx: 略

jmx-agent-id: 略

jndi-name: 数据源的名称

maximum-active-time: 如果housekeeper 检测到某个线程的活动时间大于这个数值.它将会杀掉这个线程.所以确认一下你的服务器的带宽.然后定一个合适的值.默认是5分钟.

maximum-connection-count: 最大的数据库连接数.

maximum-connection-lifetime: 一个线程的最大寿命.

minimum-connection-count: 最小的数据库连接数

overload-without-refusal-lifetime: 略

prototype-count: 连接池中可用的连接数量.如果当前的连接池中的连接少于这个数值.新的连接将被建立(假设没有超过最大可用数).例如.我们有3个活动连接2个可用连接,而我们的prototype-count是4,那么数据库连接池将试图建立另外2个连接.这和 minimum-connection-count不同. minimum-connection-count把活动的连接也计算在内.prototype-count 是spare connections 的数量.

recently-started-threshold:  略

simultaneous-build-throttle:  略

statistics: 略

statistics-log-level:  略

test-before-use: 略

test-after-use: 略

trace: 如果为true,那么每个被执行的SQL语句将会在执行期被log记录(DEBUG LEVEL).你也可以注册一个ConnectionListener (参看ProxoolFacade)得到这些信息.

verbose: 略.

 Setting up Proxool in a Servlet environment(在servlet环境中使用proxool)
   Configuration(配置)
   有3种方式来配置proxool：
      1. XML file。
      代理到 JAXPConfigurator来处理xml文件。如果文件不是绝对路径，将会定位到应用的根目录。
<servlet>
  <servlet-name>ServletConfigurator</servlet-name>
  <servlet-class>org.logicalcobwebs.proxool.configuration.ServletConfigurator</servlet-class>
  <init-param>
    <param-name>xmlFile</param-name>
    <param-value>WEB-INF/proxool.xml</param-value>
  </init-param>
  <load-on-startup>1</load-on-startup>
</servlet> 
   2. Property file。
 代理到PropertyConfigurator去解析。如果文件不是绝对路径，将会定位到应用的根目录。
   <servlet>
  <servlet-name>ServletConfigurator</servlet-name>
  <servlet-class>org.logicalcobwebs.proxool.configuration.ServletConfigurator</servlet-class>
  <init-param>
    <param-name>propertyFile</param-name>
    <param-value>WEB-INF/proxool.properties</param-value>
  </init-param>
  <load-on-startup>1</load-on-startup>
</servlet>
3. Init parameters。
   代理到PropertyConfigurator去解析。根据servlet的初始化参数创建一个Property对象。
<servlet>
  <servlet-name>ServletConfigurator</servlet-name>
  <servlet-class>org.logicalcobwebs.proxool.configuration.ServletConfigurator</servlet-class>
  <init-param>
    <param-name>jdbc-0.proxool.alias</param-name>
    <param-value>test</param-value>
  </init-param>
  <init-param>
    <param-name>jdbc-0.proxool.driver-url</param-name>
    <param-value>jdbc:hsqldb:.</param-value>
  </init-param>
  <init-param>
    <param-name>jdbc-0.proxool.driver-class</param-name>
    <param-value>org.hsqldb.jdbcDriver</param-value>
  </init-param>
  <load-on-startup>1</load-on-startup>
</servlet>
在刈除所有的连接池后，ServletConfigurator会自动停止。
 <servlet>
  <servlet-name>ServletConfigurator</servlet-name>
  <servlet-class>org.logicalcobwebs.proxool.configuration.ServletConfigurator</servlet-class>
  <init-param>
    <param-name>autoShutdown</param-name>
    <param-value>false</param-value>
  </init-param>
  <load-on-startup>1</load-on-startup>
</servlet>
Installation.（安装）
   如果在你的servlet环境中有多个web应用，你需要考虑如何来安装proxool.这里有2种方案：
   1。在你应用的库目录（web-info/lib）,他的理论如下：
   proxool将不会再web应用间共享。如果你重新装在web应用，一个新的实例将会产生。除非你显式关闭旧的proxool，否则他将继续使用各种资源（本地资源和数据库）。你可以用如下的办法来关闭他们：用上面提到的ServletConfigurator或者调用ProxoolFacade的shutdown方法。
   2。在容器的公用目录下或者classpath中，他的理论如下：
   你可以在多个web应用中共享proxool,这样的话，如果你重新装在单个的web应用，proxool依然在运行。如果你想冲起proxool,要么重起容器，要么全部应用停止并重新配置proxool.