Java标签之自定义分页标签

 3,072浏览     wenqyAdmin   

雨蝶 – 李翊君–:– / 03:50
(*+﹏+*)

做过Java Web项目的开发工程师都知道，如果单纯的使用jsp脚本开发，糅合内容和行为逻辑与一体是一个非常不好的体验，更不易于维护。所以采用了JSTL标签库，用于分离数据显示和业务逻辑，简易开发，带来优雅编程体验。JSTL 即：JSP Standard Tag Library，一个JSP标签集合，它封装了JSP应用的通用核心功能。他依赖于standard.jar和jstl.jar两个jar包。

JSTL支持通用的、结构化的任务，比如迭代，条件判断，XML文档操作，国际化标签，SQL标签。尽量只是用核心标签，包括<c:if>、<c:choose>、<c:when>、<c:otherwise>、<c:forEach>等，主要用于构造循环和分支结构以控制显示逻辑。标签引用：

<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>

格式化标签一般用于日期相关的数据处理。函数标签一般用于字符串相关的数据处理。当然，这次要记录的是如何自定义标签，增强自己的数据处理需要。这里以自定义分页标签为例。

1、实现Tag接口或者继承缺省适配的Tag相关类。

开发中通常不直接实现这些接口而是继承TagSupport/BodyTagSupport/SimpleTagSupport类，重写doStartTag()、doEndTag()等方法，定义标签要完成的功能。

现在已自定义分页标签为例，继承BodyTagSupport类，重写doStartTag方法。定义了一些属性。

  1. PageData pageData; // 分页类
  2. String funcName; // js 回调函数名
  3. String formId; // 表单的ID名
  4. String formUrl; // 表单提交的URL

重写doStartTag方法：

  1. @Override
  2. public int doStartTag() throws JspException {
  3.     JspWriter out = this.pageContext.getOut();
  4.     try {
  5.         if (pageData == null) {
  6.             return Tag.SKIP_BODY;
  7.         }
  8.         out.println(getPageHtml());
  9.     } catch (IOException e) {
  10.         throw new JspException(e);
  11.     }
  13.     return Tag.EVAL_BODY_INCLUDE;
  14. }

在getPageHtml方法里根据逻辑拼接html分页列表，如一个简单的例子：

  1. private String getPageHtml() {
  2.         if (pageData == null) {
  3.             return “”;
  4.         }
  5.         StringBuilder sBuilder = new StringBuilder();
  6.         if (pageData.hasNext()) {
  7.             sBuilder.append(“<li><a href=\”javascript:void(0)\” onclick=\””).append(this.funcName)
  8.             .append(“(“).append(pageData.getPageNo()+1).append(“,”).append(pageData.getPageSize()).append(“,'”).append(formId).append(“‘,'”).append((formUrl == null || “”.equals(formUrl)?“”:formUrl))
  9.             .append(“‘);\”>下一页</a></li>”);
  10.         } else {
  11.             sBuilder.append(“<li class=\”disabled\”>下一页</li>”);
  12.         }
  13.         if (pageData.hasPrevious()) {
  14.             sBuilder.append(“<li><a href=\”javascript:void(0)\” onclick=\””).append(this.funcName)
  15.             .append(“(“).append(pageData.getPageNo()-1).append(“,”).append(pageData.getPageSize()).append(“,'”).append(formId).append(“‘,'”).append((formUrl == null || “”.equals(formUrl)?“”:formUrl))
  16.             .append(“‘);\”>上一页</a></li>”);
  17.         } else {
  18.             sBuilder.append(“<li class=\”disabled\”>上一页</li>”);
  19.         }
  20.         return sBuilder.toString();
  21.     }

2、编写扩展名为tld的标签描述文件对自定义标签进行定义。

pages.tld自定义标签描述了标签名，标签处理类、和相关属性定义描述：

  1. <tag>
  2.     <name>page</name>
  3.     <tag-class>com.common.test.PageTag</tag-class>
  4.     <description>分页标签–power by wenqy.com</description>
  5.     <attribute>
  6.       <name>pageData</name>
  7.       <required>true</required>
  8.       <rtexprvalue>true</rtexprvalue>
  9.       <description>封装分页数据类</description>
  10.     </attribute>
  11.     <attribute>
  12.       <name>funcName</name>
  13.       <required>false</required>
  14.       <rtexprvalue>true</rtexprvalue>
  15.       <description>选择页签触发的js函数名</description>
  16.     </attribute>
  17.     <attribute>
  18.       <name>formId</name>
  19.       <required>true</required>
  20.       <rtexprvalue>true</rtexprvalue>
  21.       <description>选择页签后要提交表单的ID</description>
  22.     </attribute>
  23.     <attribute>
  24.       <name>formUrl</name>
  25.       <required>false</required>
  26.       <rtexprvalue>true</rtexprvalue>
  27.       <description>选择页签后要跳转的页面URL</description>
  28.     </attribute>
  29.   </tag>

