欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

jsp中的自定义标签

程序员文章站 2022-06-09 13:03:36
...

(jsp 1.0规范)

一,自定义标签主要用于移除Jsp页面中的java代码;

使用自定义标签移除jsp页面中的java代码,只需要完成以下两个步骤:

1,编写一个实现Tag接口的Java类(标签处理器类)。

2,编写标签库描述符(tld)文件,在tld文件中对标签处理器类描述成一个标签。(.tld文件放在WEB-INF目录下面)


二,TAG接口的执行流程;

JSP引擎将遇到自定义标签时,首先创建标签处理器类的实例对象,然后按照JSP规范定义的通信规则依次调用它的方法。

1public void setPageContext(PageContext pc)

JSP引擎实例化标签处理器后,将调用setPageContext方法将JSP页面的pageContext对象传递给标签处理器,标签处理器以后可以通过这个pageContext对象与JSP页面进行通信。


2,public void setParent(Tag t);

setPageContext方法执行完后,WEB容器接着调用的setParent方法将当前标签的父标签传递给当前标签处理器,如果当前标签没有父标签,则传递给setParent方法的参数值为null


3,public int doStartTag();

调用了setPageContext方法和setParent方法之后,WEB容器执行到自定义标签的开始标记时,就会调用标签处


理器的doStartTag方法。


4,public int doEndTag();

WEB容器执行完自定义标签的标签体后,就会接着去执行自定义标签的结束标记,此时,WEB容器会去调用标

签处理器的doEndTag方法。


5,public void release();

通常WEB容器执行完自定义标签后,标签处理器会驻留在内存中,为其它请求服务器,直至停止web

时,web容器才会调用release方法。


代码:

/*
 * 标签处理器类   页面内容不输出
 */
public class TagDemo1 extends TagSupport {//继承自TAG接口的子类

	@Override
	public int doStartTag() throws JspException {
		
		return Tag.SKIP_BODY;//页面内容不输出
	}
}


/*
 * 页面内容输出  标签处理器类
 */
public class TagDemo2 extends TagSupport {

	@Override
	public int doEndTag() throws JspException {
		return Tag.EVAL_PAGE;
	
}


/*
 * 页面内容重复输出
 */
public class TagDemo3 extends TagSupport {

	int i = 5;
	
	@Override
	public int doStartTag() throws JspException {
		return EVAL_BODY_INCLUDE;
	}
	
	@Override
	public int doAfterBody() throws JspException {
		i--;
		if(i>0){
			return EVAL_BODY_AGAIN;
		}else{
			return SKIP_BODY;
		}
		
	}
	
}


/*
 * 改变页面内容
 */
public class TagDemo4 extends BodyTagSupport {

	@Override
	public int doStartTag() throws JspException {
		// TODO Auto-generated method stub
		return EVAL_BODY_BUFFERED;
	}
	
	@Override
	public int doEndTag() throws JspException {
		BodyContent bc = this.bodyContent;
		String content = bc.getString();
		content = content.toUpperCase();
		
		try {
			this.pageContext.getOut().write(content);
		} catch (IOException e) {
			throw new RuntimeException(e);
		}
		
		return EVAL_PAGE;
	}
	
}


tld描述文件

//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">
    
    <description>A tag library exercising SimpleTag handlers.</description>
    <tlib-version>1.0</tlib-version>
    <short-name>SimpleTagLibrary</short-name>
    <uri>/yujian</uri>
    
     <tag>
           <name>demo1</name>
           <tag-class>cn.yujian.web.tag.TagDemo1</tag-class>
	   <body-content>JSP</body-content>
    </tag>
    

    <tag>
        <name>demo2</name>
	<tag-class>cn.yujian.web.tag.TagDemo2</tag-class>
	<body-content>empty</body-content>
    </tag>
    
     <tag>
        <name>demo3</name>
	<tag-class>cn.yujian.web.tag.TagDemo3</tag-class>
	<body-content>JSP</body-content>
    </tag>
    
    
    <tag>
        <name>demo4</name>
	<tag-class>cn.yujian.web.tag.TagDemo4</tag-class>
	<body-content>JSP</body-content>
    </tag>
    
</taglib>

jsp页面:

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>用标签控制页面内容是否输出</title>
  </head>
  
