文章目录
RESTful
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请求方式 |
HiddenHttpMethodFilter
浏览器只支持发送GET和POST方式的请求,在Spring MVC中提供了HiddenHttpMethodFilter帮助我们将POST请求转换为DELETE或PUT请求。
HiddenHttpMethodFilter处理put和delete请求的条件:
- 当前请求的请求方式必须为post。
- 当前请求必须传输请求参数_method。
满足以上条件,HiddenHttpMethodFilter过滤器就会将当前请求的请求方式转换为请求参数_method的值,因此请求参数_method的值才是最终的请求方式。
在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>
多个Filter过滤器执行时,执行的优先顺序是由其在web.xml中从上到下配置的顺序决定。因此在web.xml中,必须先注册CharacterEncodingFilter,再注册HiddenHttpMethodFilter。
原因如下:
- 在CharacterEncodingFilter中通过request.setCharacterEncoding(encoding)方法设置字符集。
- request.setCharacterEncoding(encoding)方法要求前面不能有任何获取请求参数的操作。
- HiddenHttpMethodFilter恰好有一个获取请求方式的操作:
String paramValue = request.getParameter(this.methodParam);
RESTful案例
准备工作
创建实体类
package com.atguigu.springmvc.Bean;
/**
* @version 1.0
* @Description
* @Author 月上叁竿
* @Date 2022-03-03 9:04
**/
public class Employee {
private Integer id;
private String lastName;
private String email;
//1 male, 0 female
private Integer gender;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public Integer getGender() {
return gender;
}
public void setGender(Integer gender) {
this.gender = gender;
}
public Employee(Integer id, String lastName, String email, Integer
gender) {
super();
this.id = id;
this.lastName = lastName;
this.email = email;
this.gender = gender;
}
public Employee() {
}
}
创建DAO模拟数据
package com.atguigu.springmvc.dao;
import com.atguigu.springmvc.Bean.Employee;
import org.springframework.stereotype.Repository;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
/**
* @version 1.0
* @Description
* @Author 月上叁竿
* @Date 2022-03-03 9:06
**/
@Repository
public class EmployeeDao {
private static Map<Integer, Employee> employees = null;
static{
employees = new HashMap<Integer, Employee>();
employees.put(1001, new Employee(1001, "E-AA", "aa@163.com", 1));
employees.put(1002, new Employee(1002, "E-BB", "bb@163.com", 1));
employees.put(1003, new Employee(1003, "E-CC", "cc@163.com", 0));
employees.put(1004, new Employee(1004, "E-DD", "dd@163.com", 0));
employees.put(1005, new Employee(1005, "E-EE", "ee@163.com", 1));
}
private static Integer initId = 1006;
public void save(Employee employee){
if(employee.getId() == null){
employee.setId(initId++);
}
employees.put(employee.getId(), employee);
}
public Collection<Employee> getAll(){
return employees.values();
}
public Employee get(Integer id){
return employees.get(id);
}
public void delete(Integer id){
employees.remove(id);
}
}
功能清单
功能 | URL地址 | 请求方式 |
---|---|---|
访问首页√ | / | GET |
查询全部数据√ | /employee | GET |
删除√ | /employee/2 | DELETE |
跳转到添加数据页面√ | /toAdd | GET |
执行保存 | /employee | POST |
跳转到更新数据页面√ | /employee/2 | GET |
执行更新√ | /employee | PUT |
具体功能:访问首页
在springMVC.xml中配置view-controller
<mvc:view-controller path="/" view-name="index"></mvc:view-controller>
创建页面
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>员工首页</title>
</head>
<body>
<h1>员工首页</h1>
<a th:href="@{/employee}">查看员工信息</a>
</body>
</html>
具体功能:查询所有员工数据
控制器方法
@GetMapping("/employee")
public String getAllEmployee(Model model){
Collection<Employee> employeeList = employeeDao.getAll();
model.addAttribute("employeeList",employeeList);
return "employees";
}
创建employees.html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>员工列表</title>
</head>
<body>
<table id="dataTable">
<tr>
<th colspan="5">Employee Info</th>
</tr>
<tr>
<th>id</th>
<th>lastName</th>
<th>email</th>
<th>gender</th>
<th>options <a th:href="@{/toAdd}">add</a></th>
</tr>
<tr th:each="employee : ${employeeList}">
<td th:text="${employee.id}"></td>
<td th:text="${employee.lastName}"></td>
<td th:text="${employee.email}"></td>
<td th:text="${employee.gender}"></td>
<td>
<a th:href="@{'/employee/' + ${employee.id}}" @click="deleteEmployee">delete</a>
<a th:href="@{'/employee/' + ${employee.id}}">update</a>
</td>
</tr>
</table>
</body>
</html>
具体功能:删除
创建处理delete请求方式的表单
<!-- 通过超链接控制表单提交,将post请求转换为delete请求 -->
<form id="deleteForm" method="post">
<!-- HiddenHttpMethodFilter要求:必须传输_method请求参数,并且值为最终的请求方式 -->
<input type="hidden" name="_method" value="delete">
</form>
删除超链接绑定点击事件
引入vue.js
<script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
删除超链接
<a th:href="@{'/employee/' + ${employee.id}}" @click="deleteEmployee">delete</a>
通过vue处理点击
<script type="text/javascript">
let app = new Vue({
el:"#dataTable",
methods:{
// event表示当前事件
deleteEmployee:function (event) {
// 通过id获取表单标签
let deleteForm = document.getElementById("deleteForm");
// 将触发事件的超链接的href属性设置为表单的action属性并赋值
deleteForm.action= event.target.href;
// 提交表单
deleteForm.submit();
// 阻止超链接的默认跳转行为
event.preventDefault();
}
}
})
</script>
控制器方法
@RequestMapping(value = "/employee/{id}",method = RequestMethod.DELETE)
public String deleteEmployee(@PathVariable("id") Integer id){
employeeDao.delete(id);
return "redirect:/employee";
}
注:由于将Vue.js文件放在了src\main\webapp中,前端控制器DispatcherServlet无法访问静态资源,因此需要引入defaultServlet来访问静态资源
<!--开放对静态资源的访问-->
<mvc:default-servlet-handler></mvc:default-servlet-handler>
所有的请求由前端控制器DispatcherServlet处理,当配置了defaultServlet后,如果有请求是DispatcherServlet不能处理的,就交由defaultServlet处理,若defaultServlet仍不能处理,则报错404。
具体功能:跳转到添加数据页面
配置view-controller
<mvc:view-controller path="/toAdd" view-name="employee_add"></mvc:view-controller>
创建employee_add.html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>add Employee</title>
</head>
<body>
<form th:action="@{/employee}" method="post">
lastName:<input type="text" name="lastName"><br>
email:<input type="text" name="email"><br>
gender:
<input type="radio" name="gender" value="0">female
<input type="radio" name="gender" value="1">male <br>
<input type="submit" value="Add">
</form>
</body>
</html>
具体功能:执行保存
@RequestMapping(value = "/employee",method = RequestMethod.POST)
public String addEmployee(Employee employee){
employeeDao.save(employee);
return "redirect:/employee";
}
具体功能:跳转到更新页面
修改超链接
<a th:href="@{'/employee/' + ${employee.id}}">update</a>
控制器方法
@GetMapping("/employee/{id}")
public String getEmployeeById(@PathVariable("id") Integer id,Model model){
Employee employee = employeeDao.get(id);
model.addAttribute("employee",employee);
return "employee_update";
}
创建employee_update.html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>add Employee</title>
</head>
<body>
<form th:action="@{/employee}" method="post">
<input type="hidden" name="_method" value="put">
<input type="hidden" name="id" th:value="${employee.id}">
lastName:<input type="text" name="lastName" th:value="${employee.lastName}"><br>
email:<input type="text" name="email" th:value="${employee.email}"><br>
gender:
<input type="radio" name="gender" value="0" th:field="${employee.gender}">female
<input type="radio" name="gender" value="1" th:field="${employee.gender}">male <br>
<input type="submit" value="Add">
</form>
</body>
</html>
具体功能:执行更新
控制器方法
@PutMapping("/employee")
public String updateEmployee(Employee employee){
employeeDao.save(employee);
return "redirect:/employee";
}