JSP自定义标签详解-优快云博客

本文链接：https://blog.youkuaiyun.com/m0_60390944/article/details/120228781

本文介绍了JSP自定义标签的特点，包括空标签、UI标签、控制标签和数据标签等。详细阐述了自定义标签的创建步骤，如创建标签助手类、编写TLD文件，并在jsp中引入使用。同时，探讨了标签的生命周期及其不同执行路径，如SKIP_BODY、EVAL_BODY_INCLUDE等，并以if、set、out、forEach和select标签为例进行了说明。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一思维导图

二，标签语言的特点

1、形式：<开始标签属性="属性值">标签体</结束标签>

2、分类：

1、空标签： br、hr

2、ui标签：input、table

3、控制标签：if、foreach

4、数据标签：set标签、out标签

5、自定义jsp标签的意义：便捷自己的开发，能够根据自己的需求来调整标签的功能，动态的实现一些功能，提高开发效率。

<a>标签语言的特点</a>
 
空标签<!--没有内容  -->
<br>
<hr>
 
UI标签
<table>
	<tr></tr>
</table>
<input>
 
控制标签
<c:if test="true">输出</c:if>
<c:if test="false">不输出</c:if>
 
数据标签
<c:set var="name" value="aa"></c:set>
<c:out value="${ name}"></c:out>

二，自定义标签步骤

1.创建一个标签助手类(继承BodyTagSupport)

2.创建标签库描述文件(tld)，添加自定义标签的配置（tld文件必须保存到WEB-INF目录或其子目录）

3，jsp通过taglib引入自定义标签库

<?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>zking 1.1 core library</description>
  <display-name>zking core</display-name>
  <tlib-version>1.1</tlib-version>
  <short-name>zking</short-name>
  <uri>http://jsp/jstl/core</uri>
 
  <tag>
    <name>Dome01</name>
    <tag-class>com.jsp.xly.Dome01</tag-class>
    <body-content>JSP</body-content>
  </tag>
</taglib>

jsp通过taglib引入自定义标签库

<%@ taglib uri="/WEB-INF/zking.tld" prefix="z"%>

<z:Dome01>Dome1</z:Dome01>

三，标签的生命周期

展示图

1、标签的开发场景（三条路线）

1.1、doStartTag——SKIP_BODY——doEndTag

1.2、doStartTag——EVAL_BODY_INCLUDE——doAfterBody——EVAL_PAGE——doEndTag

1.3、doStartTag——EVAL_BODY_INCLUDE——doAfterBody——EVAL_BODY_AGAIN(N次)——doEndTag

2、返回值

2.1、SKIP_BODY：跳过主体

2.2、EVAL_BODY_INCLUDE：计算标签主体内容并[输出]

2.3、EVAL_BODY_AGAIN:再计算主体一次

2.4、EVAL_PAGE:计算页面的后续部分

2.5、SKIP_PAGE:跳过页面的后续部分

论证三条路线的执行顺序

package com.jsp.xly;
 
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
/**
	三种路线(根据生命周期图整理出来的)
  1.dostartTag...skipBody...doEndTag
  2.dostartTag...EVAL_BODY_INCLUDE...doAfterBody...EVAL_PAGE...doEndTag
  3.dostartTag...EVAL BODN INCLUDE...doAfterBody...EVAL_BODY_AGAIN...doAfterBody...EVAL_BODY_AGAIN...doAfterBody...EVAL_BODY_AGAIN...doEndTag
 */
 
public class Dome01 extends BodyTagSupport{
 
	//开始标签
	public int doStartTag() throws JspException {
		System.out.println("Dome1...doStartTag...进来了");
		return EVAL_BODY_INCLUDE;
	}
	
	//结束标签
	public int doEndTag() throws JspException {
		System.out.println("Dome1...doEndTag...进来了");
		return super.doEndTag();
	}
	
}
public class Dome02 extends BodyTagSupport{
 
	//开始标签
	public int doStartTag() throws JspException {
		System.out.println("Dome2...doStartTag...进来了");
		return EVAL_BODY_INCLUDE;
	}
	
	//标签体
	@Override
	public int doAfterBody() throws JspException {
		System.out.println("Dome2...doAfterBody...进来了");
		return EVAL_PAGE;
	}
	
	//结束标签
	public int doEndTag() throws JspException {
		System.out.println("Dome2...doEndTag...进来了");
		return super.doEndTag();
	}
	
}
public class Dome03 extends BodyTagSupport{
 
