JSP 和 JSTL

ChatGPT-4o-mini 中英对照 JSP and JSTL

Spring 框架内置了将 Spring MVC 与 JSP 和 JSTL 集成的功能。

视图解析器

在使用 JSP 开发时，通常会声明一个 InternalResourceViewResolver bean。

InternalResourceViewResolver 可以用于调度到任何 Servlet 资源，但特别适用于 JSP。作为最佳实践，我们强烈建议将您的 JSP 文件放在 'WEB-INF' 目录下的一个子目录中，以便客户端无法直接访问。

<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
    <property name="prefix" value="/WEB-INF/jsp/"/>
    <property name="suffix" value=".jsp"/>
</bean>

xml

JSPs 与 JSTL

当使用 JSP 标准标签库 (JSTL) 时，您必须使用一个特殊的视图类 JstlView，因为 JSTL 在某些功能（例如 I18N 功能）可以正常工作之前需要一些准备。

Spring 的 JSP 标签库

Spring 提供了请求参数到命令对象的数据绑定，如前面的章节所述。为了便于结合这些数据绑定特性开发 JSP 页面，Spring 提供了一些标签，使事情变得更加简单。所有 Spring 标签都有 HTML 转义功能，可以启用或禁用字符的转义。

spring.tld 标签库描述符 (TLD) 包含在 spring-webmvc.jar 中。有关各个标签的全面参考，请浏览 API 参考 或查看标签库描述。

Spring 的表单标签库

从版本 2.0 开始，Spring 提供了一套全面的数据绑定感知标签，用于在使用 JSP 和 Spring Web MVC 时处理表单元素。每个标签都支持其对应 HTML 标签的属性集，使得这些标签使用起来既熟悉又直观。标签生成的 HTML 符合 HTML 4.01/XHTML 1.0 标准。

与其他表单/输入标签库不同，Spring 的表单标签库与 Spring Web MVC 集成，使得标签可以访问命令对象和控制器处理的参考数据。正如我们在以下示例中所展示的，表单标签使 JSP 的开发、阅读和维护变得更加容易。

我们将逐一介绍表单标签，并查看每个标签的使用示例。我们已包含生成的 HTML 代码片段，以便对某些标签进行进一步的说明。

配置

表单标签库捆绑在 spring-webmvc.jar 中。库描述符称为 spring-form.tld。

要使用此库中的标签，请在 JSP 页面顶部添加以下指令：

<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>

xml

其中 form 是您想要为该库中的标签使用的标签名称前缀。

表单标签

此标签渲染一个 HTML 'form' 元素，并为内部标签提供绑定路径以进行绑定。它将命令对象放入 PageContext 中，以便内部标签可以访问该命令对象。该库中的所有其他标签都是 form 标签的嵌套标签。

假设我们有一个域对象叫做 User。它是一个 JavaBean，具有 firstName 和 lastName 等属性。我们可以将其用作表单控制器的表单支持对象，该控制器返回 form.jsp。以下示例展示了 form.jsp 可能的样子：

<form:form>
    <table>
        <tr>
            <td>First Name:</td>
            <td><form:input path="firstName"/></td>
        </tr>
        <tr>
            <td>Last Name:</td>
            <td><form:input path="lastName"/></td>
        </tr>
        <tr>
            <td colspan="2">
                <input type="submit" value="Save Changes"/>
            </td>
        </tr>
    </table>
</form:form>

xml

firstName 和 lastName 的值是从页面控制器放置在 PageContext 中的命令对象中获取的。继续阅读以了解 form 标签与内部标签结合使用的更复杂示例。

以下列表显示了生成的 HTML，外观像一个标准表单：

<form method="POST">
    <table>
        <tr>
            <td>First Name:</td>
            <td><input name="firstName" type="text" value="Harry"/></td>
        </tr>
        <tr>
            <td>Last Name:</td>
            <td><input name="lastName" type="text" value="Potter"/></td>
        </tr>
        <tr>
            <td colspan="2">
                <input type="submit" value="Save Changes"/>
            </td>
        </tr>
    </table>
</form>

xml

前面的 JSP 假设表单支持对象的变量名为 command。如果您将表单支持对象放入模型中并使用了其他名称（这绝对是一个最佳实践），您可以将表单绑定到命名变量，如以下示例所示：

<form:form modelAttribute="user">
    <table>
        <tr>
            <td>First Name:</td>
            <td><form:input path="firstName"/></td>
        </tr>
        <tr>
            <td>Last Name:</td>
            <td><form:input path="lastName"/></td>
        </tr>
        <tr>
            <td colspan="2">
                <input type="submit" value="Save Changes"/>
            </td>
        </tr>
    </table>
