jsp自定义标签

本文详细介绍了JSP自定义标签的特点、开发步骤以及生命周期。从创建标签助手类、编写tld文件到在JSP中导入和使用自定义标签,通过多个案例展示了如何实现类似<c:set>、<c:out>、<c:if>和<c:forEach>等标签的功能。

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

标签库的运作离不开tld文件
标签库的标签是定义在tld中的tag标签内(助手类)

一、标签语言特点

<开始标签 属性=“属性值”>标签体</结束标签>

空标签

<br/><hr/>

<开始标签></结束标签>
<开始标签/>

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

2.1 创建一个标签助手类(继承BodyTagSupport)
标签属性必须助手类的属性对应、且要提供对应get/set方法

在这里插入图片描述

2.2 创建标签库描述文件(tld),添加自定义标签的配置
注:tld文件必须保存到WEB-INF目录或其子目录
在这里插入图片描述

2.3 在JSP通过taglib指令导入标签库,并通过指定后缀
访问自定义标签
在这里插入图片描述

三、标签生命周期

在这里插入图片描述

						 			SKIP_BODY
  3.1  实例化标签助手类->doStartTag()------------->doEndTag()
  
  
									EVAL_BODY_INCLUDE 			SKIP_BODY
  3.2  实例化标签助手类->doStartTag()------------->doAfterBody---------------->doEndTag()...


    							 EVAL_BODY_INCLUDE        		SKIP_BODY
  3.3  实例化标签助手类->doStartTag()------------->doAfterBody---------------->doEndTag()...
                                                              EVAL_BODY_AGAIN

SKIP_BODY:跳过主体
EVAL_BODY_INCLUDE:计算标签主体内容并[输出]
EVAL_BODY_BUFFERED:计算标签主体内容并[缓存]
EVAL_PAGE:计算页面的后续部分
SKIP_PAGE:跳过页面的后续部分
EVAL_BODY_AGAIN:再计算主体一次

案例
案例1(自定义<c:set>标签):
1)标签助手类:

package com.leiyuanlin.jsp.day02;

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

public class SetTag extends BodyTagSupport {

	private static final long serialVersionUID = -6052954908449450904L;
	private String var;
	private String value;
	public String getVar() {
		return var;
	}
	public void setVar(String var) {
		this.var = var;
	}
	public String getValue() {
		return value;
	}
	public void setValue(String value) {
		this.value = value;
	}
	@Override
	public int doStartTag() throws JspException {
		pageContext.setAttribute(var, value);
		return SKIP_BODY;
	}
}

2)创建标签描述文件(.tld)

<tag>
  <!-- 标签库中的set标签(类似c:set	c:out的定义) -->
    <name>set</name>
    <!-- 是标签运行具体代码,也就是助手类,下面填写的助手类的全路径名 -->
    <tag-class>com.leiyuanlin.jsp.day02.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>

3)导入自定义标签库 taglib

<%@page import="com.leiyuanlin.jsp.day02.Student"%>
<%@page import="java.util.ArrayList"%>
<%@page import="java.util.List"%>
<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ taglib uri="/leiyuanlin" prefix="z" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>

<body>
<!-- 自定义set标签 -->
<z:set var="zname" value="wohuo"></z:set>
</body>
</html>

案例2(ui标签<c:out>):
1)创建一个标签助手类,继承BodyTagSupport

package com.leiyuanlin.jsp.day02;

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 static final long serialVersionUID = 422069195441994245L;
	private String value;
	public String getValue() {
		return value;
	}
	public void setValue(String value) {
		this.value = value;
	}
	@Override
	public int doStartTag() throws JspException {
		JspWriter out = pageContext.getOut();
		try {
			out.print(value);
		} catch (IOException e) {
			e.printStackTrace();
		}
		return SKIP_BODY;
	}
}

2)创建标签描述文件(.tld)

<tag>
  <!-- 标签库中的out标签(类似c:set	c:out的定义) -->
    <name>out</name>
    <!-- 是标签运行具体代码,也就是助手类,下面填写的助手类的全路径名 -->
    <tag-class>com.leiyuanlin.jsp.day02.OutTag</tag-class>
    <body-content>JSP</body-content>
    <attribute>
    	<!-- 该标签的属性 -->
        <name>value</name>
        <!-- 该标签是否为必填项 -->
        <required>true</required>
        <!-- 是否支持表达式 -->
        <rtexprvalue>true</rtexprvalue>
    </attribute>
  </tag>

3)导入自定义标签库 taglib

<%@page import="com.leiyuanlin.jsp.day02.Student"%>
<%@page import="java.util.ArrayList"%>
<%@page import="java.util.List"%>
<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ taglib uri="/leiyuanlin" prefix="z" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>

<body>

<!-- 自定义set标签 -->
<z:set var="zname" value="wohuo"></z:set>
<br>

<!-- out标签 -->
<z:out value="${zname }"></z:out>
<br>

</body>
</html>

结果:
在这里插入图片描述

案例3(自定义<c:if>标签):
1)创建一个标签助手类,继承BodyTagSupport

package com.leiyuanlin.jsp.day02;

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

