用連接池提高Servlet訪問數據庫的效率

Java Servlet作爲首選的服務器端數據處理技術，正在迅速取代CGI腳本。Servlet超越CGI的優勢之一在於，不僅多個請求
可以共享公用資源，而且還可以在不同用戶請求之間保留持續數據。本文介紹一種充分發揮該特色的實用技術，即數據庫連
接池。


一、實現連接池的意義

動態Web站點往往用數據庫存儲的信息生成Web頁面，每一個頁面請求導致一次數據庫訪問。連接
數據庫不僅要開銷一定的通訊和內存資源，還必須完成用戶驗證、安全上下文配置這類任務，因而往往成爲最爲耗時的操
作。當然，實際的連接時間開銷千變萬化，但1到2秒延遲並非不常見。如果某個基於數據庫的Web應用只需建立一次初始連
接，不同頁面請求能夠共享同一連接，就能獲得顯著的性能改善。
Servlet是一個Java類。Servlet引擎（它可能是Web服務軟件的一部分，也可能是一個獨立的附加模塊）在系統啓動或Servlet
第一次被請求時將該類裝入Java虛擬機並創建它的一個實例。不同用戶請求由同一Servlet實例的多個獨立線程處理。那些要
求在不同請求之間持續有效的數據既可以用Servlet的實例變量來保存，也可以保存在獨立的輔助對象中。
用JDBC訪問數據庫首先要創建與數據庫之間的連接，獲得一個連接對象（Connection），由連接對象提供執行SQL語句的方法。
本文介紹的數據庫連接池包括一個管理類DBConnectionManager，負責提供與多個連接池對象（DBConnectionPool類）之間
的接口。每一個連接池對象管理一組JDBC連接對象，每一個連接對象可以被任意數量的Servlet共享。
類DBConnectionPool提供以下功能：

1) 從連接池獲取（或創建）可用連接。
2) 把連接返回給連接池。
3) 在系統關閉時釋放所有資源，關閉所有連接。

此外， DBConnectionPool類還能夠處理無效連接（原來登記爲可用的連接，由於某種原因不再可用，如超時，通訊問題）
，並能夠限制連接池中的連接總數不超過某個預定值。
管理類DBConnectionManager用於管理多個連接池對象，它提供以下功能：

1) 裝載和註冊JDBC驅動程序。
2) 根據在屬性文件中定義的屬性創建連接池對象。
3) 實現連接池名字與其實例之間的映射。
4) 跟蹤客戶程序對連接池的引用，保證在最後一個客戶程序結束時安全地關閉所有連接池。

本文餘下部分將詳細說明這兩個類，最後給出一個示例演示Servlet使用連接池的一般過程。


二、具體實現

DBConnectionManager.java程序清單如下：

