jsp自定义标签学习

 

 

假设我们有一个UserInfo的javabean，那么在JSP页面使用此标签只需调用此标签即可

      <!-- 创建需要展现UserInfo的实例（用于测试数据） -->
<%
UserInfo user = new UserInfo();
user.setUserName("Xuwei");
user.setAge(33);
user.setEmail("test@test.test");
pageContext.setAttribute("userinfo", user);  
%>
<!-- 给标签设置user属性绑定要展现的UserInfo对象  -->
<cc:showUserInfo user="${pageScope.userinfo }" />
    

 

开发步骤：

简单标签的开发我们只要实现Tag接口即可，为了简单起见可以直接继承实现了此接口的TagSupport类

1 创建自定义标签类

      public class UserInfoTag extends TagSupport {
	private UserInfo user;

    @Override
    public int doStartTag() throws JspException {
        try {
            JspWriter out = this.pageContext.getOut();
            if(user == null) {
                out.println("No UserInfo Found...");
                return SKIP_BODY;
            }
            out.println("<table width='500px' border='1' align='center'>");
            out.println("<tr>");
            out.println("<td width='20%'>Username:</td>");
            out.println("<td>" + user.getUserName() + "</td>");
            out.println("</tr>");
            out.println("<tr>");
            out.println("<td>Age:</td>");
            out.println("<td>" + user.getAge() + "</td>");
            out.println("</tr>");
            out.println("<tr>");
            out.println("<td>Email:</td>");
            out.println("<td>" + user.getEmail() + "</td>");
            out.println("</tr>");
            out.println("</table>");
        } catch(Exception e) {
            throw new JspException(e.getMessage());
        }
        return SKIP_BODY;
    }

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

	@Override
    public void release() {
        super.release();
        this.user = null;
    }
   
    //getter and setters
    public UserInfo getUser() {
        return user;
    }
    public void setUser(UserInfo user) {
        this.user = user;
    }
}
    

 

备注：要有对应属性的get和set方法，而不是定义的类型

 

2 在Web-Inf创建标签库描述文件.tld(Tag Library Description)

      <?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>cc</short-name>
<uri>/mytaglib</uri>
	<tag>
		<!--指定标签名 -->
		<name>showUserInfo</name>
		<!--指定标签类文件的全路径 -->
		<tag-class>com.mytags.UserInfoTag</tag-class>
		<!--如果不需要标签体则设置empty，反之设定jsp -->
		<body-content>empty</body-content>
		<!--设定属性(如果有的话) -->
		<attribute>
			<!--指定标签名 -->
		   <name>user</name>
			<!--是否是必须，如果非必须没设置则为空 -->
			<required>false</required>
			<!--是否可在属性中使用表达式 -->
			<rtexprvalue>true</rtexprvalue>
		</attribute>
	</tag>
</taglib>
    

 

3 配置web.xml

      <jsp-config>
    <taglib>
        <taglib-uri>/mytaglib</taglib-uri>
        <!—tld文件所在的位置-->
        <taglib-location>/WEB-INF/mytaglib.tld</taglib-location>
    </taglib>
</jsp-config>
    

 备注：web.xml中的 <taglib-uri>标签可以是任意名称，但是一般我们将其和tld文件中的uri对应起来 ，因为这个是唯一的标示

 

4 在需要使用此标签的jsp页面头部引入

      <%@ taglib uri="/mytaglib" prefix="cc"%>
    

备注：这里的uri="/mytaglib"指的是tld文件的uri

 

我们创建的UserInfoTag类继承了TagSupport类，而它又实现了Tag接口，Tag接口的生命周期由其所在的容器控制，如下图：

 

      setPageContext() 将所在jsp页面的pageContext注入进来，目的是为了在后面的方法中可以访问到jsp页面对象的pageContext属性
