1、RESTful 简介
REST(Representational State Transfer)是一种网络应用程序架构风格,其中资源是服务器上的离散抽象概念,可以由一个或多个URI标识。资源的表述是对资源在某个特定时刻的状态的描述,可以有多种格式,通过协商机制确定。状态转移是通过转移和操作资源的表述来实现操作资源的目的。REST风格的设计强调简单性、可伸缩性、可读性和可靠性,因此被广泛应用于Web服务和API设计中。
2、RESTful 的实现
在HTTP协议中,REST风格通过四个HTTP动词(GET、POST、PUT、DELETE)来表示四种基本操作(GET用于获取资源,POST用于新建资源,PUT用于更新资源,DELETE用于删除资源)。REST风格也提倡URL地址使用统一的风格设计,将要发送给服务器的数据作为URL地址的一部分,以保证整体风格的一致性,而不是使用问号键值对方式携带请求参数。这种风格的设计强调简单性、可读性、可伸缩性和可靠性,因此被广泛应用于Web服务和API设计中。
| 操作 | 传统方式 | REST 风格 |
|---|---|---|
| 查询操作 | getUserById?id=1 | user/1-->get 请求方式 |
| 保存操作 | saveUser | user-->post 请求方式 |
| 删除操作 | deleteUser?id=1 | user/1-->delete 请求方式 |
| 更新操作 | updateUser | user-->put 请求方式 |
3、HiddenHttpMethodFilter
在浏览器中,我们只能使用 GET 和 POST 请求发送数据到服务器。但是有些情况下,我们需要使用 PUT 或 DELETE 请求(比如更新或删除数据)。为了解决这个问题,SpringMVC 提供了 HiddenHttpMethodFilter 过滤器,它可以将 POST 请求转换为 PUT 或 DELETE 请求。
要使用 HiddenHttpMethodFilter 过滤器,我们需要满足两个条件:首先,当前请求必须是 POST 请求;其次,请求参数中必须包含一个名为 _method 的参数,该参数的值为 PUT 或 DELETE。如果满足这两个条件,HiddenHttpMethodFilter 过滤器就会将当前请求的方法转换为 _method 参数的值,也就是最终的请求方法。
为了在我们的应用程序中使用 HiddenHttpMethodFilter 过滤器,我们需要在 web.xml 文件中注册它。
<filter>
<filter-name>HiddenHttpMethodFilter</filter-name>
<filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filterclass>
</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);
4、RESTful 案例
4.1、需求
通过 restfull 实现用户的增删改查,需要提供 5 个接口。
| 接口 | method | 描述 |
|---|---|---|
| /user/list | GET | 获取用户列表 |
| /user/{userId} | GET | 根据用户 id 获取用户信息 |
| /user | POST | 新增用户信息 |
| /user | PUT | 保存用户信息 |
| /user/{userId} | DELETE | 删除用户信息 |
4.2、UserController
UserController 中实现了需求中提到的 4 个接口,大家重点看下每个接口的方法上用到的注解。
@RestController
public class UserController {
private List<User> userList = new ArrayList<>();
{
userList.add(new User(1, "Spring高手系列"));
userList.add(new User(2, "SpringMVC系列"));
}
@GetMapping("/user/list")
public List<User> list() {
System.out.println("list()");
return userList;
}
@GetMapping("/user/{userId}")
public User getUser(@PathVariable("userId") Integer userId) {
System.out.println("getUser()");
for (User user : userList) {
if (user.getUserId().equals(userId)) {
return user;
}
}
return null;
}
@PostMapping(value = "/user", produces = "text/html;charset=UTF-8")
public String add(User user) {
System.out.println("add()");
this.userList.add(user);
return "新增成功";
}
@PutMapping(value = "/user", produces = "text/html;charset=UTF-8")
public String modify(User user) {
System.out.println("modify()");
for (User item : userList) {
if (item.getUserId().equals(user.getUserId())) {
item.setName(user.getName());
}
}
return "修改成功";
}
@DeleteMapping(value = "/user/{userId}", produces = "text/html;charset=UTF-8")
public String delete(@PathVariable("userId") Integer userId) {
System.out.println("delete()");
Iterator<User> iterator = userList.iterator();
while (iterator.hasNext()) {
User user = iterator.next();
if (user.getUserId().equals(userId)) {
iterator.remove();
}
}
return "删除成功";
}
public static class User {
private Integer userId;
private String name;
public User() {
}
public User(Integer userId, String name) {
this.userId = userId;
this.name = name;
}
public Integer getUserId() {
return userId;
}
public void setUserId(Integer userId) {
this.userId = userId;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@Override
public String toString() {
return "User{" +
"userId=" + userId +
", name='" + name + '\'' +
'}';
}
}
}
4.3、添加 HiddenHttpMethodFilter
HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
4.4、测试效果
将项目发布到 tomcat,如下图,跑一下 UserController.http 中的 5 个用例,点击每个用户中的绿色箭头即可运行,注意下后面 3 个用例都是 POST 方式提交的,但是参数中多了一个_method 参数用来指定提交的类型,这个参数会被 HiddenHttpMethodFilter 解析。