001 import java.io.*;
002 import java.sql.*;
003 import java.util.*;
004 import java.util.Date;
005
006 /**
007 * 管理類DBConnectionManager支持對一個或多個由屬性文件定義的數據庫連接
008 * 池的訪問.客戶程序可以調用getInstance()方法訪問本類的唯一實例.
009 */
010 public class DBConnectionManager {
011 static private DBConnectionManager instance; // 唯一實例
012 static private int clients;
013
014 private Vector drivers = new Vector();
015 private PrintWriter log;
016 private Hashtable pools = new Hashtable();
017
018 /**
019 * 返回唯一實例.如果是第一次調用此方法,則創建實例
020 *
021 * @return DBConnectionManager 唯一實例
022 */
023 static synchronized public DBConnectionManager getInstance() {
024 if (instance == null) {
025 instance = new DBConnectionManager();
026 }
027 clients++;
028 return instance;
029 }
030
031 /**
032 * 建構函數私有以防止其它對象創建本類實例
033 */
034 private DBConnectionManager() {
035 init();
036 }
037
038 /**
039 * 將連接對象返回給由名字指定的連接池
040 *
041 * @param name 在屬性文件中定義的連接池名字
042 * @param con 連接對象
043 */
044 public void freeConnection(String name, Connection con) {
045 DBConnectionPool pool = (DBConnectionPool) pools.get(name);
046 if (pool != null) {
047 pool.freeConnection(con);
048 }
049 }
050
051 /**
052 * 獲得一個可用的(空閒的)連接.如果沒有可用連接,且已有連接數小於最大連接數
053 * 限制,則創建並返回新連接
054 *
055 * @param name 在屬性文件中定義的連接池名字
056 * @return Connection 可用連接或null
057 */
058 public Connection getConnection(String name) {
059 DBConnectionPool pool = (DBConnectionPool) pools.get(name);
060 if (pool != null) {
061 return pool.getConnection();
062 }
063 return null;
064 }
065
066 /**
067 * 獲得一個可用連接.若沒有可用連接,且已有連接數小於最大連接數限制,
068 * 則創建並返回新連接.否則,在指定的時間內等待其它線程釋放連接.
069 *
070 * @param name 連接池名字
071 * @param time 以毫秒計的等待時間
072 * @return Connection 可用連接或null
073 */
074 public Connection getConnection(String name, long time) {
075 DBConnectionPool pool = (DBConnectionPool) pools.get(name);
076 if (pool != null) {
077 return pool.getConnection(time);
078 }
079 return null;
080 }
081
082 /**
083 * 關閉所有連接,撤銷驅動程序的註冊
084 */
085 public synchronized void release() {
086 // 等待直到最後一個客戶程序調用
087 if (--clients != 0) {
088 return;
089 }
090
091 Enumeration allPools = pools.elements();
092 while (allPools.hasMoreElements()) {
093 DBConnectionPool pool = (DBConnectionPool) allPools.nextElement();
094 pool.release();
095 }
096 Enumeration allDrivers = drivers.elements();
097 while (allDrivers.hasMoreElements()) {
098 Driver driver = (Driver) allDrivers.nextElement();
099 try {
100 DriverManager.deregisterDriver(driver);
101 log("撤銷JDBC驅動程序 " + driver.getClass().getName()+"的註冊");
102 }
103 catch (SQLException e) {
104 log(e, "無法撤銷下列JDBC驅動程序的註冊: " + driver.getClass().getName());
105 }
106 }
107 }
108
109 /**
110 * 根據指定屬性創建連接池實例.
111 *
112 * @param props 連接池屬性
113 */
114 private void createPools(Properties props) {
115 Enumeration propNames = props.propertyNames();
116 while (propNames.hasMoreElements()) {
117 String name = (String) propNames.nextElement();
118 if (name.endsWith(".url")) {
119 String poolName = name.substring(0, name.lastIndexOf("."));
120 String url = props.getProperty(poolName + ".url");
121 if (url == null) {
122 log("沒有爲連接池" + poolName + "指定URL");
123 continue;
124 }
125 String user = props.getProperty(poolName + ".user");
126 String password = props.getProperty(poolName + ".password");
127 String maxconn = props.getProperty(poolName + ".maxconn", "0");
128 int max;
129 try {
130 max = Integer.valueOf(maxconn).intValue();
131 }
132 catch (NumberFormatException e) {
133 log("錯誤的最大連接數限制: " + maxconn + " .連接池: " + poolName);
134 max = 0;
135 }
136 DBConnectionPool pool =
137 new DBConnectionPool(poolName, url, user, password, max);
138 pools.put(poolName, pool);
139 log("成功創建連接池" + poolName);
140 }
141 }
142 }
143
144 /**
145 * 讀取屬性完成初始化
146 */
147 private void init() {
148 InputStream is = getClass().getResourceAsStream("/db.properties");
149 Properties dbProps = new Properties();
150 try {
151 dbProps.load(is);
152 }
153 catch (Exception e) {
154 System.err.println("不能讀取屬性文件. " +
155 "請確保db.properties在CLASSPATH指定的路徑中");
156 return;
157 }
158 String logFile = dbProps.getProperty("logfile", "DBConnectionManager.log");
159 try {
160 log = new PrintWriter(new FileWriter(logFile, true), true);
161 }
162 catch (IOException e) {
163 System.err.println("無法打開日誌文件: " + logFile);
164 log = new PrintWriter(System.err);
165 }
166 loadDrivers(dbProps);
167 createPools(dbProps);
168 }
169
170 /**
171 * 裝載和註冊所有JDBC驅動程序
172 *
173 * @param props 屬性
174 */
175 private void loadDrivers(Properties props) {
176 String driverClasses = props.getProperty("drivers");
177 StringTokenizer st = new StringTokenizer(driverClasses);
178 while (st.hasMoreElements()) {
179 String driverClassName = st.nextToken().trim();
180 try {
181 Driver driver = (Driver)
182 Class.forName(driverClassName).newInstance();
183 DriverManager.registerDriver(driver);
184 drivers.addElement(driver);
185 log("成功註冊JDBC驅動程序" + driverClassName);
186 }
187 catch (Exception e) {
188 log("無法註冊JDBC驅動程序: " +
189 driverClassName + ", 錯誤: " + e);
190 }
191 }
192 }
193
194 /**
195 * 將文本信息寫入日誌文件
196 */
197 private void log(String msg) {
198 log.println(new Date() + ": " + msg);
199 }
200
201 /**
202 * 將文本信息與異常寫入日誌文件
203 */
204 private void log(Throwable e, String msg) {
205 log.println(new Date() + ": " + msg);
206 e.printStackTrace(log);
207 }
208
209 /**
210 * 此內部類定義了一個連接池.它能夠根據要求創建新連接,直到預定的最
211 * 大連接數爲止.在返回連接給客戶程序之前,它能夠驗證連接的有效性.
212 */
213 class DBConnectionPool {
214 private int checkedOut;
215 private Vector freeConnections = new Vector();
216 private int maxConn;
217 private String name;
218 private String password;
219 private String URL;
220 private String user;
221
222 /**
223 * 創建新的連接池
224 *
225 * @param name 連接池名字
226 * @param URL 數據庫的JDBC URL
227 * @param user 數據庫帳號,或 null
228 * @param password 密碼,或 null
229 * @param maxConn 此連接池允許建立的最大連接數
230 */
231 public DBConnectionPool(String name, String URL, String user, String password,
232 int maxConn) {
233 this.name = name;
234 this.URL = URL;
235 this.user = user;
236 this.password = password;
237 this.maxConn = maxConn;
238 }
239
240 /**
241 * 將不再使用的連接返回給連接池
242 *
243 * @param con 客戶程序釋放的連接
244 */
245 public synchronized void freeConnection(Connection con) {
246 // 將指定連接加入到向量末尾
247 freeConnections.addElement(con);
248 checkedOut--;
249 notifyAll();
250 }
251
252 /**
253 * 從連接池獲得一個可用連接.如沒有空閒的連接且當前連接數小於最大連接
254 * 數限制,則創建新連接.如原來登記爲可用的連接不再有效,則從向量刪除之,
255 * 然後遞歸調用自己以嘗試新的可用連接.
256 */
257 public synchronized Connection getConnection() {
258 Connection con = null;
259 if (freeConnections.size() > 0) {
260 // 獲取向量中第一個可用連接
261 con = (Connection) freeConnections.firstElement();
262 freeConnections.removeElementAt(0);
263 try {
264 if (con.isClosed()) {
265 log("從連接池" + name+"刪除一個無效連接");
266 // 遞歸調用自己,嘗試再次獲取可用連接
267 con = getConnection();
268 }
269 }
270 catch (SQLException e) {
271 log("從連接池" + name+"刪除一個無效連接");
272 // 遞歸調用自己,嘗試再次獲取可用連接
273 con = getConnection();
274 }
275 }
276 else if (maxConn == 0 || checkedOut < maxConn) {
277 con = newConnection();
278 }
279 if (con != null) {
280 checkedOut++;
281 }
282 return con;
283 }
284
285 /**
286 * 從連接池獲取可用連接.可以指定客戶程序能夠等待的最長時間
287 * 參見前一個getConnection()方法.
288 *
289 * @param timeout 以毫秒計的等待時間限制
290 */
291 public synchronized Connection getConnection(long timeout) {
292 long startTime = new Date().getTime();
293 Connection con;
294 while ((con = getConnection()) == null) {
295 try {
296 wait(timeout);
297 }
298 catch (InterruptedException e) {}
299 if ((new Date().getTime() - startTime) >= timeout) {
300 // wait()返回的原因是超時
301 return null;
302 }
303 }
304 return con;
305 }
306
307 /**
308 * 關閉所有連接
309 */
310 public synchronized void release() {
311 Enumeration allConnections = freeConnections.elements();
312 while (allConnections.hasMoreElements()) {
313 Connection con = (Connection) allConnections.nextElement();
314 try {
315 con.close();
316 log("關閉連接池" + name+"中的一個連接");
317 }
318 catch (SQLException e) {
319 log(e, "無法關閉連接池" + name+"中的連接");
320 }
321 }
322 freeConnections.removeAllElements();
323 }
324
325 /**
326 * 創建新的連接
327 */
328 private Connection newConnection() {
329 Connection con = null;
330 try {
331 if (user == null) {
332 con = DriverManager.getConnection(URL);
333 }
334 else {
335 con = DriverManager.getConnection(URL, user, password);
336 }
337 log("連接池" + name+"創建一個新的連接");
338 }
339 catch (SQLException e) {
340 log(e, "無法創建下列URL的連接: " + URL);
341 return null;
342 }
343 return con;
344 }
345 }
346 }