3、在JSP页面中使用taglib指令引用该标签库

Jsp头部引用tld标签描述文件。

<%@ taglib prefix="fns" uri="/WEB-INF/tlds/pages.tld" %>

调用自定义标签，formUrl属性非必须。

<fns:page pageData="${requestScope.pageData }" funcName="page" formId="myForm" />

4、js方法

表单里定义pageNo、pageSize两个隐藏域，并重写页签调用方法，使用jquery方法。

  1.  <script type=“text/javascript”>
  2.         // 参数： 页数、页大小、form ID、submit URL
  3.         function page(no, size,form,url) {
  4.             var re = /^[0-9]*$/;
  5.             if(!re.test(size)){
  6.                 alert(‘页大小为数字’);
  7.                 return;
  8.             }
  9.             if(!re.test(no)){
  10.                 alert(‘页数为数字’);
  11.                 return;
  12.             }
  13.             if (no) {
  14.                 $(“#pageNo”).val(no);
  15.             }
  16.             if (size) {
  17.                 $(“#pageSize”).val(size);
  18.             }
  19.             if (url) {
  20.                 $(“#” + form).attr(“action”,url);
  21.             }
  22.             $(“#” + form).submit();
  23.             return false;
  24.         }
  25. </script>

5、pageData分页类

  1. /**
  2.  * 
  3.  * @author wenqy
  4.  *
  5.  */
  6. public class PageData implements Serializable {
  7.     private static final long serialVersionUID = 8040968899344110256L;
  8.     protected static final int DEFAULT_PAGE_NO = 0;
  9.     protected static final int DEFAULT_PAGE_SISE = 0;
  10.     protected static final int DEFAULT_INDEX_BEGIN = 0;
  11.     protected static final int DEFAULT_INDEX_END = 0;
  12.     protected List<?> items; // 页数据
  13.     protected Object[][] results;
  14.     protected int pageNo; // 当前页
  15.     protected int pageSize; // 页大小
  16.     protected int pageCount; // 页数
  17.     protected int totalCount;
  18.     protected int handleCount;
  19.     protected int lastPageSize;
  20.     protected int columnCount;
  21.     protected int beginIndex;
  22.     protected int endIndex;
  23.     protected int[] indexes; // 记录每页的起始下标
  24.     protected String orderField; // 排序字段
  25.     protected boolean isOrderAsc; // 升降排序
  26.     protected String resInfo;
  27.     protected String pageCode;
  28.     public boolean hasNext() {
  29.         return (this.pageNo < this.pageCount);
  30.     }
  32.     public boolean hasPrevious() {
  33.         return (this.pageNo > 0);
  34.     }
  36.     public static int convertFromPageToStartIndex(int paramInt1, int paramInt2) {
  37.         return ((paramInt1 – 1) * paramInt2);
  38.     }
  40.     public int currentPageNo() {
  41.         return getPageNo();
  42.     }
  44.     public int getNextIndex() {
  45.         int i = getBeginIndex() + this.pageSize;
  46.         if (i >= this.totalCount)
  47.             return getBeginIndex();
  48.         return i;
  49.     }
  51.     public int getPreviousIndex() {
  52.         int i = getBeginIndex() – this.pageSize;
  53.         if (i < 0)
  54.             return 0;
  55.         return i;
  56.     }
  58.     public List<?> getItems() {
  59.         return this.items;
  60.     }
  62.     public void setItems(List<?> paramList) {
  63.         this.items = paramList;
  64.     }
  66.     public int getPageNo() {
  67.         return this.pageNo;
  68.     }
  70.     public void setPageNo(int paramInt) {
  71.         this.pageNo = paramInt;
  72.     }
  74.     public int getPageSize() {
  75.         return this.pageSize;
  76.     }
  78.     public void setPageSize(int paramInt) {
  79.         this.pageSize = paramInt;
  80.     }
  82.     public int getPageCount() {
  83.         if (this.totalCount < 0)
  84.             return –1;
  85.         if (this.totalCount == 0)
  86.             return 0;
  87.         if (this.pageSize > 0) {
  88.             int i = this.totalCount / this.pageSize;
  89.             if (this.totalCount % this.pageSize > 0)
  90.                 ;
  91.             this.pageCount = (++i);
  92.         } else {
  93.             this.pageCount = 1;
  94.             this.pageSize = this.totalCount;
  95.         }
  96.         return this.pageCount;
  97.     }
  99.     public void setPageCount(int paramInt) {
  100.         this.pageCount = paramInt;
  101.     }
  103.     public int getTotalCount() {
  104.         return this.totalCount;
  105.     }
  107.     public void setTotalCount(int paramInt) {
  108.         if (paramInt > 0) {
  109.             this.totalCount = paramInt;
  110.             if (this.pageSize <= 0)
  111.                 return;
  112.             int i = this.totalCount / this.pageSize;
  113.             if (paramInt % this.pageSize > 0)
  114.                 ;
  115.             this.indexes = new int[++i];
  116.             for (int j = 0; j < i; ++j)
  117.                 this.indexes[j] = (this.pageSize * j);
  118.         } else {
  119.             this.totalCount = 0;
  120.         }
  121.     }
  123.     public int getBeginIndex() {
  124.         return this.beginIndex;
  125.     }
  127.     public void setBeginIndex(int paramInt) {
  128.         if (this.totalCount <= 0)
  129.             this.beginIndex = 0;
  130.         else if (paramInt >= this.totalCount)
  131.             this.beginIndex = this.indexes[(this.indexes.length – 1)];
  132.         else if (paramInt < 0)
  133.             this.beginIndex = 0;
  134.         else if (this.pageSize > 0)
  135.             this.beginIndex = this.indexes[(paramInt / this.pageSize)];
  136.         else
  137.             this.beginIndex = paramInt;
  138.     }
  140.     public int getEndIndex() {
  141.         return this.endIndex;
  142.     }
  144.     public void setEndIndex(int paramInt) {
  145.         this.endIndex = paramInt;
  146.     }
  148.     public int getLastPageSize() {
  149.         if (this.totalCount < 0)
  150.             return –1;
  151.         if (this.totalCount == 0)
  152.             return 0;
  153.         int i = this.totalCount % this.pageSize;
  154.         if (i > 0)
  155.             return i;
  156.         return this.pageSize;
  157.     }
  159.     public void setLastPageSize(int paramInt) {
  160.         this.lastPageSize = paramInt;
  161.     }
  163.     public int getColumnCount() {
  164.         return this.columnCount;
  165.     }
  167.     public void setColumnCount(int paramInt) {
  168.         this.columnCount = paramInt;
  169.     }
  171.     public int getHandleCount() {
  172.         return this.handleCount;
  173.     }
  175.     public void setHandleCount(int paramInt) {
  176.         this.handleCount = paramInt;
  177.     }
  179.     public int[] getIndexes() {
  180.         return this.indexes;
  181.     }
  183.     public void setIndexes(int[] paramArrayOfInt) {
  184.         this.indexes = paramArrayOfInt;
  185.     }
  187.     public String getOrderField() {
  188.         return this.orderField;
  189.     }
  191.     public void setOrderField(String paramString) {
  192.         this.orderField = paramString;
  193.     }
  195.     public boolean isOrderAsc() {
  196.         return this.isOrderAsc;
  197.     }
  199.     public void setOrderAsc(boolean paramBoolean) {
  200.         this.isOrderAsc = paramBoolean;
  201.     }
  203.     public Object[][] getResults() {
  204.         return this.results;
  205.     }
  207.     public void setResults(Object[][] paramArrayOfObject) {
  208.         this.results = paramArrayOfObject;
  209.     }
  211.     public String getResInfo() {
  212.         return this.resInfo;
  213.     }
  215.     public void setResInfo(String paramString) {
  216.         this.resInfo = paramString;
  217.     }
  218. }

封装Dao层的分页方法，传入pageData。Jsp会被Java容器，如：Tomcat翻译成Servlet，获取pageContext对象，调用doStartTag方法。

pageData

使用标签库可以对内容显示和业务逻辑的解耦有很大帮助，如果觉得现有标签库不能满足需要还可以自定义标签。当然也是可以选择其他模板引擎，如freemarker、velocity等等。

参考：

http://tomcat.apache.org/taglibs/standard/ Standard Taglib

 

小二，再来一碟

赏

发表评论

电子邮件地址不会被公开。 必填项已用*标注

7 + 5 = ?