目前最好的JSP分頁技術

前言<br />在使用資料庫的過程中，不可避免的需要使用到分頁的功能，可是JDBC的規範對此卻沒有很好的解決。對於這個需求很多朋友都有自己的解決方案，比如使用Vector等集合類先儲存取出的資料再分頁。但這種方法的可用性很差，與JDBC本身的介面完全不同，對不同類型的欄位的支援也不好。這裡提供了一種與JDBC相容性非常好的方案。<br />JDBC和分頁<br />Sun的JDBC規範的制定，有時很讓人哭笑不得，在JDBC1.0中，對於一個結果集（ResultSet）你甚至只能執行next()操作，而無法讓其向後滾動，這就直接導致在只執行一次SQL查詢的情況下無法獲得結果集的大小。所以，如果你使用的是JDBC1.0的驅動，那麼是幾乎無法實現分頁的。<br />好在Sun的JDBC2規範中很好的彌補了這一個不足，增加了結果集的前後滾動操作，雖然仍然不能直接支援分頁，但我們已經可以在這個基礎上寫出自己的可支援分頁的ResultSet了。</p><p>和具體資料庫相關的實現方法<br />有一些資料庫，如Mysql, Oracle等有自己的分頁方法，比如Mysql可以使用limit子句，Oracle可以使用ROWNUM來限制結果集的大小和起始位置。這裡以Mysql為例，其典型代碼如下：</p><p>1.// 計算總的記錄條數</p><p>2.String SQL = "SELECT Count(*) AS total " + this.QueryPart; </p><p>3.rs = db.executeQuery(SQL); </p><p>4.if (rs.next()) </p><p>5.Total = rs.getInt(1); </p><p>6.// 設定當前頁數和總頁數</p><p>7.TPages = (int)Math.ceil((double)this.Total/this.MaxLine); </p><p>8.CPages = (int)Math.floor((double)Offset/this.MaxLine+1); </p><p>9.// 根據條件判斷，取出所需記錄</p><p>10.if (Total > 0) { </p><p>11.SQL = Query + " LIMIT " + Offset + " , " + MaxLine; </p><p>12.rs = db.executeQuery(SQL); </p><p>13.} </p><p>14.return rs; </p><p>15.}<br />複製代碼<br />毫無疑問，這段代碼在資料庫是Mysql時將會是漂亮的，但是作為一個通用的類（事實上我後面要提供的就是一個通用類庫中的一部分），需要適應不同的資料庫，而基於這個類（庫）的應用，也可能使用不同的資料庫，所以，我們將不使用這種方法。</p><p>另一種繁瑣的實現方法<br />我看過一些人的做法（事實上包括我在內，一開始也是使用這種方法的），即不使用任何封裝，在需要分頁的地方，直接操作ResultSet滾到相應的位置，再讀取相應數量的記錄。其典型代碼如下：</p><p>1.<%</p><p>2.sqlStmt = sqlCon.createStatement(java.sql.ResultSet.TYPE_SCROLL_INSENSITIVE,</p><p>3.java.sql.ResultSet.CONCUR_READ_ONLY);</p><p>4.strSQL = "select name,age from test";</p><p>5.//執行SQL語句並擷取結果集</p><p>6.sqlRst = sqlStmt.executeQuery(strSQL);</p><p>7.//擷取記錄總數</p><p>8.sqlRst.last();</p><p>9.intRowCount = sqlRst.getRow();</p><p>10.//記算總頁數</p><p>11.intPageCount = (intRowCount+intPageSize-1) / intPageSize;</p><p>12.//調整待顯示的頁碼</p><p>13.if(intPage>intPageCount) intPage = intPageCount;</p><p>14.%></p><p>15.<table border="1" cellspacing="0" cellpadding="0"></p><p>16.<tr></p><p>17.<th>姓名</th></p><p>18.<th>年齡</th></p><p>19.</tr></p><p>20.<%</p><p>21.if(intPageCount>0){</p><p>22.//將記錄指標定位到待顯示頁的第一條記錄上</p><p>23.sqlRst.absolute((intPage-1) * intPageSize + 1);</p><p>24.//顯示資料</p><p>25.i = 0;</p><p>26.while(i<intPageSize && !sqlRst.isAfterLast()){</p><p>27.%></p><p>28.<tr></p><p>29.<td><%=sqlRst.getString(1)%></td></p><p>30.<td><%=sqlRst.getString(2)%></td></p><p>31.</tr></p><p>32.<%</p><p>33.sqlRst.next();</p><p>34.i++;</p><p>35.}</p><p>36.}</p><p>37.%></p><p>38.</table> intPageCount) intPage = intPageCount;</p><p>39.%><br />複製代碼<br />　很顯然，這種方法沒有考慮到代碼重用的問題，不僅代碼數量巨大，而且在代碼需要修改的情況下，將會無所適從。</p><p>使用Vector進行分頁<br />還見過另一些實現分頁的類，是先將所有記錄都select出來，然後將ResultSet中的資料都get出來，存入Vector等集合類中，再根據所需分頁的大小，頁數，定位到相應的位置，讀取資料。或者先使用前面提到的兩種分頁方法，取得所需的頁面之後，再存入Vector中。<br />扔開代碼的效率不說，單是從程式結構和使用的方便性上講，就是很糟糕的。比如，這種做法支援的欄位類型有限，int, double, String類型還比較好處理，如果碰到Blob, Text等類型，實現起來就很麻煩了。這是一種更不可取的方案。</p><p>一個新的Pageable介面及其實現<br />很顯然，看過上面三種實現方法後，我們對新的分頁機制有了一個目標，即：不與具體資料庫相關；儘可能做到代碼重用；儘可能與原JDBC介面的使用方法保持一致；儘可能高的效率。<br />首先，我們需要提供一個與java.sql.ResultSet向下相容的介面，把它命名為Pageable，介面定義如下：</p><p>1.public interface Pageable extends java.sql.ResultSet{</p><p>2./**返回總頁數</p><p>3.*/</p><p>4.int getPageCount();</p><p>5./**返回當前頁的記錄條數</p><p>6.*/</p><p>7.int getPageRowsCount();</p><p>8./**返回分頁大小</p><p>9.*/</p><p>10.int getPageSize();</p><p>11./**轉到指定頁</p><p>12.*/</p><p>13.void gotoPage(int page) ;</p><p>14./**設定分頁大小</p><p>15.*/</p><p>16.void setPageSize(int pageSize);</p><p>17./**返回總記錄行數</p><p>18.*/</p><p>19.int getRowsCount();</p><p>20./**</p><p>21.* 轉到當前頁的第一條記錄</p><p>22.* @exception java.sql.SQLException 異常說明。</p><p>23.*/</p><p>24.void pageFirst() throws java.sql.SQLException;</p><p>25./**</p><p>26.* 轉到當前頁的最後一條記錄</p><p>27.* @exception java.sql.SQLException 異常說明。</p><p>28.*/</p><p>29.void pageLast() throws java.sql.SQLException;</p><p>30./**返回當前頁號</p><p>31.*/</p><p>32.int getCurPage();</p><p>33.}<br />複製代碼<br />這是一個對java.sql.ResultSet進行了擴充的介面，主要是增加了對分頁的支援，如設定分頁大小，跳轉到某一頁，返回總頁數等等。<br />接著，我們需要實現這個介面，由於這個介面繼承自ResultSet，並且它的大部分功能也都和ResultSet原有功能相同，所以這裡使用了一個簡單的Decorator模式。<br />PageableResultSet2的類聲明和成員聲明如下：<br />public class PageableResultSet2 implements Pageable {<br />protected java.sql.ResultSet rs=null;<br />protected int rowsCount;<br />protected int pageSize;<br />protected int curPage;<br />protected String command = "";<br />}<br />可以看到，在PageableResultSet2中，包含了一個ResultSet的執行個體（這個執行個體只是實現了ResultSet介面，事實上它是由各個資料庫廠商分別實現的），並且把所有由ResultSet繼承來的方法都直接轉寄給該執行個體來處理。<br />PageableResultSet2中繼承自ResultSet的主要方法：<br />//……<br />public boolean next() throws SQLException {<br />return rs.next();<br />}<br />//……<br />public String getString(String columnName) throws SQLException {<br />try {<br />return rs.getString(columnName);<br />}<br />catch (SQLException e) {//這裡是為了增加一些出錯資訊的內容便於調試<br />throw new SQLException (e.toString()+" columnName="<br />+columnName+" SQL="+this.getCommand());<br />}<br />}<br />//……<br />只有在Pageable介面中新增的方法才需要自己的寫方法處理。<br />/**方法注釋可參考Pageable.java<br />*/<br />public int getCurPage() {<br />return curPage;<br />}<br />public int getPageCount() {<br />if(rowsCount==0) return 0;<br />if(pageSize==0) return 1;<br />//calculate PageCount<br />double tmpD=(double)rowsCount/pageSize;<br />int tmpI=(int)tmpD;<br />if(tmpD>tmpI) tmpI++;<br />return tmpI;<br />}<br />public int getPageRowsCount() {<br />if(pageSize==0) return rowsCount;<br />if(getRowsCount()==0) return 0;<br />if(curPage!=getPageCount()) return pageSize;<br />return rowsCount-(getPageCount()-1)*pageSize;<br />}<br />public int getPageSize() {<br />return pageSize;<br />}<br />public int getRowsCount() {<br />return rowsCount;<br />}<br />public void gotoPage(int page) {<br />if (rs == null)<br />return;<br />if (page < 1)<br />page = 1;<br />if (page > getPageCount())<br />page = getPageCount();<br />int row = (page - 1) * pageSize + 1;<br />try {<br />rs.absolute(row);<br />curPage = page;<br />}<br />catch (java.sql.SQLException e) {<br />}<br />}<br />public void pageFirst() throws java.sql.SQLException {<br />int row=(curPage-1)*pageSize+1;<br />rs.absolute(row);<br />}<br />public void pageLast() throws java.sql.SQLException {<br />int row=(curPage-1)*pageSize+getPageRowsCount();<br />rs.absolute(row);<br />}<br />public void setPageSize(int pageSize) {<br />if(pageSize>=0){<br />this.pageSize=pageSize;<br />curPage=1;<br />}<br />}<br />PageableResultSet2的構造方法：<br />public PageableResultSet2(java.sql.ResultSet rs) throws java.sql.SQLException {<br />if(rs==null) throw new SQLException("given ResultSet is NULL","user");</p><p>rs.last();<br />rowsCount=rs.getRow();<br />rs.beforeFirst();</p><p>this.rs=rs;<br />}<br />這裡只是簡單的取得一個總記錄數，並將記錄遊標移回初始位置（before first），同時將參數中的ResultSet賦給成員變數。</p><p>Pageable的使用方法<br />因為Pageable介面繼承自ResultSet，所以在使用方法上與ResultSet一致，尤其是在不需要分頁功能的時候，可以直接當成ResultSet使用。而在需要分頁時，只需要簡單的setPageSize, gotoPage，即可。<br />PreparedStatement pstmt=null;<br />Pageable rs=null;<br />……//構造SQL，並準備一個pstmt.<br />rs=new PageableResultSet2(pstmt.executeQuery());//構造一個Pageable<br />rs.setPageSize(20);//每頁20個記錄<br />rs.gotoPage(2);//跳轉到第2頁<br />for(int i=0; i<rs.getPageRowsCount(); i++){//迴圈處理<br />int id=rs.getInt(“ID”);<br />……//繼續處理<br />rs.next();<br />} </p><p>總結<br />一個好的基礎類應該是便於使用，並且具備足夠的可移植性，同時要保證其功能的完善。在上面的實現中，我們從java.sql.ResultSet介面繼承出Pageable，並實現了它。這就保證了在使用中與JDBC原有操作的一致性，同時對原有功能沒有縮減。<br />同時它也是便於使用的，因為封裝了一切必要的操作，所以在你的代碼中唯一顯得"難看"和"不舒服"的地方就是需要自己去構造一個PageableResultSet2。不過只要你願意，這也是可以解決的。<br />當然它也有具有充分的可移植性，當你將資料庫由Oracle變為Mysql或者SQLServer的時候，你仍然可以使用這些分頁的代碼。它在使用中（或者說在移植的過程中）唯一的限制就是你必須要使用一個支援JDBC2的驅動（現在明白為什麼我把類命名為PageableResultSet2了吧。:P），不過，好在JDBC2已經成為標準了，絕大多數的資料庫（如Oracle, Mysql, SQLServer）都有自己的或者第三方提供的JDBC2的驅動。<br />OK，這個分頁的實現是否對你的編程有協助呢？仔細看看，其實真正自己寫的代碼並不多的，大部分都只是簡單的轉寄操作。一個合適的模式應用可以幫你很大忙。<br />