改进Spring中的分页技术

Spring中有一个PagedListHolder，能够实现分页。

但此类有几个缺点：

1. 使用此类的代码比較繁琐

2. 此类存放的数据源是全部的记录集，即对于记录数为1000条的数据，即使我们仅仅需在一个页面中显示10条记录，每次均须要检索1000条记录出来，而且没有内在的缓存机制

3. 假设需将pageSize, maxLinkedPages这些一般为Session级的变量存于Session中。则必须在Session中存放PagedListHolder，从而导致大容量的数据经常撑满了Session

4. 仅仅是实现了Serializable标识接口。且getPage(), setPage(), setPageSize()方法中直接使用newPageSet (private) 的属性，不利于子类覆盖。

并且，内部类的各个方法耦合极强。

特定方法的使用必须信赖于某个方法或标志变量作为前提条件。

比較理想的情况是。依据每个HttpServletRequest产生一个PagesListHolder，无论记录总数有多少个。每次仅仅检索页面上所显示的记录。但将pageSize, maxLinkedPages设为Session级的效果。

鉴于上述几点，我从Spring原有的PagedListHolder抽取出一些必需的方法名作为接口，并以一个名为RequestPagedListHolder的类实现之。

以下是抽取出来的PagedListHolder接口。

[java] view
plaincopy

1. import java.io.Serializable;
2. import java.util.List;
3. /**
4. *
5. * @author Sarkuya
6. */
7. public interface PagedListHolder extends Serializable {
8. public static final int DEFAULT_PAGE_SIZE = 10;
9. public static final int DEFAULT_MAX_LINKED_PAGES = 10;
10. public void setRecordsSubst(List recordsSubset);
11. public void setRealRecordCount(long realRecordCount);
12. /**
13. * 设置每页应有多少条记录。
14. */
15. public void setPageSize(int pageSize);
16. /**
17. * 返回每页共同拥有多少条记录
18. */
19. public int getPageSize();
20. /**
21. * 依据pageSize，返回共同拥有多少页
22. */
23. public int getPageCount();
24. /**
25. * 返回当前页码。
26. * 首页为0
27. */
28. public int getPage();
29. /**
30. * 设置当前页码。

31. * 首页为0
32. */
33. public void setPage(int page);
34. /**
35. * 设置环绕当前页最多能够显示多少链接的页数。
36. * 此方法<strong>会</strong>影响getFirstLinkedPage()及getLastLinkedPage()
37. */
38. public void setMaxLinkedPages(int maxLinkedPages);
39. /**
40. * 返回环绕当前页最多能够显示多少链接的页数
41. */
42. public int getMaxLinkedPages();
43. /**
44. * 返回首页的页码(来源 www.iocblog.net)
45. */
46. public int getFirstLinkedPage();
47. /**
48. * 返回最后一页的页码
49. */
50. public int getLastLinkedPage();
51. /**
52. * 转至前一页。

53. * 假设已经是首页。则停在该页。
54. */
55. public void previousPage();
56. /**
57. * 转至下一页。
58. * 假设已经是最后一页。则停在该页。

59. */
60. public void nextPage();
61. /**
62. * 转至首页。
63. */
64. public void firstPage();
65. /**
66. * 转至最后一页
67. */
68. public void lastPage();
69. /**
70. * 返回总的记录数
71. */
72. public long getNrOfElements();
73. /**
74. * 返回在当前页面上的第一个记录在全部记录(从0開始)中的编号
75. */
76. public int getFirstElementOnPage();
77. /**
78. * 返回在当前页面上的最后一个记录在全部记录(从0開始)中的编号
79. */
80. public int getLastElementOnPage();
81. /**
82. * 返回在当前页面上的全部记录
83. */
84. public List getPageList();
85. }

setRecordsSubst()用于存放页面显示的记录源，而setRealRecordCount()用于记录满足条件的记录总数。

以下是此接口的实现：

[java] view
plaincopy

