17370845950

JSP Tag 文件中实现完全求值 Body 内容的方法

本文探讨了在 JSP Tag 文件中实现完全求值 Body 内容的方法,类似于 Java 类中 BodyTag 接口的 EVAL_BODY_INCLUDE 功能。由于 JSP Tag 文件本身的限制,直接支持完整的 JSP 代码(包括 Scriptlet 和表达式)是不可能的。本文将解释这一限制,并提供替代方案。

JSP Tag 文件提供了一种方便的方式来封装和重用 JSP 代码片段。然而,它们在处理 Body 内容时存在一些限制。一个常见的问题是如何让 Tag 文件支持其 Body 中包含完整的 JSP 代码,包括 Scriptlet () 和表达式 ()。

Tag 文件 Body 内容的限制

在 Tag 文件中,body-content 属性用于指定 Body 内容的类型。常用的值包括:

  • empty: Tag 没有 Body 内容。
  • scriptless: Tag 的 Body 内容可以包含 EL 表达式和 JSTL 标签,但不能包含 Scriptlet。
  • tagdependent: Tag 的 Body 内容由 Tag 自身处理,JSP 引擎不会对其进行解释。

遗憾的是,没有一个 body-content 的值允许在 Tag 文件的 Body 中使用完整的 JSP 代码。尝试这样做会导致类似于 "Scripting elements are disallowed here" 的错误。

示例:无法在 Tag 文件中使用 Scriptlet

考虑以下 Tag 文件 dialog.tag:

<%@tag pageEncoding="UTF-8" body-content="scriptless" %>


    

以及使用它的 Tag 文件 use-dialog.tag:

<%@tag pageEncoding="UTF-8" %>
<%@attribute name="someAttribute" type="java.lang.String" required="false" %>
<%@taglib prefix="mytaglib" uri="/WEB-INF/tlds/mytaglib" %>


    <%-- 使用变量 --%>
    Hello <%= someAttribute %>

    <%-- 使用其他标签 --%>
    

这段代码会抛出异常,因为 dialog.tag 的 Body 中包含了 Scriptlet 表达式 ()。

使用 Java 类实现 BodyTag

解决这个限制的唯一方法是使用 Java 类来实现 BodyTag 接口。BodyTag 允许你完全控制 Body 内容的处理方式。

以下是一个 Dialog.java 的示例:

import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.BodyTag;
import javax.servlet.jsp.tagext.BodyContent;
import javax.servlet.jsp.tagext.Tag;
import javax.servlet.jsp.JspException;
import java.io.IOException;

public class Dialog implements BodyTag {

    private PageContext pageContext;
    private Tag parent;
    private BodyContent bodyContent;

    @Override
    public void setPageContext(PageContext pageContext) {
        this.pageContext = pageContext;
    }

    @Override
    public void setParent(Tag parent) {
        this.parent = parent;
    }

    @Override
    public Tag getParent() {
        return parent;
    }

    @Override
    public void setBodyContent(BodyContent bodyContent) {
        this.bodyContent = bodyContent;
    }

    @Override
    public void doInitBody() throws JspException {
        // 可选:在 Body 内容求值之前执行一些初始化操作
    }

    @Override
    public int doStartTag() throws JspException {
        try {
            JspWriter out = pageContext.getOut();
            out.print("");
        } catch (IOException e) {
            throw new JspException(e);
        }
        return EVAL_BODY_BUFFERED; //  EVAL_BODY_INCLUDE 已经过时,推荐使用 EVAL_BODY_BUFFERED
    }

    @Override
    public int doEndTag() throws JspException {
        try {
            JspWriter out = pageContext.getOut();
            if (bodyContent != null) {
                out.print(bodyContent.getString()); // 输出 Body 内容
            }
            out.print("");
        } catch (IOException e) {
            throw new JspException(e);
        } finally {
            if (bodyContent != null) {
                try {
                    bodyContent.clear(); // 清理 BodyContent
                } catch (IOException e) {
                    // ignore
                }
            }
        }
        return EVAL_PAGE; // 继续评估 JSP 页面
    }

    @Override
    public void release() {
        pageContext = null;
        parent = null;
        bodyContent = null;
    }
}

关键点:

  • setPageContext(PageContext pageContext): 设置 PageContext 对象,允许访问 JSP 页面上下文。
  • doStartTag(): 在 Tag 开始标签处执行,输出 。EVAL_BODY_BUFFERED 指示容器评估 Tag 的 Body 并将其存储在 BodyContent 对象中。
  • doEndTag(): 在 Tag 结束标签处执行,输出
  • 。在此方法中,我们从 bodyContent 获取 Body 内容并将其输出。
  • release(): 释放资源,这是一个好习惯。

使用 Java Tag

为了使用 Java Tag,需要在 TLD 文件中声明它。例如,如果你的 TLD 文件是 mytaglib.tld,你可以添加以下内容:


    dialog
    com.example.Dialog
    JSP

然后,你可以像这样在 JSP 页面中使用它:

<%@taglib prefix="mytaglib" uri="/WEB-INF/tlds/mytaglib.tld" %>


    <%-- 使用变量 --%>
    Hello <%= request.getParameter("name") %>

    <%-- 使用其他标签 --%>
    

总结

虽然 JSP Tag 文件提供了一种便捷的方式来创建可重用的组件,但它们在处理包含完整 JSP 代码的 Body 内容时存在限制。要实现完全求值的 Body 内容,你需要使用 Java 类来实现 BodyTag 接口。这种方法允许你完全控制 Body 内容的处理方式,并支持 Scriptlet 和表达式。这种方式虽然稍微复杂,但提供了更大的灵活性和控制力。