jsp自定义标签

自定义jsp标签介绍

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

1. 自定义标签的开发及使用步骤
1.1 创建一个标签助手类(继承BodyTagSupport)
标签属性必须与助手类的属性对应、且要提供对应get/set方法

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

1.3 在JSP通过taglib指令导入标签库，并通过指定后缀访问自定义标签

助手类
每个标签都要有它相应的助手类来帮助它实现功能，而助手类介绍继承了BodyTagSupport这个类的来描述这个标签实现功能的一个类。
在助手类的周期中，主要有3个方法来支撑它实行。

1、doStartTag() 执行到开始标签时执行的动作

 -----2个返回值
 		SKIP_BODY 跳过主体内容
 		EVAL_BODY_INCLUDE 计算页面主体内同并包含再输出

2、doAfterBody() 介于<c:test>内容</c:test>之间执行的动作

 -----2个返回值
  EVAL_BODY_AGAIN 再次计算主体内容并输出
  SKIP_BODY 跳过主体内容

3、doEndTag() 执行到结束标签时执行的动作

 -----2个返回值
  SKIP_PAGE  跳过页面的后续内容
  EVAL_PAGE  计算页面的后续内容

生命周期
我们能通过自定义标签来实现功能，主要是依靠它的助手类来实现的，所以相对的自定义标签也有它相对的一套方法流程，也就是我们的生命周期。

标签的生命周期主要分为3条线：

一、由doStartTag开始，返回SKIP_BODY直接进入doEndTag方法,返回SKIP_PAGE或EVAL_PAGE结束

二、由doStartTag开始，返回EVAL_BODY_INCLUDE进入doAfterBody方法，然后返回SKIP_BODY直接进入doEndTag方法,返回SKIP_PAGE或EVAL_PAGE结束

三、由doStartTag开始，返回EVAL_BODY_INCLUDE进入doAfterBody方法，然后返回EVAL_BODY_AGAIN再次进入doAfterBody，直到条件满足，返回SKIP_BODY进入doEndTag方法,返回SKIP_PAGE或EVAL_PAGE结束

自定义标签案例

我们自定义两个我们c标签常用的标签:c:if和c:foreach

首先建一个z.tld文件，用来描述我们的标签

<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">

    <tag>
    <!-- 标签名 -->
    <name>if</name>
    <!-- 标签工具类 -->
    <tag-class>com.xy.taglib.IfTag</tag-class>
    <!-- 标签的内容类型：empty表示空标签，jsp表示可以为任何合法的JSP元素 -->
    <body-content>JSP</body-content>
    
    <!-- 自定义标签的属性定义,请注意一定要在标签类中提供对应的get/set方法 -->
    <attribute>
    <!-- 自定义标签的属性名称 -->
        <name>test</name>
        <!-- true表示必填 -->
        <required>true</required>
        <!-- true支持动态值,可以向值里面填jsp表达式、EL表达式,false则不支持 -->
        <rtexprvalue>true</rtexprvalue>
    </attribute>
  </tag>

	<tag>
    <name>foreach</name>
    <tag-class>com.xy.taglib.ForeachTag</tag-class>
    <body-content>JSP</body-content>
    
    <attribute>
        <name>item</name>
        <required>true</required>
        <rtexprvalue>true</rtexprvalue>
    </attribute>
     <attribute>
        <name>var</name>
        <required>true</required>
        <rtexprvalue>false</rtexprvalue>
    </attribute>
  </tag>
</taglib>

if标签的助手类

public class IfTag extends BodyTagSupport{
	
	//判断传过来就只可能就两种，符合或者不符合，所以用boolean
	private boolean test;
	
	//传入一个参数，这是一个判断的结果
	public boolean isTest() {
		return test;
	}

	public void setTest(boolean test) {
		this.test = test;
	}

	@Override
	public int doStartTag() throws JspException {
		if(test) {//如果符合值
			return EVAL_BODY_INCLUDE;
		}
		else {
			return SKIP_BODY;
		}
	}
	
	@Override
	public int doEndTag() throws JspException {
		return EVAL_BODY_AGAIN;
	}
}

foreach的助手类

public class ForeachTag extends BodyTagSupport {
	
	//因为传过来是一个什么都可能的集合
	private List<Object> item;
	//我们用来取值的
	private String var;
	
	
	public List<Object> getItem() {
		return item;
	}
	public void setItem(List<Object> item) {
		this.item = item;
	}
	public String getVar() {
		return var;
	}
	public void setVar(String var) {
		this.var = var;
	}
	
	@Override
	public int doStartTag() throws JspException {
		//判断传入集合是否为空
		if(null==item||0==item.size()) {
			return SKIP_BODY;
		}
		else {
			Iterator<Object> it = item.iterator();
			JspWriter out = pageContext.getOut();
			//获取第一个元素
			Object next = it.next();
			//保存到作用域中，以var命名,前台用var来取集合的值
			pageContext.setAttribute(var, next);
			//将获取了一个元素的迭代器保存到Page作用域中
			pageContext.setAttribute("it", it);
			try {
				out.print(next);
			} catch (IOException e) {
				e.printStackTrace();
			}
			
		}
		return EVAL_BODY_INCLUDE;
	}
	
	@Override
	public int doAfterBody() throws JspException {
		Iterator it =(Iterator)pageContext.getAttribute("it");
		//在doAfterBody里面，不需要用while
		if(it.hasNext()) {
			Object next = it.next();
			//保存到作用域中
			pageContext.setAttribute(var, next);
			//将迭代器保存到page中，留到下一次doAfterBody中再次取出遍历，直到没有元素为止
			pageContext.setAttribute("it", it);
			return EVAL_BODY_AGAIN;
		}
		return SKIP_BODY;
	}

}

然后我们再jsp页面上来用一用我们刚刚定义的标签

最后结果也是都验证成功了!