setParent()       设置此标签的父标签
setAttribute()   将标签中的属性注入到此class的属性，不需要自己实现但要提供属性的get与set方法
doStartTag()      在开始标签属性设置后调用，如果返回SKIP_BODY则忽略标签之中的内容，如果返回EVAL_BODY_INCLUDE则将标签体的内容进行输出
doEndTag()         在结束标签之前调用，返回SKIP_PAGE跳过整个jsp页面后面的输出，返回EVAL_PAGE执行页面余下部分
release()          生命周期结束时调用 
    

 

 

目标2:自定义一个类似于Asp.Net中的Reapter控件的标签

<!-- 创建需要展现javabean（UserInfo）集合的实例（用于测试数据） -->

      <%
    List<UserInfo> users = new ArrayList<UserInfo>();   
    users.add(new UserInfo("Zhangsan", 12, "Zhangsan@163.com"));
    users.add(new UserInfo("Lisi", 22, "Lisi@sina.com"));
    users.add(new UserInfo("Wangwu", 33, "Wangwu@qq.com"));
    pageContext.setAttribute("users", users);
%>

<!-- 给标签绑定数据源  -->
<table width='500px' border='1' align='center'>
    <tr>
        <td width='20%'>UserName</td>
        <td width='20%'>Age</td>
        <td>Email</td>
    </tr>
    <cc:repeater var="item" items="${pageScope.users }">
        <tr>
            <td>${item.userName }</td>
            <td>${item.age }</td>
            <td>${item.email }</td>
        </tr>
    </cc:repeater>
</table>
    

 

开发步骤：

要完成此控件我们需要实现一个迭代接口，即IterationTag，由于TagSupport同样实现了此接口，所以我们继承此类

 

1 创建自定义标签类

      public class Repeater extends TagSupport {
    private Collection items;
    private Iterator it;
    private String var;

    @Override
    public int doStartTag() throws JspException {
        if(items == null || items.size() == 0) return SKIP_BODY;
        it = items.iterator();  
        if(it.hasNext()) {
            pageContext.setAttribute(var, it.next());
        }
        return EVAL_BODY_INCLUDE;
    }

    @Override
    public int doAfterBody() throws JspException {
        if(it.hasNext()) {
            pageContext.setAttribute(var, it.next());
            return EVAL_BODY_AGAIN;
        }
        return SKIP_BODY;
    }

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

    public void setItems(Collection items) {
        this.items = items;
    }

    public void setVar(String var) {
        this.var = var;
    }
}
    

 

2在Web-Inf创建标签库描述文件.tld(Tag Library Description)

由于目标1种已经创建了此文件，我们只需增加此标签的配置即可

      <tag>
    <name>repeater</name>
    <tag-class>com.mytags.Repeater</tag-class>
    <body-content>jsp</body-content>
    <attribute>
        <name>items</name>
        <required>false</required>
        <rtexprvalue>true</rtexprvalue>
    </attribute>
    <attribute>
        <name>var</name>
        <required>true</required>
        <rtexprvalue>true</rtexprvalue>
    </attribute>
 </tag>
    

 

3 配置web.xml （目标1中已完成，无需修改）

 

4 在需要使用此标签的jsp页面头部引入

<%@ taglib uri="/mytaglib" prefix="cc"%>

 

目标4:自定义的函数库

1 创建函数库类

      public class MyFunctions {
    public static String formatMyName(String name) {
       return "your name is " + name;
    }
    public static int add(int a, int b) {
       return a+b;
    }
}

    

 

2 在TLD文件中配置 (引用于目标1中的tld文件)

      <function>
    <name>formatMyName</name>
    <function-class>com.taglib.MyFunctions</function-class>
    <function-signature>java.lang.String formatMyName(java.lang.String)</function-signature>
</function>
<function>
    <name>add</name>
    <function-class>com.taglib.MyFunctions</function-class>
    <function-signature>java.lang.String add(int, int)</function-signature>
</function>
    

 

3 JSP中调用

      ${cc:formatMyName("wangfei") }
${cc:add(12, 34) }