源码地址
7.1)RESTful简介
REST:Representational State Transfer,表现层资源状态转移。
7.1.1)资源
资源是一种看待服务器的方式,即,将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个抽象的概念,所以它不仅仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西,可以将资源设计的要多抽象有多抽象,只要想象力允许而且客户端应用开发者能够理解。与面向对象设计类似,资源是以名词为核心来组织的,首先关注的是名词。一个资源可以由一个或多个URI来标识。URI既是资源的名称,也是资源在Web上的地址。对某个资源感兴趣的客户端应用,可以通过资源的URI与其进行交互。
7.1.2)资源的表述
资源的表述是一段对于资源在某个特定时刻的状态的描述。可以在客户端-服务器端之间转移(交换)。资源的表述可以有多种格式,例如HTML/XML/JSON/纯文本/图片/视频/音频等等。资源的表述格式可以通过协商机制来确定。请求-响应方向的表述通常使用不同的格式。
7.1.3)状态转移
状态转移说的是:在客户端和服务器端之间转移(transfer)代表资源状态的表述。通过转移和操作资源的表述,来间接实现操作资源的目的。
7.2)RESTful的实现
具体说,就是 HTTP 协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。
它们分别对应四种基本操作:GET 用来获取资源,POST 用来新建资源,PUT 用来更新资源,DELETE 用来删除资源。
REST 风格提倡 URL 地址使用统一的风格设计,从前到后各个单词使用斜杠分开,不使用问号键值对方式携带请求参数,而是将要发送给服务器的数据作为 URL 地址的一部分,以保证整体风格的一致性。
操作 |
传统方式 |
REST风格 |
查询操作 |
getUserById?id=1 |
user/1-->get请求方式 |
保存操作 |
saveUser |
user-->post请求方式 |
删除操作 |
deleteUser?id=1 |
deleteUser?id=1 |
更新操作 |
updateUser |
user-->put请求方式 |
7.2.1)RESTful的查询操作实现
在源码的工程 SpringMvcDemo3中,修改视图解析器springMVC.xml,代码如下:
<!--3)配置视图控制器-->
<!-- path:设置处理的请求地址 view-name:设置请求地址所对应的视图名称 -->
<mvc:view-controller path="/" view-name="index"></mvc:view-controller>
<mvc:view-controller path="/test_view" view-name="test_view"></mvc:view-controller>
<mvc:view-controller path="/test_rest" view-name="test_rest"></mvc:view-controller>
<!--开启mvc的注解驱动-->
<mvc:annotation-driven />
</beans>
新建用户控制器UserController.java,代码如下:
@Controller
public class UserController {
/**
* 使用RESTFul模拟用户资源的增删改查
* /user GET 查询所有用户信息
* /user/1 GET 根据用户id查询用户信息
*/
@RequestMapping(value = "/user", method = RequestMethod.GET)
public String getAllUser(){
System.out.println("查询所有用户信息");
return "success";
}
@RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
public String getUserById(){
System.out.println("根据id查询用户信息");
return "success";
}
}
新建页面test_rest.html,代码如下:
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h1>RESTful示例</h1>
<a th:href="@{/user}">查询所有用户信息</a><br>
<a th:href="@{/user/1}">根据id查询用户信息</a><br>
</body>
</html>
测试:【配置Tomacat后启动工程,浏览器访问:http://localhost:8080/SpringMvcDemo3/test_rest】,点击超链接“查询所有用户信息”,页面跳转至:http://localhost:8080/SpringMvcDemo3/user,页面如下:
控制台输出:
11:16:43.746 [http-nio-8080-exec-10] DEBUG org.springframework.web.servlet.DispatcherServlet - GET "/SpringMvcDemo3/user", parameters={}
11:16:43.756 [http-nio-8080-exec-10] DEBUG org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping - Mapped to com.study.mvc.controller.UserController#getAllUser()
查询所有用户信息
11:16:43.917 [http-nio-8080-exec-10] DEBUG org.springframework.web.servlet.DispatcherServlet - Completed 200 OK
点击超链接“根据id查询用户信息”,页面跳转至:http://localhost:8080/SpringMvcDemo3/user/1,页面如下:
控制台输出:
11:18:33.397 [http-nio-8080-exec-6] DEBUG org.springframework.web.servlet.DispatcherServlet - GET "/SpringMvcDemo3/user/1", parameters={}
11:18:33.398 [http-nio-8080-exec-6] DEBUG org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping - Mapped to com.study.mvc.controller.UserController#getUserById()
根据id查询用户信息
11:18:33.401 [http-nio-8080-exec-6] DEBUG org.springframework.web.servlet.DispatcherServlet - Completed 200 OK
7.2.2)RESTful的保存操作实现
修改用户控制器UserController.java,代码如下:
@RequestMapping(value = "/user", method = RequestMethod.POST)
public String insertUser(String username, String password){
System.out.println("添加用户信息:"+username+","+password);
return "success";
}
修改页面test_rest.html,代码如下:
<form th:action="@{/user}" method="post">
用户名:<input type="text" name="username"><br>
密码:<input type="password" name="password"><br>
<input type="submit" value="添加"><br>
</form>
测试:【配置Tomacat后启动工程,浏览器访问:http://localhost:8080/SpringMvcDemo3/test_rest】,输入表单信息点击“添加”按钮,页面跳转至:http://localhost:8080/SpringMvcDemo3/user,页面如下:
控制台输出:
11:28:17.061 [http-nio-8080-exec-10] DEBUG org.springframework.web.servlet.DispatcherServlet - POST "/SpringMvcDemo3/user", parameters={masked}
11:28:17.073 [http-nio-8080-exec-10] DEBUG org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping - Mapped to com.study.mvc.controller.UserController#insertUser(String, String)
添加用户信息:admin,3457675
11:28:17.217 [http-nio-8080-exec-10] DEBUG org.springframework.web.servlet.DispatcherServlet - Completed 200 OK
7.2.3)RESTful的更新操作实现
修改用户控制器UserController.java,代码如下:
@RequestMapping(value = "/user", method = RequestMethod.PUT)
public String updateUser(String username, String password) {
System.out.println("修改用户信息:" + username + "," + password);
return "success";
}
修改页面test_rest.html,代码如下:
<form th:action="@{/user}" method="put">
用户名:<input type="text" name="username"><br>
密码:<input type="password" name="password"><br>
<input type="submit" value="修改"><br>
</form>
测试:【配置Tomacat后启动工程,浏览器访问:http://localhost:8080/SpringMvcDemo3/test_rest】,输入表单信息点击“修改”按钮,页面跳转至:http://localhost:8080/SpringMvcDemo3/user?username=admin1&password=21353432,页面如下:
控制台输出:【虽然页面执行更新方法put,但实际执行是查询方法get】
12:44:59.379 [http-nio-8080-exec-4] DEBUG org.springframework.web.servlet.DispatcherServlet - GET "/SpringMvcDemo3/user?username=admin1&password=21353432", parameters={masked}
12:44:59.379 [http-nio-8080-exec-4] DEBUG org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping - Mapped to com.study.mvc.controller.UserController#getAllUser()
查询所有用户信息
12:44:59.382 [http-nio-8080-exec-4] DEBUG org.springframework.web.servlet.DispatcherServlet - Completed 200 OK
由于浏览器只支持发送get和post方式的请求,发送put和delete请求会默认执行get请求,为执行put和delete请求SpringMVC 提供了 HiddenHttpMethodFilter 。
7.2.3.1)HiddenHttpMethodFilter
SpringMVC 提供了 HiddenHttpMethodFilter将 POST 请求转换为 DELETE 或 PUT 请求;
HiddenHttpMethodFilter处理put和delete请求的条件:
-
当前请求的请求方式必须为post
-
当前请求必须传输请求参数_method
满足以上条件,HiddenHttpMethodFilter 过滤器就会将当前请求的请求方式转换为请求参数_method的值,因此请求参数_method的值才是最终的请求方式,在web.xml中注册HiddenHttpMethodFilter,代码如下:
<!--1)配置编码过滤器-->
<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>
<init-param>
<param-name>forceResponseEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>CharacterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!--2)配置请求方式过滤器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>
目前为止,SpringMVC中提供了两个过滤器:CharacterEncodingFilter和HiddenHttpMethodFilter
在web.xml中注册时,必须先注册CharacterEncodingFilter,再注册HiddenHttpMethodFilter
原因:
-
在 CharacterEncodingFilter 中通过 request.setCharacterEncoding(encoding) 方法设置字符集的
request.setCharacterEncoding(encoding) 方法要求前面不能有任何获取请求参数的操作;
-
而 HiddenHttpMethodFilter 恰恰有一个获取请求方式的操作:
String paramValue = request.getParameter(this.methodParam);
修改页面test_rest.html,代码如下:
<form th:action="@{/user}" method="post">
<input type="hidden" name="_method" value="PUT">
用户名:<input type="text" name="username"><br>
密码:<input type="password" name="password"><br>
<input type="submit" value="修改"><br>
</form>
测试:页面再次执行上述更新操作,控制台输出:【页面执行更新方法put,实际执行也为更新方法put】
12:53:26.668 [http-nio-8080-exec-9] DEBUG org.springframework.web.servlet.DispatcherServlet - PUT "/SpringMvcDemo3/user", parameters={masked}
12:53:26.674 [http-nio-8080-exec-9] DEBUG org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping - Mapped to com.study.mvc.controller.UserController#updateUser(String, String)
修改用户信息:admin1,21353432
12:53:26.849 [http-nio-8080-exec-9] DEBUG org.springframework.web.servlet.DispatcherServlet - Completed 200 OK
7.2.4)RESTful的删除操作实现
修改用户控制器UserController.java,代码如下:
@RequestMapping(value = "/user", method = RequestMethod.DELETE)
public String deleteUser(String username, String password) {
System.out.println("删除用户信息:" + username + "," + password);
return "success";
}
修改页面test_rest.html,代码如下:
<form th:action="@{/user}" method="post">
<input type="hidden" name="_method" value="DELETE">
用户名:<input type="text" name="username"><br>
密码:<input type="password" name="password"><br>
<input type="submit" value="删除"><br>
</form>
测试:【配置Tomacat后启动工程,浏览器访问:http://localhost:8080/SpringMvcDemo3/test_rest】,输入表单信息点击“删除”按钮,页面跳转至:http://localhost:8080/SpringMvcDemo3/user,页面如下:
控制台输出:【页面执行删除方法delete,实际执行也为删除方法delete】
13:01:10.693 [http-nio-8080-exec-7] DEBUG org.springframework.web.servlet.DispatcherServlet - DELETE "/SpringMvcDemo3/user", parameters={masked}
13:01:10.695 [http-nio-8080-exec-7] DEBUG org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping - Mapped to com.study.mvc.controller.UserController#deleteUser(String, String)
删除用户信息:admin3,2311241
13:01:10.841 [http-nio-8080-exec-7] DEBUG org.springframework.web.servlet.DispatcherServlet - Completed 200 OK