1. import java.util.List;
2. import javax.servlet.http.HttpServletRequest;
3. import org.springframework.web.bind.ServletRequestDataBinder;
4. /**
5. *
6. * @author Sarkuya
7. */
8. public class RequestPagedListHolder implements PagedListHolder {
9. private static int pageSize = DEFAULT_PAGE_SIZE;
10. private static int maxLinkedPages = DEFAULT_MAX_LINKED_PAGES;
11. private int page = 0;
12. private List recordsSubset;
13. private long realRecordCount;
14. /** Creates a new instance of RequestPagedListHolder */
15. public RequestPagedListHolder(HttpServletRequest request, long realRecordCount, PagedListProvider pagedListProvider) {
16. setRealRecordCount(realRecordCount);
17. ServletRequestDataBinder binder = new ServletRequestDataBinder(this);
18. binder.bind(request);
19. checkPageNavigation(request);
20. setRecordsSubst(pagedListProvider.getRecordsSubset(getPageSize() * getPage(), getPageSize()));
21. }
22. private void checkPageNavigation(final HttpServletRequest request) {
23. String pageNavAction = request.getParameter("pageNavAction");
24. if (pageNavAction != null) {
25. if (pageNavAction.equals("firstPage")) {
26. firstPage();
27. } else if (pageNavAction.equals("previousPage")) {
28. previousPage();
29. } else if (pageNavAction.equals("nextPage")) {
30. nextPage();
31. } else if (pageNavAction.equals("lastPage")) {
32. lastPage();
33. }
34. }
35. }
36. public void setRecordsSubst(List recordsSubset) {
37. this.recordsSubset = recordsSubset;
38. }
39. public void setRealRecordCount(long realRecordCount) {
40. this.realRecordCount = realRecordCount;
41. }
42. public void setPageSize(int pageSize) {
43. this.pageSize = pageSize;
44. }
45. public int getPageSize() {
46. return pageSize;
47. }
48. public int getPageCount() {
49. float nrOfPages = (float) getNrOfElements() / getPageSize();
50. return (int) ((nrOfPages > (int) nrOfPages || nrOfPages == 0.0) ?

    nrOfPages + 1 : nrOfPages);

51. }
52. public int getPage() {
53. if (page >= getPageCount()) {
54. page = getPageCount() - 1;
55. }
56. return page;
57. }
58. public void setPage(int page) {
59. this.page = page;
60. }
61. public void setMaxLinkedPages(int maxLinkedPages) {
62. this.maxLinkedPages = maxLinkedPages;
63. }
64. public int getMaxLinkedPages() {
65. return maxLinkedPages;
66. }
67. public int getFirstLinkedPage() {
68. return Math.max(0, getPage() - (getMaxLinkedPages() / 2));
69. }
70. public int getLastLinkedPage() {
71. return Math.min(getFirstLinkedPage() + getMaxLinkedPages() - 1, getPageCount() - 1);
72. }
73. public void previousPage() {
74. if (!isAtFirstPage()) {
75. page--;
76. }
77. }
78. public void nextPage() {
79. if (!isAtLastPage()) {
80. page++;
81. }
82. }
83. public void firstPage() {
84. setPage(0);
85. }
86. public void lastPage() {
87. setPage(getPageCount() - 1);
88. }
89. public long getNrOfElements() {
90. return realRecordCount;
91. }
92. public int getFirstElementOnPage() {
93. return (getPageSize() * getPage());
94. }
95. public int getLastElementOnPage() {
96. int endIndex = getPageSize() * (getPage() + 1);
97. return (endIndex > getNrOfElements() ?

    (int)getNrOfElements() : endIndex) - 1;

98. }
99. public List getPageList() {
100. return recordsSubset;
101. }
102. public boolean isAtFirstPage() {
103. return getPage() == 0;
104. }
105. public boolean isAtLastPage() {
106. return getPage() == getPageCount() - 1;
107. }
108. }

此类有下面特点：

1. pageSize及maxLinkedPages均设为static，这样不因每一个Request而改变。因此用户不必每次显示一个不同的页面后都在UI中又一次设置它们。

2. 在构造函数中包装了全部的使用过程。既简化了该类的使用，也保证了该类被正确初始化。

3. 摒弃了newPageSet变量，降低了各个方法的耦合强度。

4. 在Spring环境中使用了ServletRequestDataBinder。大大简化了各个參数的读取设置过程。

5. 通过回调机制，每次仅仅检索PagedListProvider所提供的记录子集，节约了内存。提高了程序效率。

不难看出。PagedListProvider是个接口，仅仅有一个方法：

[java] view
plaincopy

1. import java.util.List;
2. /**
3. *
4. * @author Sarkuya
5. */
6. public interface PagedListProvider {
7. public List getRecordsSubset(int firstResult, int maxResults);
8. }

熟悉Hibernate的用户知道。Hibernate中就是须要这两个參数来实现分页了。假设不使用Hibernate。也没关系。自己实现此接口即可了。(接口实现起来非常easy，但技术细节却非简单。Hibernate用户在此居于明显的优势)(来源 www.iocblog.net)

以上的两个接口。一个实现类。便是经过改进后的分页技术了。以下看其用法。

当用户须要查看带有分面功能的页面时。都会由以下的方法处理：

[java] view
plaincopy

1. private void setPageListForView(HttpServletRequest request, ModelAndView mav, final String tableName) {
2. long totalRecordsCount = adminService.getTotalRecordCount(tableName);
3. PagedListProvider listProvider = new PagedListProvider() {
4. public List getRecordsSubset(int firstResult, int maxResults) {
5. return (List) adminService.listTable(tableName, firstResult, maxResults);
6. }
7. };
8. PagedListHolder holder = new RequestPagedListHolder(request, totalRecordsCount, listProvider);
9. mav.addObject("pagedRecords", holder);
10. }<span style="background-color: rgb(249, 252, 254); font-family: Tahoma, sans-serif;">    </span>

这是一个简单的方法，为RequestPagedListHolder的构造函数准备好实參后。生成一个实例。将其置于页面的一个名为"pagedRecords"的attribute中，以供JSP读取。

adminService.getTotalRecordCount()应不难实现。主要是getRecordsSubset()。

Service层的listTable()例如以下：

[java] view
plaincopy

1. public Collection listTable(String tableName, int firstResult, int maxResults) throws DataAccessException {
2. return ((HibernateDao) daoFactory.getDao(tableName)).findByCriteria(firstResult, maxResults);
3. }

Dao层代码：

[java] view
plaincopy

1. public Collection findByCriteria(int firstResult, int maxResults) throws DataAccessException {
2. DetachedCriteria criteria = DetachedCriteria.forClass(getEntityClass());
3. return getHibernateTemplate().findByCriteria(criteria, firstResult, maxResults);
4. }

以下看看视图层的使用。

......

    <c:forEach items="${pagedRecords.pageList}" var="record">

      ......

    </c:forEach>

    ......

通过JSTL方便地读出pagedRecords变量的pageList属性。

重抄一下上面的RequestPagedListHolder代码对应部分：

public List getPageList() {

        return recordsSubset;

    }

返回的正是Hibernate已经为我们检索出来的记录子集。