自定义标签

自定义标签必须实现下面三个接口中的一个：Tag、IterationTag、BodyTag

1.Tag
  如果要实现这个接口，可以通过扩展TagSupport这个类，来写自己需要的方法，而不需要把Tag接口中的所有方法实现。
  Tag接口的方法：
 doStartTag()、doEndTag()、getParent()、setParent()、release()、setPageContext()
  在Tag类代码中不能像jsp一样，直接使用out隐含对象，他有一个对象可以使用pageContext，通过它的getOut()方法可以得到out对象。在标签内部，访问任何的隐含对象，都是通过调用pageContext的set方法。

2.IterationTag
  IterationTag接口与Tag接口类似，用于当一个自定义标签需要重复计算它的代码体的情况下。它扩展Tag接口并实现了一个新的方法doAfterBody()来实现循环，这个方法只有从doStartTag()返回EVAL_BODY_INCLUDE时才被调用。在执行doAfterBody()方法时，如果返回的是EVAL_BODY_AGAIN，那么将再次执行doAfterBody()方法，直到doAfterBody()返回的是SKIP_BODY或者EVAL_BODY_INCLUDE。

3.BodyTag
  BodyTag接口扩展了IterationTag并提供了对代码体内容进行操作的功能。就是在计算代码体的时候可以对已经形成的代码体进行修改。BodyContent对象就是用来保存对自定义标签体计算的结果。它有一个新方法doInitBody()，这个方法只有在doStartTag()方法返回EVAL_BODY_BUFFERED时才调用，此时它将创建一个BodyContent对象保存结果。

扩展自定义标签：
添加属性
 首先要在tld文件中加入一个属性元素，然后在java文件中需要定义这个属性以及它的的setter方法。属性<attribute>元素有四个子元素分别是<name>、<required>、<rtexprvalue>、<description>，这里<rtexprvalue>表示的是属性是否接受scriptlet表达式的计算结果，默认情况下为false，即只能接受静态值。

添加变量
 可以在tld文件中给自定义标签加入一个<variable>元素，它的子元素包括<name-given>表示保存变量的名字，<variable-class>表示变量的java类型，<declared>用boolean表示这个变量是否为新的，<scope>表示变量的使用范围（AT_BEGIN表示从起始标签起，AT_END表示从终止标签后，NESTED表示起始标签和终止标签之间）。定义了变量之后，需要在java文件中把这个变量用pageContext.setAttribute("",object);这里key值应该就是变量对外的名字。

使用TagExtraInfo（TEI）类
 这个对象中有两类对象可以使用，TagData（保存标签属性的信息）、VariableInfo（描述代码变量）
 一段TagExtraInfo类代码实例：
  public VariableInfo[] getVariableInfo(TagData data) {
    String variableName = data.getAttributeString("name");
    VariableInfo vi =
      new VariableInfo(variableName,"String []", true, VariableInfo.AT_END);
    VariableInfo[] tagVariables = new VariableInfo[1];
    tagVariables[0] = vi;
    return tagVariables;
  }
 可以通过TagData类的getAttributeString方法得到某个属性的值，还有另外一个方法getAttribute也是得到某个属性的值不过返回的是一个对象。而getVariableInfo方法必须返回一个VariableInfo数组。除此之外，还需要在tld中的元素定义<tag-class>后加入一个<tei-class>元素，说明TEI类的全称。

pageContext对象中含有的方法包括：getOut();getPage();getRequest();getResponse();getServletConfig();getServletContext();getSession();

Tag接口中的返回常数意义：
EVAL_BODY_INCLUDE：告诉服务器正文的内容，并把这些内容送入输出流
SKIP_BODY：告诉服务器不要处理正文内容
EVAL_PAGE：让服务器继续执行页面
SKIP_PAGE：让服务器不要处理剩余的页面
EVAL_BODY_AGAIN：让服务器继续处理正文内容，只有doAfterBody方法可以返回
EVAL_BODY_BUFFERED：BodyTag接口的字段，在doStartTag()返回
EVAL_BODY_INCLUDE、SKIP_BODY一般由doStartTag()返回，而EVAL_PAPGE、SKIP_PAGE由doEndTag()返回。

在调用doStartTag()方法之前其实标记还调用了其他两个方法：setPageContext()和setParent()；所以在后面的方法中可以使用pageContext和parent对象，如果需要的话。

让自定义标签在页面中创建对象时必须使用一个标准的JSP对象TagExtraInfo类，它可以创建脚本变量还可以在编译的时候对标签进行检验，TEI类仅可以生成由setAttribute方法存储在PageContext对象中的变量，而并不是单独生成变量。

通过TEI类定义脚本变量可以让使用者自己定义在页面中使用对象的名称。
除了使用TEI类方法之外，还可以简单的在TLD中定义一个<variable>对象来使用自定义对象，用法如下：
<variable>
 <name-from-attribute>name</name-from-attribute>
 <variable-class>String []</variable-class>
 <declare>true</declare>
 <scope>AT_END</scope>
