JSP自定义标签开发入门

来源：互联网发布：华微大数据营销平台编辑：程序博客网时间：2024/05/16 11:08

自定义标签的作用

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

自定义标签开发和使用

快速入门：使用标签输出客户机IP。
自定义标签开发步骤：

编写一个实现Tag接口的Java类(标签处理器类)
查看JSP规范文档，可知Tag接口有5个方法，编写一个标签处理器类去实现Tag接口显然是愚蠢的，再仔细看JSP规范文档，发现Tag接口有一个已知实现类——TagSupport，它实现了Tag接口所有的方法，所以我们只需要编写一个标签处理器类去继承TagSupport类，重写我们所需要的方法，不是更好嘛！！！

public class ViewIPTag extends TagSupport {    @Override    public int doStartTag() throws JspException {        HttpServletRequest request = (HttpServletRequest) this.pageContext.getRequest();        JspWriter out = this.pageContext.getOut();        String ip = request.getRemoteAddr();        try {            // 这里输出的时候会抛出IOException异常            out.print(ip);        } catch (IOException e) {            // 捕获IOException异常后继续抛出            throw new RuntimeException(e);        }        return super.doStartTag();    }}

编写标签库描述符（tld）文件，在tld文件中对标签处理器类进行描述。(tld文件的位置：WEB-INF下。可以抄F:\Tomcat_8\apache-tomcat-8.0.36\webapps\examples\WEB-INF\jsp2\jsp2-example-taglib.tld)
这里写图片描述
itcast.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>itcast</short-name>    <!--         为自定义标签库设置一个uri，uri可以写成诸如http://www.itcast.cn这样的形式，uri也可以/开头，/后面的内容随便写，如/liayun，        这样itcast.tld中的所有标签都绑定到<uri>http://www.itcast.cn</uri>上了。        在Jsp页面中引用标签库时，需要通过uri找到标签库，        在Jsp页面中就要这样引入标签库：<%@ taglib uri="http://www.itcast.cn" prefix="itcast" %>    -->    <uri>http://www.itcast.cn</uri>    <!--         一个taglib(标签库)中包含多个自定义标签，每一个自定义标签使用一个tag标记来描述，        一个tag标记对应一个自定义标签。     -->    <tag>        <!--             为标签处理器类配一个标签名，在Jsp页面中使用标签时是通过标签名来找到要调用的标签处理器类的，            通过viewIP就能找到对应的cn.itcast.web.tag.ViewIPTag类。            -->        <name>viewIP</name>        <!-- 标签对应的处理器类 -->        <tag-class>cn.itcast.web.tag.ViewIPTag</tag-class>        <body-content>empty</body-content> <!-- 标签有没有标签体 -->    </tag></taglib>

在Jsp页面中使用自定义标签
使用如下指令引入要使用的标签库。

<%@taglib uri="标签库的uri"  prefix="标签的使用前缀"%>

标签的使用前缀最好使用标签库描述符（tld）文件的名称，这样就能知道要使用的自定义标签来源于哪一个标签库描述符（tld）文件。
例如：在1.jsp中引用itcast标签库。

<%@ page language="java" contentType="text/html; charset=UTF-8"    pageEncoding="UTF-8"%><%@ taglib uri="http://www.itcast.cn" prefix="itcast" %><!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>输出客户端的IP</title></head><body>    您的IP是(使用java代码获取输出)：    <%        // 在jsp页面中使用java代码获取客户端IP地址        String ip = request.getRemoteAddr();        out.write(ip);    %>      <hr/>    您的IP是(使用自定义标签获取输出)：    <%--使用自定义标签viewIP --%>    <itcast:viewIP/></body></html>

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

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

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

自定义标签的执行流程

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方法。

用图来表示即为：
这里写图片描述
我们在tomcat服务器的“work\Catalina\localhost\day11\org\apache\jsp\tag”目录下可以找到将1.jsp翻译成Servlet后的java源代码，如下图所示：

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

/* * Generated by the Jasper component of Apache Tomcat * Version: Apache Tomcat/8.0.36 * Generated at: 2016-08-06 15:21:22 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.tag;import javax.servlet.*;import javax.servlet.http.*;import javax.servlet.jsp.*;public final class _1_jsp extends org.apache.jasper.runtime.HttpJspBase    implements org.apache.jasper.runtime.JspSourceDependent,                 org.apache.jasper.runtime.JspSourceImports {  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/itcast.tld", Long.valueOf(1470496089047L));  }  private static final java.util.Set<java.lang.String> _jspx_imports_packages;  private static final java.util.Set<java.lang.String> _jspx_imports_classes;  static {    _jspx_imports_packages = new java.util.HashSet<>();    _jspx_imports_packages.add("javax.servlet");    _jspx_imports_packages.add("javax.servlet.http");    _jspx_imports_packages.add("javax.servlet.jsp");    _jspx_imports_classes = null;  }  private org.apache.jasper.runtime.TagHandlerPool _005fjspx_005ftagPool_005fitcast_005fviewIP_005fnobody;  private volatile javax.el.ExpressionFactory _el_expressionfactory;  private volatile org.apache.tomcat.InstanceManager _jsp_instancemanager;  public java.util.Map<java.lang.String,java.lang.Long> getDependants() {    return _jspx_dependants;  }  public java.util.Set<java.lang.String> getPackageImports() {    return _jspx_imports_packages;  }  public java.util.Set<java.lang.String> getClassImports() {    return _jspx_imports_classes;  }  public javax.el.ExpressionFactory _jsp_getExpressionFactory() {    if (_el_expressionfactory == null) {      synchronized (this) {        if (_el_expressionfactory == null) {          _el_expressionfactory = _jspxFactory.getJspApplicationContext(getServletConfig().getServletContext()).getExpressionFactory();        }      }    }    return _el_expressionfactory;  }  public org.apache.tomcat.InstanceManager _jsp_getInstanceManager() {    if (_jsp_instancemanager == null) {      synchronized (this) {        if (_jsp_instancemanager == null) {          _jsp_instancemanager = org.apache.jasper.runtime.InstanceManagerFactory.getInstanceManager(getServletConfig());        }      }    }    return _jsp_instancemanager;  }  public void _jspInit() {    _005fjspx_005ftagPool_005fitcast_005fviewIP_005fnobody = org.apache.jasper.runtime.TagHandlerPool.getTagHandlerPool(getServletConfig());  }  public void _jspDestroy() {    _005fjspx_005ftagPool_005fitcast_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 java.lang.String _jspx_method = request.getMethod();if (!"GET".equals(_jspx_method) && !"POST".equals(_jspx_method) && !"HEAD".equals(_jspx_method) && !javax.servlet.DispatcherType.ERROR.equals(request.getDispatcherType())) {response.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED, "JSPs only permit GET POST or HEAD");return;}    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("\r\n");      out.write("\r\n");      out.write("<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">\r\n");      out.write("<html>\r\n");      out.write("<head>\r\n");      out.write("<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\r\n");      out.write("<title>输出客户端的IP</title>\r\n");      out.write("</head>\r\n");      out.write("<body>\r\n");      out.write("\t您的IP是(使用java代码获取输出)：\r\n");      out.write("\t");        // 在jsp页面中使用java代码获取客户端IP地址        String ip = request.getRemoteAddr();        out.write(ip);      out.write("\t\r\n");      out.write("\t<hr/>\r\n");      out.write("\t您的IP是(使用自定义标签获取输出)：\r\n");      out.write("\t");      out.write('\r');      out.write('\n');      out.write('   ');      if (_jspx_meth_itcast_005fviewIP_005f0(_jspx_page_context))        return;      out.write("\r\n");      out.write("</body>\r\n");      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 {            if (response.isCommitted()) {              out.flush();            } else {              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_itcast_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();    //  itcast:viewIP    cn.itcast.web.tag.ViewIPTag _jspx_th_itcast_005fviewIP_005f0 = (cn.itcast.web.tag.ViewIPTag) _005fjspx_005ftagPool_005fitcast_005fviewIP_005fnobody.get(cn.itcast.web.tag.ViewIPTag.class);    _jspx_th_itcast_005fviewIP_005f0.setPageContext(_jspx_page_context);    _jspx_th_itcast_005fviewIP_005f0.setParent(null);    int _jspx_eval_itcast_005fviewIP_005f0 = _jspx_th_itcast_005fviewIP_005f0.doStartTag();    if (_jspx_th_itcast_005fviewIP_005f0.doEndTag() == javax.servlet.jsp.tagext.Tag.SKIP_PAGE) {      _005fjspx_005ftagPool_005fitcast_005fviewIP_005fnobody.reuse(_jspx_th_itcast_005fviewIP_005f0);      return true;    }    _005fjspx_005ftagPool_005fitcast_005fviewIP_005fnobody.reuse(_jspx_th_itcast_005fviewIP_005f0);    return false;  }}

下面重点分析一下上述代码中如下方法：

private boolean _jspx_meth_itcast_005fviewIP_005f0(javax.servlet.jsp.PageContext _jspx_page_context)

这里是实例化一个viewIP标签处理器类cn.itcast.web.tag.ViewIPTag的对象

cn.itcast.web.tag.ViewIPTag _jspx_th_itcast_005fviewIP_005f0 = (cn.itcast.web.tag.ViewIPTag) _005fjspx_005ftagPool_005fitcast_005fviewIP_005fnobody.get(cn.itcast.web.tag.ViewIPTag.class);

实例化标签处理器后，调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器
```
_jspx_th_itcast_005fviewIP_005f0.setPageContext(_jspx_page_context);
```
setPageContext方法执行完后，接着调用setParent方法将当前标签的父标签传递给当前标签处理器，如果当前标签没有父标签，则传递给setParent方法的参数值为null
```
_jspx_th_itcast_005fviewIP_005f0.setParent(null);
```
调用了setPageContext方法和setParent方法之后，WEB容器执行到自定义标签的开始标记时，就会调用标签处理器的doStartTag方法
```
int _jspx_eval_itcast_005fviewIP_005f0 = _jspx_th_itcast_005fviewIP_005f0.doStartTag();
```
WEB容器执行完自定义标签的标签体后，就会接着去执行自定义标签的结束标记，此时，WEB容器会去调用标签处理器的doEndTag方法
```
if (_jspx_th_itcast_005fviewIP_005f0.doEndTag() == javax.servlet.jsp.tagext.Tag.SKIP_PAGE)
```

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

0 0