SpringMVC 七 RESETFul

原创已于 2022-04-18 11:06:26 修改 · 357 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#spring

于 2022-04-18 08:50:21 首次发布

本文介绍了RESTful的基本概念，包括资源、资源的表述和状态转移，并阐述了HTTP中GET、POST、PUT和DELETE四种操作在RESTful设计中的角色。在SpringMVC中，通过HiddenHttpMethodFilter可以处理POST请求转化为PUT和DELETE请求，以实现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 地址的一部分，以保证整体风格的一致性。

3、HiddenHttpMethodFilter

由于浏览器只支持发送get和post方式的请求，那么该如何发送put和delete请求呢？

SpringMVC 提供了 HiddenHttpMethodFilter 帮助我们将 POST 请求转换为 DELETE 或 PUT 请求 HiddenHttpMethodFilter 处理put和delete请求的条件：

a>当前请求的请求方式必须为post

b>当前请求必须传输请求参数_method 满足以上条件，

HiddenHttpMethodFilter 过滤器就会将当前请求的请求方式转换为请求参数 _method的值，因此请求参数_method的值才是最终的请求方式在web.xml中注册HiddenHttpMethodFilter

<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);

针对四个请求的代码：

GET、查询

POST、添加

PUT、修改

DELETE。删除

代码：

设置web.xmlde 配置

设置web.xmlde 配置
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!--配置springMVC的编码过滤器-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <!--配置HiddenHttpMethodFilter过滤器将post请求转换为PUT，DELETE，PATCH用来处理不同业务-->
<!--
    a>当前请求的请求方式必须为post
    b>当前请求必须传输请求参数_method
    <form th:action="@{/user/1}"  method="post">
    <input type="hidden" name="_method" value="delete">
-->
    <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的前端控制器，对浏览器发送的请求统一进行处理 -->
    <servlet>
        <servlet-name>springMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 通过初始化参数指定SpringMVC配置文件的位置和名称 -->
        <init-param>
            <!-- contextConfigLocation为固定值 -->
            <param-name>contextConfigLocation</param-name>
            <!-- 使用classpath:表示从类路径查找配置文件，例如maven工程中的
            src/main/resources -->
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <!--
        作为框架的核心组件，在启动过程中有大量的初始化操作要做
        而这些操作放在第一次请求时才执行会严重影响访问速度
        因此需要通过此标签将启动控制DispatcherServlet的初始化时间提前到服务器启动时
        -->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>springMVC</servlet-name>
        <!--
        设置springMVC的核心控制器所能处理的请求的请求路径
        /所匹配的请求可以是/login或.html或.js或.css方式的请求路径
        但是/不能匹配.jsp请求路径的请求
        -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

2.控制类的代码

package com.sun.mvc.contorller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;

/**
 * @author sunyc
 * @create 2022-04-18 9:23
 */
@Controller
public class UserContorller {
    //jsp index 首页
    @RequestMapping("/")
    public String index(){
        return "index";
    }
   /*
    /user     Get 查询所有的用户
    /user/1   Get 查询单个的用户
    /user     POSt 添加用户信息
    /user/1   DELETE 删除单个的用户
    /user     PUT 修改的用户
*/

    //查询所有用户请求
    @RequestMapping(value = "/user",method = RequestMethod.GET)
    public String userAllUser(){
        System.out.println("查询所有用户请求");
        return "success";
    }
    //查询单个用户请求
    @RequestMapping(value = "/user/{id}",method = RequestMethod.GET)
    public String userById(Integer id){
        System.out.println("查询单个用户请求id="+id);

        return "success";
    }
    //添加用户信息
    @RequestMapping(value = "/user",method = RequestMethod.POST)
    public String userPost(String username,String password){
        System.out.println("添加用户信息username="+username+",password="+password);
        return "success";
    }
    //删除单个的用户
    @RequestMapping(value = "/user/{id}",method = RequestMethod.DELETE)

    public String userDelete(){
        System.out.println("删除单个的用户");

        return "success";
    }
    //修改的用户
    @RequestMapping(value = "/user",method = RequestMethod.PUT )
    public String userUpdate(String username,String password){
        System.out.println("修改的用户username="+username+",password="+password);

        return "success";
    }

}

3.index.xml

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>首页</title>
</head>
<body>
<h1>这里是index首页</h1>

<a th:href="@{/user}" th:method="get">这是查询所有的请求--》get</a><br/>
<a th:href="@{/user/1}" th:method="get">根据id查询单个用户的请求--》get</a><br/>
<form th:action="@{/user}"  method="post">
    用户名：<input type="text" name="username"><br/>
    密码：<input type="password" name="password"><br/>
    <input type="submit" >添加用户信息<br/>
</form>


<form th:action="@{/user}"  method="post">
    <input type="hidden" name="_method" value="PUT">
    用户名：<input type="text" name="username"><br/>
    密码：<input type="password" name="password"><br/>
    <input type="submit" >修改的用户信息<br/>
</form>

<form th:action="@{/user/1}"  method="post">
    <input type="hidden" name="_method" value="delete">
    id：<input type="test" name="id" value=""><br/>
    <input type="submit" >根据id删除用户信息<br/>
</form>
</body>
</html>

4.成功页

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>success</h1>
</body>
</html>