ToB企服应用市场:ToB评测及商务社交产业平台

标题: Spring MVC 中使用 RESTFul 编程风格 [打印本页]
作者: 圆咕噜咕噜    时间: 2024-7-4 21:23
标题: Spring MVC 中使用 RESTFul 编程风格
1. Spring MVC 中使用  RESTFul 编程风格

@
目录

2. RESTFul 编程风格

2.1 RESTFul 是什么

RESTFul 是 web 服务器接口 的一种计划风格。
RESTFul 定义了一组束缚条件和规范，可以让 web服务器接口 更加简洁，易于理解，易于扩展，安全可靠。
RESTFUl 对一个 web 服务器接口 都规定了哪些东西 ？
REST 对请求方式的束缚是如许的：
REST对 URL 的束缚时如许的：
RESTFul 对 URL 的束缚和规范的焦点时：通过采用 ：不同的请求方式   + URL 来确定 web 服务中的资源。
RESTFul 的英文全称时：Representational State Transfer(表述性状态转移)，简称 REST。
表述性（Representational） 是：URL + 请求方式。
状态(State) 是 ：服务器端的数据。
转移(Transfer) 是：变化。
表述性转移是指：通过 URL + 请求方式来控制服务器端数据的变化。
2.2 RESTFul风格与传统方式对比

统的 URL 与 RESTful URL 的区别是传统的 URL 是基于方法名举行资源访问和操纵，而 RESTful URL 是基于资源的结构和状态举行操纵的。下面是一张表格，展示两者之间的具体区别：
传统的 URLRESTful URLGET /getUserById?id=1GET /user/1GET /getAllUserGET /userPOST /addUserPOST /userPOST /modifyUserPUT /userGET /deleteUserById?id=1DELETE /user/1从上表中我们可以看出，传统的 URL是基于动作的，而 RESTful URL 是基于资源和状态的，因此 RESTful URL 更加清楚和易于理解，这也是 REST 架构风格被广泛使用的重要原因之一。
3. Spring MVC 中使用  RESTFul 编程风格(增删改查)的使用

3.1 预备工作

导入相干依赖 jar 包。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>com.rainbowsea</groupId>
  8.     <artifactId>springmvc-007</artifactId>
  9.     <version>1.0-SNAPSHOT</version>
  10.     <packaging>war</packaging>
  12.     <properties>
  13.         <maven.compiler.source>17</maven.compiler.source>
  14.         <maven.compiler.target>17</maven.compiler.target>
  15.     </properties>
  21.     <dependencies>
  22.         
  23.         <dependency>
  24.             <groupId>org.springframework</groupId>
  25.             <artifactId>spring-webmvc</artifactId>
  26.             <version>6.1.4</version>
  27.         </dependency>
  28.         
  29.         <dependency>
  30.             <groupId>ch.qos.logback</groupId>
  31.             <artifactId>logback-classic</artifactId>
  32.             <version>1.5.3</version>
  33.         </dependency>
  34.         
  35.         <dependency>
  36.             <groupId>jakarta.servlet</groupId>
  37.             <artifactId>jakarta.servlet-api</artifactId>
  38.             <version>6.0.0</version>
  39.             <scope>provided</scope>
  40.         </dependency>
  41.         
  42.         <dependency>
  43.             <groupId>org.thymeleaf</groupId>
  44.             <artifactId>thymeleaf-spring6</artifactId>
  45.             <version>3.1.2.RELEASE</version>
  46.         </dependency>
  47.     </dependencies>
  50. </project>
复制代码
相干包 / 目录的创建，配置。

springmvc.xml 配置文件的配置；
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xmlns:context="http://www.springframework.org/schema/context"
  5.        xmlns:mvc="http://www.springframework.org/schema/mvc"
  6.        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/cache http://www.springframework.org/schema/cache/spring-cache.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
  8.    
  9.     <context:component-scan base-package="com.rainbowsea.springmvc.controller"></context:component-scan>
  11.    
  12.     <bean id="thymeleafViewResolver" >
  13.         
  14.         <property name="characterEncoding" value="UTF-8"/>
  15.         
  16.         <property name="order" value="1"/>
  17.         
  18.         <property name="templateEngine">
  19.             <bean >
  20.                
  21.                 <property name="templateResolver">
  22.                     <bean >
  23.                         
  24.                         <property name="prefix" value="/WEB-INF/templates/"/>
  25.                         
  26.                         <property name="suffix" value=".html"/>
  27.                         
  28.                         <property name="templateMode" value="HTML"/>
  29.                         
  30.                         <property name="characterEncoding" value="UTF-8"/>
  31.                     </bean>
  32.                 </property>
  33.             </bean>
  34.         </property>
  35.     </bean>
  37.    
  38.     <mvc:annotation-driven></mvc:annotation-driven>
  40.    
  41.     <mvc:view-controller path="/" view-name="index"></mvc:view-controller>
  43. </beans>
