RESTful的风格提倡 URL 地址使用统一的风格设计

zjw_rp

已于 2023-01-18 14:19:44 修改

阅读量1.3k

点赞数 1

CC 4.0 BY-SA版权

文章标签： java mvc

于 2023-01-16 19:34:14 首次发布

本文链接：https://blog.csdn.net/zjw_rp/article/details/128703200

本文介绍了RESTful的概念，强调了URL地址的统一风格设计，避免使用问号键值对携带参数。重点讲解了如何通过HTTP的GET、POST、PUT、DELETE方法进行资源操作。同时，针对浏览器限制，提到了使用HiddenHttpMethodFilter过滤器来处理PUT和DELETE请求。文章通过代码示例展示了查询、添加、修改和删除用户信息的流程，并讨论了处理静态资源的方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

RESTful概念实现

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

资源：

资源是一种看待服务器的方式，即，将服务器看作是由很多离散的资源组成。
每个资源是服务器上一个可命名的抽象概念。

资源的表述

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

状态转移

在客户端和服务器端之间转移（transfer）代表资源状态的表述。
通过转移和操作资源的表述，来间接实现操作资源的目的。

RESTful的实现

HTTP 协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。

分别对应四种基本操作：GET 用来获取资源，POST 用来新建资源，
PUT 用来更新资源，DELETE用来删除资源。
PUT和DELETE浏览器不支持这两种方式发送请求，需要通过 HiddenHttpMethodFilter过滤器。

REST 风格提倡 URL 地址使用统一的风格设计，从前到后各个单词使用斜杠分开，

不使用问号键值对方式携带请求参数，而是将要发送给服务器的数据作为 URL 地址

的一部分，以保证整体风格的一致性。

最后概括：

面向资源进行访问，要把当前访问的这些资源以名词的方式设置到路径中，
在路径中表示当前访问的资源，同时把传输的数据也作为路径的一部分
拼接(设置)到路径中。

HiddenHttpMethodFilter过滤器解决PUT和DELETE请求

浏览器目前只能发送get和post请求，若要发送put和delete请求，

需要在web.xml中配置一个过滤器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>

实现：

配置过滤器后，发送的请求要满足两个条件，才能将请求的方式转换为put或delete
①当前请求必须为post
②当前请求必须传输请求参数_method,_method的值才是最终的请求方式

代码示例1

* 查询所有的用户信息--> (路径)/user ---> get
* 根据id查询用户信息--> (路径)/user/id(1) ---> get
* 添加用户信息--> (路径)/user/ ---> post 传输的数据比较多，可以通过表单方式提交
*修改用户信息--> (路径)/user ---> put
* 删除用户信息--> (路径)/user/id(1) ---> delete

查询所有的用户信息

controller控制层

@Controller
public class TestRestController {
@RequestMapping(value = "/user",method = RequestMethod.GET)
    public String getAllUser(){
    System.out.println("查询所有的用户信息--> (路径)/user ---> get");
    return "success";
}

thymeleaf渲染页面

<h1>index.html</h1>
<a th:href="@{/user}">查询所有的用户信息</a><br>

根据id查询用户信息

controller控制层

@RequestMapping(value = "/user/{id}",method = RequestMethod.GET)
    public String getUserById(@PathVariable("id") Integer id){
    System.out.println("根据id查询用户信息--> (路径)/user/"+id+" ---> get");
//根据id查询用户信息--> (路径)/user/id" 1 ---> get
    return "success";
}

thymeleaf渲染页面

<a th:href="@{/user/1}">查询id为1的用户信息</a><br>

添加用户信息

controller控制层

@RequestMapping(value = "/user",method = RequestMethod.POST)
public String insertUser(){
    System.out.println("添加用户信息--> (路径)/user/ ---> post");
    return "success";
}

thymeleaf渲染页面

<form th:action="@{/user}" method="post">
    <input type="submit" value="添加用户信息">
</form>

修改用户信息(PUT)

controller控制层

