JSP自定义标签

大纲:

1. 标签语言特点

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

        空标签: <br/>   <hr/>
       <开始标签></结束标签>
       <开始标签/>


2. 自定义标签的开发及使用步骤

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

标签属性必须与助手类的属性对应、且要提供对应get/set方法

2)创建标签库描述文件(tld),添加自定义标签的配置

注:tld必须放置到WEB-INF或者其子目录下

tld本质上也是一个xml文件,也要进行约束  

3)在页面通过taglib指令导入标签库,并通过指定后缀访问自定义标签


3、标签生命周期

 流程A:(主要用开发简单标签)
                                                                    SKIP_BODY
  实例化标签助手类--------------->doStartTag()----------------------->doEndTag()


  流程B:
                                              EVAL_BODY_INCLUDE                 SKIP_BODY
  实例化标签助手类->doStartTag()--------------------->doAfterBody---------------------->doEndTag()...
                                                                              EVAL_BODY_AGAIN

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


 本章节主要讲自定义test标签(基础)、自定义foreach标签、自定义数据标签、(自定义下拉框标签(满足所有应用场景)下一章节详细讲解)

项目结构:

案例: (提供mytag.tld文件)

1、自定义test标签(基础)

      1.1、在tag包下创建TestTag.java文件,并继承 BodyTagSupport(标签处理类)。

      1.2、然后在myTag.tld中编写<tag>中对应内容

      1.3、最后在jsp页面中调用自定义方法

例如:TestTag.java中的私有属性名称要与myTag.tld中<attribute>标签下的<name>标签一致

     private Object name;
     <!-- 自定义标签的属性名称 -->
     <name>name</name>

TestTag.java

package com.zking.jspTag.tag;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
public class TestTag extends BodyTagSupport {
	private Object name;
	//定义全局变量
	private int count=0;

	public Object getName() {
		return name;
	}
	public void setName(Object name) {
		this.name = name;
	}

	/**
	 * doStartTag():表示<开始标签>所对应执行的动作
	 * 例如:对应<z:test>标签所执行的动作
	 * 返回值:1)SKIP_BODY:跳过主体内容不输出
	 * 	2)EVAL_BODY_INCLUDE:计算主体内容并包含在输出中
	 */
	@Override
	public int doStartTag() throws JspException {
		count=0;
		System.out.println("name="+this.name);
		System.out.println("doStartTag():表示<开始标签>所对应执行的动作");
		return EVAL_BODY_INCLUDE;
	}
	
	/**
	 * doAfterBody():介于<开始标签>标签体与<结束标签>之间执行的动作
	 * 例如:介于<z:test>1949与</z:test>之间所执行的动作
	 * 返回值:1)SKIP_BODY:跳过主体内容不输出(在此处可理解为for循环中的break【终止】)
	 * 2)EVAL_BODY_AGAIN:再次计算主体内容并包含在输出中(可理解为continue【继续】)
	 */
	@Override
	public int doAfterBody() throws JspException {
		System.out.println("doAfterBody():介于<开始标签>标签体与<结束标签>之间执行的动作");
		if(count<3) {//标签助手类只实例化一次
			count++;
			return EVAL_BODY_AGAIN;
		}
		return SKIP_BODY;
	}

	/**
	 * doEndTag():表示<结束标签>所对应执行的动作
	 *  例如:对应</z:test>标签所执行的动作
	 *  返回值:1)SKIP_PAGE:跳过页面的后续内容
	 *  2)EVAL_PAGE:计算页面的后续内容
	 */
	@Override
	public int doEndTag() throws JspException {
		System.out.println("doEndTag():表示<结束标签>所对应执行的动作");
		return EVAL_PAGE;
	}
	
}

        mytag.tld

<!DOCTYPE taglib
  PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
   "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">