复制代码
3.2 RESTFul 风格的 “查询” 所有（RESTFul 规范 需要发送 GET请求）

RESTFul 规范中规定，如果要查询数据，需要发送 GET 请求。
  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>首页</title>
  6. </head>
  7. <body>
  8. <h1>测试 RESTFul 编程风格</h1>
  9. <hr>
  11. <a th:target="_blank" href="https://www.cnblogs.com/@{/user}">查看用户列表</a>
  13. </body>
  14. </html>
复制代码
控制器 Controller：
  1. import com.rainbowsea.springmvc.bean.User;
  2. import org.springframework.stereotype.Controller;
  3. import org.springframework.web.bind.annotation.PathVariable;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.RequestMethod;
  7. @Controller  // 交给 Spring IOC 容器进行管理
  8. public class UserController {
  10.     @RequestMapping(value = "/user", method = RequestMethod.GET)
  11.     public String getAll() {
  12.         System.out.println("正在查询所有用户信息...");
  13.         return "ok";
  14.     }
  16. }
复制代码
ok 的页面视图：
  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>OK页面</title>
  6. </head>
  7. <body>
  9. <h1>OK !</h1>
  11. </body>
  12. </html>
复制代码
启动服务器，测试：http://localhost:8080/springmvc



3.3 RESTFul 风格的 根据 “id 查询”( RESTFul 规范 需要发送 GET请求)