三、類DBConnectionPool說明

該類在209至345行實現，它表示指向某個數據庫的連接池。數據庫由JDBC URL標識。一個JDBC URL由三部分組成：協議標識
（總是jdbc），驅動程序標識（如 odbc、idb、oracle等），數據庫標識（其格式依賴於驅動程序）。例如，jdbc:odbc:de
mo，即是一個指向demo數據庫的JDBC URL，而且訪問該數據庫要使用JDBC-ODBC驅動程序。每個連接池都有一個供客戶程序
使用的名字以及可選的用戶帳號、密碼、最大連接數限制。如果Web應用程序所支持的某些數據庫操作可以被所有用戶執行，
而其它一些操作應由特別許可的用戶執行，則可以爲兩類操作分別定義連接池，兩個連接池使用相同的JDBC URL，但使用不
同的帳號和密碼。
類DBConnectionPool的建構函數需要上述所有數據作爲其參數。如222至238行所示，這些數據被保存爲它的實例變量：
如252至283行、285至305行所示， 客戶程序可以使用DBConnectionPool類提供的兩個方法獲取可用連接。兩者的共同之處
在於：如連接池中存在可用連接，則直接返回，否則創建新的連接並返回。如果沒有可用連接且已有連接總數等於最大限制
數，第一個方法將直接返回null，而第二個方法將等待直到有可用連接爲止。
所有的可用連接對象均登記在名爲freeConnections的向量（Vector）中。如果向量中有多於一個的連接，getConnection()
總是選取第一個。同時，由於新的可用連接總是從尾部加入向量，從而使得數據庫連接由於長時間閒置而被關閉的風險減低
到最小程度。
第一個getConnection()在返回可用連接給客戶程序之前，調用了isClosed()方法驗證連接仍舊有效。如果該連接被關閉或
觸發異常，getConnection()遞歸地調用自己以嘗試獲取另外的可用連接。如果在向量freeConnections中不存在任何可用連
接，getConnection()方法檢查是否已經指定最大連接數限制。如已經指定，則檢查當前連接數是否已經到達極限。此處
maxConn爲0表示沒有限制。如果沒有指定最大連接數限制或當前連接數小於該值，該方法嘗試創建新的連接。如創建成功，
則增加已使用連接的計數並返回，否則返回空值。
如325至345行所示，創建新連接由newConnection()方法實現。創建過程與是否已經指定數據庫帳號、密碼有關。
JDBC的DriverManager類提供多個getConnection()方法，這些方法要用到JDBC URL與其它一些參數，如用戶帳號和密碼等。
DriverManager將使用指定的JDBC URL確定適合於目標數據庫的驅動程序及建立連接。
在285至305行實現的第二個getConnection()方法需要一個以毫秒爲單位的時間參數，該參數表示客戶程序能夠等待的最長
時間。建立連接的具體操作仍舊由第一個getConnection()方法實現。
該方法執行時先將startTime初始化爲當前時間。在while循環中嘗試獲得一個連接。如果失敗，則以給定的時間值爲參數調
用wait()。wait()的返回可能是由於其它線程調用notify()或notifyAll()，也可能是由於預定時間已到。爲找出wait()返
回的真正原因，程序用當前時間減開始時間（startTime），如差值大於預定時間則返回空值，否則再次調用getConnection()。
把空閒的連接登記到連接池由240至250行的freeConnection()方法實現，它的參數爲返回給連接池的連接對象。該對象被加
入到freeConnections向量的末尾，然後減少已使用連接計數。調用notifyAll()是爲了通知其它正在等待可用連接的線程。
許多Servlet引擎爲實現安全關閉提供多種方法。數據庫連接池需要知道該事件以保證所有連接能夠正常關閉。DBConnectionManager
類負協調整個關閉過程，但關閉連接池中所有連接的任務則由DBConnectionPool類負責。在307至323行實現的release()
方法供DBConnectionManager調用。該方法遍歷freeConnections向量並關閉所有連接，然後從向量中刪除這些連接。


