本文共 8695 字，大约阅读时间需要 28 分钟。

一、自定义标签的作用

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

二、自定义标签开发和使用

2.1、自定义标签开发步骤

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

package me.gacl.web.tag;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 ViewIPTag 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) {    }}

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

　　

　　gacl.tld文件的代码如下：

   
       
        
    
     奋斗的小虾米的自定义标签库
        
        
    
     1.0
        
    
     GaclTagLibrary
        
        
    
     /gacl
        
        
         
            
     
      这个标签的作用是用来输出客户端的IP地址
             
             
     
      viewIP
             
             
     
      me.gacl.web.tag.ViewIPTag
             
     
      empty
         
    
   

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

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

例如：在jspTag_Test1.jsp中引用gacl标签库

<%@ page language="java" pageEncoding="UTF-8"%>
   <%@taglib uri="/gacl"  prefix="xdp"%>              你的IP地址是(使用java代码获取输出)：    <%        //在jsp页面中使用java代码获取客户端IP地址        String ip = request.getRemoteAddr();        out.write(ip);    %>    
   
     你的IP地址是(使用自定义标签获取输出)：     <%--使用自定义标签viewIP --%>     
     

　标签的运行效果如下：

　　

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

1 <%2         //在jsp页面中使用java代码获取客户端IP地址3         String ip = request.getRemoteAddr();4         out.write(ip);5 %>

　　这就是开发和使用自定义标签的好处，可以让我们的Jsp页面上不嵌套java代码。

三、自定义标签的执行流程

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

    1、public void setPageContext(PageContext pc)， JSP引擎实例化标签处理器后，将调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器，标签处理器以后可以通过这个pageContext对象与JSP页面进行通信。     2、public void setParent(Tag t)，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方法。

 　　我们在tomcat服务器的"work\Catalina\localhost\JavaWeb_JspTag_study_20140816\org\apache\jsp"目录下可以找到将jspTag_Test1.jsp翻译成Servlet后的java源代码，如下图所示：

　　打开jspTag_005fTest1_jsp.java文件，可以看到setPageContext(PageContext pc)、setParent(Tag t)、doStartTag()、doEndTag()、release()这5个方法的调用顺序和过程。

　　jspTag_005fTest1_jsp.java的代码如下：

package org.apache.jsp;import javax.servlet.*;import javax.servlet.http.*;import javax.servlet.jsp.*;public final class jspTag_005fTest1_jsp extends org.apache.jasper.runtime.HttpJspBase    implements org.apache.jasper.runtime.JspSourceDependent {  private static final JspFactory _jspxFactory = JspFactory.getDefaultFactory();  private static java.util.List _jspx_dependants;  static {    _jspx_dependants = new java.util.ArrayList(1);    _jspx_dependants.add("/WEB-INF/gacl.tld");  }  private org.apache.jasper.runtime.TagHandlerPool _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody;  private javax.el.ExpressionFactory _el_expressionfactory;  private org.apache.AnnotationProcessor _jsp_annotationprocessor;  public Object getDependants() {    return _jspx_dependants;  }  public void _jspInit() {    _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody = org.apache.jasper.runtime.TagHandlerPool.getTagHandlerPool(getServletConfig());    _el_expressionfactory = _jspxFactory.getJspApplicationContext(getServletConfig().getServletContext()).getExpressionFactory();    _jsp_annotationprocessor = (org.apache.AnnotationProcessor) getServletConfig().getServletContext().getAttribute(org.apache.AnnotationProcessor.class.getName());  }  public void _jspDestroy() {    _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody.release();  }  public void _jspService(HttpServletRequest request, HttpServletResponse response)        throws java.io.IOException, ServletException {    PageContext pageContext = null;    HttpSession session = null;    ServletContext application = null;    ServletConfig config = null;    JspWriter out = null;    Object page = this;    JspWriter _jspx_out = null;    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("\r\n");      out.write("
   \r\n");      out.write("\r\n");      out.write("\r\n");      out.write("\r\n");      out.write("  \r\n");      out.write("    \r\n");      out.write("  \r\n");      out.write("  \r\n");      out.write("  \r\n");      out.write("    你的IP地址是(使用java代码获取输出)：\r\n");      out.write("    ");        //在jsp页面中使用java代码获取客户端IP地址        String ip = request.getRemoteAddr();        out.write(ip);      out.write("\r\n");      out.write("    
   
\r\n");      out.write("     你的IP地址是(使用自定义标签获取输出)：");      if (_jspx_meth_xdp_005fviewIP_005f0(_jspx_page_context))        return;      out.write("\r\n");      out.write("  \r\n");      out.write("\r\n");    } catch (Throwable t) {      if (!(t instanceof 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);      }    } finally {      _jspxFactory.releasePageContext(_jspx_page_context);    }  }  private boolean _jspx_meth_xdp_005fviewIP_005f0(PageContext _jspx_page_context)          throws Throwable {    PageContext pageContext = _jspx_page_context;    JspWriter out = _jspx_page_context.getOut();    //  xdp:viewIP    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);    _jspx_th_xdp_005fviewIP_005f0.setPageContext(_jspx_page_context);    _jspx_th_xdp_005fviewIP_005f0.setParent(null);    int _jspx_eval_xdp_005fviewIP_005f0 = _jspx_th_xdp_005fviewIP_005f0.doStartTag();    if (_jspx_th_xdp_005fviewIP_005f0.doEndTag() == javax.servlet.jsp.tagext.Tag.SKIP_PAGE) {      _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody.reuse(_jspx_th_xdp_005fviewIP_005f0);      return true;    }    _005fjspx_005ftagPool_005fxdp_005fviewIP_005fnobody.reuse(_jspx_th_xdp_005fviewIP_005f0);    return false;  }}

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

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

1  //  xdp:viewIP2     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)

　　这就是自定义标签的执行流程。

　　这里以一个入门级的案例来讲解javaweb的自定义标签开发，在后面的博文中会进行更加详尽的介绍。

转载地址：http://wnkr.baihongyu.com/