target
掌握通过实体 Bean 接收请求参数
了解通过处理方法的形参接收请求参数
掌握通过 HttpServletRequest 接收请求参数
掌握通过 @PathVariable 接收 URL 中的请求参数
掌握通过 @RequestParam 接收请求参数
了解通过 @ModelAttribute 接收请求参数
Controller 接收请求参数的方式有很多种,下面分别介绍这些方式,读者可以根据实际情况选择合适的接收方式。
首先把项目基本的框架搭建出来,新建动态web项目:SpringMVC-03
:
① 导入jar:
将以下jar复制到lib目录下:
commons-logging-1.2.jar
spring-aop-4.3.9.RELEASE.jar
spring-beans-4.3.9.RELEASE.jar
spring-context-4.3.9.RELEASE.jar
spring-core-4.3.9.RELEASE.jar
spring-expression-4.3.9.RELEASE.jar
spring-web-4.3.9.RELEASE.jar
spring-webmvc-4.3.9.RELEASE.jar
② 配置前端控制器:
在开发 Spring MVC 应用时需要在 web.xml 中部署 DispatcherServlet,代码如下:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
<display-name>SpringMVC-01</display-name>
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
<!-- 部署 DispatcherServlet -->
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!-- 配置 DispatcherServlet 的初始化參數:设置文件的路径和文件名称 -->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc.xml</param-value>
</init-param>
<!-- 表示容器再启动时立即加载servlet -->
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<!-- 处理所有URL -->
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
③ Spring MVC 的配置文件:
在 Src 目录下创建名为 springmvc.xml 的配置文件,具体代码如下:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd">
<!-- 设置扫描组件的包: -->
<context:component-scan base-package="com.lee.springmvc.controller" />
<!-- 配置映射解析器:如何将控制器返回的结果字符串,转换为一个物理的视图文件 -->
<bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/views/" />
<property name="suffix" value=".jsp" />
</bean>
</beans>
④ 创建实体类:
User.java:
package com.lee.springmvc.bean;
public class User {
private Integer id ;
private String username;
private String password;
private String email;
private int age;
private Address address;
// getter、setter方法略
}
Address.java:
package com.lee.springmvc.bean;
public class Address {
private String province;
private String city;
//get、set、toString
}
⑤ 相关jsp页面:
在 WebContent 目录下新建 index.jsp:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>首页</title>
</head>
<body>
<form action="acceptParams" method="POST">
username: <input type="text" name="username"/><br>
password: <input type="password" name="password"/><br>
email: <input type="text" name="email"/><br>
age: <input type="text" name="age"/><br>
city: <input type="text" name="address.city"/><br>
province: <input type="text" name="address.province"/>
<input type="submit" value="Submit"/>
</form>
</body>
</html>
其中:表单的name属性值要和实体类的属性值保持一致。
在 /WEB-INF/views/ 下新建 success.jsp 页面,作为成功跳转页面:
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>springmvc</title>
</head>
<body>
欢迎来到SpringMVC!
</body>
</html>
本章以下内容都是基于此环境基础上完成的。
1. 通过实体 Bean 接收请求参数
通过一个实体 Bean 来接收请求参数,适用于 get 和 post 提交请求方式。需要注意的是,Bean 的属性名称必须与请求参数名称相同。
支持级联属性,如:dept.deptId、dept.address.tel 等。
🌰控制器中直接用User类作为参数就可以接受表单传来的数据:
package com.lee.springmvc.controller;
@Controller
public class MyController {
@RequestMapping("/acceptParams")
public String testPojo(User user) {
System.out.println(user);
return "success";
}
}
注意:
使用 POJO类传参,表单的name值需要和POJO类中的属性名一致。
此种方式应用最多。
将项目部署在Tomcat上,启动服务。访问:http://localhost:8080/SpringMVC-03/,填写表单,提交。控制台会打印:
可以发现,已经成功接收到表单传过来的值。
如果中文有乱码,需要在web.xml中配置字符编码过滤器,且配置其他过滤器之前,否则不起作用。
<!-- 字符编码过滤器 -->
<filter>
<filter-name>encodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>encodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
2. 通过处理方法的形参接收请求参数
通过处理方法的形参接收请求参数也就是直接把表单参数写在控制器类相应方法的形参中,即形参名称与表单中输入框的name值完全相同。该接收参数方式适用于 get 和 post 提交请求方式。
package com.lee.springmvc.controller;
@Controller
public class MyController {
@RequestMapping("acceptParams")
/**
* 通过形参接收请求参数,形参名称与表单输入框的name值名称完全相同
*/
public String acceptParams(String username,String password,int age) {
System.out.println(username);
System.out.println(password);
System.out.println(age);
return "success";
}
}
此种方式的缺点是:
- 没办法获取级联属性,比如此案例中用户的Address就没办法设置。
- 若需要获取的参数很多,使用起来很不方便。
此种方式极少使用
3. 通过 HttpServletRequest 接收请求参数
HttpServletRequest 是Servlet的原生API,可以像使用原生Servlet一样接受参数,方法是:request.getParameter("xxx");
通过 HttpServletRequest 接收请求参数适用于 get 和 post 提交请求方式。
package com.lee.springmvc.controller;
@Controller
public class MyController {
@RequestMapping("acceptParams")
public String acceptParams(HttpServletRequest request) {
String username = request.getParameter("username");
String password = request.getParameter("password");
String province = request.getParameter("address.province");
System.out.println(username + " " + password + " " + province);
return "success";
}
}
此种方式可以获取级联属性,但是使用的也不是很多。
4. 通过 @PathVariable 接收 URL 中的请求参数
带占位符的 URL 是Spring3.0新增的功能,该功能在 SpringMVC 向 REST目标挺进发展过程中具有里程碑的意义。(REST后面会有专题讲解)
通过 @PathVariable
注解可以将 URL中占位符参数绑定到控制器处理方法的入参中。
@RequestMapping("testPathvariable/{username}/{password}")
public String testPathvariable(@PathVariable("username") String username,
@PathVariable("password") String passwprd) {
System.out.println(username + "," + passwprd);
return "success";
}
在访问 http://localhost:8080/SpringMVC-03/testPathvariable/lee/123”路径时,上述代码自动将 URL 中的模板变量 {username} 和 {password} 绑定到通过 @PathVariable 注解的同名参数上,即 username=lee、password=123。
输出:lee,123
5. 通过 @RequestParam 接收请求参数
通过 @RequestParam 接收请求参数适用于 get 和 post 提交请求方式。
当表单名称与接收参数名不一致时,“通过处理方法的形参接收请求参数”不会报错,但是控制器会输出null,可以通过 @RequestParam处理参数名不一致的问题。
@RequestMapping("acceptParams")
public String testPathvariable(@RequestParam("username") String name,@RequestParam("password") String pwd) {
System.out.println(name + "," + pwd);
return "success";
}
注意:@RequestParam("xx")中的值必须和表单一致。
6. 通过 @ModelAttribute 接收请求参数
当 @ModelAttribute 注解放在处理方法的形参上时,用于将多个请求参数封装到一个实体对象,从而简化数据绑定流程,而且自动暴露为模型数据,在视图页面展示时使用。
而“通过实体 Bean 接收请求参数”中只是将多个请求参数封装到一个实体对象,并不能暴露为模型数据(需要使用 model.addAttribute 语句才能暴露为模型数据,数据绑定与模型数据展示后面会讲解)。
通过 @ModelAttribute 注解接收请求参数适用于 get 和 post 提交请求方式。
package com.lee.springmvc.controller;
@Controller
public class MyController {
@RequestMapping("acceptParams")
public String acceptParams(@ModelAttribute("user") User user) {
System.out.println(user);
return "success";
}
}