【JSP】自定义标签开发入门

JSP 自定义标签

　　自定义标签是用户定义的JSP语言元素。当JSP页面包含一个自定义标签时将被转化为servlet，标签转化为对被称为tag handler的对象的操作，即当servlet执行时Web container调用那些操作。

　　JSP标签扩展可以让你创建新的标签并且可以直接插入到一个JSP页面。 JSP 2.0规范中引入Simple Tag Handlers来编写这些自定义标记。

你可以继承SimpleTagSupport类并重写的doTag()方法来开发一个最简单的自定义标签

开发步骤

　　接下来，将开发一个自定义标签，功能是将long类型的时间，转化成时间的字符串。

要创建自定义的JSP标签，你首先必须创建处理标签的Java类。所以，让我们创建一个LongDateTag类，如下所示：

 package com.tag;

 import java.io.IOException;

 import java.text.SimpleDateFormat;

 import java.util.Calendar;

 import javax.servlet.jsp.JspException;

 import javax.servlet.jsp.PageContext;

 import javax.servlet.jsp.tagext.TagSupport;

 /**

  *

  * 自定义JSTL标签类

  *  处理：1.long类型时间转换字符串

  *

  * @author H__D

  *

  */

 public class LongDateTag extends TagSupport{

     private PageContext pageContext;

     private String value;

     private String partten;

     //设置PageContext对象

     public void setPageContext(PageContext pageContext) {

         //System.out.println("设置PageContext对象！");

         this.pageContext = pageContext;

     }

     public void setValue(String value)

     {

         this.value = value;

     }

     public void setPartten(String partten)

     {

         this.partten = partten;

     }

     /**

      * 标签开始处理..调用的方法

      *

      */

     @Override

     public int doStartTag() throws JspException {

         String vv = String.valueOf(value);

         System.out.println(vv);

         Long time = Long.valueOf(vv);

         Calendar calendar = Calendar.getInstance();

         calendar.setTimeInMillis(time);

         if(partten == null || partten.trim().length() == 0)

             partten = "yyyy-MM-dd HH:mm:ss.SSS";

         SimpleDateFormat simpleDateFormat = new SimpleDateFormat(partten);

         String str = simpleDateFormat.format(calendar.getTime());

         try {

             pageContext.getOut().write(str);

         } catch (IOException e) {

             // TODO Auto-generated catch block

             e.printStackTrace();

         }

         return super.doStartTag();

     }

     /**

      *

      * 标签处理结束的调用的方法

      */

     @Override

     public int doEndTag() throws JspException {

         // TODO Auto-generated method stub

         return super.doEndTag();

     }

     /**

      *

      * 释放资源

      */

     @Override

     public void release() {

         // TODO Auto-generated method stub

         super.release();

     }

     /**

      *

      * 测试主方法

      * @param args

      */

     public static void main(String[] args) {

         long a = 123456789123l;

         long time = Long.valueOf(a);

         Calendar calendar = Calendar.getInstance();

         calendar.setTimeInMillis(time);

         SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS");

         System.out.println(simpleDateFormat.format(calendar.getTime()));

     }

 }

LongDateTag

编写自定义标签的描述文件datetag.tld，将它放在WEB-INF下面，如下所示：

 <?xml version="1.0" encoding="UTF-8" ?>

 <!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN" "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">

 <!-- 标签描述TLD文件 -->

 <taglib>

     <tlib-version>1.1</tlib-version>

     <jsp-version>1.2</jsp-version>

     <!-- 默认前缀名 -->

     <short-name>diy</short-name>

     <uri>http://www.mytaglib.com/taglib</uri>

     <display-name>MyDateTaglib</display-name>

     <description>My date taglib!</description>  

     <tag>

         <name>date</name>

         <tag-class>com.tag.LongDateTag</tag-class>

         <attribute>

             <name>value</name>

             <!-- 属性是否必须 -->

             <required>true</required>

             <!-- 属性是否支持小脚本 EL表达式 -->

             <rtexprvalue>true</rtexprvalue>

         </attribute>

         <attribute>

             <name>partten</name>

             <!-- 属性是否必须 -->

             <required>false</required>

             <!-- 属性是否支持小脚本 EL表达式 -->

             <rtexprvalue>true</rtexprvalue>

         </attribute>

     </tag>

 </taglib>

datetag

在web项目中的web.xml文件中声明自定义标签，如下所示：

 <?xml version="1.0" encoding="UTF-8"?>

 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

     xmlns="http://xmlns.jcp.org/xml/ns/javaee"

     xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"

     id="WebApp_ID" version="3.1">

     <display-name>test</display-name>

     <!-- 自定义JSTL时间格式化标签 -->

     <jsp-config>

         <taglib>

             <taglib-uri>http://www.mytaglib.com/taglib</taglib-uri>

             <taglib-location>/WEB-INF/datetag.tld</taglib-location>

         </taglib>

     </jsp-config>

     <welcome-file-list>

         <welcome-file>index.html</welcome-file>

         <welcome-file>index.htm</welcome-file>

         <welcome-file>index.jsp</welcome-file>

         <welcome-file>default.html</welcome-file>

         <welcome-file>default.htm</welcome-file>

         <welcome-file>default.jsp</welcome-file>

     </welcome-file-list>

 </web-app>

web.xml

在jsp页面中使用自定义标签，如下所示：

 <%@ page language="java" contentType="text/html; charset=UTF-8"

     pageEncoding="UTF-8"%>

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

 <%@ taglib prefix="diy" uri="http://www.mytaglib.com/taglib" %>

 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

 <html>

 <head>

 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

 <title>Insert title here</title>

 </head>

 <body>

     <diy:date value="123"></diy:date>

 </body>

 </html>

index.jsp

启动服务，打开index界面，效果图，如下所示

自定义标签的执行流程

　　JSP引擎将遇到自定义标签时，首先创建标签处理器类的实例对象，然后按照JSP规范定义的通信规则依次调用它的方法。

public void setPageContext(PageContext pc)， JSP引擎实例化标签处理器后，将调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器，标签处理器以后可以通过这个pageContext对象与JSP页面进行通信。
public void setParent(Tag t)，setPageContext方法执行完后，WEB容器接着调用的setParent方法将当前标签的父标签传递给当前标签处理器，如果当前标签没有父标签，则传递给setParent方法的参数值为null。
public int doStartTag()，调用了setPageContext方法和setParent方法之后，WEB容器执行到自定义标签的开始标记时，就会调用标签处理器的doStartTag方法。
public int doEndTag()，WEB容器执行完自定义标签的标签体后，就会接着去执行自定义标签的结束标记，此时，WEB容器会去调用标签处理器的doEndTag方法。
public void release()，通常WEB容器执行完自定义标签后，标签处理器会驻留在内存中，为其它请求服务器，直至停止web应用时，web容器才会调用release方法。