`

JSP自定义标签开发入门

 
阅读更多
JSP自定义标签开发入门
一般情况下开发jsp自定义标签需要引用以下两个包

import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;

首先我们需要大致了解开发自定义标签所涉及到的接口与类的层次结构(其中SimpleTag接口与SimpleTagSupport类是JSP2.0中新引入的)。


目标1:自定义一个用表格显示用户信息的简单标签

效果图:

在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;
    }
}

2 在Web-Inf创建标签库描述文件.tdl(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>
    <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>
        <taglib-location>/WEB-INF/mytaglib.tld</taglib-location>
    </taglib>
  </jsp-config>

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

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

5 使用(参照上面的使用步骤)

此致,一个简单的JSP标签开发完成

标签类说明:

我们创建的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()          生命周期结束时调用

特别说明:在tomcat4.1之后的版本中默认开启了标签缓冲池(websphere和weblogic并不会这么做),所以执行完标签后并不会执行release()方法(_jspDestroy()时才释放),也就是说同一个jsp页面自定义标签不管使用多少次只会存在一个实例,但也并不是每一个标签都会为其创建一个缓冲池,要根据参数来判断,例如:
<cc:UserInfoTag user=”…” />
<cc:UserInfoTag />
上面例子中由于参数不同就会创建两个标签缓冲池。

这个问题可以通过设定tomcat的配置文件加以解决:
在%tomcat%\conf\web.xml加入enablePooling参数,并设置为false(不缓存自定义标签)。
<init-param>
  <param-name>enablePooling</param-name>
  <param-value>false</param-value>
</init-param>

清空%tomcat%\conf\目录
-------------------------------------------------------------------------------------------------------------------------------
TagSupport类已经为我们实现并扩展了一些方法(比如在上述方法中我们可以直接使用pageContext对象,调用父标签getParent()等),所以一般情况下我们只需重写doStartTag(),doEndTag() 即可

TLD文件说明:
<!--版本号-->
<tlib-version>1.0</tlib-version>
<jsp-version>2.0</jsp-version>
<short-name>cc</short-name>
<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>


Web.xml文件说明:
<jsp-config>
    <taglib>
<!--
标签库的uri路径
即jsp头文件中声明<%@ taglib uri="/mytaglib" prefix="cc"%>
的uri
-->
        <taglib-uri>/mytaglib</taglib-uri>
<!—tld文件所在的位置-->
        <taglib-location>/WEB-INF/mytaglib.tld</taglib-location>
    </taglib>
  </jsp-config>


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


在jsp页面使用此自定义标签:

<!-- 创建需要展现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创建标签库描述文件.tdl(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"%>

5 使用(参照上面的使用步骤)

标签类说明:
我们用到了迭代接口,以下是容器处理此接口的流程



作为目标1中的补充: 在doAfterBody()如果返回值是EVAL_BODY_AGAIN那么将重新执行此方法

目标3:使用BodyTagSupport
此目标并不会使用实际例子进行显示,主要是说明为什么,什么情况下需要使用到BodyTag接口或者BodyTagSupport类?
如果我们需要在<test>  ….   </test>之间的标签体的头部和尾部加上一些标记或者是其他处理,一般的处理方法是在doStartTag和doEndTag方法中进行, 但是如果是个迭代标签,标签体的每段内容在循环输出时每次都需要在头部和尾部加上一些标记,我们使用BodyTagSupport就很方便了,

此接口在doStartTag()方法返回值多了一个EVAL_BODY_BUFFERED,它将对主体进行计算,并输出到缓冲区(注:此处是缓冲区并非直接输出到客户端,需要我们手动(this.bodyContent.getEnclosingWriter().write(this.bodyContent.getString());)进行输出客户端的调用,否则主体内容不会进行显示)

标签类说明:
关于BodyTagSupport接口的说明


目标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) }

分享到:
评论

相关推荐

    jsp自定义标签入门实例

    本实例将带你深入理解JSP自定义标签的创建和使用。 首先,我们要了解自定义标签的结构。自定义标签通常由三部分组成:标签库描述文件(TLD)、标签处理类(Tag Handler)和JSP页面。TLD是XML格式的文件,用于定义...

    JSP自定义标签入门实例

    通过学习和实践这个JSP自定义标签入门实例,你可以掌握创建和使用自定义标签的基本流程,为进一步深入JSP开发打下坚实的基础。同时,了解自定义标签也是理解JavaServer Faces (JSF)和其他MVC框架中组件化开发的关键...

    tld自定义标签基础入门demo

    这个"tld自定义标签基础入门demo"是一个针对初学者的教程,旨在帮助刚接触TLD的程序员快速上手。 首先,我们需要理解TLD文件的结构和作用。TLD文件是一个XML文档,它包含了一系列关于自定义标签的信息,如标签的...

    JSP自定义标签简单入门教程

    本教程将引导您了解如何入门JSP自定义标签的使用。 **JSP自定义标签介绍** JSP自定义标签是JSP页面中的一个关键特性,它允许开发者创建自己的标签库,以封装复杂的业务逻辑或视图呈现。这使得JSP页面更加清晰,易于...

    简单的自定义标签入门例子

    在Java Web开发中,自定义标签(Custom Tags)是一种强大的工具,它允许开发者创建可重用的组件,提高代码的可读性和维护性。这里我们将深入探讨如何通过给定的"简单的自定义标签入门例子"来理解这个概念。 首先,...

    使用propertities配置文件的简单的自定义标签入门例子

    1. JSP自定义标签:JSP自定义标签允许开发者创建自己的标签库,以提高代码的可读性和可复用性,类似于HTML中的自定义元素。 2. TLD(Tag Library Descriptor)文件:定义自定义标签的关键文件,它包含了关于标签的...

    《JSP网络开发入门与实践》01-14章

    《JSP网络开发入门与实践》是一本专为初学者设计的教程,涵盖了从基础到实践的JSP(JavaServer Pages)技术。JSP是一种基于Java的动态网页开发技术,它允许开发者在HTML中嵌入Java代码,实现服务器端的动态内容生成...

    完整版Java JSP web开发教程 10_自定义标签(共20页).ppt

    自定义标签遵循 `&lt;Prefix:TagFileName&gt;` 格式,使用`&lt;%@ taglib&gt;`导入,并通过标签库描述符(TLD)文件定义。 11. **JSP标准标签库(JSTL)**:JSTL提供了一组标准标签,包括使用EL和不使用EL的两组,便于实现常见...

    jsp实例学习,学习的最佳例子

    如果你是初学者,可以参考`CND8 学院`发布的`JSP 教程`,它包含了关于JSP自定义标签的详细讲解和实践案例,适合用来入门学习。 总之,掌握JSP自定义标签对于提升JSP开发效率和代码质量至关重要。通过实践和理解...

    jsp入门教程

    - **用Taglib实现循环**:通过自定义标签库实现循环遍历等功能。 - **关于JSTL**:介绍JavaServer Pages Standard Tag Library(JSTL)的核心标签库及其使用方法。 #### 第10章 综合电子留言板 - **电子留言板用户...

    JSP快速入门-适用于初学者

    JSP自定义标签** 自定义标签允许开发者创建自己的标签库,提高代码的可读性和可重用性。通过编写TLD(Tag Library Descriptor)文件定义标签的行为。 **8. JSP的生命周期** JSP页面经历编译、初始化、服务和销毁四...

    JSP网络编程从入门到精通.doc

    - **标签处理类的创建**:为了增强JSP页面的功能性和灵活性,可以自定义标签库。这通常涉及到创建标签处理类,如`MytagInfo.java`和`MytagParam.java`,它们分别用于处理嵌套标签的信息和参数。 #### 六、国际化与...

    JSP网络开发入门与实践

    "JSP网络开发入门与实践"这个主题涵盖了许多核心概念和技术,旨在帮助初学者掌握JSP的精髓,并在实际项目中应用。 首先,JSP的基础知识包括: 1. **JSP页面结构**:一个JSP页面由HTML、CSS、JavaScript以及嵌入的...

    web开发入门jsp技术文档

    **JSP(Java Server Pages)技术是Web开发领域中一种重要的服务器端...继续深入学习JSP的高级特性,如自定义标签、EL和JSTL的高级用法、过滤器和监听器等,你将能够更好地驾驭Web开发。祝你在JSP的学习旅程中取得成功!

    jsp中自定义Taglib详解

    自定义标签类都必须继承一个父类:javax.servlet.jsp.tagext.SimpleTagSupport,或者TagSupport除此之外,JSP自定义标签类还有如下要求。 如果标签类包含属性,每个属性都有对应的getter和setter方法。 重写doTag()...

    《JSP从入门到精通》

    **JSP(Java Server Pages)** 是一种...书中可能还会涵盖一些高级主题,如自定义标签库的开发、AJAX与JSP的结合、JSP与Spring MVC框架的集成等,旨在帮助读者从基础到进阶,全面掌握JSP技术,实现从新手到专家的转变。

    jsp标签库jstl入门教程

    5. **JSTL验证器**如ScriptFreeTLV和PermittedTaglibsTLV,有助于维护代码质量,前者禁止使用JSP脚本元素,后者限制了可使用的自定义标签库。 **JSTL的优势:** 1. **代码分离**:通过使用JSTL,开发者能够在JSP...

Global site tag (gtag.js) - Google Analytics