一、RESTful简介
REST:Representational State Transfer,表现层资源状态转移。
- 资源:
资源是一种看待服务器的方式,即,将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个抽象的概念,所以它不仅仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西,可以将资源设计的要多抽象有多抽象,只要想象力允许而且客户端应用开发者能够理解。与面向对象设计类似,资源是以名词为核心来组织的,首先关注的是名词。一个资源可以由一个或多个URI来标识。URI既是资源的名称,也是资源在Web上的地址。对某个资源感兴趣的客户端应用,可以通过资源的URI与其进行交互。 - 资源的表述:
资源的表述是一段对于资源在某个特定时刻的状态的描述。可以在客户端-服务器端之间转移(交换)。资源的表述可以有多种格式,例如HTML/XML/JSON/纯文本/图片/视频/音频等等。资源的表述格式可以通过协商机制来确定。请求-响应方向的表述通常使用不同的格式。 - 状态转移:
状态转移说的是:在客户端和服务器端之间转移(transfer)代表资源状态的表述。通过转移和操作资源的表述,来间接实现操作资源的目的。
二、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 | user/1–>delete请求方式 |
更新操作 | updateUser | user–>put请求方式 |
通俗地说就是查询、保存、删除、更新user都是操作user这个资源,那么这四种操作在URL中的资源那一层就可以都写user,而具体不同的操作则由请求方式决定。
(一)使用RESTful风格实现get和post请求
首先,创建一个 web 模块并配置好web.xml和部署Tomcat
controller:
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@Controller
public class MyController {
@RequestMapping(value = "/")
public String toIndex(){
return "index";
}
/*
* 使用RESTFul模拟用户资源的增删改查:
* /user GET 查询所有用户信息
* /user/1 GET 根据用户id查询用户信息
* /user POST 添加用户信息
*/
@RequestMapping(value = "/user",method = RequestMethod.GET)
public String selectUsers(){
System.out.println("查询所有用户信息");
return "target";
}
@RequestMapping(value = "/user/{id}",method = RequestMethod.GET)
public String selectUserById(){
System.out.println("根据用户id查询用户信息");
return "target";
}
@RequestMapping(value = "/user",method = RequestMethod.POST)
public String addUser(){
System.out.println("添加用户信息");
return "target";
}
}
index.html:
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>首页</title>
</head>
<body>
这是index.html<br>
<a th:href="@{/user}">查询所有用户信息</a><br>
<a th:href="@{/user/1}">根据id查询用户信息</a><br>
<form th:action="@{/user}" method="post">
用户名:<input type="text" name="username"><br>
密码:<input type="password" name="password"><br>
<input type="submit" value="添加用户信息"><br>
</form>
</body>
</html>
target.html:
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
这是target.html<br>
</body>
</html>
运行Tomcat:
点击第一个链接:
IDEA输出:
点击第二个链接:
IDEA输出:
填写表单:
IDEA输出:
(二)使用RESTful风格实现put和delete请求
1.HiddenHttpMethodFilter
由于浏览器只支持发送get和post方式的请求,即使在form表单的method写上"put"或"delete",也会被视为get请求,那么该如何发送put和delete请求呢?
SpringMVC 提供了 HiddenHttpMethodFilter 帮助我们将 POST 请求转换为 DELETE 或 PUT 请求。
我们来看一下HiddenHttpMethodFilter的源码:
下面是HiddenHttpMethodFilter真正执行过滤的方法:
它会首先将我们的请求拦截,并将请求对象赋值给requestToUse,如果"POST".equals(request.getMethod()) && request.getAttribute("javax.servlet.error.exception") == null
成立就会执行下面的代码,后面那一部分是成立的不用纠结,我们只需要管前面的"POST".equals(request.getMethod())
,因此要想发送put或delete请求,我们需要先把请求设置为post请求。接着String paramValue = request.getParameter(this.methodParam);
,this.methodParam
即前面一张图看到的"_method"
,也就是将请求对象里名为"_method"
的参数值传给paramValue。如果想接着执行下面的代码就必须满足StringUtils.hasLength(paramValue)
,它的意思是paramValue有长度就往下执行。所以我们要想发送put或delete请求还要做一件事就是在请求里设置一个名为"_method"
的参数并赋值。接着String method = paramValue.toUpperCase(Locale.ENGLISH);
意思是将这个paramValue的值全部大写传给method这个字符串对象,接着ALLOWED_METHODS.contains(method)
,如果ALLOWED_METHODS这个集合包含method表示的字符串,才会往下执行。我们来看一下ALLOWED_METHODS:
它包含了三种请求的名字:PUT、DELETE、PATCH。如果满足,requestToUse = new HiddenHttpMethodFilter.HttpMethodRequestWrapper(request, method);
就会创建一个新的请求对象重新赋值给requestToUse,我们来看这个HttpMethodRequestWrapper类的源码:
这个HttpMethodRequestWrapper其实就是一个包装类,它是HttpServletRequestWrapper的子类,而HttpServletRequestWrapper又实现了HttpServletRequest接口,因此HttpMethodRequestWrapper实际还是原生Servlet请求。
HttpMethodRequestWrapper重写了HttpServletRequest的getMethod()
方法,返回的是传入的前面获取_method属性的值。
因此,这个HiddenHttpMethodFilter最后会创建一个封装了我们传入的请求方式的请求对象HttpMethodRequestWrapper,最后filterChain.doFilter((ServletRequest)requestToUse, response);
由filterChain放行我们这个请求对象,这样我们就可以往下执行访问目标资源了,至此就实现了发送put或delete请求。
总结:
HiddenHttpMethodFilter 要想处理put和delete请求的条件:
- 当前请求的请求方式必须为post
- 当前请求必须传输请求参数
_method
,参数值为put或delete
满足以上条件,HiddenHttpMethodFilter 过滤器就会将当前请求的请求方式转换为请求参数_method
的值,因此请求参数_method
的值才是最终的请求方式。
2.发送put请求
案例:发送put请求
在web.xml中注册HiddenHttpMethodFilter:
<!--注册过滤器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>
controller:
import org.springframework.stereotype.Controller;
import org.springframework