RESTFul 规范中规定，如果要查询数据，需要发送GET请求。
首页index.html
  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>首页</title>
  6. </head>
  7. <body>
  8. <h1>测试 RESTFul 编程风格</h1>
  9. <hr>
  11. <a th:target="_blank" href="https://www.cnblogs.com/@{/user}">查看用户列表</a>
  13. </body>
  14. </html>[url=https://www.cnblogs.com/@{/user/1}]查询id=1的这个用户信息[/url]
复制代码
控制器 Controller：
  1. import com.rainbowsea.springmvc.bean.User;
  2. import org.springframework.stereotype.Controller;
  3. import org.springframework.web.bind.annotation.PathVariable;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.RequestMethod;
  7. @Controller  // 交给 Spring IOC 容器进行管理
  8. public class UserController {
  11.     //@RequestMapping(value = "/user/{占位符}",method = RequestMethod.GET)
  12.     @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
  13.     public String getById(@PathVariable(value = "id") String id) {
  14.         System.out.println("正在根据用户 id 查询用户信息...用户 id 是" + id);
  16.         return "ok";
  17.     }
  19. }
复制代码
启动服务器测试：



3.4 RESTFul 风格的 “增长数据” (RESTFul 规范 需要发送 POST 请求)

RESTFul规范中规定，如果要举行保存操纵，需要发送POST请求。
这里我们添加一个 User Bean 类，用于作为对象举行存储。
  1. package com.rainbowsea.springmvc.bean;
  3. public class User {
  4.     private String username;
  5.     private String password;
  6.     private Integer age;
  8.     public User() {
  9.     }
  11.     public User(String username, String password, Integer age) {
  12.         this.username = username;
  13.         this.password = password;
  14.         this.age = age;
  15.     }
  17.     @Override
  18.     public String toString() {
  19.         return "User{" +
  20.                 "username='" + username + '\'' +
  21.                 ", password='" + password + '\'' +
  22.                 ", age=" + age +
  23.                 '}';
  24.     }
  27.     public String getUsername() {
  28.         return username;
  29.     }
  31.     public void setUsername(String username) {
  32.         this.username = username;
  33.     }
  35.     public String getPassword() {
  36.         return password;
  37.     }
  39.     public void setPassword(String password) {
  40.         this.password = password;
  41.     }
  43.     public Integer getAge() {
  44.         return age;
  45.     }
  47.     public void setAge(Integer age) {
  48.         this.age = age;
  49.     }
  50. }
复制代码
页面编写：
  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>首页</title>
  6. </head>
  7. <body>
  8. <h1>测试 RESTFul 编程风格</h1>
  9. <hr>
  11. <a th:target="_blank" href="https://www.cnblogs.com/@{/user}">查看用户列表</a>
  13. </body>
  14. </html>[url=https://www.cnblogs.com/@{/user/1}]查询id=1的这个用户信息[/url]
  15.     用户名:
  16.     密码:
  17.     年岁:
  18.     <hr>
复制代码
控制器 Controller：

启动服务器测试：


3.5 RESTFul 风格的 “修改数据” (RESTFul 规范 需要发送 PUT 请求)

RESTFul规范中规定，如果要举行保存操纵，需要发送PUT请求。
如何发送PUT请求？
第一步：首先你必须是一个POST请求。
第二步：在发送POST请求的时候，提交如许的数据：_method=PUT ，使用隐藏域举行配置

第三步：在web.xml文件配置SpringMVC提供的过滤器：HiddenHttpMethodFilter
注意：
  1.   
  2.     <input type="hidden" name="_method" value="put">
  3. 隐藏域的 name 必须只能是 “_method”, value是 put(大小写忽略)
复制代码
第一步：首先你必须是一个POST请求。
第二步：在发送POST请求的时候，提交如许的数据：_method=PUT
  1. <h2>修改</h2>
  3. <form th:action="@{/user}" method="post">
  4.    
  5.     <input type="hidden" name="_method" value="put">
  7.     用户名: <input type="text" name="username">
  9.     密码:<input type="password" name="password">
  11.     年龄: <input type="text" name="age">
  13.     <input type="submit" value="修改">
  15. </form>
复制代码

第三步：在web.xml文件配置SpringMVC提供的过滤器：HiddenHttpMethodFilter
注意：该过滤器一定要在字符编码过滤器背面配置，不然，先设置的话，可能会出现获取到的请求数据是乱码
  1.    
  4.     <filter>
  5.         <filter-name>HiddenHttpMethodFilter</filter-name>
  6.         <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
  7.     </filter>
  8.     <filter-mapping>
  9.         <filter-name>HiddenHttpMethodFilter</filter-name>
  11.         <url-pattern>/*</url-pattern>
  12.     </filter-mapping>
复制代码
页面编写：
  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>首页</title>
  6. </head>
  7. <body>
  8. <h1>测试 RESTFul 编程风格</h1>
  9. <hr>
  11. <a th:target="_blank" href="https://www.cnblogs.com/@{/user}">查看用户列表</a>
  13. </body>
  14. </html>[url=https://www.cnblogs.com/@{/user/1}]查询id=1的这个用户信息[/url]
  15.     用户名:
  16.     密码:
  17.     年岁:
  18.     <hr><h2>修改</h2>
  20. <form th:action="@{/user}" method="post">
  21.    
  22.     <input type="hidden" name="_method" value="put">
  24.     用户名: <input type="text" name="username">
  26.     密码:<input type="password" name="password">
  28.     年龄: <input type="text" name="age">
  30.     <input type="submit" value="修改">
  32. </form>
复制代码
控制器 Controller：

启动服务器测试：


3.6 RESTFul 风格的 “删除数据” 数据(RESTFul 规范 需要发送 DELETE 请求)

RESTFul规范中规定，如果要举行 删除 操纵，需要发送DELETE 请求。
如何发送 DELETE 请求？,和 发送  PUT 请求的三步是一样的，只需要将 value 的值改为 delete 即可
第一步：首先你必须是一个POST请求。
第二步：在发送POST请求的时候，提交如许的数据：_method=PUT ，使用隐藏域举行配置

第三步：在web.xml文件配置SpringMVC提供的过滤器：HiddenHttpMethodFilter
注意：
  1.   
  2.     <input type="hidden" name="_method" value="delete">
  3. 隐藏域的 name 必须只能是 “_method”, value是 delete (大小写忽略)
复制代码
页面编写：
  1. <hr>
  2. <h2>删除用户</h2>
  7. <a th:target="_blank" href="https://www.cnblogs.com/@{user/120}" onclick="del(event)">删除用户id = 120 的用户信息</a>
  8. <form id="delForm" method="post">
  9.     <input type="hidden" name="_method" value="delete">
  10. </form>
复制代码
  1. <!DOCTYPE html>
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>首页</title>
  6. </head>
  7. <body>
  8. <h1>测试 RESTFul 编程风格</h1>
  9. <hr>
  11. <a th:target="_blank" href="https://www.cnblogs.com/@{/user}">查看用户列表</a>
  13. </body>
  14. </html>[url=https://www.cnblogs.com/@{/user/1}]查询id=1的这个用户信息[/url]
  15.     用户名:
  16.     密码:
  17.     年岁:
  18.     <hr><h2>修改</h2>
  20. <form th:action="@{/user}" method="post">
  21.    
  22.     <input type="hidden" name="_method" value="put">
  24.     用户名: <input type="text" name="username">
  26.     密码:<input type="password" name="password">
  28.     年龄: <input type="text" name="age">
  30.     <input type="submit" value="修改">
  32. </form><hr>
  33. <h2>删除用户</h2>
  38. <a th:target="_blank" href="https://www.cnblogs.com/@{user/120}" onclick="del(event)">删除用户id = 120 的用户信息</a>
  39. <form id="delForm" method="post">
  40.     <input type="hidden" name="_method" value="delete">
  41. </form>
复制代码
控制器 Controller：
  1. package com.rainbowsea.springmvc.controller;
  4. import com.rainbowsea.springmvc.bean.User;
  5. import org.springframework.stereotype.Controller;
  6. import org.springframework.web.bind.annotation.PathVariable;
  7. import org.springframework.web.bind.annotation.RequestMapping;
  8. import org.springframework.web.bind.annotation.RequestMethod;
  10. @Controller  // 交给 Spring IOC 容器进行管理
  11. public class UserController {
  14.     //@RequestMapping(value = "/user/{占位符}",method = RequestMethod.GET)
  15.     @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
  16.     public String getById(@PathVariable(value = "id") String id) {
  17.         System.out.println("正在根据用户 id 查询用户信息...用户 id 是" + id);
  19.         return "ok";
  20.     }
  24.     @RequestMapping(value = "/user", method = RequestMethod.GET)
  25.     public String getAll() {
  26.         System.out.println("正在查询所有用户信息...");
  27.         return "ok";
  28.     }
  33.     @RequestMapping(value = "/user", method = RequestMethod.POST)
  34.     public String save(User user) {
  35.         System.out.println("正在保存用户信息");
  36.         System.out.println(user);
  37.         return "ok";
  38.     }
  42.     @RequestMapping(value = "/user", method = RequestMethod.PUT)
  43.     public String modify(User user) {
  44.         System.out.println("正在修改用户信息" + user);
  46.         return "ok";
  47.     }
  51.     @RequestMapping(value = "/user/{id}", method = RequestMethod.DELETE)
  52.     public String del(@PathVariable(value = "id") String id) {
  53.         System.out.println("正删除用户 : " + id);
  55.         return "ok";
  56.     }
  58. }
复制代码
启动服务器测试：


4. 补充： HiddenHttpMethodFilter 过滤器源码阐明

HiddenHttpMethodFilter是Spring MVC框架提供的，专门用于RESTFul编程风格。
实现原理可以通过源码查看：



通过源码可以看到，if语句中，首先判断是否为POST请求，如果是POST请求，调用request.getParameter(this.methodParam)。可以看到this.methodParam是_method，如许就要求我们在提交请求方式的时候必须采用这个格式：_method=put。获取到请求方式之后，调用了toUpperCase转换成大写了。因此前端页面中小写的put或者大写的PUT都是可以的。if语句中嵌套的if语句说的是，只有请求方式是 PUT,DELETE,PATCH的时候会创建HttpMethodRequestWrapper对象。而HttpMethodRequestWrapper对象的构造方法是如许的：

如许method就从POST酿成了：PUT/DELETE/PATCH。
重点注意事项：CharacterEncodingFilter和HiddenHttpMethodFilter的顺序
细心的同学应该注意到了，在HiddenHttpMethodFilter源码中有如许一行代码：

)
大家是否还记得，字符编码过滤器执行之前不能调用 request.getParameter方法，如果提前调用了，乱码问题就无法办理了。因为request.setCharacterEncoding()方法的执行必须在所有request.getParameter()方法之前执行。因此这两个过滤器就有先后顺序的要求，在web.xml文件中，应该先配置CharacterEncodingFilter，然后再配置HiddenHttpMethodFilter。
5. 总结：

第三步：在web.xml文件配置SpringMVC提供的过滤器：HiddenHttpMethodFilter**
注意：
  1.   
  2.     <input type="hidden" name="_method" value="put">
  3. 隐藏域的 name 必须只能是 “_method”, value是 put(大小写忽略)
复制代码
6. 末了：

“在这个末了的篇章中，我要表达我对每一位读者的感激之情。你们的关注和回复是我创作的动力源泉，我从你们身上汲取了无尽的灵感与勇气。我会将你们的鼓励留在心底，继续在其他的领域奋斗。感谢你们，我们总会在某个时刻再次相遇。”


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4