四、類DBConnectionManager 說明

該類只能創建一個實例，其它對象能夠調用其靜態方法（也稱爲類方法）獲得該唯一實例的引用。如031至036行所示，
DBConnectionManager類的建構函數是私有的，這是爲了避免其它對象創建該類的實例。
DBConnectionManager類的客戶程序可以調用getInstance()方法獲得對該類唯一實例的引用。如018至029行所示，類的唯
一實例在getInstance()方法第一次被調用期間創建，此後其引用就一直保存在靜態變量instance中。每次調用getInstance()
都增加一個DBConnectionManager的客戶程序計數。即，該計數代表引用DBConnectionManager唯一實例的客戶程序總數，
它將被用於控制連接池的關閉操作。
該類實例的初始化工作由146至168行之間的私有方法init()完成。其中 getResourceAsStream()方法用於定位並打開外部
文件。外部文件的定位方法依賴於類裝載器的實現。標準的本地類裝載器查找操作總是開始於類文件所在路徑，也能夠搜
索CLASSPATH中聲明的路徑。db.properties是一個屬性文件，它包含定義連接池的鍵-值對。可供定義的公用屬性如下：

drivers 以空格分隔的JDBC驅動程序類列表
logfile 日誌文件的絕對路徑

其它的屬性和特定連接池相關，其屬性名字前應加上連接池名字：

