概述
自己定义一个jsp标签并使这个标签具备相应的功能
自定义标签的开发及使用步骤
1.创建一个标签助手类(继承BodyTagSupport)
重写三个方法,doStartTag()负责开始标签,doAfterBody()负责标签体,doEndTag()负责结束标签。如果标签具备属性,标签属性必须与助手类的属性对应、且要提供对应get/set方法
2.创建标签库描述文件(tld),添加自定义标签的配置( 注:tld文件必须保存到WEB-INF目录或其子目录)
3.在JSP通过taglib指令导入标签库描述文件,并通过指定后缀访问此自定义标签
生命周期(从开始到结束)
返回值
一共有五个返回值,每个方法有两个返回值。
以自定义标签eat为例,看每个方法的返回值的具体作用。
1.创建标签助手类
package com.tag;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
public class EatTag extends BodyTagSupport {
/**
* 负责开始标签
* SKIP_BODY:跳过主体
* EVAL_BODY_INCLUDE:计算标签主体内容并[输出]
*
*/
public int doStartTag() throws JspException {
System.out.println("开始");
return super.doStartTag();
}
/**
* 负责标签体
* SKIP_BODY:跳过主体
* EVAL_BODY_AGAIN:再计算主体一次
*/
public int doAfterBody() throws JspException {
System.out.println("标签体");
return super.doAfterBody();
}
/**
* 负责结束标签
* EVAL_PAGE:计算页面的后续部分
* SKIP_PAGE:跳过页面的后续部分
* */
public int doEndTag() throws JspException {
System.out.println("结束");
return super.doEndTag();
}
}
2.创建标签库描述文件(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>Simple Tags</short-name>
<!-- 自定义标签引用名 -->
<uri>/zking</uri>
<!-- eat标签 -->
<tag>
<!-- 标签名 -->
<name>eat</name>
<!-- 标签助手类 -->
<tag-class>com.tag.EatTag</tag-class>
<!-- 标签的内容类型:empty表示空标签,jsp表示可以为任何合法的JSP元素 -->
<body-content>Jsp</body-content>
</tag>
</taglib>
3.在JSP通过taglib指令导入标签库描述文件
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<%@taglib prefix="c" uri="/zking"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
阿拉山口地方
<c:eat>吃了睡,睡了吃</c:eat>
哦撒
</body>
</html>
每个方法没有返回值时,jsp界面中eat标签中的内容不会输出
doStartTag()返回SKIP_BODY时标签体不会运行
doStartTag()返回 EVAL_BODY_INCLUDE:计算标签主体内容并[输出]
doAfterBody()返回SKIP_BODY时标签体只会运行一次jsp界面运行内容与doStartTag()返回 EVAL_BODY_INCLUDE时运行一样。
doAfterBody()返回EVAL_BODY_AGAIN时,再计算主体一次(相当于死循环)。运行时页面上会一直输出标签体的内容
doEndTag() 返回EVAL_PAGE时计算页面的后续部分,返回SKIP_PAGE时跳过页面的后续部分(eat标签后面的内容都不计算)
if标签
<!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>Simple Tags</short-name>
<!-- 自定义标签引用名 -->
<uri>/zking</uri>
<!-- if标签 -->
<tag>
<!-- 标签名 -->
<name>if</name>
<!-- 标签助手类 -->
<tag-class>com.tag.IfTag</tag-class>
<!-- 标签的内容类型:empty表示空标签,jsp表示可以为任何合法的JSP元素 -->
<body-content>Jsp</body-content>
<!-- 标签属性,要在标签助手类中设置set/get方法 -->
<attribute>
<!-- 属性名 -->
<name>test</name>
<!-- 设置该属性是否为必填属性,true表示必填 -->
<required>true</required>
<!-- true支持动态值,可以向值里面填jsp表达式、EL表达式,false则不支持 -->
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
</taglib>
由于if标签上有属性,所以需要在标签助手类中定义一个相同的属性并提供set/get方法
package com.tag;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
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 {
if(this.test)//如果test值为true
return EVAL_BODY_INCLUDE;//运行标签体
return SKIP_BODY;//否则就跳过标签体的运行
}
@Override
public int doAfterBody() throws JspException {
// TODO Auto-generated method stub
return super.doAfterBody();
}
@Override
public int doEndTag() throws JspException {
// TODO Auto-generated method stub
return super.doEndTag();
}
}
在jsp界面导入标签库描述文件后使用if标签:<c:if test=“true”>电动小马达</c:if>当test值为true是页面会打印标签内容。
forEach标签
<!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>Simple Tags</short-name>
<!-- 自定义标签引用名 -->
<uri>/zking</uri>
<!-- forEach标签 -->
<tag>
<!-- 标签名 -->
<name>forEach</name>
<!-- 标签助手类 -->
<tag-class>com.tag.ForeachTag</tag-class>
<!-- 标签的内容类型:empty表示空标签,jsp表示可以为任何合法的JSP元素 -->
<body-content>Jsp</body-content>
<!-- 标签属性,要在标签助手类中设置set/get方法 -->
<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>
</taglib>
forEach标签的助手类
package com.tag;
import java.io.IOException;
import java.util.Iterator;
import java.util.List;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.BodyTagSupport;
public class ForeachTag extends BodyTagSupport {
private List items;
private String var;
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;
}
@Override
public int doStartTag() throws JspException {
/** 开始标签
* 1.获取到集合中的值
* 2.判断集合中是否有值
* 3.为了使标签体方法可以运行,开始标签先取一个值,输出显示,将剩下的值发送给标签体
* */
Iterator<Object> i = items.iterator();//获取到集合中的值
//判断集合中是否有值
if(i.hasNext()) {
Object next = i.next();
//将迭代器放到作用域中
pageContext.setAttribute("a", i);
//取第一个值输出打印
pageContext.setAttribute(var, next);
return EVAL_BODY_INCLUDE;
}
return SKIP_BODY;
}
@Override
public int doAfterBody() throws JspException {
/** 标签体
* 1.获取到集合中剩下的值
* 2.打印集合中剩下的值
* */
//获取到集合中剩下的值
Iterator<Object> i =(Iterator<Object>)pageContext.getAttribute("a");
//打印集合中剩下的值
if(i.hasNext()) {
Object next = i.next();
pageContext.setAttribute(var, next);
return EVAL_BODY_AGAIN;
}
return SKIP_BODY;
}
@Override
public int doEndTag() throws JspException {
// TODO Auto-generated method stub
return super.doEndTag();
}
}
在jsp界面使用forEach标签,为了方便集合也在jsp界面用java加入
<%@page import="java.util.ArrayList"%>
<%@page import="java.util.List"%>
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<%@taglib prefix="c" uri="/zking"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>J2EE_09JSP标签2</title>
</head>
<%
List list=new ArrayList();
for(int i=1;i<10;i++){
list.add(i);
}
session.setAttribute("list", list);
%>
<body>
<c:forEach items="${list}" var="i">
${i }
</c:forEach>
</body>
</html>
运行后会在界面输出1 2 3 4 5 6 7 8 9