JSP 和 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>

JSP 与 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" %>

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

表单标签

此标签呈现 HTML 'form' 元素并向内部标签公开绑定路径以进行绑定。它将命令对象放入PageContext中，以便内部标签可以访问命令对象。此库中的所有其他标签都是form标签的嵌套标签。

假设我们有一个名为User的域对象。它是一个具有诸如firstName和lastName之类的属性的 JavaBean。我们可以将其用作表单控制器的表单支持对象，该控制器返回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>

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>

前面的 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>

input标签

此标签呈现一个 HTML input 元素，其绑定值为默认的type='text'。有关此标签的示例，请参见表单标签。您还可以使用 HTML5 特定的类型，例如email、tel、date等。

checkbox标签

此标签呈现一个 HTML input 标签，其type设置为checkbox。

假设我们的User具有诸如新闻通讯订阅和爱好列表之类的偏好设置。以下示例显示了Preferences类

  • Java

  • Kotlin

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;
	}
}
class Preferences(
		var receiveNewsletter: Boolean,
		var interests: StringArray,
		var favouriteWord: String
)

相应的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>

有三种方法可以处理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>

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

checkboxes标签

此标签呈现多个HTML input标签，其type属性设置为checkbox。

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

此示例假设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>

radiobuttons标签

此标签呈现多个HTML input元素，其type属性设置为radio。

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

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

password标签

此标签呈现一个HTML input标签，其类型设置为password，并包含绑定值。

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

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

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

select标签

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

假设一个User有一个技能列表。相应的HTML可能是如下所示

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

如果User的技能是草药学，则“技能”行的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>

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>

如果User的学院是格兰芬多，则“学院”行的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>
1 注意添加了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>

如果User居住在英国，则“国家”行的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>
1 注意添加了selected属性。

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

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

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>

hidden标签

此标签呈现一个HTML input标签，其type属性设置为hidden，并包含绑定值。要提交未绑定的隐藏值，请使用类型设置为hidden的HTML input标签。以下HTML显示了它的典型输出

<form:hidden path="house"/>

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

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

errors标签

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

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

  • Java

  • Kotlin

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.");
	}
}
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.")
	}
}

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>

如果我们提交一个在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>

如果我们想显示给定页面的所有错误列表呢？下一个示例显示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>

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>

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

HTTP 方法转换

REST 的一个关键原则是使用“统一接口”。这意味着可以使用相同的四种HTTP方法（GET、PUT、POST和DELETE）来操作所有资源（URL）。对于每种方法，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方法。例如，以下代码片段来自Pet Clinic示例

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

前面的示例执行HTTP POST，而“真实”DELETE方法隐藏在请求参数后面。它由在web.xml中定义的HiddenHttpMethodFilter拾取，如下例所示

<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>

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

  • Java

  • Kotlin

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

HTML5标签

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

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