<poolname>.url 數據庫的 JDBC URL 
<poolname>.maxconn 允許建立的最大連接數，0表示沒有限制 
<poolname>.user 用於該連接池的數據庫帳號
<poolname>.password 相應的密碼

其中url屬性是必需的，而其它屬性則是可選的。數據庫帳號和密碼必須合法。用於Windows平臺的db.properties文件示例
如下：

drivers=sun.jdbc.odbc.JdbcOdbcDriver jdbc.idbDriver
logfile=D://user//src//java//DBConnectionManager//log.txt

idb.url=jdbc:idb:c://local//javawebserver1.1//db//db.prp
idb.maxconn=2

access.url=jdbc:odbc:demo
access.user=demo
access.password=demopw

注意在Windows路徑中的反斜槓必須輸入2個，這是由於屬性文件中的反斜槓同時也是一個轉義字符。
init()方法在創建屬性對象並讀取db.properties文件之後，就開始檢查logfile屬性。如果屬性文件中沒有指定日誌文件，
則默認爲當前目錄下的DBConnectionManager.log文件。如日誌文件無法使用，則向System.err輸出日誌記錄。
裝載和註冊所有在drivers屬性中指定的JDBC驅動程序由170至192行之間的loadDrivers()方法實現。該方法先用StringTokenizer
將drivers屬性值分割爲對應於驅動程序名稱的字符串，然後依次裝載這些類並創建其實例，最後在 DriverManager中註冊
該實例並把它加入到一個私有的向量drivers。向量drivers將用於關閉服務時從DriverManager取消所有JDBC 驅動程序的註冊。
init()方法的最後一個任務是調用私有方法createPools()創建連接池對象。如109至142行所示，createPools()方法先創建
所有屬性名字的枚舉對象（即Enumeration對象，該對象可以想象爲一個元素系列，逐次調用其nextElement()方法將順序返
回各元素），然後在其中搜索名字以“.url”結尾的屬性。對於每一個符合條件的屬性，先提取其連接池名字部分，進而讀
取所有屬於該連接池的屬性，最後創建連接池對象並把它保存在實例變量pools中。散列表（Hashtable類 ）pools實現連接
池名字到連接池對象之間的映射，此處以連接池名字爲鍵，連接池對象爲值。
爲便於客戶程序從指定連接池獲得可用連接或將連接返回給連接池，類DBConnectionManager提供了方法getConnection()和
freeConnection()。所有這些方法都要求在參數中指定連接池名字，具體的連接獲取或返回操作則調用對應的連接池對象完
成。它們的實現分別在051至064行、066至080行、038至049行。
如082至107行所示，爲實現連接池的安全關閉，DBConnectionManager提供了方法release()。在上面我們已經提到，所有
DBConnectionManager的客戶程序都應該調用靜態方法getInstance()以獲得該管理器的引用，此調用將增加客戶程序計數。
客戶程序在關閉時調用release()可以遞減該計數。當最後一個客戶程序調用release()，遞減後的引用計數爲0，就可以調
用各個連接池的release()方法關閉所有連接了。管理類release()方法最後的任務是撤銷所有JDBC驅動程序的註冊。


