自定义标签

一、自定义标签概述

1.1 自定义标签的步骤

其实我们在JSP页面中使用标签就等于调用某个对象的某个方法一样，例如：<c:if test="">，这就是在调用对象的方法一样。自定义标签其实就是自定义类一样！

  1. 定义标签处理类：必须是Tag或SimpleTag的实现类；
  2. 编写标签库描述符文件（TLD）；
  3. 页面中使用<%@taglib%>来指定tld文件的位置。

SimpleTag接口是JSP2.0中新给出的接口，用来简化自定义标签，所以现在我们基本上都是使用SimpleTag。
Tag是老的，传统的自定义标签时使用的接口，现在不建议使用它了。

1.2 SimpleTag接口介绍

SimpleTag接口内容如下：

  • void doTag()：标签执行方法；
  • JspTag getParent()：获取父标签；
  • void setParent(JspTag parent)：设置父标签
  • void setJspContext(JspContext context)：设置PageContext
  • void setJspBody(JspFragment jspBody)：设置标签体对象；

请记住，万物皆对象！在JSP页面中的标签也是对象！你可以通过查看JSP的“真身”清楚的知道，所有标签都会变成对象的方法调用。标签对应的类我们称之为“标签处理类”！

标签的生命周期：

  1. 当容器（Tomcat）第一次执行到某个标签时，会创建标签处理类的实例；
  2. 然后调用setJspContext(JspContext)方法，把当前JSP页面的pageContext对象传递给这个方法；
  3. 如果当前标签有父标签，那么使用父标签的标签处理类对象调用setParent(JspTag)方法；
  4. 如果标签有标签体，那么把标签体转换成JspFragment对象，然后调用setJspBody()方法；
  5. 每次执行标签时，都调用doTag()方法，它是标签处理方法。

示例：
我们写一个标签类，com.veeja.tag.Mytag1：

public class MyTag1 implements SimpleTag {
	private PageContext pageContext;
	private JspFragment body;

	/**
	 * 所有的setXxx()方法都会在doTage()方法之前被tomcat调用！ 所以在doTag()中就会可以使用Tomcat传递过来的参数了。
	 */
	public void doTag() throws JspException, IOException {
		pageContext.getOut().print("hello tag!");
	}

	public JspTag getParent() {
		// TODO Auto-generated method stub
		return null;
	}

	public void setJspBody(JspFragment body) {
		this.body = body;
	}

	public void setJspContext(JspContext context) {
		this.pageContext = (PageContext) context;
	}

	public void setParent(JspTag arg0) {
		// TODO Auto-generated method stub
	}

}

1.3 标签库描述文件（TLD）

标签库描述文件是用来描述当前标签库中的标签的。
标签库描述文件的扩展名为tld，我们一般把它放到WEB-INF目录下，这样就不会被客户端直接访问到了。

示例：
我们可以参考web-inf/lib下的jstl.jar中的c.tld文件，对其进行修改，自己写一个tld文件，WEB-INF/tlds/veeja.tld：

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

<taglib xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-jsptaglibrary_2_1.xsd"
	version="2.1">

	<tlib-version>1.0</tlib-version>
	<short-name>v</short-name>
	<uri>http://www.veeja.cn/tags/veeja-1.0</uri>

	<tag>
		<name>myTag</name>
		<tag-class>com.veeja.tag.MyTag1</tag-class>
		<body-content>empty</body-content>
	</tag>

</taglib>

<name>标签用来指定当前标签的名称。
<tag-class>用来指定当前标签的标签处理类。
<body-content>用来指定标签体的类型，我们这里使用的是空标签。

1.4 使用标签

在页面中使用标签分为两步：

  1. 使用taglib导入标签库；
  2. 使用标签；

示例：
index.jsp：

<%@ taglib prefix="v" uri="/WEB-INF/tlds/veeja.tld" %>
...
  	<v:myTag1/>
...

我们在浏览器里访问看一下结果：

java swing 标签栏 java设置标签_html

二、自定义标签进阶

2.1 继承SimpleTagSupport

继承SimpleTagSuppport要比实现SimpleTag接口方便太多了，现在你只需要重写doTag()方法，其他方法都已经被SimpleTagSuppport完成了。
示例：

/**
 * SimpleTagSupport它实现了SimpleTag接口。
 *  它已经把所有的tomcat传递的数据都保存起来了。而且还提供了get方法供子类调用。 
 */
public class MyTag2 extends SimpleTagSupport {
	@Override
	public void doTag() throws JspException, IOException {
		this.getJspContext().getOut().print("鸡你太美！！！！！！！！！");
	}
}

然后我们仿照上面的例子，编辑tld文件，建立一个新的描述标签：

<tag>
		<name>myTag2</name>
		<tag-class>com.veeja.tag.MyTag2</tag-class>
		<body-content>empty</body-content>
