简单例子
实现一个标签分为两步:(1)继承SimpleTagSupport或TagSupport实现一个控制器(2)创建一个描述标签的tld文件。下面是一个简单例子:
(1)实现一个标签控制器,向页面输出“hello”:
public class Test extends SimpleTagSupport{
public void doTag() throws IOException{
JspWriter out = getJspContext().getOut();
out.write("hello");
}
}
(2)在WEB-INF文件夹下创建一个custom.tld文件:
<?xml version="1.0" encoding="UTF-8"?>
<taglib version="2.0" 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 web-jsptaglibrary_2_0.xsd">
<tlib-version>1.0</tlib-version>
<jsp-version>2.0</jsp-version>
<short-name>my</short-name>
<!-- 直接显示hello -->
<tag>
<name>Hello</name>
<tag-class>com.huanle.utils.tags.Test</tag-class>
<body-content>empty</body-content>
</tag>
</taglib>
上面代码通过<tag>
标签描述一个自定义标签,<body-content>empty</body-content>
表示这个标签没有标签体,也就是开始标签和结束标签之间没有内容。
接下就可以在jsp文件中使用这个标签了(记得使用<%@taglib prefix="my" uri="/WEB-INF/custom.tld" %>
指令导入标签库):
<%@taglib prefix="my" uri="/WEB-INF/custom.tld" %>
<!DOCTYPE html>
<html>
<head>
<title>标签</title>
</head>
<body>
<p>没有标签体,直接输出内容的标签</p>
<my:Hello/>
</body>
</html>
继承SimpleTagSupport定义简单标签
继承SimpleTagSupport,然后实现doTag()方法就可以自定义一个标签。这里有份英文教程,对继承SimpleTagSupport方式讲得非常透彻浅显易懂,链接:jsp自定义标签教程 .pdf
下面是一些例子:
定义标签属性
(1)首先在控制器里填加一个属性,并生成setter 方法
public class Test extends SimpleTagSupport{
private String name;
public void doTag() throws IOException{
JspWriter out= getJspContext().getOut();
out.write("hello");
}
public void setName(String name) {
this.name = name;
}
}
(2)在tld文件里添加这个属性的描述,用<attribute>
标签:
<tag>
<name>Hello</name>
<tag-class>com.huanle.utils.tags.Test</tag-class>
<body-content>empty</body-content>
<attribute>
<name>name</name>
</attribute>
</tag>
<attribute>
标签有多个子标签可以用来定义该属性的限制:
名称 | 用处 |
name | 定义属性名 |
required | 定义该属性是否是必须的,默认是false |
rtexprvalue | 定义是否允许使用一个运行时表达式的值作为该属性的值,默认为false。比如要支持EL表达式,这个属性应该置为true |
type | 定义属性的值类型,默认是String |
fragment | 声明这个变量是否应该被看做JspFragment. |
定义标签体
之前定义的标签标签体一直都是空的,如果要支持标签体:
(1)修改tld文件的<body-content>
值为scriptless,表示有标签体,并且标签体不含脚本(指jsp脚本,EL表达式等)
<!-- 获取标签体,输出 -->
<tag>
<name>Hello</name>
<tag-class>com.huanle.utils.tags.Test</tag-class>
<body-content>scriptless</body-content>
</tag>
(2)在标签控制器中获得标签体并输出:
public class Test extends SimpleTagSupport {
private StringWriter sw = new StringWriter();
public void doTag() throws JspException, IOException{
getJspBody().invoke(sw); getJspContext().getOut().write(sw.toString().trim().substring(0, length));
}
}
使用时就可以包含标签体了:
<my:Hello>hello</my:Hello>
继承TagSupport实现更复杂的标签
(后面更新。。。)
在标签内部使用request
标签属于其实最终会转化成一个Servlet,所有Servlet能做的标签都能做,包括操作request,session等,其中关键就在getJspContext()方法上。代码如下:
public class DispalyErrorMessageTag extends SimpleTagSupport {
public void doTag() throws IOException{
JspWriter out = getJspContext().getOut();
PageContext pageContext = (PageContext)getJspContext();
HttpServletRequest request = (HttpServletRequest) pageContext.getRequest();
String value = request.getParameter(param);
...
}
}