</form:form>

xml

input 标签

此标签渲染一个 HTML input 元素，默认绑定值和 type='text'。有关此标签的示例，请参见 The Form Tag。您还可以使用 HTML5 特定类型，例如 email、tel、date 等。

checkbox 标签

该标签渲染一个 HTML input 标签，type 设置为 checkbox。

假设我们的 User 有一些偏好，例如新闻通讯订阅和一系列爱好。以下示例展示了 Preferences 类：

Java

public class Preferences {

    private boolean receiveNewsletter;
    private String[] interests;
    private String favouriteWord;

    public boolean isReceiveNewsletter() {
        return receiveNewsletter;
    }

    public void setReceiveNewsletter(boolean receiveNewsletter) {
        this.receiveNewsletter = receiveNewsletter;
    }

    public String[] getInterests() {
        return interests;
    }

    public void setInterests(String[] interests) {
        this.interests = interests;
    }

    public String getFavouriteWord() {
        return favouriteWord;
    }

    public void setFavouriteWord(String favouriteWord) {
        this.favouriteWord = favouriteWord;
    }
}

java

Kotlin

class Preferences(
        var receiveNewsletter: Boolean,
        var interests: StringArray,
        var favouriteWord: String
)

kotlin

相应的 form.jsp 可能如下所示：

<form:form>
    <table>
        <tr>
            <td>Subscribe to newsletter?:</td>
            <%-- Approach 1: Property is of type java.lang.Boolean --%>
            <td><form:checkbox path="preferences.receiveNewsletter"/></td>
        </tr>

        <tr>
            <td>Interests:</td>
            <%-- Approach 2: Property is of an array or of type java.util.Collection --%>
            <td>
                Quidditch: <form:checkbox path="preferences.interests" value="Quidditch"/>
                Herbology: <form:checkbox path="preferences.interests" value="Herbology"/>
                Defence Against the Dark Arts: <form:checkbox path="preferences.interests" value="Defence Against the Dark Arts"/>
            </td>
        </tr>

        <tr>
            <td>Favourite Word:</td>
            <%-- Approach 3: Property is of type java.lang.Object --%>
            <td>
                Magic: <form:checkbox path="preferences.favouriteWord" value="Magic"/>
            </td>
        </tr>
    </table>
</form:form>

xml

有三种方法可以使用 checkbox 标签，这些方法可以满足您所有的复选框需求。

• 方法一：当绑定值的类型为 java.lang.Boolean 时，如果绑定值为 true，则 input(checkbox) 被标记为 checked。value 属性对应于 setValue(Object) 值属性的解析值。

• 方法二：当绑定值的类型为 array 或 java.util.Collection 时，如果配置的 setValue(Object) 值存在于绑定的 Collection 中，则 input(checkbox) 被标记为 checked。

• 方法三：对于任何其他绑定值类型，如果配置的 setValue(Object) 等于绑定值，则 input(checkbox) 被标记为 checked。

注意，无论采用何种方法，生成的 HTML 结构都是相同的。以下 HTML 代码片段定义了一些复选框：

<tr>
    <td>Interests:</td>
    <td>
        Quidditch: <input name="preferences.interests" type="checkbox" value="Quidditch"/>
        <input type="hidden" value="1" name="_preferences.interests"/>
        Herbology: <input name="preferences.interests" type="checkbox" value="Herbology"/>
        <input type="hidden" value="1" name="_preferences.interests"/>
        Defence Against the Dark Arts: <input name="preferences.interests" type="checkbox" value="Defence Against the Dark Arts"/>
        <input type="hidden" value="1" name="_preferences.interests"/>
    </td>
</tr>

xml

您可能不会期望在每个复选框后看到额外的隐藏字段。当 HTML 页面中的复选框未被选中时，它的值在表单提交时不会作为 HTTP 请求参数发送到服务器，因此我们需要一个解决方法来处理 HTML 中的这个特性，以便 Spring 表单数据绑定能够正常工作。checkbox 标签遵循现有的 Spring 约定，为每个复选框包含一个以下划线（_）为前缀的隐藏参数。通过这样做，您实际上是在告诉 Spring：“复选框在表单中是可见的，我希望我的对象（与表单数据绑定）能够反映复选框的状态，无论如何。”

checkboxes 标签

此标签渲染多个 HTML input 标签，type 设置为 checkbox。

