一、自定义标签简介
在JSP2.0以后,JSP页面中不建议使用脚本片段和JSP表达式,我们使用EL表达式来替换JSP表达式,主要用来在页面中输出一个对象,我们使用标签来替换脚本片段,比如JSP动作标签<jsp:forward></jsp:forward>相当于request.getRequestDispatcher().forward();自定义标签就是让我们以标签的形式在JSP页面中去调用Java代码,每一个标签在背后都对应一个标签处理器类,有时候我们需要一些个性化的需求,所以我们还需要在jsp动作标签以外,来自定义标签。
二、自定义标签步骤
1、创建标签处理器类
创建标签处理器类有两种方式:一种是实现Tag接口;另一种是实现SimpleTag接口。实现Tag接口比较麻烦,所以我们一般采取实现SimpleTag接口的方式。
SimpleTag接口:
//该方法在标签执行时调用,标签处理器类中主要要实现的方法
void doTag();
//获取当前标签的父标签
JspTag getParent();
// 设置当前标签的标签体,由服务器调用
void setJspBody(JspFragment jspBody);
//设置当前标签的JspContext对象
//JspContext就是JSP中的PageContext对象,可以用来获取JSP页面中的其他隐含对象
//这个方法由服务器调用,服务器通过该方法将PageContext传进处理器类中
void setJspContext(JspContext pc);
// 设置当前标签的父标签,由服务器调用
void setParent(JspTag parent);
一般我们在开发中都是通过继承SimpleTagSupport来创建标签处理器类,这样我们只需要重写父类的doTag方法,其他方法SimpleTagSupport都已经重写了,直接使用即:
@Override
public void doTag() throws JspException,IOException{
//获取标签体
JspFragment body = getJspBody();
//获取out对象
JspWriter out = getJspContext().getOut();
out.print("------寂寞的分割线------");
//将标签体的内容在页面中显示
//body.invoke(out);
//invoke方法可以传一个流,标签体中的内容会自动通过该流输出,如果传null,则默认在当前页面进行输出
body.invoke(null);
out.print("<br/>--------孤独的分割线-------")
}
创建一个有属性的自定义标签:
public class MyTag extends SimpleTagSupport{
//定义一个boolean类型的属性
private boolean test;
/**
*当标签中有属性时,服务器会自动调用处理器类中相应的setter方法将属性值设置进来
*@param test
*/
public void setTest(boolean test){
this.test = test;
}
@Override
public void doTag() throws JspException,IOException{
if(test)
getJspBody().invoke(null);
}
}
注意
:给属性设置值的setter方法必须是public的,否则该标签使用时会出错
2、注册自定义标签:在tld文件中注册
<tag>
<name>MyTag</name>
<tag-class>com.bdm.taglib.MyTag</tag-class>
<body-content>scriptless</body-content>
<attribute>
<name>test</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
</tag>
3、使用标签
①引入要使用的标签库
<%@ taglib prefix="a" uri="http://www.bdm.com/taglib/a" %>
prefix:指定使用标签时的前缀,我们可以任意指定,但是习惯上和标签库short-name一致
uri:指定要使用的标签库的uri标识,如果没有uri,则可以使用tld文件的路径
②在页面中使用标签
<前缀:标签名 属性="">
标签体
</前缀:标签名>
三、tld文件
标签库描述文件,是xml格式的文件,用来注册自定义标签,主要用来在服务器中注册自定义标签的处理器类,tld文件一般放到WEB-INF文件夹中。
示例:
<!-- 标签库的版本 -->
<tlib-version>1.0</tlib-version>
<!-- 标签的别名,我们通过别名来使用标签 -->
<short-name>a</short-name>
<!-- uri可选,设置一个uri地址,用来唯一标识我们的标签库 -->
<uri>http://www.bdm.com/taglib/a</uri>
<!-- 配置自定义标签的信息 -->
<tag>
<!-- 标签的名字 -->
<name>MyTag</name>
<!-- 标签处理器类的全类名 -->
<tag-class>com.bdm.taglib.MyTag</tag-class>
<!-- 标签体的类型,empty代表当前标签是一个自结束标签 -->
<body-content>empty</body-content>
</tag>
说明:
body-content:用来设置当前标签体的形式
empty——当前标签没有标签体,是一个自结束标签
scriptless——当前标签体中的内容如果是一个EL表达式,会自动解析EL表达式
JSP——当前标签的标签体可以是一个JSP脚本片段:由于jsp页面中很少使用脚本片段,该值很少使用
tagdependent——当前标签体中的内容如果是一个EL表达式,不会自动解析,几乎不用
一般情况下:有标签体用 scriptless,没有标签体 empty
当标签中有属性时,我们需要在tag标签中添加一个attribute子标签
<attribute>
<name>test</name>
<required>true</required>
<rtexprvalue>true</rtexprvalue>
</attribute>
name:属性名
required:属性是否必须的
rtexprvalue:如果属性的值是一个EL表达式,是否自动解析,一般都是true