1.@RequestMapping
1.1@RequestMapping使用
之前,我们是把@RequestMapping
注解放在方法之上,用来给方法绑定一个请求映射。
除外,还可以 类+方法 的组合使用,如下,
@Controller
@RequestMapping("/FirstSpringDemo")
public class FirstSpringDemo
{
@RequestMapping("/firstSpringMVC")
public String welcomeToSpringMVC()
{
System.out.println("welcome to springMVC");
return "success";
}
}
而此时,前端请求的路径就应该是:类/方法
<a href="FirstSpringDemo/firstSpringMVC">My First SpringMVC Demo</a>
1.2.@RequestMapping属性
@RequestMapping
注解的常用属性如下,
属性 | 简介 |
---|---|
value | 指定请求的实际URL地址,属性名value可省。例如@RequestMapping("/firstSpringMVC")等价于@RequestMapping(value="/firstSpringMVC") |
method | 指定请求方式,包含 GET(默认)、POST、PUT、DELETE等;可以通过枚举类RequestMethod设置,如method=RequestMethod.POST。 |
params | 规定请求中的些参数值,必须满足一定的条件。params本身是一个字符串数组。 |
headers | 规定请求中的请求头(header)必须满足一定的条件。 |
①method
属性
例如,因为超链接本身是采用GET方式提交请求。因此,若前台仍然是通过
<a href="FirstSpringDemo/firstSpringMVC">...</a>
发送请求,则处理类必须使用GET方式才能接受到此请求。如果使用“POST”等其他方式,是无法获取到该请求的,如下,
FirstSpringDemo.java
@Controller
@RequestMapping(value="/FirstSpringDemo")
public class FirstSpringDemo{
@RequestMapping(value="/firstSpringMVC",method=RequestMethod.POST)
public String welcomeToSpringMVC(){
return "success";
}
}
运行结果:
如果把超链接,替换成以下POST方式的表单提交,
<form action="FirstSpringDemo/firstSpringMVC" method="POST">
<input type="submit" value="POST方式提交"/>
</form>
点击“POST方式提交”后,就又会正常运行。
②params
属性
params支持以下表达式:
表达式 | 简介 |
---|---|
paramName | 必须包含参数名为“paramName”的参数。 |
!paramName | 不能包含参数名为“paramName”的参数。 |
paramName!=paramValue | 必须包含参数名为“paramName”的参数,但参数值不能是“paramValue”。 |
例如,我们通过超链接加入两个请求参数,如下,
<a href=
"FirstSpringDemo/requestWithParams?name=zhangsan&age=20">
requestWithParams
</a>
再通过params
来检查请求中的参数是否符合要求,如下,
FirstSpringDemo.java
@Controller
@RequestMapping(value="/FirstSpringDemo")
public class FirstSpringDemo{
@RequestMapping(value="/requestWithParams",params={"name","age!=23"})
public String requestWithParams(){
return "success";
}
}
以上请求通过params
规定请求参数必须包含“name”参数,并且“age!=23”,我们之前发来的请求“…?name=zhangsan&age=20”符合要求,因此可以被该方法接收并处理。如果发送的请求参数是“…?name=zhangsan&age=23”或“…? age=23”等不符合params规定,就会引发我们所熟悉 “404”异常。
③headers
属性
SpringMVC用headers来约束“参数”,用headers来约束“请求头”。我们可以在谷歌浏览器里查看每一次请求的“请求头”,如下,
“请求头”指明了请求所携带的MIME类型、字符集等信息。
例如,可以通过“headers”指定请求头中的“Accept-Language”必须是“zh-CN,zh;q=0.8,en-US;q=0.5,en;q=0.3”,以及“Accept-Encoding”必须是“gzip, deflate”,如下:
FirstSpringDemo.java
@RequestMapping(value="/requestWithHeaders",
headers={"Accept-Language=zh-CN,zh;q=0.8,en-US;q=0.5,en;q=0.3","Accept-Encoding=gzip, deflate"})
public String requestWithHeaders() {
return "success";
}
1.3.基于@RequestMapping的配置
①Ant风格的请求路径
SpringMVC除了支持传统方式的请求外,还支持Ant风格的请求路径。
Ant风格的请求路径支持以下3种通配符:
通配符 | 简介 |
---|---|
? | 匹配任何单字符 |
* | 匹配0或者任意数量的字符 |
** | 匹配0或者更多的目录 |
例如,在处理方法前配置@RequestMapping(value="/requestWithAntPath/*/test")
,表示请求路径的“requestWithAntPath”和“test”之间可以填任意字符,如下,
FirstSpringDemo.java
@Controller
@RequestMapping(value="/FirstSpringDemo")
public class FirstSpringDemo{
@RequestMapping(value="/requestWithAntPath/*/test")
public String requestWithAntPath(){
return "success";
}
}
如果前端发送以下请求,是可以匹配到requestWithAntPath()方法的。
<a href="FirstSpringDemo/requestWithAntPath/lanqiao/test">
requestWithAntPath...
</a>
其他Ant风格的示例如下表,
请求路径 | 匹配的示例 |
---|---|
/requestWithAntPath/**/test | /requestWithAntPath/a/b/test、/requestWithAntPath/test等 |
/requestWithAntPath/test?? | /requestWithAntPath/testxy、/requestWithAntPath/testqq等 |
②使用@PathVariable
获取动态参数
在SpringMVC中,可以使用@PathVariable来获得请求路径中的动态参数。
如下,通过前端传入一个参数“9527”,
<a href="FirstSpringDemo/requestWithPathVariable/9527">
requestWithPathVariable...
</a>
处理方法就可以通过@PathVariable来获取此参数值,如下
FirstSpringDemo.java
@Controller
@RequestMapping(value="/FirstSpringDemo")
public class FirstSpringDemo{
@RequestMapping(value="/requestWithPathVariable/{id}")
public String requestWithPathVariable(@PathVariable("id") Integer id) {
System.out.println("id:"+id);
return "success";
}
}
具体是通过@RequestMapping(value="/requestWithPathVariable/{id}")中的占位符“{id}”接收到参数值“9527”,再把参数值传给@PathVariable(“id”)中的“id”,最后再把值赋值给方法的参数id。
③REST风格
REST(Representational State Transfer)是一种编程风格,可以显著降低开发的复杂性,是当前非常流行的一种互联网软件架构。
在学习REST之前,要先知道:HTTP协议里面的多种请求方式,POST
、DELETE
、PUT
、GET
等四种方式,分别对应增删改查四种操作。但是普通浏览器的form表单只支持GET和POST两种请求。为了使浏览器支持DELETE和PUT方式,可以使用Spring提供的过滤器HiddenHttpMethodFilter,此过滤器可以通过一定的规则,将部分POST请求转化为DELETE和PUT请求。如果读者想了解HiddenHttpMethodFilter的底层代码,可以阅读spring-web-x.x.xRELEASE.jar包中HiddenHttpMethodFilter类里的doFilterInternal()方法。
实现PUT
或DELETE
请求方式的步骤如下:
第一步:
在web.xml中配置HiddenHttpMethodFilter过滤器,如下,
web.xml
<web-app …>
<filter>
<filter-name>HiddenHttpMethodFilter</filter-name>
<filter-class>
org.springframework.web.filter.HiddenHttpMethodFilter
</filter-class>
</filter>
<filter-mapping>
<filter-name>HiddenHttpMethodFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
第二步:
在form表单中指定请求方式为method="post"
;
在表单中添加一个hidden隐藏域,并设置隐藏域的name和value属性:name="_method"
、value="PUT"
或value="DELETE"
。
第三步:
在处理方法的@RequestMapping
注解中,用method属性指定请求方式(如method=RequestMethod.DELETE
、method=RequestMethod.PUT
等)。
index.jsp
<form action="FirstSpringDemo/requestWithREST/9527" method="post">
<input type="hidden" name="_method" value="DELETE" />
<input type="submit" value="删除" />
</form>
<form action="FirstSpringDemo/requestWithREST/9527" method="post">
<input type="hidden" name="_method" value="PUT" />
<input type="submit" value="修改" />
</form>
<form action="FirstSpringDemo/requestWithREST/9527" method="post">
<input type="submit" value="增加" />
</form>
<a href="FirstSpringDemo/requestWithREST/9527">查看</a>
FirstSpringDemo.java
@Controller
@RequestMapping(value="/FirstSpringDemo")
public class FirstSpringDemo
{
//使用REST风格,处理“删除”的请求
@RequestMapping(value="/requestWithREST/{id}",method=RequestMethod.DELETE)
public String requestWithRestDelete(@PathVariable("id") Integer id){
System.out.println("删除时需要的id:"+id);
return "success";
}
//使用REST风格,处理“修改”的请求
@RequestMapping(value="/requestWithREST/{id}",method=RequestMethod.PUT)
public String requestWithRestPut(@PathVariable("id") Integer id) {
System.out.println("修改时需要的id:"+id);
return "success";
}
//使用REST风格,处理“增加”的请求
@RequestMapping(value="/requestWithREST/{id}",method=RequestMethod.POST)
public String requestWithRestAdd(@PathVariable("id") Integer id){
System.out.println("增加时需要的id:"+id);
return "success";
}
//使用REST风格,处理“查看”的请求
@RequestMapping(value="/requestWithREST/{id}",method=RequestMethod.GET)
public String requestWithRestGet(@PathVariable("id") Integer id){
System.out.println("查询时需要的id:"+id);
return "success";
}
}
运行结果:
控制台显示正常,但是在操作删除和修改的时候前台报这个错误,有知道的小伙伴分享一下原因,谢谢了。
④使用@RequestParam获取请求参数
Spring MVC可以通过@RequestParam来接收请求中的参数值,该注解有三个常用属性:
属性名 | 简介 |
---|---|
value | 请求携带参数的参数名 |
required | 标识请求参数中是否必须存在某个具体的参数。 true(默认):必须存在;若不存在,将抛出异常。 false:不必须。 |
defaultValue | 给参数赋一个默认值。如果请求中不存在某个参数,则该参数就取defaultValue所设置的值。 |
index.jsp
<a href="FirstSpringDemo/requestParam?name=zhangsan&age=23">
TestRequestParam
</a>
FirstSpringDemo.java
@Controller
@RequestMapping(value="/FirstSpringDemo")
public class FirstSpringDemo{
//使用@RequestParam注解接收请求参数
@RequestMapping("/requestParam")
public String requestParam(@RequestParam(value="name") String name, @RequestParam(value="age") Integer age){
System.out.println("name: " + name + " age: " + age);
return "success";
}
}
@RequestParam通过value值与传入的参数名匹配,并将参数值赋值给@RequestParam后面的变量。
例如,通过@RequestParam(value="name")
接收index.jsp传来的name
参数值(即zhangsan),并将参数值(zhangsan)赋值给@RequestParam后面的String name,类似于String name=“zhangsan”。
若将请求中的age参数删除,如下,
<a href="FirstSpringDemo/requestParam?name=zhangsan">
TestRequestParam
</a>
为了解决此异常,就可以给age参数的@RequestParam加入required=false
,如下:
@RequestMapping("/requestParam")
public String requestParam(@RequestParam(value = "name") String name, @RequestParam(value = "age",required=false) Integer age)
{
…
}
此外,还可以通过@RequestParam的defaultValue
属性给请求参数设置默认值,如下,
@RequestMapping("/requestParam")
public String requestParam(@RequestParam(value = "name") String name, @RequestParam(value = "age",
required=false,defaultValue="23") Integer age) {
System.out.println("name: " + name + " age: " + age);
return "success";
}
通过defaultValue="23"
将age的默认值设置为”23”,即如果前端发送的请求中没有携带age参数,则age的值就是23。
⑤@RequestHeader注解
在HTTP协议中,每一次请求都会携带相关的“头信息”:
SpringMVC也提供了@RequestHeader
注解来帮助我们获取请求中的“头信息”,如下:
index.jsp
<a href="FirstSpringDemo/requestHeader"> requestHeader</a>
FirstSpringDemo.java
@Controller
@RequestMapping(value = "/FirstSpringDemo")
public class FirstSpringDemo{
@RequestMapping("/requestHeader")
public String requestHeader(@RequestHeader(value="Accept-Language") String al){
System.out.println("Accept-Language:" + al);
return "success";
}
}
通过@RequestHeader
获取“头信息”,并通过value属性指定获取头信息中的Accept-Language值,并把值赋值给al参数。
⑥@CookieValue注解
@CookieValue
可以给处理方法入参绑定某个Cookie值。例如,客户端有一个名为JSESSIONID的Cookie对象,服务端可以通过@CookieValue
来获取此JSESSIONID的值:
index.jsp
<a href="FirstSpringDemo/cookieValue">cookieValue</a>
FirstSpringDemo.java
@Controller
@RequestMapping(value = "/FirstSpringDemo")
public class FirstSpringDemo{
@RequestMapping("/cookieValue")
public String cookieValue(@CookieValue(value="JSESSIONID") String sessionid){
System.out.println("sessionid:" + sessionid);
return "success";
}
}
⑦使用实体类对象接收请求参数值
如果处理方法的参数是一个实体类对象,那么SpringMVC会将请求的参数名与实体类对象的属性进行匹配,为实体类对象的属性赋值,并且支持级联属性的赋值。以下是具体的示例:
实体类:Student.java
public class Student {
private String stuName;
private int stuAge;
private Address address ;
//setter、getter
@Override
public String toString(){
return "姓名:"+this.stuName+"\t年龄:"+this.stuAge+"\t家庭地址:"+this.address.getHomeAddress()
+"\t学校地址:"+this.address.getSchoolAddress();
}
}
实体类:Address.java
public class Address{
private String schoolAddress;
private String homeAddress;
//setter、getter
}
在form表单中使用实体类的属性名作为标签的name值(可使用级联属性):
请求页:index.jsp
<form action="FirstSpringDemo/entityProperties">
姓名:<input type="text" name="stuName"/><br>
年龄:<input type="text" name="stuAge"/><br>
<!-- 使用级联属性 -->
家庭地址:<input type="text" name="address.homeAddress"/><br>
学校地址:<input type="text" name="address.schoolAddress"/><br>
<input type="submit" value="提交"/>
</form>
请求处理类:FirstSpringDemo.java
@Controller
@RequestMapping(value = "/FirstSpringDemo")
public class FirstSpringDemo{
//使用实体类对象接收请求参数值(form表单中提交的数据)
@RequestMapping("/entityProperties")
public String entityProperties(Student student){
System.out.println(student);
return "success";
}
}
⑧使用Servlet API作为参数
如果想使用原生的Servlet API进行开发,只需要将Servlet API放入方法的参数中,如下:
//使用Servlet API开发
@RequestMapping("/developWithServletAPI")
public String developWithServletAPI(HttpServletRequest requst,HttpServletResponse response, HttpSession session){
//使用request和response参数处理请求或响应...
return "success";
}
2.处理模型数据
假设需要从数据库查询数据:在MVC设计模式中,用户从视图页面(V)发起一个请求到控制器(C),控制器调用Service/Dao等处理数据,并从数据库中返回数据(M)。之后,控制器(C)拿到数据(M)后加以处理,并返回到视图页面(V)。
SpringMVC提供了四种途径来处理带数据的视图(M和V):ModelAndView
,ModelMap
、Map
及Model
,@SessionAttributes
,@ModelAttribute
2.1 ModelAndView
ModelAndView包含了Model(M)和View(V)两部分。用法如下:
index.jsp
<a href="FirstSpringDemo/testModelAndView">testModelAndView</a>
请求处理类:FirstSpringDemo.java
@Controller
@RequestMapping(value = "/FirstSpringDemo")
public class FirstSpringDemo{
@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView(){
String view = "success";
ModelAndView mav= new ModelAndView(view);
Student student = new Student("张三",23);
//添加student对象数据放入ModelAndView中
mav.addObject("student ",student);
return mav;
}
}
通过ModelAndView的构造方法将视图页面的名称”success”放入mav对象,再通过addObject()方法将数据放入mav对象,最后返回mav。之后,程序就会跳转到mav指定的视图页面views/success.jsp(仍然会被视图解析器加上了前缀和后缀),并将mav中的数据student放入request作用域之中。
返回的视图页面:success.jsp
${requestScope.student.stuName }
2.2 使用Map、ModelMap、Model作为方法的参数处理数据
可以给SpringMVC的请求处理方法增加一个Map类型的参数。如果向此Map中增加数据,那么该数据也会被放入request作用域中。
index.jsp
<a href="FirstSpringDemo/testMap">testMap</a>
请求处理类:FirstSpringDemo.java
@Controller
@RequestMapping(value = "/FirstSpringDemo")
public class FirstSpringDemo{
@RequestMapping("/testMap")
public String testMap(Map<String, Object> map) {
Student student = new Student("张三", 23);
map.put("student", student);
return "success";
}
}
返回的视图页面success.jsp及运行结果同上例。
除了Map以外,还可以给请求处理方法增加一个ModelMap或Model类型的参数,效果完全一样,如下,
使用ModelMap类型的参数
@RequestMapping("/testModelMap")
public String testMap(ModelMap map){
Student student = new Student("张三", 23);
map.put("student", student);
return "success";
}
使用Model类型的参数
@RequestMapping("/testModel")
public String testModel(Model map){
Student student = new Student("张三", 23);
map.addAttribute("student", student);
return "success";
}
2.3 使用@SessionAttributes处理数据
我们已经知道,向ModelAndView以及Map、ModelMap、Model参数中增加数据时,数据会同时被放到request作用域中。
如果还要把数据放到session
作用域中,就需要使用@SessionAttributes
注解,如下:
index.jsp
<a href="FirstSpringDemo/testSessionAttribute">testSessionAttribute</a>
请求处理类:FirstSpringDemo.java
@SessionAttributes(value="student")
@Controller
@RequestMapping(value = "/FirstSpringDemo")
public class FirstSpringDemo{
@RequestMapping("/testSessionAttribute")
public String testSessionAttribute(Map<String ,Object> map){
Student student = new Student("张三", 23);
map.put("student", student);
return "success";
}
}
在类的上方加入@SessionAttributes(value="student")
,表示将request作用域中的"student"对象同时加入到session作用域之中。
返回的视图页面:success.jsp
request作用域中:${requestScope.student.stuName } <br/>
session作用域中:${sessionScope.student.stuName } <br/>
@SessionAttributes
除了可以使用value将指定的对象名加入到session范围,还可以使用types将某一个类型的对象都加入到session范围,如下:
@SessionAttributes(types=Student.class)
@Controller
@RequestMapping(value = "/FirstSpringDemo")
public class FirstSpringDemo{
@RequestMapping("/testSessionAttribute")
public String testSessionAttribute(Map<String ,Object> map){
Student student = new Student("张三", 23);
map.put("student", student);
return "success";
}
}
通过@SessionAttributes(types=Student.class)
将request作用域中Student类型的对象同时加入到session作用域之中。
2.4 使用@ModelAttribute注解处理数据
假设数据库中存在一条学生信息,现在我们需要修改学生的年龄(姓名等其他信息不变),先尝试用以下方式完成:
index.jsp(修改学号为31号的学生年龄)
<form action="FirstSpringDemo/testModelAttribute" method="post">
<input type="hidden" value="31" name="stuNo"/>
年龄:<input type="text" name="stuAge"/><br>
<input type="submit" value="修改"/>
</form>
请求处理类:FirstSpringDemo.java
@Controller
@RequestMapping(value = "/FirstSpringDemo")
public class FirstSpringDemo{
@RequestMapping("/testModelAttribute")
public String testModelAttribute(Student student){
//省略数据库的更新操作:将数据表中stuNo=31的学生信息,更新为参数student中的各属性值
System.out.println("更新后的学生信息:姓名: "
+ student.getStuName()+",年龄:"+student.getStuAge());
return "success";
}
}
执行index.jsp,并将年龄修改为66岁,如图:
点击修改,控制台的输出结果如下:
可以发现,年龄确实成功修改了,但是姓名却变成了null。这是因为在index.jsp的form表单中,只提交了stuAge字段的属性,而不存在stuName等其他字段的属性,因此stuAge属性会从输入框中获取,而其他属性值会使用相应类型的默认值(如String类型的stuName默认值就是null)。
这与我们的本意不符,我们的本意是:被修改的属性,使用修改后的值(如stuAge);而没被修改的属性,要使用数据库中原有的值(如果stuName应该保留“张三”)。要想实现我们的“本意”,可以在请求控制类中增加一个用@ModelAttribute
的方法,如下:
请求处理类:FirstSpringDemo.java
@Controller
@RequestMapping(value = "/FirstSpringDemo")
public class FirstSpringDemo{
@ModelAttribute
public void queryStudentBeforeUpdate (int stuNo,Map<String, Object> map) {
//使用带数据的实体类对象,模拟从数据库中获取学号为stuNo的学生对象
Student student = new Student();
student.setStuNo(stuNo);
student.setStuName("张三");
student.setStuAge(23);
//即用以上语句模拟Student student = stuService.queryStudentByNo(stuNo);
//将从数据库中查询的student对象放入map中
map.put("student", student);
}
@RequestMapping("/testModelAttribute")
public String testModelAttribute(Student student){
//省略数据库的更新操作
System.out.println("更新后的学生信息:姓名: " + student.getStuName()+",年龄:"+student.getStuAge());
return "success";
}
}
重新提交之前的form表单,控制台输出结果如下:
可以发现,不但stuAge得到了修改,并且stuName也保留了原来的值。
@ModelAttribute的应用逻辑是:
@ModelAttribute修饰的方法(如queryStudentBeforeUpdate())会在请求处理方法(如testModelAttribute())调用之前被执行:具体是,如果请求处理方法有输入参数(如student),则程序会在@ModelAttribute修饰的方法中的map对象里,寻找map中的key值是否与请求处理方法的参数名①一致,如果一致(如map中有名为”student”的key,testModelAttribute()方法也有名为”student”的参数)就会用参数student中不为null的属性值(如stuNo=31,stuAge=66)去覆盖map中的student对象值,最后使用的是覆盖后的student对象。例如,map中的student对象值是:“学号:31,姓名:张三,年龄23”,参数中student的对象值是:“学号31,姓名null,年龄66”,因此用参数student不为null的属性值(stuNo=31,stuAge=66)去覆盖map中student属性值的结果就是:“学号31,姓名:张三,年龄66”。即form表单传来的stuNo和stuAge属性得到了修改,而form表单中不存在的stuName属性则保持不变。如果map中的key值与请求处理方法的参数名不一致,则需要在参数前使用@ModelAttribute标识出map中对应的key值,如下:
请求处理类:FirstSpringDemo.java
@ModelAttribute
public void queryStudentBeforeUpdate(int stuNo,Map<String, Object> map) {
...
map.put("stu", student);
}
@RequestMapping("/testModelAttribute")
public String testModelAttribute(
@ModelAttribute("stu")Student student){
...
return "success";
}
…
map中的key是”stu”,与方法的参数名”student”不一致,就需要在参数名前使用@ModelAttribute(“stu”)来进行标识。
①参数名:实际是判断是否与“首字母小写的参数类型”一致。如参数的类型是Student,则会判断是否与首字母小写的参数类型(即”student”)一致。此段落中,用“参数名”来代替“首字母小写的参数类型”仅仅是为了便于读者阅读。
说明:
标有@ModelAttribute
注解的方法,会在请求处理类中的每一个方法执行前,都执行一次,因此需要谨慎使用。