自定义标签的简介和运用

 

自定义标签的简介和运用

一   自定义标签的简介： 

1．使用自定义标签的目的：主要是移除jsp页面中的java代码

2．自定义标签的创建步骤：

（1）创建标签处理器----java类，要实现Tag接口（放置从jsp中移除的java

代码）

        （2）编写一个扩展名为.tld的文件（标签库的描述符文件），用来指定标签处理器的类所对应的标签是什么，和jsp中自定义标签想对应

    3．Jsp页面中使用自定义标签

       直接写上该标签即可

    4．标签处理器的介绍

       标签处理器要继承Tag接口

       1．Tag在javax.servelt.tagext.Tag,它的方法为：

     （1）doEndTag()开始标签

     （2）doStartTag()结束标签

注：开始标签和结束标签会自动调用标签处理器中的方法

     （3）getParent()是获取它的父标签对象

（4）setPageContext()把当前页面的pageContex对象传给标签处理器，在toStart之前调用。

注：This.pageContext.getOut()可通过这个方法得到所有的内置对象

     （5）release()方法释放资源

二  简单举例---获取IP地址

1．在java中要想得到客户端的IP为：

              <%

               //得到的是客户端的IP地址。是字符串类型的

               String ip = request.getRemoteAddr();

                out.print(ip);

               %>

   2．用自定义标签获取客户端的IP为：

（1）．先创建标签处理器，在标签处理器中获取IP，代码为：

public class CusTagDemo1 extends TagSupport {

               public int doStartTag() throws JspException {

       HttpServletRequest request = (HttpServletRequest) this.pageContext.getRequest();

       JspWriter out = this.pageContext.getOut();

        //得到的是客户端的IP地址,是字符串类型的

        String ip = request.getRemoteAddr();

        try {

               out.print(ip);

           } catch (IOException e) {

              // TODO Auto-generated catch block

              throw new RuntimeException();

           }

       return super.doStartTag();

    }

}

注：pageContext能够获取java中的九个内置对象，

通过pageContext获取request：this.pageContext.getRequest();

 this.pageContext.getRequest()获取的是ServeltRequest，要进行强制类型转换

（2）创建扩展名为.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">

        <tlib-version>1.0</tlib-version>

        <short-name>hbsi</short-name>    标签的前缀

        <!-- 包含所有的标签，和标签绑定 -->

        <uri>http://www.hbsi.edu.cn</uri> 

        <tag>

         <name>viewIP</name>  标签后缀

        <tag-class>com.hbsi.web.tag.CusTagDemo1</tag-class>所在的路径

           <!-- 标签体的内容 -->

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

</tag>

3．在jsp中调用

    您的IP是： <hbis:viewIP/>

三   自定义标签的执行过程

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

简单概述：

    先调用setPageContex方法--à调用setParent方法---à调用doStartTag方法-à调用doEndTag方法--à调用release方法（一般情况下调用）

四  自定义标签功能的扩展

1．完成页面逻辑，可以控制某一段程序是否被执行---继承Tag接口

    （1）通过doStartTag()的返回值决定是否处理标签体的内容

       //显示标签体的内容

       return Tag.EVAL_BODY_INCLUDE;

//不显示标签体的内容

       return Tag.SKIP_BODY;

（2）通过doEndTag()方法的返回值决定是否要继续处理jsp整个页面中该自定义标签之后的代码

       //不处理整个jsp页面

       return Tag.SKIP_PAGE;

       //处理整个jsp页面

return Tag.EVAL_PAGE;

    (3)通过doEndTag方法，遇到结束标签之后决定是否执行后续的部分 

       return Tag.SKIP_PAGE;

       <hbsi:demo3/> 把此标签可以放在最前边，当前的jsp页面不会执行

2．控制jsp页面某一部分内容重复执行---  继承IterationTag接口

  控制器的代码---核心代码

    public class CusTagDemo4 extends TagSupport {

        public int doStartTag() throws JspException {

       // TODO Auto-generated method stub

       return Tag.EVAL_BODY_INCLUDE;

        }

    // 循环显示

    int count = 5;

    public int doAfterBody() throws JspException {

       // TODO Auto-generated method stub

       count--;

       if (count > 0) {

           return IterationTag.EVAL_BODY_AGAIN;

       } else {

           return IterationTag.SKIP_BODY;

       }

    }

}

    注：执行的过程

（1）      将标签处理器实例化成对象

（2）      将调用标签处理器对象的setPageContex（）将jsp页面的pageContex对象做参数传给标签处理器

（3）      调用标签处理器对象的setParent（）将父标签对象做参数传给标签处理器

（4）      调用doStartTag（）方法返回值决定是否要执行标签体

（5）      标签体的处理

（6）      调用doAfterBody()方法---它的返回值可以决定是否要重复执行标签体的内容

调用doEndTag（）方法

 3．修改jsp页面并输出---转换大小

    控制器代码

    //能够获取到标签体的内容并进行修改，然后输出到客户端

public class CusTagDemo5 extends BodyTagSupport {

        public int doStartTag() throws JspException {

       return BodyTag.EVAL_BODY_BUFFERED;

    }

// 把内容封装在BodyContent对象，自动调用 setBodyTag方法，遇到尾标签调用doEndTag（） 调用方法

    // BodyContent对象

    public int doEndTag() throws JspException {

       // 获得标签体内容

       BodyContent bc = this.getBodyContent();

       String str = bc.getString();

       str = str.toUpperCase();

       try {

           pageContext.getOut().write(str);

       } catch (IOException e) {

           // TODO Auto-generated catch block

           throw new RuntimeException();

       }

       return Tag.EVAL_PAGE;

    }