Taglib原理和实现

1、问题：Tag究竟是什么？如何实现一个Tag？

　　一个tag就是一个普通的java类，它唯一特别之处是它必须继承TagSupport或者BodyTagSupport类。这两个类提供了一些方法，负责jsp页面和你编写的类之间的交互，例如输入，输出。而这两个类是由jsp容器提供的，无须开发人员自己实现。换句话说，你只需把实现了业务逻辑的类继承TagSupport或者BodyTagSupport，再做一些特别的工作，你的类就是一个Tag。并且它自己负责和jsp页面的交互，不用你多操心。

　　“特别的工作”通常有以下几个步骤：

　　1）提供属性的set方法，此后这个属性就可以在jsp页面设置。以jstl标签为例 ＜c:out value=""/＞，这个value就是jsp数据到tag之间的入口。所以tag里面必须有一个setValue方法，具体的属性可以不叫value。例如

setValue(String data){this.data = data;}

　　这个“value”的名称是在tld里定义的。取什么名字都可以，只需tag里提供相应的set方法即可。

　　2）处理 doStartTag 或 doEndTag 。这两个方法是 TagSupport提供的。 还是以＜c:out value= ""/＞为例，当jsp解析这个标签的时候，在“＜”处触发 doStartTag 事件，在“＞”时触发 doEndTag 事件。通常在 doStartTag 里进行逻辑操作，在 doEndTag 里控制输出。

　　3）编写tld文件。

　　4）在jsp页面导入tld

　　这样，你的jsp页面就可以使用自己的tag了。

　　通常你会发现自己绝大多数活动都集中在 doStartTag 或 doEndTag 方法里。确实如此，熟悉一些接口和类之后，写taglib很容易。正如《jsp设计》的作者所言：里面的逻辑稍微有点复杂，但毕竟没有火箭上天那么难。

　　2、一个简单的例子：OutputTag

package diegoyun;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.TagSupport;
/**
* @author chenys
*/
public class OutputTag extends TagSupport
{
private String name=null;
public void setName(String name)
{
this.name = name;
}

public int doStartTag() throws JspException{
try
{
JspWriter out = pageContext.getOut();
out.print("Hello! " + name);
}
catch (Exception e)
{
throw new JspException(e);
}
return EVAL_PAGE;
}
}

　　简要说明：

　　1、如何输出到jsp页面：

　　调用JspWriter JspWriter out = pageContext.getOut();out.print......

　　记住这个方法就可以了。

　　2、输出后如何作处理

　　函数会返回几个值之一。EVAL_PAGE 表示tag已处理完毕，返回jsp页面。还有几个值，例如 EVAL_BODY_AGAIN 和EVAL_BODY_INCLUDE等，后面我们会作讨论

　　编写tld

＜?xml version="1.0" encoding="ISO-8859-1" ?＞
＜!DOCTYPE taglib
PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
"http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd"＞
＜taglib＞
＜tlib-version＞1.0＜/tlib-version＞
＜jsp-version＞1.2＜/jsp-version＞
＜short-name＞diego＜/short-name＞
＜!--OutputTag--＞
＜tag＞
＜name＞out＜/name＞
＜tag-class＞diegoyun.OutputTag＜/tag-class＞
＜body-content＞empty＜/body-content＞
＜attribute＞
＜name＞name＜/name＞
＜required＞false＜/required＞
＜rtexprvalue＞false＜/rtexprvalue＞
＜/attribute＞
＜/tag＞
＜/taglib＞

　　在WEB-INF下新建tlds文件夹，把这个文件取名为diego.tld，放到tlds文件夹下。路径应该这样：WEB-INF/tlds/diego.tld
关于tld的简单说明：

　　short-name：taglib的名称，也称为前缀。比如＜c:out value=""/＞ 里的“c”

　　name：tag的名字。例如＜c:out value=""/＞ 里的"out”，我们的类也取名为out，由于有前缀作区分，不会混淆

　　tag-class：具体的tag类。带包名

　　body-content：指tag之间的内容。例如＜c:out value=""＞ ...... ＜/c＞ 起始和关闭标签之间就是body-content。由于没有处理body-content，所以上面设为empty

　　＜attribute＞里的name：属性名字。例如＜c:out value=""/＞里的value。名字可任意取，只要类里提供相应的set方法即可。

　　required：是否必填属性。

　　rtexprvalue：是否支持运行时表达式取值。这是tag的强大功能。以后我们会讨论。暂时设为false

　　编写jsp页面

＜%@ page language="java"%＞
＜%@ taglib uri="/WEB-INF/tlds/diego.tld" prefix="diego"%＞
＜html＞
＜body＞
Test Tag:
＜diego:out name="diegoyun"/＞
＜/body＞
＜/html＞

