如何自定义Jsp标签

目录

一、标签语言的特点

二、自定义标签的开发及其使用步骤

三、标签的生命周期

四、实践自定义标签：if、set、out

---

一、标签语言的特点

1.1 在我们想自定义属于自己的标签前，我们肯定要先来了解一下

标签结构：

我们就以 if 标签来做例子：

了解标签结构 
<c:if test="true">        开始标签
       true                     标签体
</c:if>                        结束标签

我们看一下标签的分类：控制标签、数据标签、UI标签

没有标签体也能在网页中输出内容的标签就是：UI标签

经过试验我发现：点击c:if标签可以跳转到c.tld文件中，而c.tld文件就是c标签库的定义配置文件！

	<c:if test="true">true</c:if>
	<c:if test="false">false</c:if>
	<c:set var="l" value="Leaf"></c:set>
	<c:out value="${l }"></c:out>

---

二、自定义标签的开发及其使用步骤

2.1 在了解了标签的一些基本结构以及特点后，我们进一步探索，

根据上面点击 if 标签 发现自定义标签是与tld文件有关的；

我们再次试验发现把c.tld文件中的tag元素删除后相关的标签就不能用了；

因此我们得到两条结论：

    <!-- 
        1、自定义标签是与tld文件相关的
        2、标签库中的标签与tld中的tag元素有关，也就是跟tag元素对应的助手类有关。
    -->

 于是我们想到如果把这个tld文件复制一份，把需要改的地方改成自己的，那是不是也能使用？

所以我们把tld文件复制一份：Leaf.tld，根据引入的代码：

<%@ taglib prefix="l" uri="http://jsp.leaf.com" %>

我们想到在tld文件中是否有这个uri，于是Ctrl+F查找一下，果然在tld文件中发现了这个uri，于是我们把它改成自己定义的uri：

  <description>JSTL 1.1 core library</description>
  <display-name>JSTL core</display-name>
  <tlib-version>1.1</tlib-version>
  <short-name>c</short-name>
  <uri>http://jsp.leaf.com</uri>

然后新建一个Jsp文件，引入刚刚自定义的这个tld文件，发现果然存在！

 

接着我们用这个自己定义的tld文件测试一下那几个标签试试能不能使用：

注：复制的tld文件必须保存放在WEB-IFN目录或其子目录中

	<l:if test="true">true</l:if>
	<l:if test="false">false</l:if>
	<l:set var="l" value="Leaf"></l:set>
	<l:out value="${l }"></l:out>

 运行网页：

 我们发现正常可用！

---

三、标签的生命周期

3.1 我们又了解了跟自定义标签相关的tld文件、tag元素，

接下来就来了解一下它的生命周期吧：

我们新建一个类，继承tag元素对应的助手类：BodyTagSupport

DemoTag1类：

package com.leaf.tag;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;

/**
 * 助手类：必须继承bodytagSupport
 * @author Leaf
 *
 * 2022年6月17日 下午7:32:58
 */
public class DemoTag1 extends BodyTagSupport {
	
	@Override
	public int doStartTag() throws JspException {
		System.out.println("=========开始标签doStartTag=========");
		//return SKIP_BODY;//跳过标签体
		return EVAL_BODY_INCLUDE;
	}
	
	@Override
	public int doAfterBody() throws JspException {
		System.out.println("=========标签体doAfterBody=========");
		return super.doAfterBody();
		//return EVAL_BODY_AGAIN;//循环标签体
	}
	
	@Override
	public int doEndTag() throws JspException {
		System.out.println("=========结束标签doEndTag=========");
		return super.doEndTag();
		//return SKIP_PAGE;//不再计算后面的内容
	}
	
}

经过多次运行试验我们得到一些结论：

<!-- 
    1、有标签体的情况下，默认会调用助手类的doStartTag、doAfterBody、doEndTag方法；
    2、如果开始标签doStartTag返回的值是SKIP_BODY，那么标签体doAfterBody就不会调用执行；
    3、如果将开始标签doStartTag的返回值改为EVAL_BODY_INCLUDE，那么标签体doAfterBody就会调用执行；
     4、如果将开始标签doStartTag的返回值改为EVAL_BODY_AGAIN，那么会一直调用标签体doAfterBody方法，进入循环；
     5、如果将结束标签doEndTag的返回值改为SKIP_PAGE，那么就不会再计算后面的内容。
 -->

---

四、实践自定义标签：if、set、out

了解了那么多理论知识，大多都是试验测试，不怎么好看运行结果，

而接下来我们就来利用我们了解的理论知识来实践一下：

4.1自定义几个属于自己的标签吧~

4.2 if标签的的定义

我们需要先建一个if标签类，继承助手类：定义一个if属性test：boolean类型

package com.leaf.tag;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;