本节基于前面 checkbox 标签部分的示例。有时，您可能不想在 JSP 页面中列出所有可能的爱好。您更愿意在运行时提供可用选项的列表，并将其传递给标签。这就是 checkboxes 标签的目的。您可以在 items 属性中传递一个 Array、List 或 Map，其中包含可用选项。通常，绑定属性是一个集合，以便可以保存用户选择的多个值。以下示例展示了一个使用此标签的 JSP：

<form:form>
    <table>
        <tr>
            <td>Interests:</td>
            <td>
                <%-- Property is of an array or of type java.util.Collection --%>
                <form:checkboxes path="preferences.interests" items="${interestList}"/>
            </td>
        </tr>
    </table>
</form:form>

xml

这个示例假设 interestList 是一个可用作模型属性的 List，其中包含要选择的值的字符串。如果使用 Map，则映射条目的键用作值，映射条目的值用作要显示的标签。您还可以使用自定义对象，通过使用 itemValue 提供值的属性名称，通过使用 itemLabel 提供标签。

radiobutton 标签

此标签渲染一个 HTML input 元素，其 type 设置为 radio。

一个典型的使用模式涉及多个标签实例绑定到相同的属性，但具有不同的值，如下例所示：

<tr>
    <td>Sex:</td>
    <td>
        Male: <form:radiobutton path="sex" value="M"/> <br/>
        Female: <form:radiobutton path="sex" value="F"/>
    </td>
</tr>

xml

radiobuttons 标签

此标签渲染多个 HTML input 元素，type 设置为 radio。

与 checkboxes tag 一样，您可能希望将可用选项作为运行时变量传递。对于这种用法，您可以使用 radiobuttons 标签。您可以在 items 属性中传递一个 Array、List 或 Map，其中包含可用选项。如果您使用 Map，则映射条目的键用作值，映射条目的值用作要显示的标签。您还可以使用自定义对象，通过使用 itemValue 提供值的属性名称，通过使用 itemLabel 提供标签，如以下示例所示：

<tr>
    <td>Sex:</td>
    <td><form:radiobuttons path="sex" items="${sexOptions}"/></td>
</tr>

xml

password 标签

此标签渲染一个 HTML input 标签，类型设置为 password，并绑定值。

<tr>
    <td>Password:</td>
    <td>
        <form:password path="password"/>
    </td>
</tr>

xml

请注意，默认情况下，密码值是不可见的。如果您确实希望显示密码值，可以将 showPassword 属性的值设置为 true，如下例所示：

<tr>
    <td>Password:</td>
    <td>
        <form:password path="password" value="^76525bvHGq" showPassword="true"/>
    </td>
</tr>

xml

select 标签

此标签渲染一个 HTML 'select' 元素。它支持与所选选项的数据绑定，以及使用嵌套的 option 和 options 标签。

假设一个 User 拥有一系列技能。相应的 HTML 可能如下所示：

<tr>
    <td>Skills:</td>
    <td><form:select path="skills" items="${skills}"/></td>
</tr>

xml

如果 User 的技能在草药学方面，那么 'Skills' 行的 HTML 源代码可能如下所示：

<tr>
    <td>Skills:</td>
    <td>
        <select name="skills" multiple="true">
            <option value="Potions">Potions</option>
            <option value="Herbology" selected="selected">Herbology</option>
            <option value="Quidditch">Quidditch</option>
        </select>
    </td>
</tr>

xml

option 标签

此标签渲染一个 HTML option 元素。它根据绑定的值设置 selected。以下 HTML 显示了它的典型输出：

<tr>
    <td>House:</td>
    <td>
        <form:select path="house">
            <form:option value="Gryffindor"/>
            <form:option value="Hufflepuff"/>
            <form:option value="Ravenclaw"/>
            <form:option value="Slytherin"/>
        </form:select>
    </td>
</tr>

xml

如果 User 的房子在格兰芬多，'House' 行的 HTML 源代码如下：

<tr>
    <td>House:</td>
    <td>
        <select name="house">
            <option value="Gryffindor" selected="selected">Gryffindor</option> // <1>
            <option value="Hufflepuff">Hufflepuff</option>
            <option value="Ravenclaw">Ravenclaw</option>
            <option value="Slytherin">Slytherin</option>
        </select>
    </td>
</tr>

xml

• 注意添加了一个 selected 属性。

options 标签

此标签渲染一个 HTML option 元素的列表。它根据绑定的值设置 selected 属性。以下 HTML 显示了它的典型输出：