</variable>
对于variable的子元素，<name-from-attribute>指的是创建的变量名称从属性name中来取得，当然也可以通过<name-given>元素来限制变量的名称。注意这两个元素是互斥的。

一个扩展BodyTagSupport的自定义标记的生命周期如下：
1.创建标记
2.调用Setter方法
3.调用doStartTag()方法
4.调用setBodyContent()方法
5.调用InitBody()方法
6.处理标记的Body
7.doAfterBody()；根据返回值，如果为EVAL_BODY_AGAIN，继续执行6，如果不是，执行8
8.调用doEndTag()方法
9.判断标记是否需要重用，如果要，执行4；否则执行release()方法。

TagSupport类的方法findAncestorWithClass()方法可以用来查找指定的父类，它有两个参数一个为本身的类名，还有一个就是要查找的父类的名称，如果没有返回null；例如ParentTag parent = (ParentTag) this.findAncestorWithClass(this,ParentTag.class);

自定义标记的验证方法：
JSP1.1
 TEI类可以在编译时刻检验自己的标记，这个类中有一个isValid()方法，如果TLD中为这个标记定义了这个TEI类，那么网页在编译的时候将会调用这个方法，并且会传入一个包含属性具体内容的参数TagData。（在JSP1.2中同样有效）
JSP1.2
 JSP1.2中引入一个新的标记检验方法，定义了一个新类TagLibraryValidator，并且可以由此派生出检验标志的类，大多数情况下仅使用这个类的validate()方法，它有三个参数：prefix（在taglib指令中定义的前缀）；uri（TLD文件中的URI）；page（JSP页的PageData XML版本），validate()方法返回值为null时表示验证成功，否则返回的String类型将是一个错误信息。
当validator在TLD文件中定义时，它应该放在<tag>元素定义的外面，因为它是用来处理验证标记库中的所有标记的。
<validator><validator-class></validator-class></validator>。

比较JSP1.2和JSP1.1中的方法：
TagLibraryValidator比TEI类更全面，可以用来检测整个网页，而不仅仅是标记本身，可以用来处理标记间的合作，并且这种方法可以用来通知程序员错误出在哪里，但是同时它的方法也比TEI类的方法复杂多了，因为它需要遍历整个XML版本的JSP（完成getAttributeValue方法）。

JSP1.2中的TryCatchFinally接口：
这个接口主要是用于当自定义标记出现异常时释放自定义标记中的资源使用的，它定义了两个方法：
public void doCatch(Throwable t);（当doStartTag,doInitBody,doAfterBody,doEndTag方法出现异常时会调用这个方法）
piblic void doFinally();（当doEndTag被调用后，无论是否出现异常都会调用这个方法，就像程序中的finally块，可以用来释放资源）

在JSP1.2中，可以通过在tld文件中加入一个元素<uri></uri>来指定自己的在taglib指令中使用的名称，然后把这个tld文件与Manifest.mf一起放在META-INF目录中，那么在页面中就可以非常方便地导入这些tld。

编写自定义标记的原则：
1.使用脚本变量（允许设计者为脚本变量起名、将脚本变量的数量减到最小、使用一个组合脚本对象和存取函数即使用JavaBean）
2.当设计相互协作的标记时应该尽量避免创建一套新的语言，应当尽量使用脚本变量
3.编写代码而不是内容，不要在自定义标记中产生HTML，这样会失去通用性

 

打开某个jsp页面，页面上的select下拉列表框用Struts自定义标签来完成

    1、新建页面：Test.jsp

    2、在Web应用的WEB-INF目录下自定义标签TLD文件：TestTag.tld

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.1//EN" "http://java.sun.com/j2ee/dtds/web-jsptaglibrary_1_1.dtd">
<taglib>
   <tlibversion>1.0</tlibversion>
   <jspversion>1.1</jspversion>
   <shortname>dtree</shortname>
   <uri>http://jakarta.apache.org/struts/tags-bean</uri>

   <tag>
     <name>selectResnodes</name>
     <tagclass>myWeb.taglib.SelectTag</tagclass>
     <bodycontent>empty</bodycontent>
     <attribute>
        <name>id</name>
        <required>true</required>
        <rtexprvalue>false</rtexprvalue>
     </attribute>
     <attribute>
        <name>nodeslist</name>
        <required>true</required>
        <rtexprvalue>false</rtexprvalue>
     </attribute>
     <attribute>
         <name>scope</name>
         <required>false</required>
         <rtexprvalue>false</rtexprvalue>
     </attribute>
   </tag>
</taglib>
 

    3、在myWeb.Action包下定义AbstractResAction.java文件和TestAction.java文件（利用了java的反射机制）

    AbstractResAction.java文件：

package myWeb.Action;import java.lang.reflect.Method;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.struts.action.Action;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;