/**
 * if标签：
 * 分析
 	* 如果满足条件，就打印标签体--->doStartTag的返回值：EVAL_BODY_INCLUDE
 	* 如果不满足条件，就不输出标签体--->doStartTag的返回值：SKIP_BODY
 * 需要获取到是否满足条件的结果值，那么该标签就有一个属性，属性值是boolean
 * @author Leaf
 *
 * 2022年6月17日 下午8:29:39
 */
public class IfTag extends BodyTagSupport {
	
	private boolean test;
	
	public boolean isTest() {
		return test;
	}

	public void setTest(boolean test) {
		this.test = test;
	}

	@Override
	public int doStartTag() throws JspException {
		return test ? EVAL_BODY_INCLUDE : SKIP_BODY;
	}
	
}

 我们写好这个标签类后就要去Leaf.tld文件里写好相关的配置，我们把其他的配置全部删除，

 留下一个范本：

4.3 配置tld文件：<c:if test=""></c:if>

<?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>JSTL 1.1 core library</description>
  <display-name>JSTL core</display-name>
  <tlib-version>1.1</tlib-version>
  <short-name>l</short-name>
  <uri>http://jsp.leaf.com</uri>

  <validator>
    <description>
        Provides core validation features for JSTL tags.
    </description>
    <validator-class>
        org.apache.taglibs.standard.tlv.JstlCoreTLV
    </validator-class>
  </validator>

  <tag>
  	<!-- 代表标签库标签的名字 -->
    <name>if</name>
    <!-- 该标签对应的助手类 -->
    <tag-class>com.leaf.tag.IfTag</tag-class>
    <!-- 代表是一个JSP标签 -->
    <body-content>JSP</body-content>
     <attribute>
    	<!-- 该自定义JSP标签的属性名称 -->
        <name>test</name>
        <!-- 该属性是否必填 -->
        <required>true</required>
        <!-- 该属性值是否支持表达式 -->
        <rtexprvalue>true</rtexprvalue>
     </attribute>
  </tag>

我们使用测试一下：

<l:if test="true">true</l:if>

<l:if test="false">false</l:if>

运行： 

 我们发现没有问题！

接着我们继续来试一下Set以及Out标签的定义：

Set标签类：这个我们就是拿到一个存储数据的地方：pageContext

package com.leaf.tag;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;

/**
 * 数据标签：存储数据的
 * 作用域：pagecontext、request、session、application(servletContext)
 * 
 * 要存储数据，以键值对的方式进行存储，分析得来该标签有2个属性
 * @author Leaf
 *
 * 2022年6月18日 上午12:23:18
 */
public class SetTag extends BodyTagSupport {
	
	private String var;
	private Object value;
	
	public String getvar() {
		return var;
	}

	public void setvar(String var) {
		this.var = var;
	}

	public Object getValue() {
		return value;
	}

	public void setValue(Object value) {
		this.value = value;
	}

	@Override
	public int doStartTag() throws JspException {
		//要存储数据，以键值对的方式进行存储，分析得来该标签有2个属性
		pageContext.setAttribute(var, value);
		return super.doStartTag();
	}
	
}

我们继续定义标签类：

Out标签类：这个我们主要就是拿到一个输出流：pageContext.getOut();

package com.leaf.tag;

import java.io.IOException;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.BodyTagSupport;

/**
 * Out标签
 * servlet中后台代码 前台输出内容：out.print
 * 将数据输出到前台，首先拿到输出流
 * @author Leaf
 *
 * 2022年6月18日 上午12:32:10
 */
public class OutTag extends BodyTagSupport {
	
	private Object value;
	
	public Object getValue() {
		return value;
	}

	public void setValue(Object value) {
		this.value = value;
	}

	@Override
	public int doStartTag() throws JspException {
		//拿到输出流
		JspWriter out = pageContext.getOut();
		try {
			//输出value
			out.print(value);
		} catch (IOException e) {
			e.printStackTrace();
		}
		return super.doStartTag();
	}
	
}

写好标签类后我们就统一去Leaf.tld文件配置一下：

Leaf.tld文件配置：

<tag>
    <name>set</name>
    <tag-class>com.leaf.tag.SetTag</tag-class>
    <body-content>JSP</body-content>
     <attribute>
        <name>var</name>
        <required>true</required>
        <rtexprvalue>false</rtexprvalue>
     </attribute>
     <attribute>
        <name>value</name>
        <required>true</required>
        <rtexprvalue>true</rtexprvalue>
     </attribute>
  </tag>
  
  <tag>
    <name>out</name>
    <tag-class>com.leaf.tag.OutTag</tag-class>
    <body-content>JSP</body-content>
     <attribute>
        <name>value</name>
        <required>true</required>
        <rtexprvalue>true</rtexprvalue>
     </attribute>
  </tag>

最后来一起使用测试一下啦：

    <l:if test="true">true</l:if>
    <l:if test="false">false</l:if>
    <l:set var="l" value="Leaf"></l:set>
    <l:out value="${l }"></l:out>

运行网页：

 我们发现都成功啦~

---

OK，这样Leaf今天带来的关于自定义标签的相关学习笔记分享就到这里啦~