JSP 自定义标签

时间：2021-01-25 04:52:49

0 标签技术的API继承体系

JSP 自定义标签

1 作用

jsp自定义标签用于移除页面中的java代码

2 实现

2.1 标签处理类ViewIPTag.java

 package com.zsm.util;

 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;

 //pom中需要添加jsp-api依赖

 public class ViewIPTag implements Tag {

     // 接收传递进来的PageContext对象

     private PageContext pageContext;

     public void setPageContext(PageContext pageContext) {

         System.out.println("setPageContext(PageContext pageContext)");

         this.pageContext = pageContext;

     }

     public void setParent(Tag arg0) {

         System.out.println("调用setParent()方法");

     }

     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;

     }

     public int doEndTag() throws JspException {

         System.out.println("调用doEndTag()方法");

         return 0;

     }

     public void release() {

         System.out.println("调用release()方法");

     }

     public Tag getParent() {

         System.out.println("调用getParent()方法");

         return null;

     }

 }

2.2 自定义标签ZsmCustomTag.tld

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

 <!--置于WEB_INF下-->

 <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>ZsmTagLibrary</short-name>

     <!--

     为自定义标签库设置一个uri，uri以/开头，/后面的内容随便写，如这里的/zsm ，

     在Jsp页面中引用标签库时，需要通过uri找到标签库

     在Jsp页面中就要这样引入标签库：<%@taglib uri="/zsm" prefix="zsm"%>

     -->

     <uri>/zsm</uri>

     <!--一个taglib(标签库)中包含多个自定义标签，每一个自定义标签使用一个tag标记来描述  -->

     <!-- 一个tag标记对应一个自定义标签 -->

     <tag>

         <description>这个标签的作用是用来输出客户端的IP地址</description>

         <!--

         为标签处理器类配一个标签名，在Jsp页面中使用标签时是通过标签名来找到要调用的标签处理器类的

         通过viewIP就能找到对应的com.zsm.util.ViewIPTag类

         -->

         <name>viewIP</name>

         <!-- 标签对应的处理器类-->

         <tag-class>com.zsm.util.ViewIPTag</tag-class>

         <body-content>empty</body-content>

     </tag>

 </taglib>

2.3 页面jspCustomTag.jsp

 <%@ page language="java" pageEncoding="UTF-8"%>

 <!-- 使用taglib指令引用gacl标签库，标签库的前缀(prefix)可以随便设置，如这里设置成 prefix="xdp" -->

 <%@taglib uri="/zsm" prefix="xdp"%>

 <!DOCTYPE HTML>

 <html>

 <head>

 <title>输出客户端的IP</title>

 </head>

 <body>

     你的IP地址是(使用java代码获取输出)：

     <%

     //在jsp页面中使用java代码获取客户端IP地址

     String ip = request.getRemoteAddr();

     out.write(ip);

 %>

     <hr />

     你的IP地址是(使用自定义标签获取输出)：

     <%--使用自定义标签viewIP --%>

     <xdp:viewIP />

 </body>

 </html>

参考资料：

http://www.cnblogs.com/xdp-gacl/p/3916734.html

3 进阶

　　传统标自定义标签（实现Tag接口）开发：http://www.cnblogs.com/xdp-gacl/p/3916946.html

　　简单自定义标签（实现SimpleTag接口）开发：http://www.cnblogs.com/xdp-gacl/p/3916968.html

　　由于传统标签使用三个标签接口来完成不同的功能，显得过于繁琐，不利于标签技术的推广， SUN公司为降低标签技术的学习难度，在JSP 2.0中定义了一个更为简单、便于编写和调用的SimpleTag接口来实现标签的功能。

实现SimpleTag接口的标签通常称为简单标签。简单标签共定义了5个方法：

  • setJspContext方法
  • setParent和getParent方法
  • setJspBody方法
  • doTag方法(非常重要)，简单标签使用这个方法就可以完成所有的业务逻辑

3.1 SimpleTag方法介绍

3.1.1 setJspContext方法

　　用于把JSP页面的pageContext对象传递给标签处理器对象

3.1.2 setParent方法

　　用于把父标签处理器对象传递给当前标签处理器对象

3.1.3 getParent方法

用于获得当前标签的父标签处理器对象

3.1.4 setJspBody方法

　　用于把代表标签体的JspFragment对象传递给标签处理器对象

3.1.5 doTag方法

　　用于完成所有的标签逻辑，包括输出、迭代、修改标签体内容等。在doTag方法中可以抛出javax.servlet.jsp.SkipPageException异常，用于通知WEB容器不再执行JSP页面中位于结束标记后面的内容，这等效于在传统标签的doEndTag方法中返回Tag.SKIP_PAGE常量的情况。

3.2 SimpleTag接口方法的执行顺序

　　当web容器开始执行标签时，会调用如下方法完成标签的初始化：

  1. WEB容器调用标签处理器对象的setJspContext方法，将代表JSP页面的pageContext对象传递给标签处理器对象。
  2. WEB容器调用标签处理器对象的setParent方法，将父标签处理器对象传递给这个标签处理器对象。注意，只有在标签存在父标签的情况下，WEB容器才会调用这个方法。
  3. 如果调用标签时设置了属性，容器将调用每个属性对应的setter方法把属性值传递给标签处理器对象。如果标签的属性值是EL表达式或脚本表达式，则WEB容器首先计算表达式的值，然后把值传递给标签处理器对象。
  4. 如果简单标签有标签体，WEB容器将调用setJspBody方法把代表标签体的JspFragment对象传递进来。
  5. 执行标签时WEB容器调用标签处理器的doTag()方法，开发人员在方法体内通过操作JspFragment对象，就可以实现是否执行、迭代、修改标签体的目的。

3.3 开发简单标签实现页面逻辑

　　SUN公司针对SimpleTag接口提供了一个默认的实现类SimpleTagSupport，SimpleTagSupport类中实现了SimpleTag接口的所有方法，因此我们可以编写一个类继承SimpleTagSupport类，然后根据业务需要再重写doTag方法。

4 导出自定义标签

参考资料：http://www.cnblogs.com/xdp-gacl/p/3916976.html#blogTitle7

相关文章