<!-- 标签库描述符 -->
<taglib xmlns="http://java.sun.com/JSP/TagLibraryDescriptor">
	<!-- 代表标签库的版本号 -->
	<tlib-version>1.0</tlib-version>
	<!-- 代表jsp的版本 -->
	<jsp-version>1.2</jsp-version>
	<!-- 你的标签库的简称 -->
	<short-name>z</short-name>
	<!-- 你标签库的引用uri -->
	<uri>/zking</uri>

	<tag>
		<name>test</name>
		<!-- 标签工具类 -->
		<!--每一个标签都会独立对应一个标签助手类  -->
		<tag-class>com.zking.jspTag.tag.TestTag</tag-class>
		<!-- 标签的内容类型:empty表示空标签,jsp表示可以为任何合法的JSP元素 -->
		<body-content>jsp</body-content>
		
		<!-- 自定义标签的属性定义,请注意一定要在标签类中提供对应的get/set方法 -->
		<attribute>
			<!-- 自定义标签的属性名称 -->
			<name>name</name>
			<!-- true表示必填 -->
			<required>true</required>
			<!-- true支持动态值,可以向值里面填jsp表达式、EL表达式,false则不支持 -->
			<rtexprvalue>true</rtexprvalue>
		</attribute>
	</tag>
	<tag>
		<name>foreach</name>
		<tag-class>com.zking.jspTag.tag.foreachTag</tag-class>
		<!-- 标签的内容类型:empty表示空标签,jsp表示可以为任何合法的JSP元素 -->
		<body-content>jsp</body-content>
		
		<!-- 自定义标签的属性定义,请注意一定要在标签类中提供对应的get/set方法 -->
		<attribute>
			<!-- 自定义标签的属性名称 -->
			<name>items</name>
			<!-- true表示必填 -->
			<required>true</required>
			<!-- true支持动态值,可以向值里面填jsp表达式、EL表达式,false则不支持 -->
			<rtexprvalue>true</rtexprvalue>
		</attribute>
		<attribute>
			<!-- 自定义标签的属性名称 -->
			<name>var</name>
			<!-- true表示必填 -->
			<required>true</required>
			<!-- true支持动态值,可以向值里面填jsp表达式、EL表达式,false则不支持 -->
			<rtexprvalue>false</rtexprvalue>
		</attribute>
	</tag>
	<tag>
		<name>dept</name>
		<tag-class>com.zking.jspTag.tag.DeptTag</tag-class>
		<!-- 标签的内容类型:empty表示空标签,jsp表示可以为任何合法的JSP元素 -->
		<body-content>empty</body-content>
		
		<!-- 自定义标签的属性定义,请注意一定要在标签类中提供对应的get/set方法 -->
		<attribute>
			<!-- 自定义标签的属性名称 -->
			<name>var</name>
			<!-- true表示必填 -->
			<required>true</required>
			<!-- true支持动态值,可以向值里面填jsp表达式、EL表达式,false则不支持 -->
			<rtexprvalue>false</rtexprvalue>
		</attribute>
		<attribute>
			<!-- 自定义标签的属性名称 -->
			<name>scope</name>
			<!-- true表示必填 -->
			<required>false</required>
			<!-- true支持动态值,可以向值里面填jsp表达式、EL表达式,false则不支持 -->
			<rtexprvalue>false</rtexprvalue>
		</attribute>
	</tag>
</taglib>

2、自定义foreach标签 (操作步骤同test标签)

foreach循环不仅仅遍历集合,它也可以遍历数组。本次属性类型使用List方便操作,一般情况下是使用Object类型。List泛型默认是Object.

foreachTag.java (注解在代码中都有解释说明)

package com.zking.jspTag.tag;

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 List items;
	//每次遍历所定义的变量名,实际上在这里是将每次循环遍历的结果保存到指定作用域中,并以var属性来命名
	private String var;
	
	@Override
	public int doStartTag() throws JspException {
		//判断items是否为空
		if(null==items) {
			return SKIP_BODY;
		}else {
			//获取items的迭代器[xx,yy,jk]  var=n
			Iterator it = items.iterator();
			//获取迭代器中的下一个元素(移动下标)
			Object value = it.next();
			//将获取的值保存到page作用域中,并与以var属性来命名
			//pageContext.setAttribute("n",var);
			pageContext.setAttribute(var, value);
			//将剩余未完成的迭代器对象保存到page作用域,留到doAfterBody中再次进行遍历
			pageContext.setAttribute("it", it);
			return EVAL_BODY_INCLUDE;
		}
	}
	
	@Override
	public int doAfterBody() throws JspException {
		//SKIP_BODY:break
		//EVAL_BODY_AGAIN:continue
		//将剩余未完成的迭代器对象取出来(强转)
		Iterator it = (Iterator) pageContext.getAttribute("it");
		//使用if判断,判断迭代器中的下一个元素是否存在
		if(it.hasNext()) {
			//取出迭代器中的下一个元素(移动下标)
			Object value = it.next();
			//将获取的值保存到page作用域中,并与以var属性来命名
			//pageContext.setAttribute("n",var);
			pageContext.setAttribute(var, value);
			//将剩余未完成的迭代器对象保存到page作用域,留到doAfterBody中再次进行遍历
			pageContext.setAttribute("it", it);
			return EVAL_BODY_AGAIN;
		}
		return SKIP_BODY;
	}

	@Override
	public int doEndTag() throws JspException {
		return EVAL_PAGE;
	}
	
	public List getItems() {
		return items;
	}
	public void setItems(List items) {
		this.items = items;
	}
	public String getVar() {
		return var;
	}
	public void setVar(String var) {
		this.var = var;
	}
	
}

 3、自定义数据标签

 自定义数据标签顾名思义就是将自己编写数据循环遍历输出到页面中。