</tag>

在页面中直接使用：

<body>
	<v:myTag1/>
	<v:myTag2/>
</body>

浏览器访问查看结果：

java swing 标签栏 java设置标签_java swing 标签栏_02

2.2 有标签体的标签

我们先来看看标签体内容的可选值，<body-content>元素的可选值有：

  • empty：无标签体。
  • JSP：传统标签支持它，JSP2.0不支持。SimpleTag已经不再支持使用<body-content>JSP</body-content>。标签体内容可以是任何东西：EL、JSTL、<%=%>、<%%>，以及html；
  • scriptless：标签体内容不能是Java脚本，但可以是EL、JSTL等。在SimpleTag中，如果需要有标签体，那么就使用该选项；
  • tagdependent：标签体内容不做运算，由标签处理类自行处理，无论标签体内容是EL、JSP、JSTL，都不会做运算。这个选项几乎没有人会使用！

自定义有标签体的标签需要：

  • 获取标签体对象：JspFragment jspBody = getJspBody();；
  • 把标签体内容输出到页面：jspBody.invoke(null)；
  • tld中指定标签内容类型：scriptless。

示例：

  1. 自定义标签类：
public class MyTag3 extends SimpleTagSupport {
	@Override
	public void doTag() throws JspException, IOException {
		// 获取当前的jsp页面的输出流
		Writer out = this.getJspContext().getOut();

		out.write("**********************<br>");
		
		// 执行标签体内容，把结果写到指定的流中，即页面上。
		this.getJspBody().invoke(out);

		out.write("<br>**********************");
	}
}
  1. 重写tld文件。
<tag>
	<name>myTag3</name>
	<tag-class>com.veeja.tag.MyTag3</tag-class>
	<body-content>scriptless</body-content>
</tag>
  1. 在界面中使用：
<body>
	<v:myTag1 />
	<v:myTag2 />
	<br>
	<%
		request.setAttribute("xxx", "我就是死，就是从外边跳下去...");
	%>
	<v:myTag3>${xxx }</v:myTag3>
	<br>
	<v:myTag3>真香！~</v:myTag3>
</body>
  1. 结果：

2.3 不执行标签下面的页面内容

如果希望在执行了自定义标签后，不再执行JSP页面下面的东西，那么就需要在doTag()方法中使用SkipPageException。
示例：

  1. 自定义标签类：
public class SkipTag extends SimpleTagSupport {
	@Override
	public void doTag() throws JspException, IOException {
		this.getJspContext().getOut().print("下面所有的东西，都将湮灭在我的威能之下！！！！！！！！！！！！！！");
		throw new SkipPageException();// 抛出这个异常后，在本标签之后的内容，都看不到！
	}
}
  1. tld文件
<tag>
	<name>skipTag</name>
	<tag-class>com.veeja.tag.SkipTag</tag-class>
	<body-content>empty</body-content>
</tag>
  1. 页面中调用。
<body>
	<v:myTag1 />
	<br>
	<v:myTag2 />
	<br>
	<v:skipTag />
	<br>
	<%
		request.setAttribute("xxx", "我就是死，就是从外边跳下去...");
	%>
	<v:myTag3>${xxx }</v:myTag3>
	<br>
	<v:myTag3>真香！~</v:myTag3>
</body>
  1. 结果：

    结果符合预期。

2.4 带有属性的标签

一般标签都会带有属性，例如<c:if test="">，其中test就是一个boolean类型的属性。完成带有属性的标签需要：

  • 在处理类中给出JavaBean属性（提供get/set方法）；
  • 在tld文件中部署相关属性。

我们举一个例子来演示这个特性：

  1. 新建标签处理类：
public class MyTag5 extends SimpleTagSupport {
	private boolean test;

	public boolean isTest() {
		return test;
	}

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

	@Override
	public void doTag() throws JspException, IOException {
		if (test) {
			this.getJspBody().invoke(null);// 如果传递的输出流为null，表示使用的就是当前页面的out！
		}
	}
}
  1. tld文件，这里有点特殊，需要仔细的观察不同：
<tag>
	<name>MyTag5</name>
	<tag-class>com.veeja.tag.MyTag5</tag-class>
	<body-content>scriptless</body-content>
	<attribute>
		<name>test</name>
		<required>true</required>
		<rtexprvalue>true</rtexprvalue>
	</attribute>
</tag>
  1. 其中<required>标签标示这个属性是否为必须的，可选的值有true和false。
    <rtexprvalue>标示属性是否可以使用el表达式。
  2. 在页面中使用：
<body>
	<v:MyTag5 test="false">是不是很难很枯燥，但是可惜，这句话根本看不见。</v:MyTag5>
	<v:MyTag5 test="true">这篇博客马上就完事了！！！加油！！！</v:MyTag5>
</body>
  1. 查看结果：

    结果符合预期。

END.