SpringMVC——RESTful

最新推荐文章于 2024-03-12 10:15:27 发布

前丨尘忆·梦

最新推荐文章于 2024-03-12 10:15:27 发布

阅读量1.1k

点赞数 1

分类专栏：微服务核心：SSM+SpringBoot2+设计模式+MQ 文章标签： restful 后端 java

本文链接：https://blog.csdn.net/qq_36879493/article/details/123087559

版权

微服务核心：SSM+SpringBoot2+设计模式+MQ 专栏收录该内容

61 篇文章 3 订阅

订阅专栏

RESTful

1、RESTful简介

REST：Representational State Transfer，表现层资源状态转移。

1.1、资源

资源是一种看待服务器的方式，即：将服务器看作是由很多离散的资源组成。每个资源是服务器上一个可命名的抽象概念。因为资源是一个抽象的概念，所以它不仅仅能代表服务器文件系统中的一个文件、数据库中的一张表等等具体的东西，可以将资源设计的要多抽象有多抽象，只要想象力允许而且客户端应用开发者能够理解。与面向对象设计类似，资源是以名词为核心来组织的，首先关注的是名词。一个资源可以由一个或多个 URI 来标识。URI 既是资源的名称，也是资源在 Web 上的地址。对某个资源感兴趣的客户端应用，可以通过资源的 URI 与其进行交互。

1.2、资源的表述

资源的表述是一段对于资源在某个特定时刻的状态的描述。可以在客户端-服务器端之间转移（交换）。资源的表述可以有多种格式，例如 HTML/XML/JSON/纯文本/图片/视频/音频等等。资源的表述格式可以通过协商机制来确定。请求–响应方向的表述通常使用不同的格式。

13、状态转移

状态转移说的是：在客户端和服务器端之间转移（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：

<!--配置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>

注：
目前为止，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、准备数据

和传统 CRUD 一样，实现对员工信息的增删改查。

4.1.1、准备实体类：bean.Employee

public class Employee {
    private Integer id;
    private String lastName;
    private String email;
    //1 male, 0 female
    private Integer gender;

    public Employee() {
    }

    public Employee(Integer id, String lastName, String email, Integer gender) {
        this.id = id;
        this.lastName = lastName;
        this.email = email;
        this.gender = 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;
    }

    @Override
    public String toString() {
        return "Employee{" +
                "id=" + id +
                ", lastName='" + lastName + '\'' +
                ", email='" + email + '\'' +
                ", gender=" + gender +
                '}';
    }
}

4.1.2、准备 dao 模拟数据

@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(mvc.bean.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);
    }
}

4.1.3、准备控制器方法

@Controller
public class EmployeeController {
    @Autowired
    private EmployeeDao employeeDao;
}

4.2、功能清单

功能	URL 地址	请求方式
访问首页√	/	GET
查询全部数据√	/employee	GET
删除√	/employee/2	DELETE
跳转到添加数据页面√	/toAdd	GET
执行保存√	/employee	POST
跳转到更新数据页面√	/employee/2	GET
执行更新√	/employee	PUT

4.3、访问首页

配置 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>

4.4、具体功能：查询所有员工数据

控制器方法：

@GetMapping("/employee")
public String getAllEmployee(Model model){
    Collection<Employee> employeeList = employeeDao.getAll();
    model.addAttribute("employeeList", employeeList);

    return "employee_list";
}

创建 employee_list.html：

<table>
    <tr>
        <th colspan="5">Employee Info</th>
    </tr>
    <tr>
        <th>id</th>
        <th>lastName</th>
        <th>email</th>
        <th>gender</th>
        <th>options</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 href="">delete</a>
            <a href="">update</a>
        </td>
    </tr>
</table>

4.5、具体功能：删除

创建处理 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>

通过 vue 处理点击事件：

<script type="text/javascript">
    var vue = new vue({
        el:"#dataTable",
        methods:{
            eleteEmployee:function (event) {
                var deleteForm = document.getElementById("deleteForm");
                //将触发点击事件的超链接的href属性赋值给表单的action
                deleteForm.action = event.target.href;
                //提交表单
                deleteForm.onsubmit();
                //取消超链接默认行为
                event.preventDefault();
            }
        }
    });
</script>

控制器方法：

@RequestMapping(value = "/employee/{id}", method = RequestMethod.GET)
public String deleteEmployee(@PathVariable("id")Integer id){
    employeeDao.delete(id);
    return "redirect:/employee";
}

这里还是使用的是 GET，不是 DELETE

4.6、具体功能：跳转到添加数据页面

配置 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="1">male
               <input type="radio" name="gender" value="0">female<br/>
        <input type="submit" value="add"><br/>
    </form>
</body>
</html>

控制器方法：

@RequestMapping(value = "/employee", method = RequestMethod.POST)
public String addEmployee(Employee employee){
    employeeDao.save(employee);
    return "redirect:/employee";
}

4.7、实现回显功能（修改功能的一部分）

配置 view-controller：

<mvc:view-controller path="/toAdd" view-name="employee_add"></mvc:view-controller>

配置控制器：

@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";
}

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.lastName}"><br/>
        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>

4.7、具体功能：修改

修改超链接：

<a th:href="@{'/employee/' + ${employee.id}}">update</a>

4.7.1、实现回显功能

配置 view-controller：

<mvc:view-controller path="/toAdd" view-name="employee_add"></mvc:view-controller>

配置控制器：

@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";
}

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.lastName}"><br/>
        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>

更新操作的控制器方法：

@RequestMapping(value = "/employee", method = RequestMethod.PUT)
public String updateEmployee(Employee employee){
    employeeDao.save(employee);
    return "redirect:/employee";
}

前丨尘忆·梦

关注

1
点赞
踩
8

收藏

觉得还不错? 一键收藏
2
评论
SpringMVC——RESTful

RESTful文章目录RESTful1、RESTful简介1.1、资源1.2、资源的表述13、状态转移2、RESTful的实现3、HiddenHttpMethodFilter4、RESTful 案例4.1、准备数据4.1.1、准备实体类：bean.Employee4.1.2、准备 dao 模拟数据4.1.3、准备控制器方法4.2、功能清单4.3、访问首页4.4、具体功能：查询所有员工数据4.5、具体功能：删除4.6、具体功能：跳转到添加数据页面4.7、实现回显功能（修改功能的一部分）4.7、具体功能：修改
复制链接

扫一扫