  <body>
   <flx:demo1>
   	aaaaaaaaaaa
   </flx:demo1>
  </body>
</html>


<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<flx:demo2/>
<html>
  <head>
    <title>用标签可以控制整个页面是否执行</title>
  </head>
  
  <body>
  aaaaaaaaaaaaaaaaaaaaa 
  </body>
</html>
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<flx:demo2/>
<html>
  <head>
    <title>用标签可以控制整个页面是否执行</title>
  </head>
  
  <body>
  aaaaaaaaaaaaaaaaaaaaa 
  </body>
</html>
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>用标签修改页面内容</title>
  </head>
  
  <body>
	<flx:demo4> 
	  	aaaaaaaaaaaaaaaaaaaaa
	</flx:demo4>
  </body>
</html>


  jsp 2.0规范  简单标签 

 一,由于传统标签使用三个标签接口来完成不同的功能,显得过于繁琐,不利于标签技术的推广, SUN公司为降低标签技术的学习难度,在JSP 2.0中定义了一个更为简单、便于编写和调用的SimpleTag接口来实现标签的功能。实现SimpleTag接口的标签通常称为简单标签。简单标签共定义了5个方法:

setJspContext方法 

setParentgetParent方法 

setJspBody方法 

doTag方法


二,SimpleTag方法介绍

 setJspContext方法 

用于把JSP页面的pageContext对象传递给标签处理器对象  


setParent方法 

用于把父标签处理器对象传递给当前标签处理器对象  


getParent方法 

用于获得当前标签的父标签处理器对象  


setJspBody方法 

用于把代表标签体的JspFragment对象传递给标签处理器对象  


doTag方法 

用于完成所有的标签逻辑,包括输出、迭代、修改标签体内容等。在doTag方法中可以抛javax.servlet.jsp.SkipPageException异常,用于通知WEB容器不再执行JSP页面中位于结束标记后面的内容,这等效于在传统标签的doEndTag方法中返回Tag.SKIP_PAGE常量的情况。  


三,SimpleTag接口方法的执行顺序

 l当web容器开始执行标签时,会调用如下方法完成标签的初始化 

1,•WEB容器调用标签处理器对象的setJspContext方法,将代表JSP页面的pageContext对象传递给标签处理器对象。 

2,•WEB容器调用标签处理器对象的setParent方法,将父标签处理器对象传递给这个标签处理器对象。注意,只有在标签存在父标签的情况下,WEB容器才会调用这个方法。

3,•如果调用标签时设置了属性,容器将调用每个属性对应的setter方法把属性值传递给标签处理器对象。如果标签的属性值是EL表达式或脚本表达式,则WEB容器首先计算表达式的值,然后把值传递给标签处理器对象。

4,•如果简单标签有标签体,容器将调用setJspBody方法把代表标签体的JspFragment对象传递进来。

l执行标签时:

1,•容器调用标签处理器的doTag()方法,开发人员在方法体内通过操作JspFragment对象,就可以实现是否执行、迭代、修改标签体的目的。


四,JspFragment 

javax.servlet.jsp.tagext.JspFragment类是在JSP2.0中定义的,它的实例对象代表JSP页面中的一段符合JSP语法规范的JSP片段,这段JSP片段中不能包含JSP脚本元素。

WEB容器在处理简单标签的标签体时,会把标签体内容用一个JspFragment对象表示,并调用标签处理器对象的setJspBody方法把JspFragment对象传递给标签处理器对象。JspFragment类中只定义了两个方法,如下所示:

 getJspContext方法 

用于返回代表调用页面的JspContext对象.

public abstract void invoke(java.io.Writer out) 