五、Servlet使用連接池示例

Servlet API所定義的Servlet生命週期類如：

1) 創建並初始化Servlet（init()方法）。
2) 響應客戶程序的服務請求（service()方法）。
3) Servlet終止運行，釋放所有資源（destroy()方法）。

本例演示連接池應用，上述關鍵步驟中的相關操作爲：

1) 在init()，用實例變量connMgr 保存調用DBConnectionManager.getInstance()所返回的引用。
2) 在service()，調用getConnection()，執行數據庫操作，用freeConnection()將連接返回給連接池。
3) 在destroy()，調用release()關閉所有連接，釋放所有資源。

示例程序清單如下：

import java.io.*;
import java.sql.*;
import javax.servlet.*;
import javax.servlet.http.*;
public class TestServlet extends HttpServlet {
private DBConnectionManager connMgr;

public void init(ServletConfig conf) throws ServletException {
super.init(conf);
connMgr = DBConnectionManager.getInstance();
}

public void service(HttpServletRequest req, HttpServletResponse res) 
throws IOException {

res.setContentType("text/html");
PrintWriter out = res.getWriter();
Connection con = connMgr.getConnection("idb");
if (con == null) {
out.println("不能獲取數據庫連接.");
return;
}
ResultSet rs = null;
ResultSetMetaData md = null;
Statement stmt = null;
try {
stmt = con.createStatement();
rs = stmt.executeQuery("SELECT * FROM EMPLOYEE");
md = rs.getMetaData();
out.println("<H1>職工數據</H1>");
while (rs.next()) {
out.println("<BR>");
for (int i = 1; i < md.getColumnCount(); i++) {
out.print(rs.getString(i) + ", ");
}
}
stmt.close();
rs.close();
}
catch (SQLException e) {
e.printStackTrace(out);
}
connMgr.freeConnection("idb", con);
}

public void destroy() {
connMgr.release();
super.destroy();
}
}