当前位置：网站首页>2.0SpingMVC使用RESTful
2.0SpingMVC使用RESTful
2022-06-25 04:00:00 【gh-xiaohe】
文章目录
作者: gh-xiaohe
gh-xiaohe的博客
觉得博主文章写的不错的话，希望大家三连（关注，点赞，评论），多多支持一下！！！
RESTful
1、RESTful简介
REST：Representational State Transfer，表现层资源状态转移。
a>资源
资源是一种看待服务器的方式，即，将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个抽象的概念，所以它不仅仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西，可以将资源设计的要多抽象有多抽象，只要想象力允许而且客户端应用开发者能够理解。与面向对象设计类似，资源是以名词为核心来组织的，首先关注的是名词。一个资源可以由一个或多个URI来标识。URI既是资源的名称，也是资源在Web上的地址。对某个资源感兴趣的客户端应用，可以通过资源的URI与其进行交互。
b>资源的表述
资源的表述是一段对于资源在某个特定时刻的状态的描述。可以在客户端-服务器端之间转移（交换）。资源的表述可以有多种格式，例如HTML/XML/JSON/纯文本/图片/视频/音频等等。资源的表述格式可以通过协商机制来确定。请求-响应方向的表述通常使用不同的格式。
c>状态转移
状态转移说的是：在客户端和服务器端之间转移（transfer）代表资源状态的表述。通过转移和操作资源的表述，来间接实现操作资源的目的。
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 | user/1–>delete请求方式 |
| 更新操作 | updateUser | user–>put请求方式 |
3、HiddenHttpMethodFilter 过滤器
由于浏览器只支持发送get和post方式的请求，那么该如何发送put和delete请求呢？
SpringMVC 提供了 HiddenHttpMethodFilter 帮助我们将 POST 请求转换为 DELETE 或 PUT 请求
HiddenHttpMethodFilter 处理put和delete请求的条件：
当前请求的请求方式必须为post
当前请求必须传输请求参数_method
满足以上条件，HiddenHttpMethodFilter 过滤器就会将当前请求的请求方式转换为请求参数_method的值，因此请求参数==_method==的值才是最终的请求方式
在web.xml中注册HiddenHttpMethodFilter
<!--配置处理请求方式put和delete的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>
![[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-yCdaHbkm-1655820991011)(RESTful.assets/image-20220620214025581.png)]](/img/4c/13775f0d6840a3b7ac0079606cfb9d.png)
源码
/* 过滤器 一定有三个方法 ①初始化（重要） ②执行过滤 ③销毁的三个方法 方式一: 执行过滤的方法doFilter到底执行了谁 子类不在去父类寻找 方式二: 查找参数是 filterChain 必然是执行过滤的方法 filterChain 用来放行 */
public class HiddenHttpMethodFilter extends OncePerRequestFilter {
private static final List<String> ALLOWED_METHODS;
public static final String DEFAULT_METHOD_PARAM = "_method";
private String methodParam = "_method";
public HiddenHttpMethodFilter() {
}
public void setMethodParam(String methodParam) {
Assert.hasText(methodParam, "'methodParam' must not be empty");
this.methodParam = methodParam;
}
//查找参数是 filterChain 必然是执行过滤的方法 filterChain 用来放行 (执行过滤的方法)
//HttpServletRequest request, HttpServletResponse response 过滤是拦截的请求 和 响应
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
HttpServletRequest requestToUse = request; // 赋值为 HttpServletRequest 对象
// 获取请求参数 是否等于 POST 恒为 true
if ("POST".equals(request.getMethod()) && request.getAttribute("javax.servlet.error.exception") == null) {
// 获取请求参数 this.methodParam private String methodParam = "_method"; (常量国定的值)
String paramValue = request.getParameter(this.methodParam);
if (StringUtils.hasLength(paramValue)) {
// 是否有长度 是否为空
String method = paramValue.toUpperCase(Locale.ENGLISH); // 将_method 的值转化为大写
if (ALLOWED_METHODS.contains(method)) {
//只能写 PUT DELETE PATCH 下面有讲解
// requestToUse 给他赋值 变成了 PUT DELETE PATCH
requestToUse = new HiddenHttpMethodFilter.HttpMethodRequestWrapper(request, method);
}
}
}
// 在放行时 把新创建的请求对象 作为了一个 过滤拦截的对象 进行了放行
filterChain.doFilter((ServletRequest)requestToUse, response);// 日后获取的结果都是 PUT DELETE PATCH
}
static {
//List 结合 // 把后面的三个值放到了list结合中 HttpMethod枚举
ALLOWED_METHODS = Collections.unmodifiableList(Arrays.asList(HttpMethod.PUT.name(), HttpMethod.DELETE.name(), HttpMethod.PATCH.name()));
}
private static class HttpMethodRequestWrapper extends HttpServletRequestWrapper {
private final String method; // ② PUT DELETE PATCH
public HttpMethodRequestWrapper(HttpServletRequest request, String method) {
super(request);
this.method = method; // ① PUT DELETE PATCH
}
public String getMethod() {
return this.method; // ③ PUT DELETE PATCH
}
}
}
注：
有多个过滤器时，过滤器的执行顺序有决定，配置的越靠前，就先执行
目前为止，SpringMVC中提供了两个过滤器：CharacterEncodingFilter和HiddenHttpMethodFilter在web.xml中注册时，必须先注册CharacterEncodingFilter，再注册HiddenHttpMethodFilter
原因：
在 CharacterEncodingFilter 中通过 request.setCharacterEncoding(encoding) 方法设置字符集的
request.setCharacterEncoding(encoding) 方法要求前面不能有任何获取请求参数的操作
而 HiddenHttpMethodFilter 恰恰有一个获取请求方式的操作：
String paramValue = request.getParameter(this.methodParam);
RESTful案例
1、准备工作
和传统 CRUD 一样，实现对员工信息的增删改查。
搭建环境
准备实体类
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模拟数据
import java.util.Collection; import java.util.HashMap; import java.util.Map; import com.atguigu.mvc.bean.Employee; import org.springframework.stereotype.Repository; @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", "[email protected]", 1)); employees.put(1002, new Employee(1002, "E-BB", "[email protected]", 1)); employees.put(1003, new Employee(1003, "E-CC", "[email protected]", 0)); employees.put(1004, new Employee(1004, "E-DD", "[email protected]", 0)); employees.put(1005, new Employee(1005, "E-EE", "[email protected]", 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); } }
2、功能清单
| 功能 | URL 地址 | 请求方式 |
|---|---|---|
| 访问首页√ | / | GET |
| 查询全部数据√ | /employee | GET |
| 删除√ | /employee/2 | DELETE |
| 跳转到添加数据页面√ | /toAdd | GET |
| 执行保存√ | /employee | POST |
| 跳转到更新数据页面√ | /employee/2 | GET |
| 执行更新√ | /employee | PUT |
3、具体功能：访问首页
a>配置view-controller
<mvc:view-controller path="/" view-name="index"/>
b>创建页面
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8" >
<title>Title</title>
</head>
<body>
<h1>首页</h1>
<a th:href="@{/employee}">访问员工信息</a>
</body>
</html>
4、具体功能：查询所有员工数据
a>控制器方法
@RequestMapping(value = "/employee", method = RequestMethod.GET)
public String getEmployeeList(Model model){
Collection<Employee> employeeList = employeeDao.getAll();
model.addAttribute("employeeList", employeeList);
return "employee_list";
}
b>创建employee_list.html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Employee Info</title>
<script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
</head>
<body>
<!--边距 = 1 , 取消边距, 取消间距 居中-->
<table border="1" cellpadding="0" cellspacing="0" style="text-align: center;" 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>
<!--写法错误: { 会被解析为 %7B } 会被解析为 %7D-->
<!--<a th:href="@{/employee/${employee.id}}">delete</a>-->
<!--方式一:-->
<a @click="deleteEmployee" th:href="@{
'/employee/'+${employee.id}}">delete</a>
<!--方式二:-->
<a th:href="@{
'/employee/'+${employee.id}}">update</a>
</td>
</tr>
</table>
</body>
</html>
5、具体功能：删除 重点
a>创建处理delete请求方式的表单
<!-- 作用：通过超链接控制表单的提交，将post请求转换为delete请求 -->
<form id="delete_form" method="post">
<!-- HiddenHttpMethodFilter要求：必须传输_method请求参数，并且值为最终的请求方式 -->
<input type="hidden" name="_method" value="delete"/>
</form>
b>删除超链接绑定点击事件
- 引入vue.js
<script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
- 创建超链接
<!--写法错误: { 会被解析为 %7B } 会被解析为 %7D-->
<!--<a th:href="@{/employee/${employee.id}}">delete</a>-->
<!--方式一:-->
<a @click="deleteEmployee" th:href="@{
'/employee/'+${employee.id}}">delete</a>
<!--方式二:-->
<a th:href="@{
'/employee/'+${employee.id}}">update</a>
- 通过vue处理点击事件
<script type="text/javascript"> var vue = new Vue({
el:"#dataTable", methods:{
deleteEmployee:function (event) {
//根据id获取表单元素 var deleteForm = document.getElementById("deleteForm"); //将触发点击事件的超链接的href属性赋值给表单的action deleteForm.action = event.target.href; //提交表单 deleteForm.submit(); //取消超链接的默认行为 event.preventDefault(); } } }); </script>
c>控制器方法
@RequestMapping(value = "/employee/{id}", method = RequestMethod.DELETE)
public String deleteEmployee(@PathVariable("id") Integer id){
employeeDao.delete(id);
return "redirect:/employee";
}
6、具体功能：跳转到添加数据页面
a>配置view-controller
<mvc:view-controller path="/toAdd" view-name="employee_add"></mvc:view-controller>
b>创建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="1">male
<input type="radio" name="gender" value="0">female<br>
<input type="submit" value="add"><br>
</form>
</body>
</html>
* 7、具体功能：执行保存
a>控制器方法
@RequestMapping(value = "/employee", method = RequestMethod.POST)
public String addEmployee(Employee employee){
employeeDao.save(employee);
return "redirect:/employee";
}
8、具体功能：跳转到更新数据页面
a>修改超链接
<a th:href="@{
'/employee/'+${employee.id}}">update</a>
b>控制器方法
@RequestMapping(value = "/employee/{id}", method = RequestMethod.GET)
public String getEmployeeById(@PathVariable("id") Integer id, Model model){
Employee employee = employeeDao.get(id);
model.addAttribute("employee", employee);
return "employee_update";
}
c>创建employee_update.html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Update 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>
<!-- th:field="${employee.gender}"可用于单选框或复选框的回显 若单选框的value和employee.gender的值一致，则添加checked="checked"属性 -->
gender:<input type="radio" name="gender" value="1" th:field="${employee.gender}">male
<input type="radio" name="gender" value="0" th:field="${employee.gender}">female<br>
<input type="submit" value="update"><br>
</form>
</body>
</html>
9、具体功能：执行更新
a>控制器方法
@RequestMapping(value = "/employee", method = RequestMethod.PUT)
public String updateEmployee(Employee employee){
employeeDao.save(employee);
return "redirect:/employee";
}
边栏推荐
- js的call()和apply()
- ThinkPHP is integrated with esaywechat. What's wrong with wechat payment callback without callback?
- CTF_ Web: deserialization learning notes (I) classes and objects in PHP
- Sourcetree pulls the code and prompts to fill in authentic, but the configuration cannot change the user
- 马斯克发布人形机器人，AI对马斯克为什么意义重大？
- Use of deferred environment variable in gbase 8s
- kenlm
- CTF_ Web: how to recognize and evaluate a regular expression
- Gbase 8s parallel operation problem scenario description
- What is the storage engine and the three common database storage engines for MySQL
猜你喜欢
机器学习深度学习——向量化
Numpy NP tips: use OpenCV to interpolate and zoom the array to a fixed shape cv2 resize(res, dsize=(64, 64), interpolation=cv2. INTER_ CUBIC)
Musk released humanoid robot. Why is AI significant to musk?
冰冰学习笔记：循环队列的实现
论文笔记: 多标签学习 ESMC (没看懂, 还没写出来, 暂时放这里占个位置)
Nodejs 通过Heidisql连接mysql出现ER_BAD_DB_ERROR: Unknown database 'my_db_books'
CTF_ Web:8-bit controllable character getshell
Failed to install redis interface
navicat可不可以直接操作安卓数据库SQLite
Anaconda installation +tensorflow installation +keras installation +numpy installation (including image and version information compatibility issues)
随机推荐
彻底理解数据库事务
GBASE 8s的触发器
2020.3.3 notes async/await and promise and Then processes and threads
马斯克发布人形机器人，AI对马斯克为什么意义重大？
冰冰学习笔记：循环队列的实现
How to screen out words related to products and eliminate invalid words accurately
mysql的tinyint字段类型判断的疑惑
What is data persistence?
Error 1062 is reported during MySQL insertion, but I do not have this field.
记录小知识点
unity Quad剔除背面并剔除透明部分的shader
Laravel document sorting 3. CSRF protection
cnpm : 无法加载文件 C:\Users\Administrator\AppData\Roaming\npm\cnpm.ps1，因为在此系统上禁止运行脚本。
CTF_ Web: file contains pseudo protocol with PHP
GBASE 8s的级联删除功能
php封装curl发送get、post请求方法，并使用
Shutter fittedbox component
【esp32学习之路6——flash加密】
Laravel document sorting 7. View
Multithreading structure of gbase 8s