    @RequestMapping(value = "/user",method = RequestMethod.PUT)
    public String updateUser(){
        System.out.println("修改用户信息--> (路径)/user/ ---> put");
        return "success";
    }

web.xml配置过滤器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>

thymeleaf渲染页面

<form th:action="@{/user}" method="post">
    <input type="hidden" name="_method" value="put">
    <input type="submit" value="修改用户信息">
</form>

删除用户信息(Delete)

controller控制层

    @RequestMapping(value = "/user/{id}",method = RequestMethod.DELETE)
    public String deleteUser(@PathVariable("id") Integer id){
        System.out.println("删除用户信息--> (路径)/user/"+id+" ---> delete");
//删除用户信息--> (路径)/user/"+2+" ---> delete
        return "success";
    }

thymeleaf渲染页面

<form th:action="@{/user/2}" method="post">
    <input type="hidden" name="_method" value="delete">
    <input type="submit" value="删除用户信息">
</form>

处理静态资源

配置默认的servlet处理静态资源：

当前工程的web.xml配置的前端控制器DispatcherServlet的url-pattern是/
tomcat的web.xml配置的DefaultServlet的url-pattern也是/
此时，浏览器发送的请求会优先被DIspatcherServlet进行处理，
但是DispatcherServlet无法处理静态资源。
若配置了<mvc:default-servlet-handler/>，
此时浏览器发送的所有请求都会被DefaultServlet处理。
若配置了<mvc:default-servlet-handler/>和<mvc:annotation-driven/>
浏览器发送的请求会先被DispatcherServlet处理，
无法处理在交给DefaultServlet处理。

<!--    配置默认的servlet处理静态资源-->
    <mvc:default-servlet-handler />
    <!--    开启mvc的注解驱动-->
    <mvc:annotation-driven></mvc:annotation-driven>

代码示例2

配置文件

<!-- SpringMVC.xml配置文件   配置默认的servlet处理静态资源-->
    <mvc:default-servlet-handler />
    <!--    开启mvc的注解驱动-->
    <mvc:annotation-driven></mvc:annotation-driven>

<!--视图控制器-->
    <mvc:view-controller path="/" view-name="index"/>
    <mvc:view-controller path="/to/add" view-name="employee_add"/>

数据模拟dao层(代替数据库表)

package com.atguigu.dao;

import com.atguigu.pojo.Employee;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Repository;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
@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);
    }
}

实体类

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

    public Employee() {
    }
   ....
}

controller控制层

/**
 * 查询所有的员工信息 --> /employee --> get
 * 跳转到添加页面 --> /to/add --> get
 * 添加员工信息 --> /employee -->post
 * 跳转到修改页面 --> /employee/id(1) -->get
 * 修改员工信息 --> /employee -->put
 * 删除员工信息 --> /employee -->delete
 */
@Controller
public class EmployeeController {
    @Autowired
    private EmployeeDao employeeDao;

<!--查询所有数据-->
    @RequestMapping(value = "/employee" ,method = RequestMethod.GET)
    public String getAllEmployee(Model model){
//        获取所有的员工信息
        Collection<Employee> allEmployee = employeeDao.getAll();
//        将所有的员工信息在请求域中共享数据
        model.addAttribute("allEmployee",allEmployee);
//        跳转到列表页面
        return "employee_list";
    }

<!-添加数据-->
    @RequestMapping(value = "/employee",method = RequestMethod.POST)
    public String addEmployee(Employee employee){
//        保存员工信息
        employeeDao.save(employee);
//        重定向到列表功能 /employee
        return "redirect:/employee";
    }

<!--修改数据，1，把数据查询出来，显示在页面进行修改-->
    @RequestMapping(value = "/employee/{id}",method = RequestMethod.GET)
    public String toUpdate(@PathVariable("id") Integer id,Model model){
        //根据id查询员工信息
        Employee employee = employeeDao.get(id);
//        将员工信息共享到请求域中
        model.addAttribute("employee",employee);
//        跳转到employee_update.html
        return "employee_update";
    }
<!--修改数据 2，进行获取在页面填写的修改数据，进行处理-->
    @RequestMapping(value = "/employee",method = RequestMethod.PUT)
    public String updateEmployee(Employee employee){
//        修改员工信息
        employeeDao.save(employee);
//        重定向到列表功能：/employee
        return "redirect:employee";
    }

<!--处理删除数据-->
    @RequestMapping(value = "/employee/{id}", method = RequestMethod.DELETE)
    public String deleteEmployee(@PathVariable("id") Integer id){
        //删除员工信息
        employeeDao.delete(id);
        //重定向到列表功能：/employee
        return "redirect:/employee";
    }
}

