用displaytag组件兑现分页详解

用displaytag组件实现分页详解
用displaytag组件实现分页详解

在看刘伟老师的博客项目视频的时候,看到在项目中用到了displaytag组件来实现分页的功能,感觉这个组件挺好用的,可以很方便的实现我们想要的功能。
下面就具体讲一下如何把displaytag这个组件应用到我们的项目中。

学习任何一下开源的项目,第一步肯定是免不了的,去官方网站上把源码下载下来,这里我们也不例外,先到displaytag的官方网站上把源码下载下来。

第一步,到displaytag官方网站(http://displaytag.sourceforge.net)上把源码下载下来。

解压后目录如下:


第一个docs是相应的文档说明,第二个displaytag-1.2.jar这个是displaytag的核心包1.2是他的版本号。第三个是导出时用到的包,displaytag-examples-1.2.war这个是例子的应用,可以把这个包放在tomcat/webapps下部署看一下这个例子。

我们现在只是用到分布功能,所以只导入核心包diaplaytag-1.2.jar就行了(把diaplaytag-1.2.jar放在工程下的WebRoot/WEB-INF/lib目录下),要是还要用导出的功能就还要把下面的二个扩展包也导入进去。

第二步,把displaytag所依赖的一些其它包也放在工程下的WebRoot/WEB-INF/lib目录下

commons-logging
commons-lang
commons-collections
commons-beanutils
log4j
itext (optional, for pdf/rtf export)
如果需要把文件导成pdf,excel等还需要把displaytag-export-poi jar也导入进来。

要是要用到导出功能的话,还需要在web.xml里增加一个过滤器,

<filter>
    <filter-name>ResponseOverrideFilter</filter-name>
    <filter-class>org.displaytag.filter.ResponseOverrideFilter</filter-class>
</filter>

<filter-mapping>
    <filter-name>ResponseOverrideFilter</filter-name>
    <url-pattern>*.do</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>ResponseOverrideFilter</filter-name>
    <url-pattern>*.jsp</url-pattern>
</filter-mapping>

这里我们只用到分页功能,所以这一步可以跳过。

到这里准备工作我们就完成了,下面来具体运用。

第三步,把displaytag运用到你所需要运用分页功能的页面中。

首先,得在页面的头部引入这个标签<%@ taglib uri="http://displaytag.sf.net" prefix="display" %>

这就类似于JSTL,或者是struts2类似,也要在头部引入相应的标签才能使用一样。

然后我们直接在页面中应用,

最基本的:

<display:table />test为你的属性名字,如你上一页使用了request.setAttribute("blog", blog);然后转向到你要使用分页的页面上,这时你的显示页面就应该是<display:table name="blog" />


这是最简单的应用,我们可以给他加上样式,也可以定义显示的列标题。

<% request.setAttribute( "test", new TestList(10, false) ); %>

<display:table name="test">
<display:column property="id" title="ID" />
<display:column property="name" />
<display:column property="email" />
<display:column property="status" />
<display:column property="description" title="Comments"/>
</display:table>


下面我们再给他加上分页的功能,这个才是我们用他的重点,呵呵

如果想对代码分页,只需在display:table标签中添加一项pagesize="每页显示行数",如
<display:table name="test" pagesize="10"/>

2. 对列排序
display tag可对列进行排序,就是点击列名,对该列的数据进行排序。你只需对想要排序的列添加 sort="true" 就OK,如下面的代码可对前三列进行排序。在display:table中添加defaultsort="列数",可默认对指定的列排序。
<display:table name="test" styleClass="list" cellspacing="0" cellpadding="0" defaultsort="1">
<display:column property="id" title="ID" class="idcol" sort="true"/>
<display:column property="name" url="detail.jsp" paramId="id" paramProperty="id" sort="true"/>
<display:column property="email" autolink="true" sort="true"/>
<display:column property="description" title="Comments"/>
</display:table>
如果table有分页,Display Tag默认只对当前页进行排序,如果想对整个list排序,可以在display:table之间添加一段代码:
<display:setProperty name="sort.amount" value="list"/>

3. 导出数据

在display:table中添加export="true",看看会出现什么!Display Tag默认会提供三种数据导出方式:CSV、Excel、XML 。

另外Display Tag还可以导出为PDF格式,在http://prdownloads.sourceforge.net/itext/下载一个辅助包iText.jar,copy到lib目录下,然后在display:table之间添加一段代码:

<display:setProperty name="export.pdf" value="true"/>,大功告成。

4. Display Tag的属性设置

前面所说的display:setProperty 是一种改变Display Tag属性的方法,但是在每个jsp中都要写太麻烦了。

Display Tag中设置了很多默认的属性,它有一个专门的属性文件,是在它的jar包中的displaytag/properties/TableTag.properties

想要改变它的默认属性,我们可以在WEB-INFclasses下新建一个文件displaytag.properties,仿照TableTag.properties中属性的格式设置需要修改的属性。

TableTag.properties中的# messages中设置的是显示在页面上的提示信息。默认是英文的,我们可以把它改为中文的。不过这里只能使用unicode,就是说中文字符必须转换为unicode码,这个可以使用jdk自带的native2ascii.exe进行转换。

5. 其它功能

DisplayTag还有一些很实用的小功能,这里提两个。一个是对数据的Format,这是1.1版本添加的新功能,可以使用标签的方式格式化时间、数字、字符串。比如日期,在需要格式化的column标签中添加format="{0,date,yyyy-MM-dd}",第一个参数为格式化的数据序号,第二个参数是数据类型,数字为number,第三个参数为数据格式。

另外一个功能是对table数据的合计功能。在table标签中添加 decorator="org.displaytag.decorator.TotalTableDecorator",然后在想要进行合计的数据列的column标签中添加 total="true",该列就可以被计算总数了。但这个功能有个缺点,不能用在有分页的时候,它只能合计第一页的数据。

DisplayTag的不足 初次使用DisplayTag的人可能会觉得惊喜,但是用久了会发现很多问题,最大的问题是对中文的支持不好,比如如果查询条件中有中文,就无法翻页,无法对中文排序,将中文导出为指定文件时出现乱码等等。这些问题有时候会让人很郁闷,有时候逼得你要去修改它的源代码。下面是对以上几个问题的解决方法:

1. 对于中文无法翻页、排序,最简单的办法是修改Tomcat下的server.xml文件。找到HTTP的Connector标签,在里面添加一项URIEncoding="...",引号里面的内容取决于你的页面编码,比如可以是GBK,UTF8等。这样上面两个问题就可以解决了。

2. 导出为文件:其实这个功能除了中文支持外还有很多其它问题,比如它会将Html标签一起导出、只导出显示的内容,但如果对table进行了decorator,decorator后的内容无法导出。如果想要将中文正确导出,需要修改DisplayTag源代码。

下载相同版本的源代码,在org.displaytag.export.ExcelView.java文件中找到getMimeType()方法,将此方法修改为 return "application/vnd.ms-excel;charset=GB2312";,修改后导出数据的速度会慢很多,不过将就吧。

下面看一下我这个博客文章管理页面的具体应用:

<%@ page language="java" contentType="text/html; charset=UTF-8"%>
<%@ taglib uri="http://displaytag.sf.net" prefix="display" %>
<%@include file="header.jsp" %>
<style type="text/css" media="all">
        @import url("/blog/admin/css/screen.css");
</style>
<script type="text/javascript"> 
    function del() {
     var msg = "您真的确定要删除吗?\n\n请确认!";
     if (confirm(msg)==true){
       return true;
      }else{
       return false;
      }
     }
</script>

<h2>博文管理</h2>
<display:table pagesize="3" requestURI="/servlet/AdminBlogListServlet" >
<display:column property="id" title="编号" sortable="true"/>
<display:column property="title" title="主题"/>
<display:column property="category" title="分类"/>
<display:column property="createdTime" title="日期" sortable="true"/>
<display:column title="操作">
   <a href="/blog/servlet/PreEditBlogServlet?id=${blog.id}"><img src="/blog/admin/images/edit.gif " border="0"/></a>
        <a href="/blog/servlet/DeleteBlogServlet?id=${blog.id}" onclick="javascript:return del()"><img src="/blog/admin/images/delete.gif" border="0"/></a>  
</display:column>

</display:table>
<%@include file="footer.jsp" %>

注意事项:

有时候,要是点下一页出现Nothing found to display. ,就在加上requestURI="这里写上你显示列表页"

编号和日期上有个向上和向下的小三角,点击那里可以进行排序。

默认分页,上一页下一页这些是在显示表格的上面的,我们可以通过属性文件来把他改成下面,或者是上下都有。

在src目录下新建一个displaytag.properties属性文件,或者是把到示例程序把这个文件复制过来再修改

paging.banner.placement=bottom

这样分页显示就在表格的下面了。


用这个分页很简单.在displaytab1.1以前只能把所有记录全从数据库查出来,然后给个list给它,它就会自己自动分页,数据量大时影响性能,到1.1版本时,这个问题已经解决,官方文档上说有两种解决方法,下面是其中一种.

<display:table name="mesList" pagesize="10" id="element" requestURI="Page" partialList="true"
    size="resultSize">:

<display:column property="id" title="ID" sortable="true" ></display:column>
    <display:column property="toId" ></display:column>
    <display:column property="content" ></display:column>
    <display:column property="fromId" ></display:column>
    <display:column property="posttime" ></display:column>
</display:table>

1,取得分页时参数的名字String name =new ParamEncoder("element").encodeParameterName(TableTagParameters.PARAMETER_PAGE);

int pageNo = Integer.parseInt(request.getParameter(name));

这里的element是上面<display:tablej里的id="element";

这两句的作用就相当于以前自己写分页时XXXservlet?pageNo=2,

获取当前是第2页,根据当的页数算出数据库里从第几条开始查,

我的servlet中是这写的,如果用struts就写在一个action中:

   int resultSize = 0;
   int pageSize =10;
   List<Message> mesList = null ;
 
   String name =new ParamEncoder("element").encodeParameterName(TableTagParameters.PARAMETER_PAGE);
   int pageNo = 0;
   try{
    pageNo = Integer.parseInt(request.getParameter(name));
   }catch(Exception e){
    pageNo =1;
   }
   int start = (pageNo-1)*pageSize;
   try {
    resultSize = getCount();//DAO中的查询总记录条数的方法
    mesList = getMes(start, pageSize);//DAO中查询从第start条开始,取pagesize条记录.(mysql数据库)
   } catch (Exception e) {
    // TODO Auto-generated catch block
    e.printStackTrace();
   }
   request.setAttribute("resultSize",resultSize);
   request.setAttribute("mesList",mesList);
   request.getRequestDispatcher("mes.jsp").forward(request, response);

配置文件displaytag.properties:

paging.banner.items_name=消息
paging.banner.no_items_found=<span class="pagebanner">没有找到{0}记录。</span>
paging.banner.one_item_found=<span class="pagebanner">共找到一条{0}记录。</span>
paging.banner.all_items_found=<span class="pagebanner">共找到{0}条{1}记录,显示所有{2}记录。</span>
paging.banner.some_items_found=<span class="pagebanner">共找到{0}条{1}记录,当前显示从第{2}条至第{3}条。</span>
paging.banner.full=<span class="pagelinks">[<a href="{1}">首页</a>/<a href="{2}">上一页</a>]{0}[<a href="{3}">下一页</a>/<a href="{4}">尾页</a>]</span>
paging.banner.first=<span class="pagelinks">[首页/上一页] {0}[<a href="{3}">下一页</a>/<a href="{4}">尾页</a>]</span>
paging.banner.last=<span class="pagelinks">[<a href="{1}">首页</a>/<a href="{2}">上一页</a>]{0} [下一页/尾页]</span>
paging.banner.page.link=<a href="{1}" title="转到第{0}页">{0}</a>
paging.banner.placement=bottom

因为我用的myeclipse装了properties的插件,可以直接写中文,发布时会自动转为unicode编码,所以用时就用工具将上面相应的中文转为unicode编码,在放在displaytag.properties中.下面是转好了的:

paging.banner.items_name=\u6d88\u606f
paging.banner.no_items_found=<span class="pagebanner">\u6ca1\u6709\u627e\u5230{0}\u8bb0\u5f55\u3002</span>
paging.banner.one_item_found=<span class="pagebanner">\u5171\u627e\u5230\u4e00\u6761{0}\u8bb0\u5f55\u3002</span>
paging.banner.all_items_found=<span class="pagebanner">\u5171\u627e\u5230{0}\u6761{1}\u8bb0\u5f55\uff0c\u663e\u793a\u6240\u6709{2}\u8bb0\u5f55\u3002</span>
paging.banner.some_items_found=<span class="pagebanner">\u5171\u627e\u5230{0}\u6761{1}\u8bb0\u5f55\uff0c\u5f53\u524d\u663e\u793a\u4ece\u7b2c{2}\u6761\u81f3\u7b2c{3}\u6761\u3002</span>
paging.banner.full=<span class="pagelinks">[<a href="{1}">\u9996\u9875</a>/<a href="{2}">\u4e0a\u4e00\u9875</a>]{0}[<a href="{3}">\u4e0b\u4e00\u9875</a>/<a href="{4}">\u5c3e\u9875</a>]</span>
paging.banner.first=<span class="pagelinks">[\u9996\u9875/\u4e0a\u4e00\u9875] {0}[<a href="{3}">\u4e0b\u4e00\u9875</a>/<a href="{4}">\u5c3e\u9875</a>]</span>
paging.banner.last=<span class="pagelinks">[<a href="{1}">\u9996\u9875</a>/<a href="{2}">\u4e0a\u4e00\u9875</a>]{0} [\u4e0b\u4e00\u9875/\u5c3e\u9875]</span>
paging.banner.page.link=<a href="{1}" title="\u8f6c\u5230\u7b2c{0}\u9875">{0}</a>
paging.banner.placement=bottom