public abstract class AbstractResAction extends Action {
 public final ActionForward execute(ActionMapping actionMapping,
   ActionForm actionForm, HttpServletRequest httpServletRequest,
   HttpServletResponse httpServletResponse) {
  String cmd = httpServletRequest.getParameter("actionType"); // 获取参数，其实为函数名
 
  System.out.println("actionType = " + cmd);
 
  if (cmd == null || cmd.equals(""))
   return actionMapping.findForward("default");
  try {
   Method method = this.getClass()
     .getMethod(
       cmd,new Class[] { ActionMapping.class,
         ActionForm.class, HttpServletRequest.class,
         HttpServletResponse.class });

   // 利用反射机制，调用method方法。而这个method方法是由页面指定的actionType定义的。
   return (ActionForward) method.invoke(this, new Object[] {
     actionMapping, actionForm, httpServletRequest,
     httpServletResponse });
  } catch (Exception e) {
   e.printStackTrace();
   return actionMapping.findForward("default");
  }
 }
}

 TestAction.java文件：package myWeb.Action;import java.util.ArrayList; import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;import com.asiainfo.ainx.advancedres.bo.ResnodesBO; public class QueryNodesAction extends AbstractResAction {
 public ActionForward showNodesList(ActionMapping mapping, ActionForm form,
   HttpServletRequest request, HttpServletResponse response) {
  ResnodesBO bo = new ResnodesBO();
  ArrayList alNodes = bo.selectData();   //我的应用中定义了BO和DAO类来封装对数据库的读写。此处为从数据库中取出的数据结果集
 
  request.setAttribute("resnodesList",alNodes);  //页面中的用到该自定义标签时要用到resnodesList这个属性
  return mapping.findForward("showResnode");
 }
 

4、在myWeb.taglib包下定义SelectTag.java文件

package myWeb.taglib; import java.io.IOException;
import java.util.ArrayList;import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.TagSupport;import org.apache.struts.util.RequestUtils;import myWeb.vo.ResnodesVO; public class SelectTag extends TagSupport {//这里的三个属性对应TestTag.tld文件中对selectResnodes定义的三个属性
 private String id; private String scope; private String nodeslist; /**
  * @throws IOException
  */
 public int doStartTag() {
  ArrayList list = null;
  try {
   list = (ArrayList) RequestUtils.lookup(pageContext, nodeslist,
     scope);  } catch (JspException e1) {
   e1.printStackTrace();
  }
  if (list == null || list.size() == 0)
   return SKIP_BODY;  JspWriter out = pageContext.getOut();
  try {   if (list != null) {
    out.println("<select name=\"Sel_Nodes\" style=\"width:90%\">");
    for (int i = 0; i < list.size(); i++) {
     ResnodesVO nodevo = (ResnodesVO) list.get(i);
     out.println("<option value=\"" + nodevo.getId() + "\">"
       + nodevo.getSName() + "</option>");
//     System.out.println(nodevo.getSName());
    }
    out.println("</select>");
    out.flush();
   }
  } catch (IOException e) {
   e.printStackTrace();
  }
  return EVAL_BODY_INCLUDE;
 } public String getId() {
  return id;
 } public void setId(String id) {
  this.id = id;
 } public String getNodeslist() {
  return nodeslist;
 } public void setNodeslist(String nodeslist) {
  this.nodeslist = nodeslist;
 } public String getScope() {
  return scope;
 } public void setScope(String scope) {
  this.scope = scope;
 }}

    5、修改struts-config.xml文件：

……<action-mappings>  ……  <action type="myWeb.Action.TestAction" scope="request" path="/queryResnodes">  <!-- 在地址栏或链接中请求时用该路径queryResnodes -->
   <forward name="showResnode" path="/Test.jsp" />    <!-- 在TestAction.java中执行查询数据的函数后，跳转至该showResnode定义的页面，即Test.jsp -->
  </action>  ……</action-mappings>……

    6、保证Test.jsp中包含如下的代码：

<%@ taglib uri="/WEB-INF/TestTag.tld" prefix="slotnode"%> 
<body>

……

<slotnode:selectResnodes id="nodelist" nodeslist="resnodesList" scope="request" />

……

</body>

其中prefix的名字是随便起的，只要有意义就可以。但是在后面用的时候就要用这个名字，本例中是slotnode。<slotnode:selectResnodes …… 中的selectResnodes和TestTag.tld中定义的<tag><name>selectResnodes</name>……必须是相同的的另外 nodeslist="resnodesList"中resnodesList即TestAction.java中定义的 request.setAttribute("resnodesList",alNodes);  中写入的属性resnodesList，两个名字必须是相同的。

    7、比如我的Web应用发布的名字为LearnTag，发布在本地的Tomcat中，默认端口8080则在地址栏输入：http://localhost：8080/LearnTag /queryResnodes.do？actionType=showNodesList

    OK.出来结果了吧。

    整理的有点乱，再总结一下：

    从页面发起。do请求，请求转至action，在action文件中执行数据库查询，取得需要的数据

    将查询得到的数据列表用setAttribute加入request

    自定义标签中取request中的加入的数据列表

    由自定义标签中的标签java文件完成将数据打印出来的功能（用JspWriter类）

    在页面显示出来。查看jsp文件的源代码，可以看到自定义的标签和数据都转换为html的代码了