RESTful风格

本文介绍了RESTful风格在API设计中的优势,详细阐述了如何在Spring MVC中利用`@RequestMapping`的`method`属性及衍生注解如`@GetMapping`, `@PostMapping`等实现RESTful接口。通过示例说明了如何处理表单提交,特别是如何模拟DELETE请求,以符合RESTful原则。" 77851598,1347733,解决Android Studio编译错误:Timeout waiting to lock artifact cache,"['Android开发', 'Android Studio', 'Gradle', '问题解决']

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

RESTful风格

我们在对一个数据进行增删改查操作时,按照传统的方式需要定义四个接口,来接收增删改查这四种不同的请求。设想一下,如果我们有一个用户信息需要增删改查,就需要/addUser,/delectUser,/updateUser,/queryUser四个不同的uri,这样做未免过于繁琐,而且每次都需要给不同的uri起不同的名字也不容易,这个时候我们可以使用RESTful风格的API

RESTful风格定义

首先我们看一下RESTful风格的定义

REST,即Representational State Transfer的缩写。直接翻译的意思是"表现层状态转化"。

它是一种互联网应用程序的API设计理念:URL定位资源,用HTTP动词(GET,POST,DELETE,DETC)描述操作。

RESTful风格定义了一系列的请求类型,简单的和增删改查的对应关系如下

CRUD 动作HTTP 方法
CreatePOST
QueryGET
UpdatePUT或PATCH
DeleteDELETE

使用了RESTful风格,我们只需要一个/user的uri就足够了,RESTful风格的API可以使用同样的uri,而用不同的请求类型来对数据做不同的操作,而这在Spring MVC中也可以实现

@RequestMapping的method属性

@RequestMapping中有一个method属性,我们可以通过设置这个属性来绑定这个接收请求的方法接收的是什么类型的请求

@RestController
public class MyController {

    @RequestMapping(path = "/user", method = RequestMethod.GET)
    public String queryUser() {
        return "queryUser";
    }

    @RequestMapping(path = "/user", method = RequestMethod.POST)
    public String createUser() {
        return "createUser";
    }
}

设置method属性时使用RequestMethod这个枚举类的值

这里定义了两个方法,这两个方法都使用/user这个uri,然而这并不冲突,前端的请求如果是GET类型的,就会执行queryUser方法,如果是POST类型的,就会执行updateUser方法

我们使用postman这个工具来帮助我们发送不同的请求,测试返回的结果

在这里插入图片描述

在这里插入图片描述

从不同的结果可以看出,两次请求分别走了不同的请求处理方法

@RequestMapping衍生注解

除了使用@RequestMapping的method属性,还可以使用@RequestMapping注解的衍生注解来指定接收请求方法接收的请求类型,有以下几个衍生注解

  • @GetMapping
  • @PostMapping
  • @DeleteMapping
  • @PatchMapping
  • @PutMapping

使用这些衍生注解,就不需要使用@RequestMapping注解了,点开可以发现这些衍生注解相当于设置了method属性的@RequestMapping注解

在这里插入图片描述

@RestController
public class MyController {

    @GetMapping("/user")
    public String queryUser() {
        return "queryUser";
    }

    @PostMapping("/user")
    public String createUser() {
        return "createUser";
    }
}

表单提交使用RESTful风格

在表单提交中,只有GET和POST两种请求,不过这种情况也是可以使用RESTful风格的,只需要遵循Spring Boot的规范就行

例如我们现在要发送一个请求类型为DELETE的请求,表单元素的method属性还是写post,然后在表单中添加一个input元素,一般是hidden类型的,然后元素名命名为_method,值绑定真正的请求类型即可,这个value属性的DELETE不分大小写

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Index</title>
</head>
<body>
<form action="/user" method="post">
    <input type="hidden" name="_method" value="delete">
    <input type="submit" value="删除">
</form>

</body>
</html>

然后在配置文件中使用以下配置将Spring MVC的表单过滤器功能打开

spring:
  mvc:
    hiddenmethod:
      filter:
        enabled: true

这样表单发送的请求虽然原生是POST类型的,但是Spring MVC会当成DELETE类型处理

### RESTful 风格 API 的设计原则 RESTful API 设计遵循一系列指导方针,旨在创建易于理解和使用的接口。这些原则确保了接口的一致性、可用性和可扩展性[^1]。 #### 资源导向 RESTful API 将系统的核心组件视为资源。每个资源通过唯一的 URI (统一资源标识符) 进行访问。例如,在电子商务平台中,“产品”可以被定义为一种资源,并可通过 `/products/{id}` 访问特定的产品实例[^3]。 #### 使用标准 HTTP 方法操作资源 为了保持一致性并简化客户端的理解成本,RESTful API 利用了 HTTP 提供的标准动词来执行 CRUD 操作: - `GET` 请求用于获取资源数据; - `POST` 用来提交新实体到指定集合下; - `PUT` 和 `PATCH` 分别表示更新整个现有记录或者部分修改字段; - `DELETE` 执行删除动作[^4]。 #### 状态无连接性 每次请求都应包含处理该次调用所需的所有信息;服务器不应依赖于任何存储在它上面的状态或上下文来完成这个过程。这意味着每一个事务都是独立存在的,不会受到之前或其他并发会话的影响[^5]。 #### 统一接口 API 应当提供一个统一的方式来进行交互,无论是在不同的端点之间还是跨多个服务提供商的情况下。这通常涉及到采用一致性的命名约定、错误响应模式以及支持相同类型的媒体格式(如 JSON 或 XML)。此外,良好的文档说明也是至关重要的组成部分之一[^2]。 ### 实现 RESTful API 实现 RESTful API 可以选用多种编程语言和技术栈,比如 Python Flask/Django, Node.js Express, Java Spring Boot 等等。这里给出一段简单的Python代码片段作为例子: ```python from flask import Flask, jsonify, request app = Flask(__name__) @app.route('/api/v1/resources', methods=['GET']) def get_resources(): # 处理 GET 请求逻辑... pass if __name__ == '__main__': app.run(debug=True) ``` 上述示例展示了如何利用Flask框架快速搭建起能够接收来自外部世界的HTTP请求的服务端程序。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值