public class IfTag extends BodyTagSupport {

	private static final long serialVersionUID = -7583281930825502504L;
	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;
	}
}

2)创建标签描述文件(.tld)

<tag>
  <!-- 标签库中的if标签(类似c:set	c:out的定义) -->
    <name>if</name>
    <!-- 是标签运行具体代码,也就是助手类,下面填写的助手类的全路径名 -->
    <tag-class>com.leiyuanlin.jsp.day02.IfTag</tag-class>
    <body-content>JSP</body-content>
    <attribute>
    	<!-- 该标签的属性 -->
        <name>test</name>
        <!-- 该标签是否为必填项 -->
        <required>true</required>
        <!-- 是否支持表达式 -->
        <rtexprvalue>true</rtexprvalue>
    </attribute>
  </tag>

3)导入自定义标签库 taglib

<%@page import="com.leiyuanlin.jsp.day02.Student"%>
<%@page import="java.util.ArrayList"%>
<%@page import="java.util.List"%>
<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ taglib uri="/leiyuanlin" prefix="z" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>

<body>
<!-- 自定义if标签 -->
<%
	String tname = "zs";
	request.setAttribute("tname", tname);
%>
<z:if test="${tname eq 'zs'}">
	${tname}
</z:if>

</body>
</html>

结果:
在这里插入图片描述

student类:

package com.leiyuanlin.jsp.day02;

public class Student {
	private String sid;
	private String sname;
	public Student() {
	}
	public Student(String sid, String sname) {
		this.sid = sid;
		this.sname = sname;
	}
	public String getSid() {
		return sid;
	}
	public void setSid(String sid) {
		this.sid = sid;
	}
	public String getSname() {
		return sname;
	}
	public void setSname(String sname) {
		this.sname = sname;
	}
	@Override
	public String toString() {
		return "Student [sid=" + sid + ", sname=" + sname + "]";
	}
	
}  

案例4(自定义<c:forEach>标签):
1)创建一个标签助手类,继承BodyTagSupport

package com.leiyuanlin.jsp.day02;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

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

public class ForEachTag extends BodyTagSupport {

	private static final long serialVersionUID = -953030179719119165L;
	private String var;
	private List<Object> items = new ArrayList<>();
	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 {
		Iterator<Object> it = items.iterator();
//		默认指针存放的位置是没有指针对象的,现在需要指向对象,那么需要指针下移
		pageContext.setAttribute(var, it.next());
//		因为集合中元素较多,那么指针需要循环的向下移动,那么我们需要将迭代器保存,用于下一次指针下移所用
		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()) {
//			指针下移指向新的元素
			pageContext.setAttribute(var, it.next());
//			再保存正在使用的迭代器
			pageContext.setAttribute("it", it);
			return EVAL_BODY_AGAIN;
		}else {
			return EVAL_PAGE;
		}
	}
}

2)创建标签描述文件(.tld)

<tag>
  <!-- 标签库中的forEach标签(类似c:set	c:out的定义) -->
    <name>forEach</name>
    <!-- 是标签运行具体代码,也就是助手类,下面填写的助手类的全路径名 -->
    <tag-class>com.leiyuanlin.jsp.day02.ForEachTag</tag-class>
    <body-content>JSP</body-content>
    <attribute>
    	<!-- 该标签的属性 -->
        <name>var</name>
        <!-- 该标签是否为必填项 -->
        <required>true</required>
        <!-- 是否支持表达式 -->
        <rtexprvalue>false</rtexprvalue>
    </attribute>
    <attribute>
    	<!-- 该标签的属性 -->
        <name>items</name>
        <!-- 该标签是否为必填项 -->
        <required>true</required>
        <!-- 是否支持表达式 -->
        <rtexprvalue>true</rtexprvalue>
    </attribute>
  </tag>

3)导入自定义标签库 taglib

<%@page import="com.leiyuanlin.jsp.day02.Student"%>
<%@page import="java.util.ArrayList"%>
<%@page import="java.util.List"%>
<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ taglib uri="/leiyuanlin" prefix="z" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>

<body>
<!-- 自定义forEach标签 -->
<%
	List<Student> list = new ArrayList<Student>();
	list.add(new Student("s001","zs"));
	list.add(new Student("s002","ls"));
	list.add(new Student("s003","ww"));
	list.add(new Student("s004","xl"));
	request.setAttribute("list", list);
%>
<br>
<z:forEach items="${list }" var="l">
	${l.sid },${l.sname }<br>
</z:forEach>

</body>
</html>

结果:
在这里插入图片描述

案例5(自定义标签):
1)创建一个标签助手类,继承BodyTagSupport

package com.leiyuanlin.jsp.day02;

import java.io.IOException;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
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.BeanUtils;
/**
 * <select id='' name=''>
	 <option value=''>===请选择===</option>
   </select>
   查询维度:下拉列表
   修改页面:下拉列表	数据回显
   
   最终效果:<z:select>...</z:select>
   1、id、name
   2、数据源items、存入数据库中的值textKey(value)、展示列textVal(option中的内容)
   3、加入属性(默认头部属性值headTextKey,默认的展示列值headTextVal)
   4、加入属性,能够实现数据回显的功能selectedVal
 * @author 2018101801
 *
 */