　　我的编程环境是eclipse+tomcat.启动服务器，如果一切按照上面步骤的话，就能看到 Test Tag: Hello! diegoyun 字样

　　最简单的tag就这么出来了。并不难,是不是?

Taglib 原理和实现之支持El表达式

　1.先看这么一个例子

＜%@ page contentType="text/html; charset=gb2312" language="java"%＞
＜%@ taglib uri="/WEB-INF/tlds/c.tld" prefix="c"%＞
＜!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"＞
＜html＞
＜body＞
＜%
String tut = "tutorial";
request.setAttribute("tut",tut);
%＞
The String in request is :
＜c:out value="${tut}"/＞
＜/body＞
＜/html＞

　　2.如何支持el表达式

　　在路径org.apache.taglibs.standard.lang.support下，有个叫 ExpressionEvaluatorManager.evaluate 的方法，当el表达式作为入参时，调用这个方法，在tag内即可自动把el 表达式转化。例如，你想tag的value字段支持el表达式，那么只需在set方法里如下调用：

public void setValue(Object value)throws JspException
{
this.value = ExpressionEvaluatorManager.evaluate(
"value", value.toString(), Object.class, this, pageContext);
}

　　ExpressionEvaluatorManager.evaluate有四个参数。第一个表示tag的名字，在取el表达式出错时使用。一般和属性名字相同。第二个要求字符串，通常简单调用输入对象的toString方法。第三个是类，通常用Object.class。第四个用this即可，第五个是pageContext变量。

　　通常不用对这个方法思考太多。只需改改属性名字，其他照搬即可。

　　注意：当你的tag属性支持el表达式时，你必须把它声明为Object对象。如上述的value，应该声明为：

private Object value = null;

　　3.实例：让OutputTag支持El表达式

package diegoyun;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.TagSupport;

import org.apache.taglibs.standard.lang.support.ExpressionEvaluatorManager;

public class NewOutputTag extends TagSupport
{
private Object name = null;

public void setName(Object name) throws JspException
{
this.name = ExpressionEvaluatorManager.evaluate(
"name", name.toString(), Object.class, this, pageContext);
}
public int doStartTag() throws JspException{
try
{
JspWriter out = pageContext.getOut();
out.print("Hello! " + name);
}
catch (Exception e)
{
throw new JspException(e);
}
return EVAL_PAGE;

}
}

　　在diego.tld里添加声明

＜!--NewOutputTag--＞
＜tag＞
＜name＞newout＜/name＞
＜tag-class＞diegoyun.NewOutputTag＜/tag-class＞
＜body-content＞empty＜/body-content＞
＜attribute＞
＜name＞name＜/name＞
＜required＞false＜/required＞
＜rtexprvalue＞true＜/rtexprvalue＞
＜/attribute＞
＜/tag＞

　　编写jsp测试

＜%@ page language="java" %＞
＜%@ taglib uri="/WEB-INF/tlds/diego.tld" prefix="diego"%＞
＜html＞
＜body bgcolor="#FFFFFF"＞
＜%
String s = "diego";
request.setAttribute("name",s);
%＞
Test El supported tag:
＜br＞
＜diego:newout name="${name}"/＞

＜/body＞
＜/html＞

　　可以看到页面输出为：

　　Test El supported tag:
　　Hello! diego

Taglib 原理和实现之嵌套和属性读取

　1、问题：在request里有一个 Man 对象，它有两个属性：name和age。现在，我们想用一个嵌套的tag，父tag取得对象，子tag取得name属性并显示在页面上。例如，它的形式如下：

＜diego:with object="${Man}"＞
＜diego:output property="name"/＞
＜/diego:with＞

　　object 支持el表达式，表示取得 Man 对象。output的property表示从该对象取得名为name的属性。

　　2、如何支持tag之间的嵌套

　　在子tag里调用getParent 方法，可以得到父tag对象。用 findAncestorWithClass 方法，则可以通过递归找到想要找的tag。例如

＜diego:with object="${people}"＞ ＜!--表示取得一个对象--＞
＜diego:withCollection property="men"＞ ＜!--表示取得对象里的一个属性，这个属性是个 Collection,Collection里添加了许多man，每个man有名字和年龄--＞
＜diego:output property="name"/＞ ＜!--取得name属性并显示--＞
＜/diego:withCollection＞
＜/diego:with＞

　　对于最内层的outputTag来说，调用getParent，可以得到 withCollectionTag，通过如 findAncestorWithClass（this，WithTag.class）的方式，可以得到withTag。得到Tag之后，就可以取得 Tag的属性，进行业务逻辑处理，然后输出到jsp

　　3、如何支持类属性查找功能