	//开始标签
	public int doStartTag() throws JspException {
		System.out.println("Dome3...doStartTag...进来了");
		return EVAL_BODY_INCLUDE;
	}
	
	//标签体
	@Override
	public int doAfterBody() throws JspException {
		System.out.println("Dome3...doAfterBody...进来了");
		return EVAL_BODY_AGAIN;
	}
	
	//结束标签
	public int doEndTag() throws JspException {
		System.out.println("Dome3...doEndTag...进来了");
		return super.doEndTag();
	}
	
}

控制标签（if标签）

package com.jsp.xly;
 
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
 
/**
    1.dostartTag...SKIP_BODY...doEndTag
    2.dostartTag...EVAL_BODY_INCLUDE...doAfterBody...EVAL_PAGE...doEndTag
 * 
 *	针对第一条第二条做一个实际应用
 *  开发一个控制标签
 */
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;
	}
	
}
 
  //标签库描述文件(tld)
  <tag>
    <name>if</name>
    <tag-class>com.jsp.xly.IfTag</tag-class>
    <body-content>JSP</body-content>
    <attribute>
    <!-- 自定义标签的成员变量 -->
        <name>test</name>
        <!-- 改成员变量是否必传 -->
        <required>true</required>
        <!-- 是否支持EL表达式 -->
        <rtexprvalue>false</rtexprvalue>
    </attribute>
  </tag>
  //测试
  <z:if test="true">输出</z:if>
  <z:if test="false">不输出</z:if>

数据标签（set标签/out标签）

set标签

package com.jsp.xly;
 
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
/**
 *  案例3和案例4（涉及第一条和第二条）
 *  set、out标签（需要借助一个JspWriter）
 *  在没有标签体的情况下，是通过 JspWriter来输出内容的
 */
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 {
		pageContext.setAttribute(var, value);
		return super.doStartTag();
	}
	
}
 
tld文件
<tag>
    <name>set</name>
    <tag-class>com.jsp.xly.SetTag</tag-class>
    <body-content>JSP</body-content>
    <attribute>
    	<!-- 自定义标签的成员变量 -->
        <name>var</name>
        <!-- 改成员变量是否必传 -->
        <required>true</required>
        <!-- 是否支持EL表达式 -->
        <rtexprvalue>false</rtexprvalue>
    </attribute>
    <attribute>
    <!-- 自定义标签的成员变量 -->
        <name>value</name>
        <!-- 改成员变量是否必传 -->
        <required>true</required>
        <!-- 是否支持EL表达式 -->
        <rtexprvalue>true</rtexprvalue>
    </attribute>
  </tag>
测试
<z:set var="name1" value="aa"></z:set>

out标签

package com.jsp.xly;
 
import java.io.IOException;
 
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.BodyTagSupport;
 
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 {
			out.print(value);
		} catch (IOException e) {
			e.printStackTrace();
		}
		return super.doStartTag();
	}
	
}
 
 
tld文件
<tag>
    <name>out</name>
    <tag-class>com.jsp.xly.OutTag</tag-class>
    <body-content>JSP</body-content>
    <attribute>
    <!-- 自定义标签的成员变量 -->
        <name>value</name>
        <!-- 改成员变量是否必传 -->
        <required>true</required>
        <!-- 是否支持EL表达式 -->
        <rtexprvalue>true</rtexprvalue>
    </attribute>
  </tag>
测试
<z:if test="false">不输出</z:if>

Foreach标签和Select标签

1、ForEach标签

package com.jsp.xly;
 
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
 
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
 
/**
 *  熟悉第二第三路的开发
 *实现思路
 *  1，最少接受两个参数  var/items
 *  2, 一定会有标签体，对应要重写doAfterBody方法
 *  3， 必定有判断条件决定doAfterbody的返回值EVAL_PAGE和EVAL_BODY_AGAIN
 *  将取集合元素的过程，看成指针下移的过程，环绕指针还指向下一个，那么返回值为EVAL_BODY_AGAIN
 *  如果没有下一个元素，那么返回值为EVAL_PAGE
 */
public class ForeachTag extends BodyTagSupport{
 
	private String var;
	private List<Object> items = new ArrayList<Object>();
	
	public String getVar() {
		return var;
	}
 
	public void setVar(String var) {
		this.var = var;
	}
 
	public List<Object> getItems() {
		return items;
	}
 