实现步骤(mytag.tld中已写好内容):

        1、创建一个实体类(Dept.java实体类为例),提供无参和有参构造方法、get/set方法

        2、创建对应的标签助手类DeptTag.jjava

        3、其余步骤同前面自定义标签一致

DeptTag.java

package com.zking.jspTag.tag;

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

import javax.servlet.ServletContext;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;

import com.zking.jspTag.util.Dept;
import com.zking.jspTag.util.Role;
/**
 * 	自定义的数据标签
 * @author gss
 *
 */
public class DeptTag extends BodyTagSupport{
	//将查询出来的数据保存到指定作用域中,并以var属性命名
	private String var;
	//可以通过该参数指明你所要存储的作用域(page/request/session/application)默认page
	private String scope;//作用域
	
	@Override
	public int doStartTag() throws JspException {
		//本案例的静态数据填充
		/*List<Dept> list = new ArrayList<>();
		list.add(new Dept(1,"研发部"));
		list.add(new Dept(2,"市场部"));
		list.add(new Dept(3,"人事部"));*/
		
		List<Role> list = new ArrayList<>();
		list.add(new Role(1,"管理员"));
		list.add(new Role(2,"普通人员"));
		list.add(new Role(3,"高级人员"));
		
		//获取Request对象
		HttpServletRequest request = (HttpServletRequest) pageContext.getRequest();
		//获取Session对象
		HttpSession session = pageContext.getSession();
		//获取Application对象
		ServletContext application = pageContext.getServletContext();
		
		//判断scope
		if(null==scope) {
			pageContext.setAttribute(var, list);
		}else if(scope.equals("request")) {
			request.setAttribute(var, list);
		}else if(scope.equals("session")) {
			session.setAttribute(var, list);
		}else if(scope.equals("application")) {
			application.setAttribute(var, list);
		}else {
			pageContext.setAttribute(var, list);
		}
		return SKIP_BODY;
	}
	
	@Override
	public int doEndTag() throws JspException {
		return EVAL_PAGE;
	}
	
	public String getVar() {
		return var;
	}
	public void setVar(String var) {
		this.var = var;
	}
	public String getScope() {
		return scope;
	}
	public void setScope(String scope) {
		this.scope = scope;
	}
	
}

4、在index.jsp中调用方法

<%@page import="java.util.Arrays"%>
<%@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="/zking" 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>
<%
	List<String> list = Arrays.asList(new String[]{"sum","xy","time"});
	//作用域(小->大):page -> request -> session ->application
	request.setAttribute("list", list);
	request.setAttribute("name", "lxy");
%>
<!--requestScope.list (隐式作用域)获取某个作用域的list 直接定位作用域  -->
<!-- ${list} 由小到大进行遍历 ,直到找到为止-->
<!--var 不允许接收表达式 必须给为true  -->

<c:forEach items="${list}" var="y">
	${y}
</c:forEach>

<h2>1、自定义test标签</h2>
<z:test name="${name}">1949101</z:test>
3.14159265<br/>
1521<br/>
8080<br/>
3306<br/>

<h2>2、自定义out标签</h2>
<!-- 空标签也行value="${name }"既接收纯文本也能接收动态值 -->
<z:out value="t277"></z:out>

<h2>3、自定义if标签</h2>
<!-- test="${name eq 'lxy' }判断是否是正确的,是就输出;反之亦然 -->
<!-- false(不输出): 111()/zzz  -->
<z:if test="true">
	人生处处都是戏,戏里处处看人生。
</z:if>

<h2>4、自定义foreach标签</h2>
<z:foreach items="${list}" var="x">
	${x}
</z:foreach>

<h2>5、自定义数据标签</h2>
<z:dept var="data" scope="request"/>
${requestScope.data}

<!-- <select><option value="1">研发部</option></select> -->

<z:select items="${data }" optionValue="roleId" optionText="roleName"/>

</body>
</html>

运行效果如图所示:


 总结:

        文章的最后预留了:自定义out标签(简单)、自定义if标签(简单)、自定义下拉框标签(满足所有应用场景)还没有讲,同志们可以先尝试做做。送给大家的话:在这个世界中,学习,永远都是无止境的;没有人天生优秀,但总有人熠熠生辉,我们也不能停下脚步。

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值