 用于执行JspFragment对象所代表的JSP代码片段 参数out用于指定将JspFragment对象的执行结果写入到哪个输出流对象中,如果传递给参数out的值为null,则将执行结果写入到JspContext.getOut()方法返回的输出流对象中。(简而言之,可以理解为写给浏览器)


五,invoke方法详解  

在标签处理器中如果没有调用JspFragment.invoke方法,其结果就相当于忽略标签体内容;

在标签处理器中重复调用JspFragment.invoke方法,则标签体内容将会被重复执行; 

若想在标签处理器中修改标签体内容,只需在调用invoke方法时指定一个可取出结果数据的输出流对象(例如StringWriter),让标签体的执行结果输出到该输出流对象中,然后从该输出流对象中取出数据进行修改后再输出到目标设备,即可达到修改标签体的目的。

代码:(标签处理器类)

/*
 * 输出标签体
 */
public class SimpleTagDemo1 extends SimpleTagSupport {

	@Override
	public void doTag() throws JspException, IOException {
		JspFragment jf = this.getJspBody();
		jf.invoke(null);
	}
}


/*
 * 循环输出标签体
 */
 public class SimpleTagDemo2 extends SimpleTagSupport {

	@Override
	public void doTag() throws JspException, IOException {
		JspFragment jf = this.getJspBody();
		for(int i=0;i<5;i++){
			jf.invoke(null);
		}
	}
}
 
 
/*
 * 修改内容
 */
 public class SimpleTagDemo3 extends SimpleTagSupport {

	@Override
	public void doTag() throws JspException, IOException {
		
		JspFragment jf = this.getJspBody();
		StringWriter sw = new StringWriter();
		jf.invoke(sw);//将内容写入缓冲
		String content = sw.toString(); //获取缓冲区的内容进行修改
		content = content.toUpperCase();
		this.getJspContext().getOut().write(content);
	}
}
 
 
/*
 * 采用抛异常的方式在阻止内容执行
 */
 public class SimpleTagDemo4 extends SimpleTagSupport {

	@Override
	public void doTag() throws JspException, IOException {
		throw new SkipPageException();
	}
}

tld描述文件:

<?xml version="1.0" encoding="UTF-8" ?>

<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">
    
    
    <description>A tag library exercising SimpleTag handlers.</description>
    <tlib-version>1.0</tlib-version>
    <short-name>SimpleTagLibrary</short-name>
    <uri>/yujian_simple</uri>
    
     
    <tag>
        <name>simpledemo1</name>
	<tag-class>cn.yujian.web.simpletag.SimpleTagDemo1</tag-class>
	<body-content>scriptless</body-content><!--scriptless表示不能有脚本代码-->
    </tag>
    
    
    <tag>
        <name>simpledemo2</name>
	<tag-class>cn.yujian.web.simpletag.SimpleTagDemo2</tag-class>
	<body-content>scriptless</body-content>
    </tag>
    
     <tag>
        <name>simpledemo3</name>
	<tag-class>cn.yujian.web.simpletag.SimpleTagDemo3</tag-class>
	<body-content>scriptless</body-content>
    </tag>
    
    <tag>
        <name>simpledemo4</name>
	<tag-class>cn.yujian.web.simpletag.SimpleTagDemo4</tag-class>
	<body-content>scriptless</body-content>
    </tag>
    
</taglib>


jsp页面:

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian_simple" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>用简单标签控制页面内容是否输出</title>
  </head>
  
  <body>
  	<flx:simpledemo1>
    	This is my JSP page. <br>
    </flx:simpledemo1>
  </body>
</html>
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian_simple" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>用简单标签控制页面内容重复输出</title>
  </head>
  
  <body>
  	<flx:simpledemo2>
    	This is my JSP page. <br>
    </flx:simpledemo2>
  </body>
</html>


<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian_simple" prefix="flx" %>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<flx:simpledemo4/>
  <head>
    <title>用简单标签控制整个页面是否执行</title>
  </head>
  
  <body>
    	This is my JSP page. <br>
  </body>
</html>



开发带属性的标签

自定义标签可以定义一个或多个属性,这样,在JSP页面中应用自定义标签时就可以设置这些属性的值,通过这些属性为标签处理器传递参数信息,从而提高标签的灵活性和复用性。