<tr>
    <td>Country:</td>
    <td>
        <form:select path="country">
            <form:option value="-" label="--Please Select"/>
            <form:options items="${countryList}" itemValue="code" itemLabel="name"/>
        </form:select>
    </td>
</tr>

xml

如果 User 住在英国，'Country' 行的 HTML 源代码将如下所示：

<tr>
    <td>Country:</td>
    <td>
        <select name="country">
            <option value="-">--Please Select</option>
            <option value="AT">Austria</option>
            <option value="UK" selected="selected">United Kingdom</option> // <1>
            <option value="US">United States</option>
        </select>
    </td>
</tr>

xml

• 注意添加了一个 selected 属性。

正如前面的例子所示，option 标签与 options 标签的组合使用生成相同的标准 HTML，但允许您在 JSP 中显式指定一个仅用于显示的值（它应该属于的位置），例如例子中的默认字符串：“-- Please Select”。

items 属性通常用一个项目对象的集合或数组来填充。 itemValue 和 itemLabel 指的是这些项目对象的 bean 属性（如果指定的话）。否则，项目对象本身会被转换为字符串。或者，您可以指定一个 Map 的项目，在这种情况下，map 的键被解释为选项值，map 的值对应于选项标签。如果 itemValue 或 itemLabel（或两者）也被指定，那么项目值属性适用于 map 键，项目标签属性适用于 map 值。

textarea 标签

此标签渲染一个 HTML textarea 元素。以下 HTML 显示了它的典型输出：

<tr>
    <td>Notes:</td>
    <td><form:textarea path="notes" rows="3" cols="20"/></td>
    <td><form:errors path="notes"/></td>
</tr>

xml

hidden 标签

此标签渲染一个 HTML input 标签，type 设置为 hidden，并绑定值。要提交一个未绑定的隐藏值，请使用 HTML input 标签，type 设置为 hidden。以下 HTML 显示了它的典型输出：

<form:hidden path="house"/>

xml

如果我们选择将 house 值作为隐藏值提交，HTML 将如下所示：

<input name="house" type="hidden" value="Gryffindor"/>

xml

errors 标签

此标签在 HTML span 元素中渲染字段错误。它提供对在您的控制器中创建的错误或与您的控制器关联的任何验证器创建的错误的访问。

假设我们希望在提交表单后显示 firstName 和 lastName 字段的所有错误消息。我们有一个用于 User 类实例的验证器，称为 UserValidator，如下例所示：

Java

public class UserValidator implements Validator {

    public boolean supports(Class candidate) {
        return User.class.isAssignableFrom(candidate);
    }

    public void validate(Object obj, Errors errors) {
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "firstName", "required", "Field is required.");
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "lastName", "required", "Field is required.");
    }
}

java

Kotlin

class UserValidator : Validator {

    override fun supports(candidate: Class<*>): Boolean {
        return User::class.java.isAssignableFrom(candidate)
    }

    override fun validate(obj: Any, errors: Errors) {
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "firstName", "required", "Field is required.")
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "lastName", "required", "Field is required.")
    }
}

kotlin

form.jsp 可以如下所示：

<form:form>
    <table>
        <tr>
            <td>First Name:</td>
            <td><form:input path="firstName"/></td>
            <%-- Show errors for firstName field --%>
            <td><form:errors path="firstName"/></td>
        </tr>

        <tr>
            <td>Last Name:</td>
            <td><form:input path="lastName"/></td>
            <%-- Show errors for lastName field --%>
            <td><form:errors path="lastName"/></td>
        </tr>
        <tr>
            <td colspan="3">
                <input type="submit" value="Save Changes"/>
            </td>
        </tr>
    </table>
</form:form>

xml

如果我们提交一个 firstName 和 lastName 字段为空值的表单，HTML 将如下所示：

<form method="POST">
    <table>
        <tr>
            <td>First Name:</td>
            <td><input name="firstName" type="text" value=""/></td>
            <%-- Associated errors to firstName field displayed --%>
            <td><span name="firstName.errors">Field is required.</span></td>
        </tr>

        <tr>
            <td>Last Name:</td>
            <td><input name="lastName" type="text" value=""/></td>
            <%-- Associated errors to lastName field displayed --%>
            <td><span name="lastName.errors">Field is required.</span></td>
        </tr>
        <tr>
            <td colspan="3">
                <input type="submit" value="Save Changes"/>
            </td>
        </tr>
    </table>
</form>

xml