public class SelectTag extends BodyTagSupport {
	
	private static final long serialVersionUID = 3493562186572795048L;
	private String id;
	private String name;
	private List<Object> items = new ArrayList<>();
	private String textKey;
	private String textVal;
	private String headTextKey;
	private String headTextVal;
	private String selectedVal;
	public String getId() {
		return id;
	}
	public void setId(String id) {
		this.id = id;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	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 getHeadTextKey() {
		return headTextKey;
	}
	public void setHeadTextKey(String headTextKey) {
		this.headTextKey = headTextKey;
	}
	public String getHeadTextVal() {
		return headTextVal;
	}
	public void setHeadTextVal(String headTextVal) {
		this.headTextVal = headTextVal;
	}
	public String getSelectedVal() {
		return selectedVal;
	}
	public void setSelectedVal(String selectedVal) {
		this.selectedVal = selectedVal;
	}
	
	@Override
	public int doStartTag() throws JspException {
		JspWriter out = pageContext.getOut();
		try {
			out.write(toHTML());
		} catch (IOException | NoSuchFieldException | SecurityException | IllegalArgumentException | IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
			e.printStackTrace();
		}
		return super.doStartTag();
	}
	
	/**
	 * 拼接出下拉列表所对应的select的html代码
	 * <select id='' name=''>
		 <option value=''>===请选择===</option>
	   </select>
	 * @return
	 * @throws SecurityException 
	 * @throws NoSuchFieldException 
	 * @throws IllegalAccessException 
	 * @throws IllegalArgumentException 
	 * @throws NoSuchMethodException 
	 * @throws InvocationTargetException 
	 */
	private String toHTML() throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException, InvocationTargetException, NoSuchMethodException {
		StringBuilder sb = new StringBuilder();
		sb.append("<select id='' name=''>");
		
		if(!(headTextKey == null || "".equals(headTextKey) || headTextVal == null || "".equals(headTextVal) )) {
			sb.append("<option value='"+headTextKey+"' selected>"+headTextVal+"</option>");
		}
		String val;
		String html;
		for (Object obj : items) {
//			要让学生id存入数据,让学生的名字展示再jsp页面
//			<option value='s001'>zs</option>
//			有两种方式(通过反射拿值)
			
//			第一种
			/*Field textKeyField = obj.getClass().getDeclaredField(textKey);
			textKeyField.setAccessible(true);
			val = (String) textKeyField.get(obj);
			Field textValField = obj.getClass().getDeclaredField(textVal);
			textValField.setAccessible(true);
			html = (String) textValField.get(obj);*/
			
			
//			第二种
			val = BeanUtils.getProperty(obj, textKey);
			html = BeanUtils.getProperty(obj, textVal);
			if(val.equals(selectedVal)) {
				sb.append("<option value='"+val+"' selected>"+html+"</option>");
			}else {
				sb.append("<option value='"+val+"'>"+html+"</option>");
			}
			
		}
		
		sb.append("</select>");
		return sb.toString();
	}
}

2)创建标签描述文件(.tld)

<tag>
    <name>select</name>
    <tag-class>com.leiyuanlin.jsp.day02.SelectTag</tag-class>
    <body-content>JSP</body-content>
    <attribute>
        <name>id</name>
        <required>false</required>
        <rtexprvalue>false</rtexprvalue>
    </attribute>
    <attribute>
        <name>name</name>
        <required>false</required>
        <rtexprvalue>false</rtexprvalue>
    </attribute>
    <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>headTextKey</name>
        <required>false</required>
        <rtexprvalue>false</rtexprvalue>
    </attribute>
    <attribute>
        <name>headTextVal</name>
        <required>false</required>
        <rtexprvalue>false</rtexprvalue>
    </attribute>
    <attribute>
        <name>selectedVal</name>
        <required>false</required>
        <rtexprvalue>true</rtexprvalue>
    </attribute>
  </tag>

3)导入自定义标签库 taglib

<%@page import="com.leiyuanlin.jsp.day02.Student"%>
<%@page import="java.util.ArrayList"%>
<%@page import="java.util.List"%>
<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ taglib uri="/leiyuanlin" prefix="z" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>

<body>

<!-- 自定义select标签 -->
<%
	List<Student> list = new ArrayList<Student>();
	list.add(new Student("s001","zs"));
	list.add(new Student("s002","ls"));
	list.add(new Student("s003","ww"));
	list.add(new Student("s004","xl"));
	request.setAttribute("list", list);
%>
<!-- 未选中 -->
<z:select headTextKey="-1" headTextVal="===请选择===" textVal="sname" items="${list }" textKey="sid"></z:select>
<br><br><br><br>

<!-- 选中 -->
<z:select headTextKey="-1" headTextVal="===请选择===" textVal="sname" items="${list }" textKey="sid" selectedVal="s003"></z:select>
</body>
</html>

结果(未选中):
在这里插入图片描述
结果(选中):
在这里插入图片描述
感谢观看!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值