在JSF中實(shí)現(xiàn)分頁.docx

在JSF中實(shí)現(xiàn)分頁（一） 對(duì)于大多數(shù)Web應(yīng)用，分頁都是必不可少的功能，當(dāng)然在JSF中也一樣，我在這里用兩篇文章介紹兩種方法來展示一下，如何在JSF中實(shí)現(xiàn)分頁。本文假定你已經(jīng)對(duì)JSF有了一些簡單的了解，懂得基本配置和使用，并建立起一個(gè)blank項(xiàng)目。Myfaces是Apache基金會(huì)中的一個(gè)一級(jí)項(xiàng)目，除了實(shí)現(xiàn)JSF標(biāo)準(zhǔn)外，做了很多的擴(kuò)展工作，在Myfaces包中有一個(gè)擴(kuò)展包Tomahawk，我們將主要使用其中的兩個(gè)Component實(shí)現(xiàn)分頁：一個(gè)是，另一個(gè)是，在第一篇里面，我們簡易的組合這兩個(gè)Component來實(shí)現(xiàn)一種簡單，但并不高效的分頁。下面的例子來自于Myfaces-Sample，我省去了其中和分頁邏輯無關(guān)的內(nèi)容，詳細(xì)的例子可以下載Myfaces-Sample包或者訪問http:/www.irian.at/myfaces/home.jsf 查看。第一部分：dataTable在這一部分中，dataTable綁定了一個(gè)backing bean - pagedSort中的cars屬性，我們可以在這個(gè)屬性中加入數(shù)據(jù)訪問邏輯，從數(shù)據(jù)庫或者其他來源取得用于顯示的數(shù)據(jù)。比如我們可以通過Hibernate獲取一個(gè)List，其中包含有我們用于顯示的POJOs。注意，dataTable中的rows屬性指的是每頁的行數(shù)，是必須指定的，否則是無法進(jìn)行分頁的，如果在項(xiàng)目中會(huì)使用固定行數(shù)的分頁，建議把這個(gè)值寫在BaseBackingBean中，并暴露一個(gè)property，供頁面調(diào)用，所以每次在頁面中就可以這么寫#backingBean.pageSize。第二部分：dataScroller這里定義了我們用于分頁的，最主要的是配置該分頁Component針對(duì)哪個(gè)dataTable進(jìn)行分頁的“for”屬性，該屬性與dataTable綁定，并對(duì)其進(jìn)行分頁，在這里，綁定了第一部分中的id=data的dataTable，下面有很多的是指定分頁的導(dǎo)航樣式的，這里使用了圖片作為導(dǎo)航，可以把他們改成文字形式的導(dǎo)航。當(dāng)然這只是最簡單，也是一種不推薦的分頁方式，因?yàn)樵诿看芜M(jìn)行分頁的時(shí)候，將會(huì)從數(shù)據(jù)庫中取回所有的記錄放入List中，然后，dataScroller在對(duì)這個(gè)List進(jìn)行分頁，如果在數(shù)據(jù)量很大的情況下，這種方式顯然是不符合要求的，假設(shè)每條記錄占用1k內(nèi)存，數(shù)據(jù)庫中有100萬條記錄，每次要把這個(gè)List全部讀取出來將占用1G內(nèi)存。我們需要一種Load on demand方式的讀取，也就是只在需要查看某頁的時(shí)候讀取該頁的數(shù)據(jù)。另外一方面，JSF的生命周期中有多個(gè)階段會(huì)調(diào)用到#pagedSort.cars中對(duì)應(yīng)的方法，如果在這里調(diào)用了數(shù)據(jù)訪問邏輯，就會(huì)在只顯示一次頁面的情況下進(jìn)行多次數(shù)據(jù)庫操作，也是相當(dāng)?shù)暮馁M(fèi)資源的。所以我們需要有更好的分頁方式去解決以上問題，下一篇我將介紹另一種方法以改善這些問題。前面一篇直接使用了Myfaces中的兩個(gè)Component完成了一個(gè)簡單的分頁，這里將會(huì)介紹一種On-demand loading的方法來進(jìn)行分頁，僅僅在需要數(shù)據(jù)的時(shí)候加載。 先來說一些題外話，為了實(shí)現(xiàn)這種方式的分頁，公司里大約5-6個(gè)人做了半個(gè)多月的工作，擴(kuò)展了dataTable，修改了dataScrollor，以及各種其他的方法，但是都不是很優(yōu)雅。在上個(gè)月底的時(shí)候，在Myfaces的Mail List中也針對(duì)這個(gè)問題展開了一系列的討論，最后有人總結(jié)了討論中提出的比較好的方法，提出了以下的分頁方法，也是目前實(shí)現(xiàn)的最為優(yōu)雅的方法，也就是不對(duì)dataTable和dataScrollor做任何修改，僅僅通過擴(kuò)展DataModel來實(shí)現(xiàn)分頁。 DataModel 是一個(gè)抽象類，用于封裝各種類型的數(shù)據(jù)源和數(shù)據(jù)對(duì)象的訪問，JSF中dataTable中綁定的數(shù)據(jù)實(shí)際上被包裝成了一個(gè)DataModel，以消除各種不同數(shù)據(jù)源和數(shù)據(jù)類型的復(fù)雜性，在前面一篇中我們?cè)L問數(shù)據(jù)庫并拿到了一個(gè)List，交給dataTable，這時(shí)候，JSF會(huì)將這個(gè)List包裝成 ListDataModel ，dataTable訪問數(shù)據(jù)都是通過這個(gè)DataModel進(jìn)行的，而不是直接使用List。 接下來我們要將需要的頁的數(shù)據(jù)封裝到一個(gè)DataPage中去，這個(gè)類表示了我們需要的一頁的數(shù)據(jù)，里面包含有三個(gè)元素：datasetSize，startRow，和一個(gè)用于表示具體數(shù)據(jù)的List。datasetSize表示了這個(gè)記錄集的總條數(shù)，查詢數(shù)據(jù)的時(shí)候，使用同樣的條件取count即可，startRow表示該頁的起始行在數(shù)據(jù)庫中所有記錄集中的位置。/*/ /* *Asimpleclassthatrepresentsapageofdataoutofalongerset,iea*listofobjectstogetherwithinfotoindicatethestartingrowandthefull*sizeofthedataset.EJBscanreturninstancesofthistypewhenreturning*subsetsofavailabledata. */ public class DataPage private int datasetSize; private int startRow; private Listdata; /*/ /* *Createanobjectrepresentingasublistofadataset.* param datasetSize*isthetotalnumberofmatchingrowsavailable.* param startRow*istheindexwithinthecompletedatasetofthefirstelement*inthedatalist.* param data*isalistofconsecutiveobjectsfromthedataset. */ public DataPage( int datasetSize, int startRow,Listdata) this .datasetSize = datasetSize; this .startRow = startRow; this .data = data; /*/ /* *Returnthenumberofitemsinthefulldataset. */ public int getDatasetSize() return datasetSize; /*/ /* *Returntheoffsetwithinthefulldatasetofthefirstelementinthe*listheldbythisobject. */ public int getStartRow() return startRow; /*/ /* *Returnthelistofobjectsheldbythisobject,whichisacontinuous*subsetofthefulldataset. */ public ListgetData() return data; 接下來，我們要對(duì)DataModel進(jìn)行封裝，達(dá)到我們分頁的要求。該DataModel僅僅持有了一頁的數(shù)據(jù)DataPage，并在適當(dāng)?shù)臅r(shí)候加載數(shù)據(jù)，讀取我們需要頁的數(shù)據(jù)。 /*/ /* *AspecialtypeofJSFDataModeltoallowadatatableanddatascrollertopage*throughalargesetofdatawithouthavingtoholdtheentiresetofdatain*memoryatonce.*Anytimeamanagedbeanwantstoavoidholdinganentiredataset,themanaged*beanshoulddeclareaninnerclasswhichextendsthisclassandimplements*thefetchDatamethod.Thismethodiscalledasneededwhenthetablerequires*datathatisntavailableinthecurrentdatapageheldbythisobject.*Thisdoesrequirethemanagedbean(andingeneralthebusinessmethodthat*themanagedbeanuses)toprovidethedatawrappedinaDataPageobjectthat*providesinfoonthefullsizeofthedataset. */ public abstract class PagedListDataModel extends DataModel int pageSize; int rowIndex;DataPagepage; /*/ /* *Createadatamodelthatpagesthroughthedatashowingthespecified*numberofrowsoneachpage. */ public PagedListDataModel( int pageSize) super (); this .pageSize = pageSize; this .rowIndex = - 1 ; this .page = null ; /*/ /* *Notusedinthisclass;dataisfetchedviaacallbacktothefetchData*methodratherthanbyexplicitlyassigningalist. */ public void setWrappedData(Objecto) if (o instanceof DataPage) this .page = (DataPage)o; else throw new UnsupportedOperationException( setWrappedData ); public int getRowIndex() return rowIndex; /*/ /* *Specifywhatthecurrentrowwithinthedatasetis.Notethatthe*UIDatacomponentwillrepeatedlycallthismethodfollowedbygetRowData*toobtaintheobjectstorenderinthetable. */ public void setRowIndex( int index) rowIndex = index; /*/ /* *Returnthetotalnumberofrowsofdataavailable(notjustthenumberof*rowsinthecurrentpage!). */ public int getRowCount() return getPage().getDatasetSize(); /*/ /* *ReturnaDataPageobject;ifoneisnotcurrentlyavailablethenfetch*one.Notethatthisdoesntensurethatthedatapagereturnedincludes*thecurrentrowIndexrow;seegetRowData. */ private DataPagegetPage() if (page != null ) return page; int rowIndex = getRowIndex(); int startRow = rowIndex; if (rowIndex = - 1 ) / evenwhennorowisselected,westillneedapage / objectsothatweknowtheamountofdataavailable. startRow = 0 ; / invokemethodonenclosingclass page = fetchPage(startRow,pageSize); return page; /*/ /* *ReturntheobjectcorrespondingtothecurrentrowIndex.IftheDataPage*objectcurrentlycacheddoesntincludethatindexthenfetchPageis*calledtoretrievetheappropriatepage. */ public ObjectgetRowData() if (rowIndex = datasetSize) throw new IllegalArgumentException( InvalidrowIndex ); if (rowIndex = endRow) page = fetchPage(rowIndex,pageSize);startRow = page.getStartRow(); return page.getData().get(rowIndex - startRow); public ObjectgetWrappedData() return page.getData(); /*/ /* *ReturntrueiftherowIndexvalueiscurrentlysettoavaluethat*matchessomeelementinthedataset.Notethatitmaymatcharowthatis*notinthecurrentlycachedDataPage;ifsothenwhengetRowDatais*calledtherequiredDataPagewillbefetchedbycallingfetchData. */ public boolean isRowAvailable() DataPagepage = getPage(); if (page = null ) return false ; int rowIndex = getRowIndex(); if (rowIndex = page.getDatasetSize() return false ; else return true ; /*/ /* *Methodwhichmustbeimplementedincooperationwiththemanagedbean*classtofetchdataondemand. */ public abstract DataPagefetchPage( int startRow, int pageSize); 最后，我們需要在Backing Bean中加一些東西，調(diào)用業(yè)務(wù)邏輯，并將數(shù)據(jù)交給PagedListDataModel，來幫我們完成最后的分頁工作。 public SomeManagedBean . private DataPagegetDataPage( int startRow, int pageSize) / accessdatabasehere,orcallEJBtodoso public DataModelgetDataModel() if (dataModel = null ) dataModel = new LocalDataModel(20); return dataModel; private class LocalDataModel extends PagedListDataModel public LocalDataModel( int pageSize) super (pageSize); public DataPagefetchPage( int startRow, int pageSize) / callenclosingmanagedbeanmethodtofetchthedata return getDataPage(startRow,pageSize); 這里面有一個(gè)getDataPage的方法，只需要把所有業(yè)務(wù)邏輯的調(diào)用放在這里就可以了，最后業(yè)務(wù)邏輯調(diào)用的結(jié)果返回一個(gè)List，總條數(shù)返回一個(gè)int型的count放到DataPage中去就可以了。 為了實(shí)現(xiàn)復(fù)用，把上面第三段的代碼中的LocalDataModel類和getDataPage方法抽到BasePagedBackingBean中，把getDataPage方法改成： protected abstract DataPage getDataPage(int startRow, int pageSize); 這樣我們把所有需要分頁的Backing Bean繼承自這個(gè)抽象類，并實(shí)現(xiàn)getDataPage方法即可很容易的實(shí)現(xiàn)分頁。 在具體應(yīng)用中可以這么寫： protected DataPagegetDataPage( int startRow, int pageSize) ListscheduleList = scheduleService.getSchedulesByDate(scheduleDate,startRow,pageSize); int dataSetSize = scheduleService.getSchedulesCountByDate(scheduleDate); return new DataPage(dataSetSize,startRow,scheduleList); 在數(shù)據(jù)訪問中，我們只需要取出我們需要行數(shù)的記錄就可以了，這在hibernate中非常容易實(shí)現(xiàn)。 如果使用Criteria查詢的話，只要加上： criteria.setFirstResult(startRow); criteria.setMaxResults(pageSize); 使用Query查詢的話，只要加上 query.setFirstResult(startRow); query.setMaxResults(pageSize); 并把兩個(gè)參數(shù)傳入即可。 我們還需要另外寫一個(gè)Count的DAO，取出相同查詢條件的記錄條數(shù)即可。 還要修改一下Backing Bean中與dataTable綁定的property，將返回類型由List改成DataModel，而第一篇中用到的頁面不需要做任何修改就可以滿足新的需求了。 里面最重要的是 PagedListDataModel 中 fetchPage 這個(gè)方法，當(dāng)滿足取數(shù)據(jù)的條件時(shí)，都會(huì)調(diào)用它取數(shù)據(jù)，因?yàn)闃I(yè)務(wù)邏輯不同，不便于將業(yè)務(wù)邏輯的調(diào)用放在里面實(shí)現(xiàn)，于是將其作為抽象方法，將具體的實(shí)現(xiàn)放到具體的Backing Bean中進(jìn)行，在BaseBackingBean中，實(shí)現(xiàn)了這個(gè)方法，調(diào)用了getDataPage(startRow, pageSize)這個(gè)方法，而在BaseBackingBean中，這個(gè)方法又推遲到更具體的頁面中實(shí)現(xiàn)，這樣，我們?cè)诰唧w的頁面中只需要實(shí)現(xiàn)一個(gè)getDataPage(startRow, pageSize)這個(gè)方法訪問業(yè)務(wù)邏輯。 大功告成，這個(gè)實(shí)現(xiàn)把前面遇到的兩個(gè)問題都解決了， On-demand loading 是沒有問題了，因?yàn)橹挥性谑状巫x取和換頁的時(shí)候DataModel才會(huì)向數(shù)據(jù)庫請(qǐng)求數(shù)據(jù)，雖然在JSF的生命周期中多次調(diào)用與dataTable綁定的方法，但是因?yàn)槊看螛I(yè)務(wù)邏輯請(qǐng)求以后，數(shù)據(jù)都會(huì)存放在DataPage中，如果里面的數(shù)據(jù)滿足需求的話，就不再請(qǐng)求訪問數(shù)據(jù)庫，這樣多次訪問數(shù)據(jù)庫的問題也解決了。 雖然這樣的話，dataScrollor的Tag使用起來還是很復(fù)雜，通常在同一個(gè)項(xiàng)目中，我們只會(huì)使用一種樣式的分頁導(dǎo)航，不過沒關(guān)系，我們只需要修改以下DataScrollor的Render Kit，把一些可以定義的值固定下來，再定義一個(gè)TLD文件，就可以在項(xiàng)目中使用簡化版的Tag了。 這個(gè)方法一開始發(fā)布在Myfaces的Wiki中，/myfaces/WorkingWithLargeTables，那里很少有人關(guān)注到，大家有興趣可以看看原文，本文只是對(duì)這種方法做一些簡單的介紹，并非自創(chuàng)，希望大家能夠多多關(guān)注開源社區(qū)，因?yàn)槟抢镉凶钚伦詈玫臇|西。 從Nightly Build服務(wù)器中拿到的12.27的Myfaces包，發(fā)現(xiàn)里面擴(kuò)充了很多新的Component，只是并沒有正式發(fā)布，大家有興趣的話可以研究研究。 好久沒有寫點(diǎn)東西了，這次想把JSF中的分頁系列文章再擴(kuò)充一點(diǎn)，說明一下查詢和分頁結(jié)合的情況，當(dāng)我們把查詢條件和查詢結(jié)果放到一個(gè)頁面上時(shí)，查詢還是非常容易實(shí)現(xiàn)的，甚至不需要我們手工去從數(shù)據(jù)庫中查詢。 在本系列文章中的第二篇中，介紹了一種 Load On Demand的方式，我們?cè)谶@里需要繼續(xù)利用這種方式，并對(duì)其做一些小小的擴(kuò)展。這里我們使用 Hibernate3 作為持久化方案。 簡單的介紹一下應(yīng)用情景，一個(gè)系統(tǒng)中包含了一些 Customer 的信息，我們需要對(duì)其進(jìn)行查詢并對(duì)查詢結(jié)果進(jìn)行分頁。 首先處理?xiàng)l件查詢的情況，通常會(huì)根據(jù) VO 中的字段進(jìn)行 like 型查詢，有時(shí)候時(shí)間或數(shù)字之類的會(huì)使用Between查詢，因?yàn)椴樵儣l件一般不會(huì)很復(fù)雜，在這里，使用 Hibernate3 中的 Criteria 查詢來處理這樣的情況，我們把所有的查詢條件通過 Customer 這個(gè) VO 傳進(jìn)來，然后只對(duì)非空字段進(jìn)行 like 查詢，我們用到這樣的方法。 public ListqueryByConditions(Customercustomer, int startRow, int pageSize)Criteriacriteria = getSession().createCriteria(Customer. class ); if ( ! StringUtils.isEmpty(customer.getCustomerName()criteria.add(QueryUtils.getCriteriaParam( customerName ,customer.getCustomerName(); if ( ! StringUtils.isEmpty(customer.getAddress()criteria.add(QueryUtils.getCriteriaParam( address ,customer.getAddress(); if ( ! StringUtils.isEmpty(customer.getFax()criteria.add(QueryUtils.getCriteriaParam( fax ,customer.getFax(); return criteriaPagedList(criteria,startRow,pageSize); 另外對(duì)應(yīng)的一個(gè)count方法略去，只需要在前面加入一個(gè)criteria.setProjection(Projections.count(customerId); 因?yàn)榭紤]到以后的擴(kuò)展，使用了一個(gè)Utils方法，QueryUtils.getCriteriaParam方法 public static final SimpleExpressiongetCriteriaParam(Stringname,Stringparam) return Expression.lik