SpringMVC学习01:请求路径映射和参数绑定
SpringMVC入门案例
环境搭建
-
创建Maven项目选择webapp骨架创建(需要手动创建java和resources文件夹),在pom.xml中导入依赖的坐标
<properties> <!--版本锁定,指定spring的版本--> <spring.version>5.0.2.RELEASE</spring.version> </properties> <dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>servlet-api</artifactId> <version>2.5</version> <scope>provided</scope> </dependency> <dependency> <groupId>javax.servlet.jsp</groupId> <artifactId>jsp-api</artifactId> <version>2.0</version> <scope>provided</scope> </dependency> </dependencies>
-
配置SpringMVC组件
-
将SpringMVC组件注入到spring容器中,在resources目录下创建SpringMVC.xml配置文件
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:context="http://www.springframework.org/schema/context" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> <!--配置spring创建时要扫描的包--> <context:component-scan base-package="com.chenpeng.controller"/> <!--配置视图解析器--> <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <!--配置前缀--> <property name="prefix" value="/WEB-INF/pages/"></property> <!--配置后缀--> <property name="suffix" value=".jsp"></property> </bean> <!--配置spring开启注解mvc的支持,自动加载处理器适配器和处理器映射器--> <mvc:annotation-driven conversion-service="conversionService"/> </beans>
-
配置SpringMVC的核心控制器,在webapp/WEB-INF目录下配置web.xml
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd" > <web-app> <!--配置SpringMVC的前端控制器--> <servlet> <servlet-name>dispatcherServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <!--配置Servlet的初始化参数,读取SpringMVC的配置文件,创建spring容器--> <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>dispatcherServlet</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> </web-app>
-
创建控制器和视图页面
-
在java目录下创建控制器类com.chenpeng.controller.HelloController
/** * 控制器 */ @Controller @RequestMapping(path = "/user") public class HelloController { /** * 入门案例 * @return */ @RequestMapping(path = "/hello")//请求映射注解 public String sayHello(){ System.out.println("Hello SpringMVC"); return "success"; } }
-
删除骨架生成的index.jsp重新创建主页视图index.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title>Title</title> </head> <body> <h1>入门程序</h1> <a href="user/hello">hello SpringMVC</a> </body> </html>
-
在webapp/WEB-INF目录下创建目录pages,在其中创建success.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" isELIgnored="false"%> <html> <head> <title>Title</title> </head> <body> <h1>入门成功</h1> </body> </html>
-
-
请求路径映射
@RequestMapping注解
- 作用:建立请求URL和处理方法之间的对应关系
- 可以作用在方法和类上
- 作用在类上:第一级的访问目录
- 作用在方法上:第二级的访问目录
- 细节:路径可以不编写 / 表示应用的根目录开始
- 细节:${ pageContext.request.contextPath }也可以省略不写,但是路径上不能写 /
- 属性
- path:指定请求路径的url(与value属性作用相同)
- mthod:指定方法的请求方式,可选值:
- RequestMethod.GET
- RequestMethod.POST
- RequestMethod.PUT
- RequestMethod.HEAD
- params:指定限制请求参数的条件
- headers:发送的请求中必须包含的请求头
@PathVariable注解
-
作用:绑定url中的占位符
-
属性:
- value:指定url中占位符的名称
-
restful风格url
- 请求路径一样,可以根据不同的请求方式去执行后台的不同方法
-
例如
<a href="anno/chenyu">PathVariable注解</a>
/** * PathVariable注解 * @param id * @return */ @RequestMapping(path = "/{id}") public String testPathVariable(@PathVariable(value = "id")String id){ System.out.println(id); return "success"; }
请求参数的绑定
请求参数的绑定说明
- 绑定机制:
- 表单提交的数据都是键值对的格式
- SpringMVC的参数绑定过程是把表单提交的请求参数,作为控制器中方法的参数进行绑定
- 要求提交表单的name和参数的名称是相同的
- 支持的数据类型:
- 基本数据类型和String类型
- 实体类型(JavaBean)
- 集合数据类型(List、map集合等)
基本数据类型和String类型的参数绑定
<a href="param/testParam?name=aaa&age=20">请求参数绑定</a>
/**
* 请求参数绑定入门
* @param name
* @param age
* @return
*/
@RequestMapping(path = "/testParam")
public String testParam(String name,Integer age){
System.out.println("执行了"+name+age);
return "success";
}
实体类型的参数绑定
-
如果实体类中只有基本数据类型和String类型的属性,则需要提交表单的name和实体类中的属性名称一致,例如
public class User implements Serializable { private String username; private String password; private Double money; public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public Double getMoney() { return money; } public void setMoney(Double money) { this.money = money; } @Override public String toString() { return "User{" + "username='" + username + '\'' + ", password='" + password + '\'' + ", money=" + money+ '}'; } }
<form action="param/saveUser"> 用户名:<input type="text" name="username"><br> 密码:<input type="text" name="password"><br> 金额:<input type="text" name="money"><br> <input type="submit" value="提交"> </form>
/** * 请求参数绑定把数据封装到实体类中 * @param user * @return */ @RequestMapping(path = "/saveUser") public String saveUser(User user){ System.out.println("执行了"); System.out.println(user); return "success"; }
-
如果实体类中包含其他的实体类对象,那么表单的name属性需要写成对象.属性名,例如
public class Account implements Serializable { private String name; private Integer age; private Date birthday; public String getName() { return name; } public void setName(String name) { this.name = name; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } public Date getBirthday() { return birthday; } public void setBirthday(Date birthday) { this.birthday = birthday; } @Override public String toString() { return "Account{" + "name='" + name + '\'' + ", age=" + age + ", birthday=" + birthday + '}'; } }
public class User implements Serializable { private String username; private String password; private Double money; private Account account; ... public Account getAccount() { return account; } public void setAccount(Account account) { this.account = account; } @Override public String toString() { return "User{" + "username='" + username + '\'' + ", password='" + password + '\'' + ", money=" + money + ", account=" + account + '}'; } }
<form action="param/saveUser"> 用户名:<input type="text" name="username"><br> 密码:<input type="text" name="password"><br> 金额:<input type="text" name="money"><br> 姓名:<input type="text" name="account.name"><br> 年龄:<input type="text" name="account.age"><br> <input type="submit" value="提交"> </form>
/** * 实体类中包含其他实体类对象 * @param account * @return */ @RequestMapping(path = "/saveAccount") public String saveAccount(Account account){ System.out.println("执行了"); System.out.println(account); return "success"; }
集合类型的参数绑定
-
对于list类型集合,表单的name属性需要写成list[下标].属性名
-
对于map类型集合,表单的name属性需要写成map[键].属性名
public class User implements Serializable { private String username; private String password; private Double money; private List<Account> list; private Map<String,Account> map; ... public List<Account> getList() { return list; } public void setList(List<Account> list) { this.list = list; } public Map<String, Account> getMap() { return map; } public void setMap(Map<String, Account> map) { this.map = map; } @Override public String toString() { return "User{" + "username='" + username + '\'' + ", password='" + password + '\'' + ", money=" + money + ", list=" + list + ", map=" + map + '}'; } }
<form action="param/saveUser" method="post"> 用户名:<input type="text" name="username"><br> 密码:<input type="text" name="password"><br> 金额:<input type="text" name="money"><br> 姓名:<input type="text" name="list[0].name"><br> 年龄:<input type="text" name="list[0].age"><br> 姓名:<input type="text" name="map['cy'].name"><br> 年龄:<input type="text" name="map['cy'].age"><br> <input type="submit" value="提交"> </form>
自定义类型转换器
表单提交的数据都是String类型,SpringMVC框架内部为我们进行了数据类型转换得到我们想要的数据类型,我们也可以自定义数据类型转换,自定义类型转换器需要实现Converter接口
-
在java目录下创建类com.chenpeng.utils.StringToDateConverter
//把字符串转换成日期格式 public class StringToDateConverter implements Converter<String, Date> { @Override public Date convert(String s) { if(s == null){ throw new RuntimeException("请您输入生日"); }else{ SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd"); try { return sdf.parse(s); } catch (ParseException e) { throw new RuntimeException("自定义转换出错"); } } } }
-
注册自定义类型转换器,在SpringMVC.xml中添加配置
<!--配置自定义转换器--> <bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean"> <property name="converters"> <set> <bean class="com.chenpeng.utils.StringToDateConverter"></bean> </set> </property> </bean>
在控制器中使用原生ServletAPI对象
SpringMVC支持使用原生ServletAPI对象作为控制器的参数
/**
* Servlet的原生API对象
* @param request,response
* @return
*/
@RequestMapping(path = "/testServlet")
public String testServlet(HttpServletRequest request, HttpServletResponse response){
System.out.println("执行了");
System.out.println(request);
System.out.println(response);
return "success";
}
解决请求参数中文乱码的问题
在webapp/WEB-INF目录下的web.xml中添加配置
<!--配置解决中文乱码的问题-->
<filter>
<filter-name>characterEncodingFilter</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>characterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
常用注解
-
@RequestParam注解
- 作用:把请求中的指定名称的参数传递给控制器中的形参赋值
- 属性:
- value:请求参数中的名称
- required:请求参数中是否必须提供此参数,默认值是true,必须提供
/** * RequestParam注解 * @param username * @return */ @RequestMapping(path = "/testRequestParam") public String testRequestParam(@RequestParam(name = "name")String username){//name属性和value属性可以替换使用 System.out.println("执行了"); System.out.println(username); return "success"; }
-
@RequestBody注解
- 作用:用于获取请求体的内容(不适用与get方式请求)
- 属性:
- required:是否必须有请求体,默认值是true
/** * RequestBody注解 * @param body * @return */ @RequestMapping(path = "/testRequestBody") public String testRequestBody(@RequestBody String body){ System.out.println("执行了"); System.out.println(body); return "success"; }
-
@RequestHeader注解
- 作用:获取指定请求头的值
- 属性:
- value:请求头的名称
/** * RequestHeader注解 * @param header * @return */ @RequestMapping(path = "/testRequestHeader") public String testRequestHeader(@RequestHeader(value = "Accept")String header){ System.out.println(header); return "success"; }
-
@CookieValue注解
- 作用:用于获取指定cookie的名称的值
- 属性:
- value:cookie的名称
/** * CookieValue注解 * @param cookieValue * @return */ @RequestMapping(path = "/testCookieValue") public String testCookieValue(@CookieValue(value = "JSESSIONID")String cookieValue){ System.out.println(cookieValue); return "success"; }
-
@ModelAttribute注解
- 作用:
- 出现在方法上:表示当前方法会在控制器方法执行前线执行
- 出现在参数上:获取指定的数据给参数赋值
- 属性:
- value:出现在参数上时,指定数据的名称
- 应用场景:
- 当提交表单数据不是完整的实体数据时,保证没有提交的字段使用数据库原来的数据
/** * ModelAttribute注解,作用在方法上,当前方法会在控制器方法执行钱执行 * @return */ @ModelAttribute public User showUser(){ System.out.println("showUser执行了"); User user = new User(); user.setUsername("chenyu"); user.setPassword("123456"); user.setMoney(500.0); return user; } @RequestMapping(path = "/updateUser") public String updateUser(User user){ System.out.println(user); return "success"; }
@ModelAttribute public void showUser(Map<String,User> map){ System.out.println("showUser执行了"); User user = new User(); user.setUsername("chenyuyu"); user.setPassword("123456"); user.setMoney(500.0); map.put("cy",user); } /** * ModelAttribute注解,作用在参数上,表示获取指定的数据给参数赋值 * @param user * @return */ @RequestMapping(path = "/displayUser") public String displayUser(@ModelAttribute(value = "cy") User user){ System.out.println(user); return "success"; }
- 作用:
-
@SessionAttributes注解
- 作用:用于多次执行控制器方法间的参数共享
- 属性:
- value:指定存入属性的名称
@SessionAttributes(value = {"username","password","age"},types = {String.class,Integer.class}) public class AnnoController { /** * 向session域中保存数据 * @param model * @return */ @RequestMapping(path = "/saveSession") public String saveSession(Model model){ System.out.println("向session域中保存数据"); model.addAttribute("username","chenyu"); model.addAttribute("password","666"); model.addAttribute("age",123456); return "success"; } /** * 从session域中取出数据 * @param modelMap * @return */ @RequestMapping(path = "/getSession") public String getSession(ModelMap modelMap){ System.out.println("从session域中取出数据"); String username = (String) modelMap.get("username"); String password = (String) modelMap.get("password"); Integer age = (Integer) modelMap.get("age"); System.out.println(username+password+age); return "success"; } /** * 清除session域中的数据 * @return */ @RequestMapping(path = "/deleteSession") public String deleteSession(SessionStatus sessionStatus){ System.out.println("清除session域中的数据"); sessionStatus.setComplete(); return "success"; } }