	public void setItems(List<Object> items) {
		this.items = items;
	}
 
	@Override
	public int doStartTag() throws JspException {
		//在此处保存迭代器，供doAfterBody中使用
		Iterator<Object> it = items.iterator();
		pageContext.setAttribute("it", "it");
		return EVAL_BODY_INCLUDE;
	}
	
	@Override
	public int doAfterBody() throws JspException {
		Iterator<Object> it = (Iterator<Object>)pageContext.getAttribute("it");
		if(it.hasNext()) {
			//通过var拿到当前对象/让指针下移it.next()
			pageContext.setAttribute(var, it.next());
			//保存指针下移后的状态
			pageContext.setAttribute("it", it);
			//继续循环
		    return EVAL_BODY_AGAIN;
		}else {
			//结束循环
			return EVAL_PAGE;
		}
	}
	
}
 
 
tld文件
<tag>
    <name>forEach</name>
    <tag-class>com.jsp.xly.ForeachTag</tag-class>
    <body-content>JSP</body-content>
    <attribute>
    <!-- 自定义标签的成员变量 -->
        <name>var</name>
        <!-- 改成员变量是否必传 -->
        <required>true</required>
        <!-- 是否支持EL表达式 -->
        <rtexprvalue>false</rtexprvalue>
    </attribute>
    <attribute>
    <!-- 自定义标签的成员变量 -->
        <name>items</name>
        <!-- 改成员变量是否必传 -->
        <required>true</required>
        <!-- 是否支持EL表达式 -->
        <rtexprvalue>true</rtexprvalue>
    </attribute>
  </tag>
测试
<%
	List user = new ArrayList<>();
	user.add(new User("a1", "aa"));
	user.add(new User("b1", "bb"));
	user.add(new User("c1", "cc"));
	user.add(new User("d1", "dd"));
	request.setAttribute("user", user);
%>
 
<z:forEach items="${user }" var="a">
	${a.id }:${a.name }<br>
</z:forEach>

2、select标签（包含美化）

package com.jsp.xly;
 
import java.io.IOException;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;
 
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.BodyTagSupport;
 
import org.apache.commons.beanutils.PropertyUtils;
 
import com.sun.org.apache.xml.internal.serializer.ToHTMLSAXHandler;
 
/**
 *  最终案例
 *  目的：将所有的自定义标签的知识点，用于实际项目开发
 *  不管if/set/out/foreach... 那都是C标签已经具备的功能，直接用就好
 *  学习自定义标签理解其目的，就是弥补现成C标签没有的功能
 *  
 *  以前的查询下拉框
    <select>
	<option value="">===请选择===</option>
	<option value="1">华哥</option>
	<option value="2">晓哥</option>
	<option value="3">娜姐</option>
	</select>	
	修改之前：在这里面有大量的c:foreach,c:if判断
	不足之处：代码过大，相类似的代码过多
	
	目前：<c:select></c:select>
	通过上述标签实现上述代码功能
	
	分析属性：
	1，需要遍历展示items，用于遍历展示的  user->user(id,name)->id=option>value;name=option>html(text文本内容)
	2，对象key属性textKey,用于对应option>value
	3，对象value属性textVal,用于对应option>text
	4，对象默认key属性headerTextKey,用于对应默认的option>value
	5，对象value属性headerTextVal,用于对应默认的option>text
	6，对象回显值属性SelectedVal,用于判断数据是否选中
	
	没有标签体，又需要往页面输出内容  JspWriter
	
 *  
 */
public class SelectTag extends BodyTagSupport{
 
	private List<Object> items = new ArrayList<Object>();
	private String textKey;//用于对应option>value
	private String textVal;//用于对应option>text
	private String headerTextKey;//用于对应默认的option>value
	private String headerTextVal;//用于对应默认的option>text
	private String SelectedVal;//用于判断数据是否选中
	
	//定义属性美化。拓展/操作标签
	private String cssStyle;//美化
	private String id;//绑定事件...操作标签
	private String className;//美化
	
	public int doStartTag() throws JspException {
		JspWriter out = pageContext.getOut();
		try {
			out.print(ToHTML());
		} catch (Exception e) {
			e.printStackTrace();
		}
		return super.doStartTag();
	}
	
//	<select>
//	<option value="">===请选择===</option>
//	<option value="1">华哥</option>
//	<option checked value="2">晓哥</option>
//	<option value="3">娜姐</option>
//	</select>	
	