　　显然，在上面的outputTag中，我们要根据属性的名字，查找类中有没有这个属性。然后取出属性的值并显示。通常，这可以编写自己的反射函数来完成。更简单的办法，是通过 BeanUtil 的PropertyUtils方法来完成功能。BeanUtil 是apache上的一个开源项目。

　　示例如下：

import org.apache.commons.beanutils.PropertyUtils;
......
property = PropertyUtils.getProperty(currentClass, propertyName);

　　propertyName是待查找属性的名字，例如上面的"name"，currentClass是待查找的类，例如上面的People

　　记得把 commons-beanutils.jar添加到WEB-INF/lib目录下

　　4、现在让我们实现开篇提出的问题，编写WithTag如下：

package diegoyun;

import java.io.IOException;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;

import org.apache.taglibs.standard.lang.support.ExpressionEvaluatorManager;

/**
* @author chenys
*/
public class WithTag extends BodyTagSupport
{
　private Object value = null;
　private Object output = null;

　public void setOutput(Object output)
　{
　　this.output = output;
　}
　public Object getValue()
　{
　　return value;
　}
　public void setValue(Object value)throws JspException
　{
　　this.value = ExpressionEvaluatorManager.evaluate("value", value.toString(), Object.class, this, pageContext);
　}
　public int doStartTag()
　{
　　return EVAL_BODY_INCLUDE;
　}
　public int doEndTag()throws JspException
　{
　　try
　　{
　　　pageContext.getOut().print(output);
　　}
　　catch (IOException e)
　　{
　　　throw new JspException(e);
　　}
　　return EVAL_PAGE;
　}
}

　　编写 NestedOutputTag 如下：

package diegoyun;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;

import org.apache.commons.beanutils.PropertyUtils;

/**
* @author chenys
*/
public class NestedOutputTag extends BodyTagSupport
{
　private String property = null;

　public void setProperty(String property)
　{
　　this.property = property;
　}

　public int doEndTag()throws JspException
　{
　　WithTag parent =(WithTag)getParent();
　　if(parent==null)
　　　throw new JspException("Can not find parent Tag ");
　　　try
　　　{
　　　　Object propertyValue = PropertyUtils.getProperty(parent.getValue(), property);
　　　　parent.setOutput(propertyValue);
　　　}
　　　catch (Exception e)
　　　{
　　　　throw new JspException(e);
　　　}
　　　return EVAL_PAGE;
　　}
}

　　在包diegoyun下添加一个包vo，在vo下写一个Man类：

package diegoyun.vo;

/**
* @author chenys
*/
public class Man
{
　private String name = null;
　private int age = 0;

　public int getAge()
　{
　　return age;
　}
　public void setAge(int age)
　{
　　this.age = age;
　}
　public String getName()
　{
　　return name;
　}
　public void setName(String name)
　{
　　this.name = name;
　}
}

　　写TLD

＜!--WithTag--＞
＜tag＞
＜name＞with＜/name＞
＜tag-class＞diegoyun.WithTag＜/tag-class＞
＜body-content＞JSP＜/body-content＞
＜attribute＞
＜name＞value＜/name＞
＜required＞false＜/required＞
＜rtexprvalue＞true＜/rtexprvalue＞
＜/attribute＞
＜/tag＞
＜!--OutputTag3--＞
＜tag＞
＜name＞nestedout＜/name＞
＜tag-class＞diegoyun.NestedOutputTag＜/tag-class＞
＜body-content＞empty＜/body-content＞
＜attribute＞
＜name＞property＜/name＞
＜required＞false＜/required＞
＜rtexprvalue＞false＜/rtexprvalue＞
＜/attribute＞
＜/tag＞

　　写JSP页面

＜%@ page language="java" %＞
＜%@ page import="diegoyun.vo.*"%＞
＜%@ taglib uri="/WEB-INF/tlds/diego.tld" prefix="diego"%＞

＜html＞
＜body bgcolor="#FFFFFF"＞
＜%
Man man = new Man();
man.setName("diego");

request.setAttribute("man",man);
%＞
Test nested tag:
＜br＞
＜diego:with value="${man}"＞
＜diego:nestedout property="name"/＞
＜/diego:with＞
＜/body＞
＜/html＞

　　运行页面，则可以看到：

Test nested tag:
diego

　　5、结束语：

　　上述例子简单描绘了嵌套的Tag之间如何交互。通常子Tag负责取得数据，然后设置父Tag的属性，最后在父Tag里显示到jsp页面。如上面的例子，父 Tag 的 output 表示待打印的对象，通过 nestedoutTag 取得name的值，设置output，然后打印出来。

　　通过支持El表达式和动态属性联结，Tag可以实现强大的处理功能。将逻辑都集中到Tag里，极大的简化页面的编写。