JSP学习-09-自定义标签

JSP 自定义标签

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

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

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

自定义标签主要用于移除Jsp页面中的java代码。

自定义标签开发步骤

标签格式为：

<ex:Hello />

自定义标签开发步骤

　　　1、编写一个实现Tag接口的Java类(标签处理器类)

package com.dtt.test;

import java.io.IOException;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.Tag;

public class ViewIP implements Tag {

    //接收传递进来的PageContext对象
    private PageContext pageContext;
    
    @Override
    public int doEndTag() throws JspException {
        System.out.println("调用doEndTag()方法");
        return 0;
    }

    @Override
    public int doStartTag() throws JspException {
        System.out.println("调用doStartTag()方法");
        HttpServletRequest request =(HttpServletRequest) pageContext.getRequest();
        JspWriter out = pageContext.getOut();
        String ip = request.getRemoteAddr();
        try {
            //这里输出的时候会抛出IOException异常
            out.write(ip);
        } catch (IOException e) {
            //捕获IOException异常后继续抛出
            throw new RuntimeException(e);
        }
        return 0;
    }

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

    @Override
    public void release() {
        System.out.println("调用release()方法");
    }

    @Override
    public void setPageContext(PageContext pageContext) {
        System.out.println("setPageContext(PageContext pageContext)");
        this.pageContext = pageContext;
    }

    @Override
    public void setParent(Tag arg0) {

    }

}

在WEB-INF/目录下新建tld文件，在tld文件中对标签处理器类进行描述

如下代码

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

<taglib xmlns="http://java.sun.com/xml/ns/j2ee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-jsptaglibrary_2_0.xsd"
    version="2.0">
    <!-- description用来添加对taglib(标签库)的描述 -->
    <description>自定义标签库</description>
    <!--taglib(标签库)的版本号 -->
    <tlib-version>1.0</tlib-version>
    <short-name>GaclTagLibrary</short-name>
    <!-- 
        为自定义标签库设置一个uri，uri以/开头，/后面的内容随便写，如这里的/dtt ，
        在Jsp页面中引用标签库时，需要通过uri找到标签库
        在Jsp页面中就要这样引入标签库：<%@taglib uri="/dtt" prefix="dtt"%>
    -->
    <uri>/dtt</uri>
    
    <!--一个taglib(标签库)中包含多个自定义标签，每一个自定义标签使用一个tag标记来描述  -->
    <!-- 一个tag标记对应一个自定义标签 -->
     <tag>
        <description>这个标签的作用是用来输出客户端的IP地址</description>
        
        <name>viewIP</name>
        <!-- 标签对应的处理器类-->
        <tag-class>com.dtt.test.ViewIP</tag-class>
        <body-content>empty</body-content><!-- body-content为标签体的限制，它有4个值： EMPTY【不允许有标签体】，JSP【允许有JSP代码】 ，scriptless【不允许有脚本代码（也就是<%%>），允许有EL表达式，文本，JSP行为】 ， tagdepentend【标签体内的JSP代码不会被解析，直接输出文本】

-->
    </tag>
    
</taglib>

在Jsp页面中使用自定义标签

　　1、使用"<%@taglib uri="标签库的uri" prefix="标签的使用前缀"%>"指令引入要使用的标签库。

例如：在Test01.jsp中引用dtt标签库

<%@ page language="java" pageEncoding="UTF-8"%>
<!-- 使用taglib指令引用gacl标签库，标签库的前缀(prefix)可以随便设置，如这里设置成 prefix="xdp" -->
<%@taglib uri="/dtt"  prefix="dtt"%>
<!DOCTYPE HTML>
<html>
  <head>
    <title>输出客户端的IP</title>
  </head>
  
  <body>
    你的IP地址是(使用java代码获取输出)：
    <%
        //在jsp页面中使用java代码获取客户端IP地址
        String ip = request.getRemoteAddr();
        out.write(ip);
    %>
    <hr/>
     你的IP地址是(使用自定义标签获取输出)：
     <%--使用自定义标签viewIP --%>
     <dtt:viewIP/>
  </body>
</html>

从运行效果种可以看到，使用自定义标签就可以将jsp页面上的java代码移除掉，如需要在jsp页面上输出客户端的IP地址时，使用 <xdp:viewIP/>标签就可以代替jsp页面上的这些代码：

自定义标签的执行流程

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

Test.java代码如下

/*
 * Generated by the Jasper component of Apache Tomcat
 * Version: Apache Tomcat/7.0.52
 * Generated at: 2018-10-22 07:13:31 UTC
 * Note: The last modified time of this file was set to
 *       the last modified time of the source file after
 *       generation to assist with modification tracking.
 */
