JAVA/JSP学习系列之七(Orion下自定义Tag)

我会详细讲解“JAVA/JSP学习系列之七(Orion下自定义Tag)”的完整攻略。

简介

在 JSP 中，除了基本的 JSP 标签之外，可以自定义标签，把常用代码独立出来形成自己的标签库，方便代码的复用。本篇文章将介绍使用 Orion 开发工具自定义 JSP 标签的方法。

环境

• 开发工具：Orion
• 服务器：Tomcat

步骤

1. 创建标签处理类

首先，我们需要创建一个 Java 类来处理自定义标签。这个类需要实现 javax.servlet.jsp.tagext.Tag 接口，然后重写其四个方法：doStartTag()、doEndTag()、setParent() 和 setPageContext()。

下面是一个示例：

package com.example.util.tag;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.Tag;
import javax.servlet.jsp.tagext.TagSupport;

public class MyTag extends TagSupport {
    private String text;

    public void setText(String text) {
        this.text = text;
    }

    @Override
    public int doStartTag() throws JspException {
        try {
            // 输出标签内容
            pageContext.getOut().write(text);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return EVAL_BODY_INCLUDE;
    }

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

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

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

在上面的代码中，我们实现了一个 MyTag 类，它有一个 text 属性，用于设置标签的内容。在 doStartTag() 方法里面，我们将 text 输出到页面。

2. 创建标签库描述文件

这一步是非常重要的一步。我们需要创建标签库描述文件，告诉 JSP 引擎如何识别我们的标签。

下面是一个示例：

<?xml version="1.0" encoding="UTF-8"?>
<taglib version="2.1" 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_1.xsd">

  <description>MyTag Library</description>

  <tlib-version>1.0</tlib-version>

  <short-name>mytag</short-name>

  <tag>
    <name>mytag</name>
    <tag-class>com.example.util.tag.MyTag</tag-class>
    <attribute>
      <name>text</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
    </attribute>
  </tag>

</taglib>

在这个文件中，我们定义了一个 short-name，它是标签库的简称；然后定义了一个 tag，它包含了标签的信息，包括标签的名称、处理类以及标签的属性等。

3. 导入标签库

现在我们已经创建了一个自定义标签，还定义了一个标签库描述文件，接下来需要将标签库导入到 JSP 页面中。

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

<mytag:mytag text="My Custom Tag" />

在上面的代码中，我们使用了 taglib 指令来导入标签库，然后就可以使用自定义标签了。

示例

示例一

下面是一个简单示例，它使用 MyTag 输出 "Hello World!"：

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

<mytag:mytag text="Hello World!" />

示例二

下面是一个稍微复杂一些的示例，它使用 MyTag 输出一个由属性生成的列表：

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

<%-- generate a list containing 1 to i --%>
<%
    int i = 10;
    List<Integer> list = new ArrayList<>();
    for (int j = 1; j <= i; j++) {
        list.add(j);
    }
%>

<%-- use MyTag to display list items --%>
<mytag:mytag text="&lt;ul>" />
<c:forEach items="${list}" var="item">
    <mytag:mytag text="&lt;li>${item}&lt;/li>" />
</c:forEach>
<mytag:mytag text="&lt;/ul>" />

在上面的代码中，我们使用了一个 JSTL 的 forEach 标签，循环输出列表的每一项。同时，我们还将输出内容包裹在 MyTag 中，形成了一个列表。注意在输出 HTML 标签时，需要使用字符实体（< 和 >）替代 < 和 >。