自定义jsp标签

JSP标签

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

标签语言特点
<开始标签 属性=“属性值”>标签体</结束标签>
空标签

<br/><hr/>

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

ui标签
控制标签
数据标签

自定义标签的开发及使用步骤
1 创建一个标签助手类(继承BodyTagSupport)
标签属性必须助手类的属性对应、且要提供对应get/set方法
如图所示:
在这里插入图片描述

2 创建标签库描述文件(tld),添加自定义标签的配置
注:tld文件必须保存到WEB-INF目录或其子目录
如图所示:在这里插入图片描述
解释tld文件:
在tld 文件中,映射了标记名和处理程序类;
tallib元素,代表开始一个标记库的描述
tlib-version元素,代表标记库的版本
jsp-version元素,代表标记所支持的JSP 的版本
short-name为标记库起别名,相当于注释,无实际用途
tag元素,代表开始描述一个标记,其下子元素如下:
name——为标记处理类起的标记名
tag-class——指定标记处理类的全名(即带包的名字)
body-content——标记体的类型,该示例中不需要标记体,所有设置为EMPTY,该值的其他取值在后续内容中讲解
tag中的子元素
attribute用于为标签声明属性,其子元素如下:
name——用于指定属性名称
required——用于声明该属性是否为必需的,本例中声明color、loop 两个属性都不是必需的。
3 在JSP通过taglib指令导入标签库,并通过指定后缀
访问自定义标签
如图所示:
在这里插入图片描述

JSP标签生命周期

我们以图来解析和了解它的生命周期
如图所示:
在这里插入图片描述
我们通过我们的实例来具体的理解这个图
创建一个类继承BodyTagSupport,写一个助手类,然后写出列三个方法
代码如下:

package com.dengrenli.jsp;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
/**
 * Demo标签的助手类
 * @author machenike
 * doStartTag()方法的返回值:通常可以取两个值:
 *      EVAL_BODY_INCLUDE——包含标记体,本例中要编写自结束标记所以不使用该值;
 *      SKIP_BODY——跳过标记体,即不处理标记体,开发自结束标记应该使用该值。
 * doEndTag()方法的返回值:通常可以取两个值:
 *      SKIP_PAGE——返回这个值,则终止页面执行;
 *      EVAL_PAGE——返回该值则处理完当前标记后,JSP 页面中止运行。
   doAfterBody()方法的返回值:通常可以取两个值:
        EVAL_BODY_AGAIN:再计算主体一次
 *      SKIP_BODY——跳过标记体,即不处理标记体,开发自结束标记应该使用该值。
 *
 */
public class DemoTag extends BodyTagSupport {

	
	private static final long serialVersionUID = 8303320588876845328L;

	 private String test;
	 
	public String getTest() {
		return test;
	}
	public void setTest(String test) {
		this.test = test;
	}
	@Override
	public int doStartTag() throws JspException {
		System.out.println("-------doStartTag-------");
		return super.doStartTag();
	}
	@Override
	public int doAfterBody() throws JspException {
		System.out.println("-------doAfterBody-------");
		return super.doAfterBody();
	} 
	@Override
	public int doEndTag() throws JspException {
		System.out.println("-------doEndTag-------");
		return super.doEndTag();
	}
	
	
}

Demo标签的助手类
1 、 doStartTag()方法的返回值:通常可以取两个值:
EVAL_BODY_INCLUDE——包含标记体,本例中要编写自结束标记所以不使用该值;
SKIP_BODY——跳过标记体,即不处理标记体,开发自结束标记应该使用该值。
2、doAfterBody()方法的返回值:通常可以取两个值:
EVAL_BODY_AGAIN:再计算主体一次
SKIP_BODY——跳过标记体,即不处理标记体,开发自结束标记应该使用该值。

3 、doEndTag()方法的返回值:通常可以取两个值:
SKIP_PAGE——返回这个值,则终止页面执行;
EVAL_PAGE——返回该值则处理完当前标记后,JSP 页面中止运行。

然后我们需要把助手类写进我们创建的.tld文件当中,这样我们在jsp界面上才能通过我们的自定义标签调用到我们助手类的方法:
如图所示:
在这里插入图片描述

(1)doStartTag() 默认返回EVAL_BODY_INCLUDE,如果jsp界面有标签体内容,则会运行doAfterBody(),如果jsp界面没有标签体内容,则不会运行doAfterBody();
如图(无标签内容):
在这里插入图片描述
结果如图所示:
在这里插入图片描述

(2).如果doStartTag方法中的返回值为SKIP_BODY,那无论有无标签体都不会运行doAfterBody方法
如图所示:
在这里插入图片描述
结果如图所示:
在这里插入图片描述

