JSP:自定义标签的实现步骤及小例

一个非常好的自定义标签的例子就是有权限才显示相应的超链接，这个就可以用自定义标签来完成，在doTag中判断是否有权限。

1. 步骤

  * 标签处理类（标签也是一个对象，那么就需要先有类！）
  * tld文件，它是一个xml
  * 页面中使用<%@taglib%>来指定tld文件的位置

2. 标签处理类JspTag---{Tag、 SimpleTag}
  SimpleTag接口：
  * void doTag()：每次执行标签时都会调用这个方法；
  * JspTag getParent()：返回父标签（非生命周期方法）
  * void setParent(JspTag)：设置父标签
  * void setJspBody(JspFragment)：设置标签体
  * void seetJspContext(JspContext)：设置jsp上下文对象，它儿子是PageContext

　　其中doTag()会在其他三个方法之后被tomcat调用。就是Tomcat在解析JSP页面的时候遇到了你定义的标签，

那么就到tld文件中找到相应的类反射生成对象，调用那几个set方法（是不是有点像注入的意思），然后调用doTag。

3. 配置tld文件

tld文件一般都放到WEB-INF之下，这样保证客户端访问不到！
  <tag>
      <name>myTag1</name> 指定当前标签的名称
      <tag-class>cn.itcast.tag.MyTag1</tag-class> 指定当前标签的标签处理类！
      <body-content>empty</body-content> 指定标签体的类型，我们这里使用的是空标签！
  </tag>

4. 页面中指定tld文件位置

<%@ taglib prefix="it" uri="/WEB-INF/tlds/itcast-tag.tld" %>
导标签库，就是为页面指定tld文件的位置！

标签体内容

  * empty：无标签体！
  * JSP：jsp2.0已经不在支持这个类型了！表示标签体内容可以是：java脚本，可以是标签，可以是el表达式
  * scriptless：只能是EL表达式，也可以是其他的标签！
  * tagdependent：标签体内容不会被执行，而是直接赋值标签处理类！

不再执行标签下面内容的标签！在标签处理类中的doTag()中使用SkipPageException来结束！
　　Tomcat会调用标签处理类的doTag()方法，然后Tomcat会得到SkipPageException，它会跳过本页面其他内容！翻看源码即知。

标签属性

步骤：
1. 给你的标签处理类添加属性！
　　为标签处理类添加属性，属性至少要且一个set方法！这个set方法会在doTag()方法之前被tomcat执行！所在doTag()中就可以使用属性了。

2. 在tld文件中对属性进行配置

      <attribute>
          <name>test</name> 指定属性名
          <required>true</required> 指定属性是否为必需的
          <rtexprvalue>true</rtexprvalue> 指定属性是否可以使用EL

      </attribute>

例子

public class MyTag1 implements SimpleTag {
    private PageContext pageContext;
    private JspFragment body;

    /**
     * 所有的setXxx()方法都会在doTag()方法之前被tomcat调用！
     * 所在doTag()中就可以使用tomcat传递过来的对象了。
     */
    @Override
    public void doTag() throws JspException, IOException {
        pageContext.getOut().print("Hello Tag!");
    }

    @Override
    public JspTag getParent() {
        return null;
    }

    @Override
    public void setJspBody(JspFragment body) {
        this.body = body;
    }

    @Override
    public void setJspContext(JspContext context) {    
        this.pageContext = (PageContext) context;
    }

    public void setParent(JspTag arg0) {}
}

/**
 * SimpleTagSupport它实现了SimpleTag接口。
 *   它已经把所有的tomcat传递的数据都保存起来了！而且还提供了get方法供子类调用！
 * @author cxf
 *
 */
public class MyTag2 extends SimpleTagSupport {
    @Override
    public void doTag() throws JspException, IOException {
        this.getJspContext().getOut().print("再 Hello 一次 Tag!");
    }
}

public class MyTag3 extends SimpleTagSupport {
    @Override
    public void doTag() throws JspException, IOException {
        Writer out = this.getJspContext().getOut();//获取当前jsp页面的输出流
        out.write("******************<br/>");
        this.getJspBody().invoke(out);//执行标签体内容，把结果写到指定的流中，即页面上。
        out.write("<br/>******************");
    }
}
public class MyTag4 extends SimpleTagSupport {
    @Override
    public void doTag() throws JspException, IOException {
        this.getJspContext().getOut().print("只能看到我，下面什么都没有！");
        throw new SkipPageException();//抛出这个异常后，在本标签后面的内容，将看不到！
    }
}
public class MyTag5 extends SimpleTagSupport {
    private boolean test;

    /*
     * 这个方法会由tomcat来调用，并且在doTag()之前
     */
    public void setTest(boolean test) {
        this.test = test;
    }

    @Override
    public void doTag() throws JspException, IOException {
        if(test) {
            /*
             * 执行标签体
             */
            this.getJspBody().invoke(null);//如果传递的输出流为null，表示使用的就是当前页面的out！
        }
    }
}

tld文件定义

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

<taglib xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-jsptaglibrary_2_1.xsd"
    version="2.1">
   
  <tlib-version>1.0</tlib-version>
  <short-name>itcast</short-name>
  <uri>http://www.itcast.cn/tags/it-1.0</uri>
 
  <tag>
      <name>myTag1</name>
      <tag-class>cn.itcast.tag.MyTag1</tag-class>
      <body-content>empty</body-content>
  </tag>
 
  <tag>
      <name>myTag2</name>
      <tag-class>cn.itcast.tag.MyTag2</tag-class>
      <body-content>empty</body-content>
  </tag>
 
  <tag>
      <name>myTag3</name>
      <tag-class>cn.itcast.tag.MyTag3</tag-class>
      <body-content>scriptless</body-content>
  </tag>
 
  <tag>
      <name>myTag4</name>
      <tag-class>cn.itcast.tag.MyTag4</tag-class>
      <body-content>empty</body-content>
  </tag>
 
  <tag>
      <name>myTag5</name>
      <tag-class>cn.itcast.tag.MyTag5</tag-class>
      <body-content>scriptless</body-content>
      <attribute>
          <name>test</name>
          <required>true</required>
          <rtexprvalue>true</rtexprvalue>
      </attribute>
  </tag>
</taglib>
在页面中使用标签

<%@ taglib prefix="it" uri="/WEB-INF/tlds/itcast-tag.tld" %>

<it:myTag5 test="${empty param.xxx }">
  <h1><it:myTag4/></h1>
</it:myTag5>

<h1><it:myTag1/></h1>
<h2><it:myTag2/></h2>
<hr/>
<%
request.setAttribute("xxx", "zhangSan");
%>
<h3>
<it:myTag3>${xxx }</it:myTag3>
</h3>
<h3>
<it:myTag3>我是张三</it:myTag3>
</h3>