如果我们想要显示给定页面的所有错误列表怎么办？下一个示例显示了 errors 标签也支持一些基本的通配符功能。

• path="*": 显示所有错误。

• path="lastName": 显示与 lastName 字段相关的所有错误。

• 如果省略 path，则仅显示对象错误。

以下示例在页面顶部显示错误列表，接着在字段旁边显示特定字段的错误：

<form:form>
    <form:errors path="*" cssClass="errorBox"/>
    <table>
        <tr>
            <td>First Name:</td>
            <td><form:input path="firstName"/></td>
            <td><form:errors path="firstName"/></td>
        </tr>
        <tr>
            <td>Last Name:</td>
            <td><form:input path="lastName"/></td>
            <td><form:errors path="lastName"/></td>
        </tr>
        <tr>
            <td colspan="3">
                <input type="submit" value="Save Changes"/>
            </td>
        </tr>
    </table>
</form:form>

xml

HTML 将如下所示：

<form method="POST">
    <span name="*.errors" class="errorBox">Field is required.<br/>Field is required.</span>
    <table>
        <tr>
            <td>First Name:</td>
            <td><input name="firstName" type="text" value=""/></td>
            <td><span name="firstName.errors">Field is required.</span></td>
        </tr>

        <tr>
            <td>Last Name:</td>
            <td><input name="lastName" type="text" value=""/></td>
            <td><span name="lastName.errors">Field is required.</span></td>
        </tr>
        <tr>
            <td colspan="3">
                <input type="submit" value="Save Changes"/>
            </td>
        </tr>
    </table>
</form>

xml

spring-form.tld 标签库描述符 (TLD) 包含在 spring-webmvc.jar 中。有关各个标签的全面参考，请浏览 API 参考 或查看标签库描述。

HTTP 方法转换

REST 的一个关键原则是使用“统一接口”。这意味着所有资源（URL）都可以通过使用相同的四个 HTTP 方法进行操作：GET、PUT、POST 和 DELETE。对于每个方法，HTTP 规范定义了确切的语义。例如，GET 应始终是一个安全操作，这意味着它没有副作用，而 PUT 或 DELETE 应该是幂等的，这意味着你可以反复执行这些操作，但最终结果应该是相同的。虽然 HTTP 定义了这四种方法，但 HTML 仅支持两种：GET 和 POST。幸运的是，有两种可能的解决方法：你可以使用 JavaScript 来执行 PUT 或 DELETE，或者你可以通过将“真实”方法作为附加参数（在 HTML 表单中建模为隐藏输入字段）进行 POST。Spring 的 HiddenHttpMethodFilter 使用了后者的技巧。这个过滤器是一个普通的 Servlet 过滤器，因此可以与任何 Web 框架结合使用（不仅仅是 Spring MVC）。将这个过滤器添加到你的 web.xml 中，带有隐藏 method 参数的 POST 将被转换为相应的 HTTP 方法请求。

为了支持 HTTP 方法转换，Spring MVC 表单标签被更新以支持设置 HTTP 方法。例如，以下代码片段来自宠物诊所示例：

<form:form method="delete">
    <p class="submit"><input type="submit" value="Delete Pet"/></p>
</form:form>

xml

前面的示例执行了一个 HTTP POST，实际的 DELETE 方法隐藏在请求参数后面。它被 HiddenHttpMethodFilter 拦截，该过滤器在 web.xml 中定义，如下例所示：

<filter>
    <filter-name>httpMethodFilter</filter-name>
    <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>

<filter-mapping>
    <filter-name>httpMethodFilter</filter-name>
    <servlet-name>petclinic</servlet-name>
</filter-mapping>

xml

以下示例展示了相应的 @Controller 方法：

Java

@RequestMapping(method = RequestMethod.DELETE)
public String deletePet(@PathVariable int ownerId, @PathVariable int petId) {
    this.clinic.deletePet(petId);
    return "redirect:/owners/" + ownerId;
}

java

Kotlin

@RequestMapping(method = [RequestMethod.DELETE])
fun deletePet(@PathVariable ownerId: Int, @PathVariable petId: Int): String {
    clinic.deletePet(petId)
    return "redirect:/owners/$ownerId"
}

kotlin

HTML5 标签

Spring 表单标签库允许输入动态属性，这意味着您可以输入任何 HTML5 特定的属性。

表单 input 标签支持输入除 text 以外的类型属性。这是为了允许渲染新的 HTML5 特定输入类型，例如 email、date、range 等。请注意，输入 type='text' 并不是必需的，因为 text 是默认类型。