1.4(学习笔记)JSP自定义标签

àì夳堔傛蜴生んèń 2021-12-16 15:59 239阅读 0赞

一、JSP自定义标签

JSP自定义标签，可以通过实现Tag接口、继承TagSupport类来设置标签功能。

后续通过配置文件将标签和具体的实现类关联。

二、自定义第一个标签（实现Tag接口）

自定义标签需要先创建一个Java类，然后实现Tge接口或者继承S.....类

我们先来看实现接口这种方法自定义标签：

2.1创建Java类

HelloTag.java

import java.io.IOException;
    
    import javax.servlet.jsp.JspException;
    import javax.servlet.jsp.JspWriter;
    import javax.servlet.jsp.PageContext;
    import javax.servlet.jsp.tagext.Tag;
    
    public class HelloTag implements Tag {
        
        private PageContext pageContext;
        
        @Override
        public int doEndTag() throws JspException {
            // TODO Auto-generated method stub
            System.out.println("endTag");
            return EVAL_PAGE;//继续显示该标签后续内容
        }
    
        @Override
        public int doStartTag() throws JspException {
            // TODO Auto-generated method stub
            String msg = "MyTag";
            JspWriter out = pageContext.getOut();
            try {
                out.println(msg);
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
            System.out.println("startTag");
            return EVAL_BODY_INCLUDE;//显示标签体中的内容
        }
    
        @Override
        public Tag getParent() {
            // TODO Auto-generated method stub
            return null;
        }
    
        @Override
        public void release() {
            // TODO Auto-generated method stub
        }
    
        @Override
        public void setPageContext(PageContext pageContext) {
            // TODO Auto-generated method stub
            //获取JSP页面的pageContext
            this.pageContext = pageContext;
            System.out.println("pageContext");
        }
    
        @Override
        public void setParent(Tag arg0) {
            // TODO Auto-generated method stub
        }
        
    }

2.2创建好java类后，需要创建配置文件

2.2.1创建my\_tag\_config.tld文件

在WEB-INF文件夹下新建XML文件。

![1435315-20190131121440774-990969650.png][]

将.xml改为.tld（结果如下图所示）

![1435315-20190131121618055-999365838.png][]

点击next,进入如下页面。（结果如下图所示）

![1435315-20190131121825765-1965271381.png][]

点击next（结果如下图所示）

![1435315-20190131122141059-165628449.png][]

点击next，（效果如下图所示）

![1435315-20190131122234330-55137234.png][]

点击finish，创建结束。

打开创建好的文件，效果如下图所示。

![1435315-20190131122334648-543593296.png][]

接着我们就要对其进行配置，将标签和我们创建的类关联。

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN" "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd" >
    <taglib>
      <tlib-version>1.0</tlib-version>
      <jsp-version>1.2</jsp-version>
      <short-name>short-name</short-name>
      
      
      <uri>http://www.myTag.com</uri>
      
      <tag>
        <name>hello</name>   
        <tag-class>com.myTag.HelloTag</tag-class>  
        <body-content>JSP</body-content> 
      </tag>
    </taglib>

其中<body-content>中的属性有四种：

tagdependent,empty,JSP,

各个属性的含义可参阅：[https://www.cnblogs.com/keyi/p/7127685.html][https_www.cnblogs.com_keyi_p_7127685.html]

以上都配置好了后，我们就来使用标签。

**tag.jsp**

<%@ page language="java" contentType="text/html; charset=UTF-8"
        pageEncoding="UTF-8"%>
    
    
    <%@ taglib uri="http://www.myTag.com" prefix = "m" %>
    
    <!DOCTYPE html>
    <html>
    <head>
    <meta charset="UTF-8">
    <title>Insert title here</title>
    </head>
    <body>
        <m:hello>include body</m:hello>
    </body>
    </html>

![1435315-20190131160013908-135535654.png][]

自定义标签的功能是输出“MyTag”，结果正常输出。

我们来看下控制台的输出：

![1435315-20190131130410851-1715073357.png][]

最后我们分析下标签的执行流程

我们看下tag.jsp生存的servlet中的代码：

![1435315-20190131131010677-1337806944.png][]

Servlet中调用了一个方法，我们来看下这个方法

![1435315-20190131131056294-186909414.png][]

查看代码可以很清楚的看到自定义标签的执行流程。

三、自定义out标签（继承TagSupport类实现）

java类

import java.io.IOException;
    
    import javax.servlet.jsp.JspException;
    import javax.servlet.jsp.JspWriter;
    import javax.servlet.jsp.PageContext;
    import javax.servlet.jsp.tagext.TagSupport;
    
    public class HelloTagEx extends TagSupport {
        private String value;
        private JspWriter out;
        
        public void setValue(String value) {
        //设置值
            this.value = value;
        }
    
        @Override
        public int doStartTag() throws JspException {
            // TODO Auto-generated method stub
    　　　　  //不重写setPageContext方法，也可直接使用pageContext
    　　　　　// 例如： this.out = pageContext.getOut();
            try {
                out.println(value); //将设置的value输出
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
            return SKIP_BODY;//不输出标签体中内容
        }
        
        @Override
        public int doEndTag() throws JspException {
            // TODO Auto-generated method stub
            return SKIP_PAGE;//不输出界面后续内容
        }
        
        @Override
        public int doAfterBody() throws JspException {
            // TODO Auto-generated method stub
            
            return super.doAfterBody();
        }
        
        @Override //此方法也可以不重写，在doStartTag、doEndTag中可以直接使用pageContext 　　　　　　　　　 public void setPageContext(PageContext pageContext) {
            this.pageContext = pageContext;
            this.out = pageContext.getOut();
        }
    }

标签配置：

<tag>
              <name>helloEx</name>
              <tag-class>com.myTag.HelloTagEx</tag-class>
             <body-content>JSP</body-content>  
             
              <attribute>
                  <name>value</name>  
                  <required>true</required>      
                  <rtexprvalue>true</rtexprvalue> 
              </attribute>
        </tag>

**tag.jsp**

![1435315-20190131162703699-1945261874.png][]

四、自定义if标签

有了前面两个作为基础，后面的就很简单了。

标签类

import javax.servlet.jsp.JspException;
    import javax.servlet.jsp.tagext.TagSupport;
    
    public class IF extends TagSupport{
        private boolean flag;
        
        public void setFlag(boolean flag) {
            this.flag = flag;
        }
        
        @Override
        public int doStartTag() throws JspException {
            // TODO Auto-generated method stub
            if(flag == true) {
        //如果为true，标签体中内容执行，反正不执行。
                return EVAL_BODY_INCLUDE;
            }else {
                return SKIP_BODY;
            }
        }
        
        @Override
        public int doEndTag() throws JspException {
            // TODO Auto-generated method stub
            return EVAL_PAGE;//IF标签结束后，继续执行页面内容
        }
        
        
    }

配置：

<tag>
              <name>IF</name>
              <tag-class>com.myTag.IF</tag-class>
             <body-content>JSP</body-content>  
             
              <attribute>
                  <name>flag</name>  
                  <required>true</required>      
                  <rtexprvalue>true</rtexprvalue> 
              </attribute>
        </tag>

tag.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8"
        pageEncoding="UTF-8"%>
    
    
    <%@ taglib uri="http://www.myTag.com" prefix = "m" %>
    
    <!DOCTYPE html>
    <html>
    <head>
    <meta charset="UTF-8">
    <title>Insert title here</title>
    </head>
    <body>
        <m:IF flag="${3>2}">
            true
        </m:IF>
    </body>
    </html>

![1435315-20190131164036445-1335025619.png][]

五、自定义foreach标签

标签类：ForEach.java

import java.util.Iterator;
    import java.util.List;
    
    import javax.servlet.jsp.JspException;
    import javax.servlet.jsp.tagext.TagSupport;
    
    public class ForEach extends TagSupport {
        
        private List<String> list;
        private String var;
    
        public void setList(List<String> list) {
            this.list = list;
        }
        
        public void setVar(String var) {
            this.var = var;
        }
        
        @Override
        public int doStartTag() throws JspException {
            // TODO Auto-generated method stub
            if(list == null) {
                return SKIP_BODY;
            }else {
                Iterator<String> items = list.iterator(); 
                pageContext.setAttribute("ite", items);
                pageContext.setAttribute("list", list);
                //由于doStartTage方法结束后是输出标签体，
                //而标签体中有${var}表达式用于输出迭代对象
                //所以此处最好先拿出一个对象。
                if(items.hasNext()) {
        //如果迭代器中有元素，设置值，并输出标签体
                    pageContext.setAttribute(var, items.next());
                    return EVAL_BODY_INCLUDE;
                }else {
        //反之则不输出标签体
                    return SKIP_BODY;
                }
                
            }
        }
        
        @Override
        public int doAfterBody() throws JspException {
            // TODO Auto-generated method stub
            //获取迭代器
            Iterator<String> items = (Iterator<String>)pageContext.getAttribute("ite");
            if(items.hasNext()) {
        //将其中元素取出，并设置。
                String value = (String) items.next();
                pageContext.setAttribute(var, value);
                return EVAL_BODY_AGAIN; //再一次执行标签体
            }else {
                return SKIP_BODY; //迭代器为空，则停止输出标签体
            }
        }
        
        @Override
        public int doEndTag() throws JspException {
        //结束标签后的内容继续输出
            // TODO Auto-generated method stub
            return EVAL_PAGE;
        }
    }

配置：

<tag>
              <name>FOREACH</name>
              <tag-class>com.myTag.ForEach</tag-class>
             <body-content>JSP</body-content>  
             
             <attribute>
                  <name>var</name>  
                  <required>true</required>      
                  <rtexprvalue>false</rtexprvalue> 
              </attribute>
             
              <attribute>
                  <name>list</name>  
                  <required>true</required>      
                  <rtexprvalue>true</rtexprvalue> 
              </attribute>
              
        </tag>

tag.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8"
        pageEncoding="UTF-8"%>
    <%@ page import = "java.util.*" %>
    
    <%@ taglib uri="http://www.myTag.com" prefix = "m" %>
    
    <!DOCTYPE html>
    <html>
    <head>
    <meta charset="UTF-8">
    <title>Insert title here</title>
    </head>
    <body>
    
        <%
            List<String> list = new ArrayList<String>();
            for(int i = 0; i < 5 ; i++){
                list.add("str" + i);
            }
            pageContext.setAttribute("list", list);
        %>    
        <m:FOREACH list="${list}" var="s">
            ${s}
        </m:FOREACH>
    </body>
    </html>

![1435315-20190131180526507-1965692077.png][]

foreach主要通过表达式将list对象传递到ForEach.java中，

在ForEach.java中主要通过doAfterBody()方法，将迭代器中元素

通过pageSetAttribute()设置到page中，然后输出$\{var\},输出的表达式又会自动获取设置的值，

然后往复输出执行doAfterBody()方法，并且输出标签体(表达式$｛var｝)，来实现foreach。

直到迭代器元素全部输出，方法才终止。

那个doAfterBody()和return EVAL\_BODY\_AGAIN配合的流程可能不太好理解，

我们来看下tag.jsp生成的Servlet中的代码就很好理解了。

![1435315-20190131182049076-7665119.png][]

![1435315-20190131182000810-588633118.png][]

执行顺序为(不考虑后续输出终止情况):

doStartTag->标签体内容->doAfterBody->doEndTag

<xx>  标签开始（doStartTag）

xxxxxx   标签体

doAfterBody判断是否继续输出标签体（doAfterBody方法也可看作标签体的一部分）

</xx>  标签结束（doEndTag）

参考资料：

[https://blog.csdn.net/qq\_42246139/article/details/80623607][https_blog.csdn.net_qq_42246139_article_details_80623607]

[https://blog.csdn.net/qq\_41815326/article/details/81356733][https_blog.csdn.net_qq_41815326_article_details_81356733]

转载于:https://www.cnblogs.com/huang-changfan/p/10341557.html

[1435315-20190131121440774-990969650.png]: /images/20211216/5dfb24ffdef542e082917259a5a86527.png
[1435315-20190131121618055-999365838.png]: /images/20211216/b396259263de407489015427cda36b7a.png
[1435315-20190131121825765-1965271381.png]: /images/20211216/aacaa87e35e540508913470c0e1ccbd0.png
[1435315-20190131122141059-165628449.png]: /images/20211216/ddd46057e641460c8bdc0bb91a2c0011.png
[1435315-20190131122234330-55137234.png]: https://img2018.cnblogs.com/blog/1435315/201901/1435315-20190131122234330-55137234.png
[1435315-20190131122334648-543593296.png]: https://img2018.cnblogs.com/blog/1435315/201901/1435315-20190131122334648-543593296.png
[https_www.cnblogs.com_keyi_p_7127685.html]: https://www.cnblogs.com/keyi/p/7127685.html
[1435315-20190131160013908-135535654.png]: https://img2018.cnblogs.com/blog/1435315/201901/1435315-20190131160013908-135535654.png
[1435315-20190131130410851-1715073357.png]: https://img2018.cnblogs.com/blog/1435315/201901/1435315-20190131130410851-1715073357.png
[1435315-20190131131010677-1337806944.png]: https://img2018.cnblogs.com/blog/1435315/201901/1435315-20190131131010677-1337806944.png
[1435315-20190131131056294-186909414.png]: https://img2018.cnblogs.com/blog/1435315/201901/1435315-20190131131056294-186909414.png
[1435315-20190131162703699-1945261874.png]: https://img2018.cnblogs.com/blog/1435315/201901/1435315-20190131162703699-1945261874.png
[1435315-20190131164036445-1335025619.png]: https://img2018.cnblogs.com/blog/1435315/201901/1435315-20190131164036445-1335025619.png
[1435315-20190131180526507-1965692077.png]: https://img2018.cnblogs.com/blog/1435315/201901/1435315-20190131180526507-1965692077.png
[1435315-20190131182049076-7665119.png]: https://img2018.cnblogs.com/blog/1435315/201901/1435315-20190131182049076-7665119.png
[1435315-20190131182000810-588633118.png]: https://img2018.cnblogs.com/blog/1435315/201901/1435315-20190131182000810-588633118.png
[https_blog.csdn.net_qq_42246139_article_details_80623607]: https://blog.csdn.net/qq_42246139/article/details/80623607
[https_blog.csdn.net_qq_41815326_article_details_81356733]: https://blog.csdn.net/qq_41815326/article/details/81356733