thymeleaf渲染页面

employee_list主页面

<head>
    <meta charset="UTF-8">
    <title>employee list</title>
    <link rel="stylesheet" th:href="@{/static/css/index_work.css}">
</head>
<body>
<div id="app">
    <table>
        <tr>
            <th colspan="5">employee_list</th>
        </tr>
        <tr>
            <th>id</th>
            <th>lastName</th>
            <th>email</th>
            <th>gender</th>
            <th>options（<a th:href="@{/to/add}">add</a>）</th>
        </tr>
        <tr th:each="employee : ${allEmployee}">
            <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 @click="deleteEmployee()" th:href="@{'/employee/'+${employee.id}}">delete</a>
                <a th:href="@{'/employee/'+${employee.id}}">update</a>
            </td>
        </tr>
    </table>
    <form method="post">
        <input type="hidden" name="_method" value="delete">
    </form>
</div>

<script type="text/javascript" th:src="@{/static/js/vue.js}"></script>
<script type="text/javascript">
    var vue = new Vue({
        el:"#app",
        methods:{
            deleteEmployee(){
                //获取form表单
                var form = document.getElementsByTagName("form")[0];
                //将超链接的href属性值赋值给form表单的action属性
                //event.target表示当前触发事件的标签
                form.action = event.target.href;
                //表单提交
                form.submit();
                //阻止超链接的默认行为
                event.preventDefault();
            }
        }
    });
</script>
</body>
</html>

employee_add页面增加数据

<head>
    <meta charset="UTF-8">
    <title>add employee</title>
    <link rel="stylesheet" type="text/css" th:href="@{/static/css/index_work.css}">
</head>
<body>
<form th:action="@{/employee}" method="post">
  <table>
    <tr>
        <th colspan="2">add employee</th>
    </tr>
      <tr>
          <td>lastName</td>
          <td>
              <input type="text" name="lastName">
          </td>
      </tr>
      <tr>
          <td>email</td>
          <td>
              <input type="text" name="email">
          </td>
      </tr>
      <tr>
          <td>gender</td>
          <td>
              <input type="radio" name="gender" value="1">male
              <input type="radio" name="gender" value="0">female
          </td>
      </tr>
      <tr>
          <td colspan="2">
              <input type="submit" value="add">
          </td>
      </tr>
  </table>
</form>
</body>
</html>

employee_update修改页面

<head>
  <meta charset="UTF-8">
  <title>update employee</title>
  <link rel="stylesheet" type="text/css" th:href="@{/static/css/index_work.css}">
</head>
<body>
<form th:action="@{/employee}" method="post">
  <input type="hidden" name="_method" value="put">
  <input type="hidden" name="id" th:value="${employee.id}">
  <table>
    <tr>
      <th colspan="2">add employee</th>
    </tr>
    <tr>
      <td>lastName</td>
      <td>
        <input type="text" name="lastName" th:value="${employee.lastName}">
      </td>
    </tr>
    <tr>
      <td>email</td>
      <td>
        <input type="text" name="email" th:value="${employee.email}">
      </td>
    </tr>
    <tr>
      <td>gender</td>
      <td>
        <input type="radio" name="gender" value="1" th:field="${employee.gender}">male
        <input type="radio" name="gender" value="0" th:field="${employee.gender}">female
      </td>
    </tr>
    <tr>
      <td colspan="2">
        <input type="submit" value="update">
      </td>
    </tr>
  </table>
</form>
</body>
</html>