JavaWeb_JSP_自定义标签

本博文为子墨原创，转载请注明出处！

http://blog.csdn.net/zimo2013/article/details/9101981

1.自定义标签

    作用：自定义标签用于移除Jsp页面中的java代码

    完成一个标签需满足下面步骤：
        (1).一个继承标签相关类的java类
        (2).编写标签库描述符tld(Tag Library Descriptor)文件，在tld文件中对标签处理器类描述成一个标签。
        (3).配置app的web.xml信息
        (4).在page页引用

        具体代码配置>>

2.JspTag接口

    其中Tag接口为传统的标签接口，SimpleTag为简单接口，可以完成传统标签的所有功能

 

3.SimpleTag接口
    SimpleTag接口是JSP2.0中新增的一个标签接口。由于传统标签使用三个标签接口来完成不同的功能，显得过于繁琐，不利于标签技术的推广.SimpleTagSupport是SimpleTag接口的实现类，只定义了一个用于处理标签逻辑的doTag方法。
    (1).生命周期(LifeCycle)
        1).创建标签处理器类的实例对象;
        2).调用setJspContext()，通过该方法可以得到隐式对象；
        3).在父标签存在的情况下，调用setParent()；
        4).如果调用标签设置了属性，调用与每个属性对应的setter方法，把属性值传递给对象;
        5).在标签体存在情况下，调用setJspBody()把代表标签体的JspFragment对象传递进来;
        6).执行标签时，容器调用标签处理器的doTag()方法.
    (2).toTag()
        如果page后面的页面输出，则直接 throw new SkipPageException()；
        如果输出标签体信息，则直接 this.getJspBody().invoke(null);其中invoke作用，将标签体中的信息写入invoke接收的流对象中去，null默认为this.getJspContext().getOut()
    (3).获得标签体信息
        不可以直接获得，必须invoke()一个流对象，再从流对象中读取，而传统标签可以直接通过this.bodyContent.getString()获得

public void doTag() throws JspException, IOException {
		StringWriter sw = new StringWriter();		//新建一个StringWriter，可以方便读取流信息
		this.getJspBody().invoke(sw);			//将标签体信息写进一个流，如果为null则默认为浏览器
		String str = sw.toString().toUpperCase();	//sw.toString()方法可以获得流中的字符串信息
		this.getJspContext().getOut().write(str);	//将处理后的结果写入JspWriter缓存中去
	}

4.Tag接口
    (1).生命周期(LifeCycle)
        1).创建标签处理器类的实例对象;
        2).调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器;
        3).调用setParent方法将当前标签的父标签传递给当前标签处理器，如果不存在，则返回null。
        4).调用标签处理器的doStartTag();
        5).调用doEndTag();
        6).通常WEB容器执行完自定义标签后，标签处理器会驻留在内存中，为其它请求服务，直至停止web应用时，web容器才会调用release方法。
    (2).返回值说明

 

    (3).EVAL_BODY_BUFFERED的特别说明
        doStartTag()返回EVAL_BODY_BUFFERED，隐含操作(创建BodyContent对象，调用setBodyContent()，写入到BodyContent对象中),可以通过this.bodyContent.getString()直接获得标签体的字符串信息。没有返回EVAL_BODY_BUFFERED，则不会创建BodyContent对象。

public int doEndTag() throws JspException {
		String str = this.bodyContent.getString().toUpperCase();//为得到标签体信息，doStartTag()必须返回EVAL_BODY_BUFFERED
		try {
			this.pageContext.getOut().write(str);
		} catch (IOException e) {
			throw new RuntimeException(e);
		}
		return super.doEndTag();
	}

 

5.tld

<tag>
	<name>simpleEnd</name> <!-- 标签名称 -->
	<tag-class>com.baidu.web.tag.SimpleEnd</tag-class><!-- 标签所在的java类，完整路径 -->
	<body-content>empty</body-content> <!-- 标签体，empty(简单和传统标题通用)，JSP(传统标签)，scriptles(简单标签标签) -->
	<attribute>
	<name>flag</name>  <!-- 属性名，大小写敏感 -->
		<required>true</required> <!-- 该属性是否必须指定 -->
		<rtexprvalue>true</rtexprvalue> <!-- 属性是否支持el表达式 -->
		<!-- <type>java.lang.Integer</type> 属性类型 -->
	</attribute>
</tag>

 

SimpleTagSupport的相关操作代码

	//编辑标签体内容
	public void doTag() throws JspException, IOException {
		StringWriter sw = new StringWriter();		//新建一个StringWriter，可以方便读取流信息
		this.getJspBody().invoke(sw);				//将标签体信息写进一个流，如果为null则默认为浏览器
		String str = sw.toString().toUpperCase();	//sw.toString()方法可以获得流中的字符串信息
		this.getJspContext().getOut().write(str);	//将处理后的结果写入JspWriter缓存中去
	}
	//控制标签体后的page页是否输出
	public void doTag() throws JspException, IOException {
		if(flag){
			throw new SkipPageException();	//不输出，直接抛出一个异常
		}
	}
	//标签体信息的迭代输出
	public void doTag() throws JspException, IOException {
		for(int i=0; i<count; i++){
			this.getJspBody().invoke(null);
		}
	}
	//控制标签体信息是否输出
	public void doTag() throws JspException, IOException {
		if(flag){
			this.getJspBody().invoke(null);
		}
	}

TagSupport的相关操作代码

	//编辑标签体内容
	public int doStartTag() throws JspException {
		return EVAL_BODY_BUFFERED;
	}
	public int doEndTag() throws JspException {
		String str = this.bodyContent.getString().toUpperCase();//为得到标签体信息，doStartTag()必须返回EVAL_BODY_BUFFERED
		try {
			this.pageContext.getOut().write(str);
		} catch (IOException e) {
			throw new RuntimeException(e);
		}
		return super.doEndTag();
	}
	
	//标签体信息的迭代输出
	public int doStartTag() throws JspException {
		return EVAL_BODY_INCLUDE;
	}
	public int doAfterBody() throws JspException {
		count--;
		if(count > 0){
			return EVAL_BODY_AGAIN;
		}
		return SKIP_BODY;
	}
	
	//控制标签体后的page页是否输出
	public int doEndTag() throws JspException {
		if(flag){
			return SKIP_PAGE;
		}
		return EVAL_PAGE;
	}
	
	//控制标签体信息是否输出
	if(!flag){
		return SKIP_BODY;
	}
	return EVAL_BODY_INCLUDE;