(3).如果doStartTag方法中的返回值为EVAL_BODY_INCLUDE,doAfterBody方法中的返回值为EVAL_BODY_AGAIN,则会无限运行doAfterBody方法
如图所示:
在这里插入图片描述
结果如图所示:
在这里插入图片描述

我相信通过我对自定义jsp标签生命周期的介绍,我相信大家一定有个疑问,就是了解它的生命周期有什么用呢?
下面就让我们自己来定义jsp标签,并且实现它们所需要的功能,我们通过实战演练,来更好的理解自定义jsp标签。

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

package com.dengrenli.jsp.day02;

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

public class SetTag extends BodyTagSupport {

	private static final long serialVersionUID = 1769466336895726910L;
	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>
    <name>set</name>
    
    <tag-class>com.dengrenli.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 language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
    <%@ taglib uri="/deng" prefix="z" %>
    <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<!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="name" value="lyl"></z:set>

</body>
</html>

案例2(自定义<z:out>标签):
1、创建一个标签助手类,继承BodyTagSupport

package com.dengrenli.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 = 8058454072631995005L;
	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>
    <name>out</name>
    <tag-class>com.dengrenli.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 language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
    <%@ taglib uri="/deng" prefix="z" %>
    <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<!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="name" value="lyl"></z:set>
<!-- 自定义out标签 -->
<z:out value="${name }"></z:out>

</body>
</html>

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

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

package com.dengrenli.jsp.day02;

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

public class IfTag extends BodyTagSupport {

	/**
	 * 
	 */
	private static final long serialVersionUID = 5704358178552838077L;
	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>
    <name>if</name>
    <tag-class>com.dengrenli.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 language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
    <%@ taglib uri="/deng" prefix="z" %>
    <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<!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="name" value="lyl"></z:set>
<!-- 自定义out标签 -->
<z:out value="${name }"></z:out>
<!-- 自定义out标签 -->
<z:if test="true">
	<li>科比</li>
</z:if>
</body>
</html>

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

student类:

package com.dengrenli.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(自定义<z:forEach>标签):
1、创建一个标签助手类,继承BodyTagSupport

package com.dengrenli.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 = 3544680991074470870L;
	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>
    <name>forEach</name>
    <tag-class>com.dengrenli.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="java.util.ArrayList"%>
<%@page import="com.dengrenli.jsp.day02.Student"%>
<%@page import="java.util.List"%>
<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
    <%@ taglib uri="/deng" prefix="z" %>
    <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<!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="name" value="lyl"></z:set>
<!-- 自定义out标签 -->
<z:out value="${name }"></z:out>
<!-- 自定义out标签 -->
<z:if test="true">
	<li>科比</li>
</z:if>
<!-- 自定义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","yl"));
	request.setAttribute("list", list);
%>
<br>
<z:forEach items="${list}" var="d">
	${d.sid },${d.sname }<br>
</z:forEach>
</body>
</html>

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

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

package com.dengrenli.jsp.day02;

import java.io.IOException;
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 machenike
 *
 */
public class SelectTag extends BodyTagSupport {

	
	private static final long serialVersionUID = 7670015428082811040L;
	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>forEach</name>
    <tag-class>com.dengrenli.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>
  <tag>
    <name>select</name>
    <tag-class>com.dengrenli.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="java.util.ArrayList"%>
<%@page import="com.dengrenli.jsp.day02.Student"%>
<%@page import="java.util.List"%>
<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
    <%@ taglib uri="/deng" prefix="z" %>
    <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<!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="name" value="lyl"></z:set>
<!-- 自定义out标签 -->
<z:out value="${name }"></z:out>
<!-- 自定义out标签 -->
<z:if test="true">
	<li>科比</li>
</z:if>
<!-- 自定义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","yl"));
	request.setAttribute("list", list);
%>
<br>
<z:forEach items="${list}" var="d">
	${d.sid },${d.sname }<br>
</z:forEach>
<!-- 自定义select标签 -->
<%
	List<Student> list1 = new ArrayList<Student>();
	list1.add(new Student("s001","zs"));
	list1.add(new Student("s002","ls"));
	list1.add(new Student("s003","ww"));
	list1.add(new Student("s004","yl"));
	request.setAttribute("list1", list1);
%>
<!-- 未选中,没有===请选择=== -->
<z:select textVal="sname" items="${list1 }" textKey="sid"></z:select>
<br>
<!-- 选中 -->
<z:select headTextKey="-1" headTextVal="===请选择===" textVal="sname" items="${list1 }" textKey="sid" selectedVal="s004"></z:select>
</body>
</html>

结果如图(未选中):
在这里插入图片描述
结果如图(选中):
在这里插入图片描述
案例都讲完了,我觉得主要还是去靠自己去多理解,我相信通过我的讲解你应该对自定义jsp标签有了更深的认识

谢谢大家,多多指教!

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值