	//拼接
	private String ToHTML() throws Exception {
		StringBuffer sb = new StringBuffer();
		sb.append("<select id='"+id+"' class='"+className+"' style='"+cssStyle+"'>");
		//拼接默认显示标签
		if(headerTextVal!=null&&!"".equals(headerTextVal)) {
		sb.append("<option value='"+headerTextKey+"'>"+headerTextVal+"</option>");
		}
		//循环显示数据源
		if(items.size()>0) {
			for (Object obj : items) {
				//obj对应user  希望拿到user的id放入option--value，name放入option--text
				//通过反射获取到id对应的属性对象
				Field textKeyField = obj.getClass().getDeclaredField(textKey);
				textKeyField.setAccessible(true);
				//获取id的对应值
				//textKeyField.get(obj);
				//PropertyUtils.getProperty(obj, textVal);//此代码等价上面三行代码（工具包）
				String value = textKeyField.get(obj).toString();
				sb.append("<option value='"+textKeyField.get(obj)+"'>"+PropertyUtils.getProperty(obj, textVal)+"</option>");
				
				//修改页面下拉框回显选中
				//但下拉框的value值等于selectedVal，那么就要默认下拉框选中
				if(value.equals(SelectedVal)) {
					sb.append("<option selected value='"+textKeyField.get(obj)+"'>"+PropertyUtils.getProperty(obj, textVal)+"</option>");
				}else {
					sb.append("<option value='"+textKeyField.get(obj)+"'>"+PropertyUtils.getProperty(obj, textVal)+"</option>");
				}
			}
		}
		sb.append("</select>");
		return null;
	}
 
	public String getCssStyle() {
		return cssStyle;
	}
 
	public void setCssStyle(String cssStyle) {
		this.cssStyle = cssStyle;
	}
 
	public String getId() {
		return id;
	}
 
	public void setId(String id) {
		this.id = id;
	}
 
	public String getClassName() {
		return className;
	}
 
	public void setClassName(String className) {
		this.className = className;
	}
 
	public List<Object> getItems() {
		return items;
	}
	public void setItems(List<Object> items) {
		this.items = items;
	}
	public String getTextKey() {
		return textKey;
	}
	public void setTextKey(String textKey) {
		this.textKey = textKey;
	}
	public String getTextVal() {
		return textVal;
	}
	public void setTextVal(String textVal) {
		this.textVal = textVal;
	}
	public String getHeaderTextKey() {
		return headerTextKey;
	}
	public void setHeaderTextKey(String headerTextKey) {
		this.headerTextKey = headerTextKey;
	}
	public String getHeaderTextVal() {
		return headerTextVal;
	}
	public void setHeaderTextVal(String headerTextVal) {
		this.headerTextVal = headerTextVal;
	}
	public String getSelectedVal() {
		return SelectedVal;
	}
	public void setSelectedVal(String selectedVal) {
		SelectedVal = selectedVal;
	}
	
}
 
tld文件
<tag>
    <name>select</name>
    <tag-class>com.jsp.xly.SelectTag</tag-class>
    <body-content>JSP</body-content>
    <attribute>
        <name>items</name>
        <required>true</required>
        <rtexprvalue>true</rtexprvalue>
    </attribute>
    <attribute>
        <name>textKey</name>
        <required>true</required>
        <rtexprvalue>false</rtexprvalue>
    </attribute>
    <attribute>
        <name>textVal</name>
        <required>true</required>
        <rtexprvalue>false</rtexprvalue>
    </attribute>
    <attribute>
        <name>headerTextKey</name>
        <required>false</required>
        <rtexprvalue>false</rtexprvalue>
    </attribute>
    <attribute>
        <name>headerTextVal</name>
        <required>false</required>
        <rtexprvalue>false</rtexprvalue>
    </attribute>
    <attribute>
        <name>SelectedVal</name>
        <required>false</required>
        <rtexprvalue>false</rtexprvalue>
    </attribute>
  </tag>
测试
<!-- 模拟的是新增场景 -->
<z:select cssStyle="color:red" textVal="name" items="${user}" textKey="id"></z:select>
<!-- 模拟修改场景 -->
<z:select selectedVal="u04" textVal="name" items="${user}" textKey="id"></z:select>
<!-- 模拟查询 所有 -->
<z:select headerTextKey="" headerTextVal="--请选择--" textVal="name"  items="${user}" textKey="id"></z:select>