package org.apache.jsp;

import javax.servlet.*;
import javax.servlet.http.*;
import javax.servlet.jsp.*;

public final class Test01_jsp extends org.apache.jasper.runtime.HttpJspBase
    implements org.apache.jasper.runtime.JspSourceDependent {

  private static final javax.servlet.jsp.JspFactory _jspxFactory =
          javax.servlet.jsp.JspFactory.getDefaultFactory();

  private static java.util.Map<java.lang.String,java.lang.Long> _jspx_dependants;

  static {
    _jspx_dependants = new java.util.HashMap<java.lang.String,java.lang.Long>(1);
    _jspx_dependants.put("/WEB-INF/dtt.tld", Long.valueOf(1540192400000L));
  }

  private org.apache.jasper.runtime.TagHandlerPool _005fjspx_005ftagPool_005fdtt_005fviewIP_005fnobody;

  private javax.el.ExpressionFactory _el_expressionfactory;
  private org.apache.tomcat.InstanceManager _jsp_instancemanager;

  public java.util.Map<java.lang.String,java.lang.Long> getDependants() {
    return _jspx_dependants;
  }

  public void _jspInit() {
    _005fjspx_005ftagPool_005fdtt_005fviewIP_005fnobody = org.apache.jasper.runtime.TagHandlerPool.getTagHandlerPool(getServletConfig());
    _el_expressionfactory = _jspxFactory.getJspApplicationContext(getServletConfig().getServletContext()).getExpressionFactory();
    _jsp_instancemanager = org.apache.jasper.runtime.InstanceManagerFactory.getInstanceManager(getServletConfig());
  }

  public void _jspDestroy() {
    _005fjspx_005ftagPool_005fdtt_005fviewIP_005fnobody.release();
  }

  public void _jspService(final javax.servlet.http.HttpServletRequest request, final javax.servlet.http.HttpServletResponse response)
        throws java.io.IOException, javax.servlet.ServletException {

    final javax.servlet.jsp.PageContext pageContext;
    javax.servlet.http.HttpSession session = null;
    final javax.servlet.ServletContext application;
    final javax.servlet.ServletConfig config;
    javax.servlet.jsp.JspWriter out = null;
    final java.lang.Object page = this;
    javax.servlet.jsp.JspWriter _jspx_out = null;
    javax.servlet.jsp.PageContext _jspx_page_context = null;


    try {
      response.setContentType("text/html;charset=UTF-8");
      pageContext = _jspxFactory.getPageContext(this, request, response,
      			null, true, 8192, true);
      _jspx_page_context = pageContext;
      application = pageContext.getServletContext();
      config = pageContext.getServletConfig();
      session = pageContext.getSession();
      out = pageContext.getOut();
      _jspx_out = out;

      out.write("
");
      out.write("<!-- 使用taglib指令引用gacl标签库，标签库的前缀(prefix)可以随便设置，如这里设置成 prefix="xdp" -->
");
      out.write("
");
      out.write("<!DOCTYPE HTML>
");
      out.write("<html>
");
      out.write("  <head>
");
      out.write("    <title>输出客户端的IP</title>
");
      out.write("  </head>
");
      out.write("  
");
      out.write("  <body>
");
      out.write("    你的IP地址是(使用java代码获取输出)：
");
      out.write("    ");

        //在jsp页面中使用java代码获取客户端IP地址
        String ip = request.getRemoteAddr();
        out.write(ip);
    
      out.write("
");
      out.write("    <hr/>
");
      out.write("     你的IP地址是(使用自定义标签获取输出)：
");
      out.write("     ");
      out.write("
");
      out.write("     ");
      if (_jspx_meth_dtt_005fviewIP_005f0(_jspx_page_context))
        return;
      out.write("
");
      out.write("  </body>
");
      out.write("</html>");
    } catch (java.lang.Throwable t) {
      if (!(t instanceof javax.servlet.jsp.SkipPageException)){
        out = _jspx_out;
        if (out != null && out.getBufferSize() != 0)
          try { out.clearBuffer(); } catch (java.io.IOException e) {}
        if (_jspx_page_context != null) _jspx_page_context.handlePageException(t);
        else throw new ServletException(t);
      }
    } finally {
      _jspxFactory.releasePageContext(_jspx_page_context);
    }
  }

  private boolean _jspx_meth_dtt_005fviewIP_005f0(javax.servlet.jsp.PageContext _jspx_page_context)
          throws java.lang.Throwable {
    javax.servlet.jsp.PageContext pageContext = _jspx_page_context;
    javax.servlet.jsp.JspWriter out = _jspx_page_context.getOut();
    //  dtt:viewIP
    com.dtt.test.ViewIP _jspx_th_dtt_005fviewIP_005f0 = (com.dtt.test.ViewIP) _005fjspx_005ftagPool_005fdtt_005fviewIP_005fnobody.get(com.dtt.test.ViewIP.class);
    _jspx_th_dtt_005fviewIP_005f0.setPageContext(_jspx_page_context);
    _jspx_th_dtt_005fviewIP_005f0.setParent(null);
    int _jspx_eval_dtt_005fviewIP_005f0 = _jspx_th_dtt_005fviewIP_005f0.doStartTag();
    if (_jspx_th_dtt_005fviewIP_005f0.doEndTag() == javax.servlet.jsp.tagext.Tag.SKIP_PAGE) {
      _005fjspx_005ftagPool_005fdtt_005fviewIP_005fnobody.reuse(_jspx_th_dtt_005fviewIP_005f0);
      return true;
    }
    _005fjspx_005ftagPool_005fdtt_005fviewIP_005fnobody.reuse(_jspx_th_dtt_005fviewIP_005f0);
    return false;
  }
}

下面重点分析一下上述代码中标红色的那个 private boolean _jspx_meth_xdp_005fviewIP_005f0(PageContext _jspx_page_context)方法中的代码

　　①、这里是实例化一个viewIP标签处理器类me.gacl.web.tag.ViewIPTag的对象

1  //  xdp:viewIP
2     me.gacl.web.tag.ViewIPTag _jspx_th_xdp_005fviewIP_005f0 = (me.gacl.web.tag.ViewIPTag) _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody.get(me.gacl.web.tag.ViewIPTag.class);

　　②、实例化标签处理器后，调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器

1 _jspx_th_xdp_005fviewIP_005f0.setPageContext(_jspx_page_context);

　　③、setPageContext方法执行完后，接着调用的setParent方法将当前标签的父标签传递给当前标签处理器，如果当前标签没有父标签，则传递给setParent方法的参数值为null

1 _jspx_th_xdp_005fviewIP_005f0.setParent(null);

　　④、调用了setPageContext方法和setParent方法之后，WEB容器执行到自定义标签的开始标记时，就会调用标签处理器的doStartTag方法

1 int _jspx_eval_xdp_005fviewIP_005f0 = _jspx_th_xdp_005fviewIP_005f0.doStartTag();

　　⑤、WEB容器执行完自定义标签的标签体后，就会接着去执行自定义标签的结束标记，此时，WEB容器会去调用标签处理器的doEndTag方法

1 if (_jspx_th_xdp_005fviewIP_005f0.doEndTag() == javax.servlet.jsp.tagext.Tag.SKIP_PAGE)

package javax.servlet.jsp.tagext;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;

public abstract interface Tag
  extends JspTag
{
  public static final int SKIP_BODY = 0;
  public static final int EVAL_BODY_INCLUDE = 1;
  public static final int SKIP_PAGE = 5;
  public static final int EVAL_PAGE = 6;
  
  public abstract void setPageContext(PageContext paramPageContext);
  
  public abstract void setParent(Tag paramTag);
  
  public abstract Tag getParent();
  
  public abstract int doStartTag()
    throws JspException;
  
  public abstract int doEndTag()
    throws JspException;
  
  public abstract void release();
}

我们现在已经清楚了方法的执行顺序了，可Tag接口的源码还有4个变量阿，它们是用来做什么的呢？我们在编写JSP页面时，经常需要在页面中引入一些逻辑，例如：
- 控制JSP页面某一部分（标签体）是否执行
- 控制整个JSP页面是否执行
- 控制JSP页面内容重复执行
- 修改JSP页面内容输出

doStartTag()方法使用的是SKIP_BODY和EVAL_BODY_INCLUDE这两个变量，判断是否执行标签体的内容。
doEndTag()方法使用的是SKIP_PAGE和EVAL_PAGE这两个变量，判断是否执行剩下页面的内容
控制JSP页面内容重复执行和修改JSP页面内容输出后面会有！

相关阅读:
js工具库
 细说log4j之log4j 1.x
细说log4j之概述
 细说RESTful API安全之概述
 【转】javascript代码混淆和压缩
 细说RESTful API之入门介绍
 j2ee应用开发调试工具
 java定时器实现总结
 浏览器书签同步工具
 简单备份mysql数据库策略及实现方式
原文地址：https://www.cnblogs.com/mtime2004/p/9813563.html