 要想让一个自定义标签具有属性,通常需要完成两个任务: 

在标签处理器中编写每个属性对应的setter方法

TLD文件中描术标签的属性

l为自定义标签定义属性时,每个属性都必须按照JavaBean的属性命名方式,在标签处理器中定义属性名对应的setter方法,用来接收JSP页面调用自定义标签时传递进来的属性值。例如属性url,在标签处理器类中就要定义相应的setUrl(Stringurl)方法。

l在标签处理器中定义相应的set方法后,JSP引擎在解析执行开始标签前,也就是调用doStartTag方法前,会调用set属性方法,为标签设置属性。

代码:

public class SimpleTagDemo5 extends SimpleTagSupport {

	private int count;
	private Date birthday;
	public void setBirthday(Date birthday) {
		this.birthday = birthday;
	}
	public void setCount(int count) {
		this.count = count;
	}
	@Override
	public void doTag() throws JspException, IOException {
		
		System.out.println(this.birthday);
		for(int i=0;i<count;i++){
			this.getJspBody().invoke(null);
		}
	}
}

tld描述文件:

   <tag>
                <name>simpledemo5</name>
		<tag-class>cn.yujian.web.simpletag.SimpleTagDemo5</tag-class>
		<body-content>scriptless</body-content>
		
		<attribute>
			<name>count</name>
			<required>true</required>
			<rtexprvalue>true</rtexprvalue>
		</attribute>
		
		<attribute>
			<name>birthday</name>
			<required>true</required>
			<rtexprvalue>true</rtexprvalue>
		</attribute>
		
    </tag>

jsp文件:

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian_simple" prefix="flx" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>带属性的标签</title>
  </head>
  
  <body>
  	<flx:simpledemo5 count="10" birthday="<%=new Date() %>">
    	This is my JSP page. <br>
    </flx:simpledemo5>
  </body>
</html>



在TLD中描述标签属性attribute:


description   不是必须;

用于指定属性的描述信息。


name  是必须;

用于指定属性的名称。属性名称是大小写敏感的,并且不能以jsp_jspjavasun

开头。   


required   不是必须;

用于指定在JSP页面中调用自定义标签时是否必须设置这个属性。其取值包括true

false,默认值为falsetrue表示必须设置,否则可以设置也可以不设置该属性。



rtexprvalue  不是必须;

rtexprvalueruntime expression value(运行时表达式)的英文简写,用于指定属性值是一个静态值或动态值。其取值包括truefalse,默认值为falsefalse表示只能为该属性指定静态文本值,例如"123"true表示可以为该属性指定一个JSP动态元素,动态元素的结果作为属性值,例如JSP表达式<%=value %>


type   不是必须;

用于指定属性值的Java类型。



拓展:

html转义标签
public class HtmlFilterTag extends SimpleTagSupport {

	@Override
	public void doTag() throws JspException, IOException {
		
		StringWriter sw = new StringWriter();
		this.getJspBody().invoke(sw);
		
		String content = sw.toString();
		content = filter(content);
		this.getJspContext().getOut().write(content);
	}
	
	public  String filter(String message) {

        if (message == null)
            return (null);

        char content[] = new char[message.length()];
        message.getChars(0, message.length(), content, 0);
        StringBuffer result = new StringBuffer(content.length + 50);
        for (int i = 0; i < content.length; i++) {
            switch (content[i]) {
            case '<':
                result.append("&lt;");
                break;
            case '>':
                result.append("&gt;");
                break;
            case '&':
                result.append("&amp;");
                break;
            case '"':
                result.append("&quot;");
                break;
            default:
                result.append(content[i]);
            }
        }
        return (result.toString());

    }

}

tld描述:

  <tag>
        <name>htmlfilter</name>
	<tag-class>cn.yujian.web.example.HtmlFilterTag</tag-class>
	<body-content>scriptless</body-content>
    </tag>


jsp使用:

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@taglib uri="/yujian_example" prefix="c" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>My JSP '6.jsp' starting page</title>
  </head>
  
  <body>
    <c:htmlfilter>
    	<a href="">点点</a>
    </c:htmlfilter>
  </body>
</html>



转载于:https://my.oschina.net/u/936286/blog/350460