day01-2-@RequestMapping和Rest
@RequestMapping和Rest
1.@RequestMapping
1.1基本使用
@RequestMapping注解可以指定 控制器(处理器) 的某个方法的请求url
1.2@RequestMapping其他使用方式
1.2.1修饰方法和类
@RequestMapping注解可以修饰方法,还可以修饰类。
当同时修饰类和方法时,请求的url就是组合形式:/类请求值/方法请求值
例子
(1)UserHandler.java:
package com.li.web;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
/**
* @author 李
* @version 1.0
*/
@RequestMapping(value = "/user")
@Controller //UserHandler就是一个处理器/控制器,注入到spring容器
public class UserHandler {
/**
* 1.method = RequestMethod.POST 表示请求buy方法必须是post请求
* 2.RequestMethod 四个常用的选项 :GET, POST, PUT, DELETE
* 3.如果没有配置 RequestMethod,SpringMVC控制器默认支持 get和 post两种方式
* 4.buy()方法对应的完整请求url = http://ip:port/web工程路径/user/buy
* @return
*/
@RequestMapping(value = "/buy", method = RequestMethod.POST)
public String buy() {
System.out.println("购买商品");
return "success";
}
}
(2)request.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>购买商品</title>
</head>
<body>
<h1>购买商品</h1>
<%--
buy()方法对应的完整请求 url = http://ip:port/web工程路径/user/buy
--%>
<form action="user/buy" method="post">
购买人:<input type="text" name="username"/><br/>
购买量:<input type="text" name="nums"/><br/>
<input type="submit" value="提交"/>
</form>
</body>
</html>
(3)success.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>操作成功</title>
</head>
<body>
<h1>恭喜,操作成功!</h1>
</body>
</html>
在浏览器中访问 http://localhost:8080/springmvc/request.jsp
,点击提交按钮,结果如下:
1.2.2指定请求方式
-
@RequestMapping 可以指定请求的方式(post/get/put/delete...),请求方式要和指定方式一致,否则报错:
-
SpringMVC 控制器默认支持get 和 post两种请求方式,即如果没有指定 method,可以接收 get 和 post请求
1.2.3指定params和headers,支持简单表达式
param1
:表示请求必须包含名为 param1 的请求参数!param1
:表示请求不能包含名为 param1 的请求参数param1 != value1
:表示请求包含名为 param1 的请求参数,但其值不能为 value1{"param1 = value1", "param2"}
:请求必须包含名为 param1 和 param2 的两个请求参数,且 param1的值必须为 value1
应用实例
(1)修改UserHandler.java,增加方法
//...
@RequestMapping(value = "/user")
@Controller
public class UserHandler {
//...
/**
* 1.params = "bookId" 表示请求该方式时,必须给一个名为 bookId的参数
* 2.search(String bookId){} 表示请求目标方法时,
* 携带的 bookId参数的值会被填充到目标方法的同名形参中
* @param bookId
* @return
*/
@RequestMapping(value = "/find", params = "bookId", method = RequestMethod.GET)
public String search(String bookId) {
System.out.println("查询书籍 bookId=" + bookId);
return "success";
}
}
(2)request.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>购买商品</title>
</head>
<body>
<h1>演示params的使用</h1>
<a href="user/find?bookId=100">查询书籍</a>
</body>
</html>
(3) success.jsp 不变。
(4)redeployTomcat,在浏览器地址栏访问:http://localhost:8080/springmvc/request.jsp
,点击查询书籍超链接,结果如下:
(5)修改UserHandler.java,指定参数的值=100。
(6)修改request.jsp,修改发送的值为200.
(7)redeployTomcat,重新范文request.jsp,点击超链接,这里可以看到出现异常,因为发送的值和方法指定的值不一样。
1.2.4支持Ant 风格资源地址
?
:匹配文件名中的一个字符*
:匹配文件名中的任意字符,长度任意**
:匹配多层路径- Ant 风格的 url 地址举例:
/user/*/createUser
:匹配 /user/aaa/createUser、/user/bbb/createUser 等 URL/user/**/createUser
:匹配 /user/createUser、/user/aaa/bbb/createUser 等 URL/user/createUser??
: 匹配 /user/createUserab、/user/createUsercd 等 URL
应用实例
(1)修改UserHandler.java,增加方法:
//...
@RequestMapping(value = "/user")
@Controller
public class UserHandler {
//...
/**
* 要求:可以匹配 /user/message/aa, /user/message/aa/bb/cc
* @RequestMapping(value = "/message/**")
* 表示可以匹配多层的路径
* @return
*/
@RequestMapping(value = "/message/**")
public String im(){
System.out.println("发送消息");
return "success";
}
}
(2)修改request.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>购买商品</title>
</head>
<body>
<h1>演示 Ant 风格的请求资源方式</h1>
<a href="user/message/aa">发送消息 1</a><br>
<a href="user/message/aa/bb/cc">发送消息 2</a><br>
</body>
</html>
(3) success.jsp 不变。
(4)redeployTomcat,在浏览器地址栏访问:http://localhost:8080/springmvc/request.jsp
,分别点击两个超链接,都能成功访问方法,并跳转到success.jsp
1.2.5可配合@PathVariable映射URL绑定的占位符
- @RequestMapping 还可以配合 @PathVariable(路径变量) 映射 URL 绑定的占位符
- 这样就不需要在url地址栏上带参数名了,更加简洁明了
例子
request.jsp页面如下,其中 kristina 和 300 皆为参数值
<h1>占位符的演示</h1>
<a href="user/reg/kristina/300">占位符的演示</a>
(1)修改UserHandler.java,增加方法,注意@PathVariable("username") 不能少
//...
@RequestMapping(value = "/user")
@Controller
public class UserHandler {
/**
* 我们希望目标方法获取到username和 userid
* 前端页面为:<a href="user/reg/kristina/300">占位符的演示</a>
* 1. value = "/reg/{username}/{userid}"
* 表示 kristina=>{username} ,300=>{userid}
* 2.通过 @PathVariable 将变量赋给对应的形参
*/
@RequestMapping(value = "/reg/{username}/{userid}")
public String register(@PathVariable("username") String name,
@PathVariable("userid") int id) {
System.out.println("接收到的参数--username=" + name + "--userid=" + id);
return "success";
}
}
(2)success.jsp不变
(3)redeployTomcat,访问 http://localhost:8080/springmvc/request.jsp
,点击超链接,成功访问到success.jsp,后台输出如下:
1.2.6注意事项和使用细节
-
映射的URL不能重复,否则报错:
Caused by: java.lang.IllegalStateException: Ambiguous mapping. Cannot map 'userHandler' method com.li.web.UserHandler#buy() to {POST [/user/buy]}: There is already 'userHandler' bean method
-
各种请求的简写形式
@RequestMapping(value="/buy",method=RequestMethod.POST)
等价于@PostMapping(value="buy")
以此类推,还有
@GetMapping
,@PostMapping
,@PutMapping
,@DeleteMapping
-
如果我们确定表单或者超链接会提交某个字段数据,比如email,要求提交的参数名和目标方法的参数名保持一致。
例如:
/** * hello3(String email){} 如果请求参数有email=xx,就会将传递的参数值赋给String email * 但是要求名称保持一致!如果不一致,那么接收不到数据,而是null * @param email * @return */ @GetMapping(value = "/hello3") public String hello3(String email) { System.out.println("hello3= " + email); return "success"; }
1.2.7练习
编写一个表单,以Post方式提交表单信息,后端编写ComputerHandler,可以接收到表单信息
computer.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>hw-电脑信息</title>
</head>
<body>
<h1>电脑信息</h1>
<form action="computer/info" method="post">
品牌:<input type="text" name="brand"/><br/>
价格:<input type="text" name="price"/><br/>
数量:<input type="text" name="nums"/><br/>
<input type="submit" value="提交">
</form>
</body>
</html>
ComputerHandler:
package com.li.web;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
/**
* @author 李
* @version 1.0
*/
@RequestMapping("/computer")
@Controller
public class ComputerHandler {
//注意接收的参数名要和info方法的形参名一致
@PostMapping("/info")
public String info(String brand, String price, String nums) {
System.out.println("brand=" + brand +
" price=" + price + " nums=" + nums);
return "success";
}
}
redeployTomcat,访问:http://localhost:8080/springmvc/computer.jsp
,输入信息,点击提交表单。
后台输出:
1.3Postman接口测试工具
1.3.1Postman介绍
-
Postman是什么?
- Postman是一款功能超级强大的用于发送HTTP请求的测试工具
- 是做WEB页面开发和测试的人员的常用工具
- 它可以创建和发送任何HTTP请求(Get/Post/Put/Delete...)
-
Postman相关资源
具体安装步骤
(1)下载Postman软件
(2)安装
-
右键安装包,选择用管理员身份运行。Postman不会让你选择安装路径,会直接安装,一般安装在系统盘
-
安装成功后,桌面上会出现快捷图标
1.3.2Postman快速入门
快速入门需求说明:使用 Postman向 http://www.baidu.com
发出 get请求,得到返回的 html格式数据
快速入门-实现步骤
-
进入Postman,默认界面如下:
-
创建Http Request,如果你已经创建过,会直接进入Workspace
-
在新页面输入要测试的 url,点击save
-
在弹出的新窗口中点击Create a collection
-
在弹出的新窗口中填入collection名称,点击create,然后点击save
-
配置完毕的界面
-
点击Send按钮,即可向目标url发送请求,获取返回数据
1.3.3Postman完成Controller层测试
(1)测试用例1
使用Postman,完成对之前编写的UserHandler方法的请求测试
@RequestMapping(value = "/user")
@Controller //UserHandler就是一个处理器/控制器,注入到spring容器
public class UserHandler {
@RequestMapping(value = "/find", params = "bookId=100", method = RequestMethod.GET)
public String search(String bookId) {
System.out.println("查询书籍 bookId=" + bookId);
return "success";
}
}
测试
- 确定请求地址url:
http://localhost:8080/springmvc/user/find
- 使用请求的方式:Get
- 确定请求的参数/数据:bookId=100
- 确定 Header有没有特殊的指定:无
点击Send,返回数据,测试成功。
(2)测试用例2
@RequestMapping(value = "/user")
@Controller //UserHandler就是一个处理器/控制器,注入到spring容器
public class UserHandler {
@RequestMapping(value = "/message/**")
public String im() {
System.out.println("发送消息");
return "success";
}
}
测试
- 确定请求地址url:
http://localhost:8080/springmvc/user/message/aa/bb/cc
- 使用请求的方式:Get 或者 Post
- 确定请求的参数/数据:无
- 确定 Header有没有特殊的指定:无
点击Send,返回数据,测试成功。
(3)测试用例3
@RequestMapping(value = "/user")
@Controller //UserHandler就是一个处理器/控制器,注入到spring容器
public class UserHandler {
@RequestMapping(value = "/reg/{username}/{userid}")
public String register(@PathVariable("username") String name,
@PathVariable("userid") int id) {
System.out.println("接收到的参数--username=" + name + "--userid=" + id);
return "success";
}
}
测试
- 确定请求地址url:
http://localhost:8080/springmvc/user/reg/jack/1000
- 使用请求的方式:Get 或者 Post
- 确定请求的参数/数据:无
- 确定 Header有没有特殊的指定:无
点击Send,返回数据,测试成功。
关于Postman的其他使用,在讲解框架和项目时,再具体演示
2.REST-优雅的url请求风格
2.1REST基本介绍
-
REST:即 Representational State Transfer,表述性状态传递。它结构清晰,同时可以隐藏行为。
-
通过一个url来直观展示传统风格与REST风格的区别:
-
传统风格:
当我们在浏览器上访问一些资源时,可以看到有些网页的url为http://localhost/students/selectById?id=1
(该地址表示查找id为1的students对象)http://localhost/students/saveStudent
(该地址表示保存students信息) -
REST风格:
http://localhosts/student/1
http://localhosts/student
通过这两种风格的对比,我们可以看到REST风格的一部分优点:
(1)可以隐藏资源访问行为(如隐藏了selectById等),这样就无法通过地址得知对资源进行了哪种操作
(2)可以明显的看到其书写简化了,不仅书写简化了,在开发时代码也可以简化。
-
-
HTTP 协议里,四个表示操作方式的动词:GET,POST,PUT,DELETE。它们分别对应四种基本操作:GET用来获取资源,POST用来新建资源,PUT用来更新资源,DELETE用来删除资源。
-
传统的url通过参数说明 crud的类型,而rest则是通过 get/post/put/delete 来说明 crud的类型
- REST的核心过滤器
- 当前的浏览器只支持 post/get 请求,因此为了得到 put/delete 的请求方式,需要使用 Spring 提供的
HiddenHttpMethodFilter
过滤器进行转换。 - HiddenHttpMethodFilter :浏览器form表单只支持GET 和 POST请求,而DELETE、PUT 等method并不支持,Spring 添加了一个过滤器,可以将这些请求转换为标准的http方法,使得支持这四种请求方式。
- 需要特别注意:HiddenHttpMethodFilter 只能对 post请求方式进行转换
- 这个过滤器需要在web.xml中配置
- 当前的浏览器只支持 post/get 请求,因此为了得到 put/delete 的请求方式,需要使用 Spring 提供的
2.2Rest风格的url-完成crud操作
2.2.1需求说明
2.2.2代码实现
-
修改web.xml添加 HiddenHttpMethodFilter过滤器,它的作用是将post请求转换为指定的delete或put请求
<!--配置HiddenHttpMethodFilter过滤器 1.它的作用是将以post方式提交的delete请求和put请求进行转换 2.配置url-pattern为/*,表示所有请求都经过hiddenHttpMethodFilter过滤 --> <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>
-
在SpringDispatcherServlet-servlet.xml添加两个常规的配置
<!--加入两个常规的配置--> <!--支持SpringMVC的高级功能,比如:JSR303校验,映射动态请求--> <mvc:annotation-driven></mvc:annotation-driven> <!--将SpringMVC不能处理的请求,交给tomcat处理,比如css,js--> <mvc:default-servlet-handler/>
注意:mvc:annotion添加的是后缀为mvc的命名空间:
-
创建rest.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title>rest</title> <script type="text/javascript" src="script/jquery-3.6.0.min.js"></script> <script type="text/javascript"> $(function () { $("#deleteBook").click(function () { //将当前的超链接的href的值,赋给hiddenForm表单的action属性 $("#hiddenForm").attr("action", this.href); $(":hidden").val("DELETE");//给hidden的_method参数赋值为delete $("#hiddenForm").submit();//提交表单 return false;//改变超链接行为,不再提交 }) //与上同理,不一样的是这里原本就是表单post请求 $("#updateBook").click(function () { //带上目标请求格式,HiddenHttpMethodFilter会自动将post请求转成你指定的格式 $(":hidden").val("PUT");//给hidden的_method参数赋值为put }) }) </script> </head> <body> <h2>Rest风格的crud操作案例</h2> <hr/> <h3>rest风格的url 查询书籍[get]</h3> <a href="user/book/200">点击查询书籍</a> <hr/> <h3>rest风格的url 添加书籍[post]</h3> <form action="user/book" method="post"> name:<input name="bookName" type="text"/><br/> <input type="submit" value="添加书籍"/> </form> <hr/> <h3>rest风格的url 删除书籍[delete]</h3> <%--说明: 1.在默认情况下,超链接是get请求 2.要将get请求转成SpringMVC可以识别的delete,就要考虑HiddenHttpMethodFilter机制: public static final String DEFAULT_METHOD_PARAM = "_method"; ------------------------------------- private static final List<String> ALLOWED_METHODS = Collections.unmodifiableList(Arrays.asList(HttpMethod.PUT.name(), HttpMethod.DELETE.name(), HttpMethod.PATCH.name())); ------------------------------------- //获取请求的方式,如果是post方式,就进行处理 if ("POST".equals(request.getMethod()) && request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE) == null) { String paramValue = request.getParameter(this.methodParam); if (StringUtils.hasLength(paramValue)) { String method = paramValue.toUpperCase(Locale.ENGLISH); if (ALLOWED_METHODS.contains(method)) {//若指定method在ALLOWED_METHODS中存在 //进行包装,转换为springmvc可以解析的请求 requestToUse = new HttpMethodRequestWrapper(request, method); } } } -------------------------------------- 3.从上述代码可以看到,HiddenHttpMethodFilter 过滤器可以对以 Post方式提交的delete,put,patch转换成springmvc识别的RequestMethod.DElETE,RequestMethod.PUT... 4.但是当前的超链接为 get请求,怎么将get请求转换成 post的请求方式呢? 5.我们可以使用jquery来进行处理,让用户点击超链接的时候,走一个表单的请求 --%> <a href="user/book/600" id="deleteBook">删除指定id的书籍</a> <form action="" method="post" id="hiddenForm"> <input type="hidden" name="_method"/> </form> <hr/> <h3>rest风格的url 修改书籍[put]</h3> <form action="user/book/666" method="post" id="updateBook"> <input type="hidden" name="_method"> <input type="submit" value="修改书籍"/> </form> </body> </html>
-
BookHandle.java
- 下面的代码中可以看到,许多方法的REST风格匹配的url是一样的,但是由于它们的请求方式不同,所以匹配到的方法不同。这也是rest风格的优点:不仅简化了url,而且隐藏了行为。
- 所以实际上SpringMVC的Controller层的url是可以相同的,会另外根据请求方式的不同来匹配方法
package com.li.web.rest; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.*; /** * @author 李 * @version 1.0 * 用于处理rest风格的请求-crud */ @RequestMapping(value = "/user") @Controller public class bookHandler { //查询[get] @RequestMapping(value = "/book/{id}", method = RequestMethod.GET) public String getBook(@PathVariable("id") String id) { System.out.println("查询书籍 id=" + id); return "success"; } //添加[post] @PostMapping(value = "/book") public String addBook(String bookName) {//注意参数名字要和表单提交的参数名称一致 System.out.println("添加书籍 bookName=" + bookName); return "success"; } //删除[delete] @DeleteMapping(value = "/book/{id}") public String delBook(@PathVariable("id") String id) { System.out.println("删除书籍 id=" + id); //return "success";//这样写,返回会报错:HTTP Status 405 - JSPs only permit GET POST or HEAD //redirect:/user/success 重定向,会被解析成 /web工程路径/user/success,然后返回给浏览器解析 return "redirect:/user/success";//重定向到一个没有指定method的 Handler方法 } //如果请求是 /user/success,就转发到success.jsp @RequestMapping(value = "/success") public String successGeneral() { return "success";//该方法转发到success.jsp页面 } @PutMapping(value = "/book/{id}") public String updateBook(@PathVariable("id") String id) { System.out.println("修改书籍 id=" + id); return "redirect:/user/success";//同理 } }
-
success.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title>操作成功</title> </head> <body> <h1>恭喜,操作成功!</h1> </body> </html>
-
测试,redeployTomcat,访问:
http://localhost:8080/springmvc/rest.jsp
,在分别点击四种提交方式,前端页面和后台输出如下:
2.2.3注意事项和使用细节
-
HiddenHttpMethodFilter在将 post请求转成 delete/put请求时,是按照
_method
参数名来读取的 -
如果web项目是运行在 Tomcat8及以上,会发现被过滤成 DELETE和 PUT请求后,到达控制器Controller时能顺利执行,但是返回(forward)会报HTTP 405 提示:HTTP Status 405 - JSPs only permit GET POST or HEAD。意为JSP只允许GET POST 或 HEAD
(1)解决方式1:使用Tomcat7
(2)解决方式2:将请求转发(forward)改为重定向(redirect),重定向到一个Handler,由Handler转发到页面。
-
页面测试时,如果出现点击修改书籍,仍然走的是删除url,可能是浏览器缓存等原因,换成Chrome即可。如果再不行,使用js修改表单的hidden的_method的值