什么是RESTful

简介: RESTful是一种设计规范,强调将资源作为核心,通过URI唯一标识,结合HTTP动词(GET、POST、PUT、DELETE)实现资源的操作。它解决了传统接口行为不统一、路径混乱的问题,具有结构清晰、标准统一、易于维护和扩展的优点。

为什么需要RESTful

对于http接口的调用,其历程经历过原始servlet,到后面的struts,SpringMVC,对于后端的参数封装也逐渐从单个属性演变成对象封装,然而即使到现在,我们对于http接口的封装,仍有不少公司采用下述示例:

@ApiOperation("执行")
@PostMapping("/execute")
public Result<Void> execute(@Valid @RequestBody ExecuteRequest request) {
    // 业务逻辑处理...
    return Result.success();
}

在这种模式下,开发人员一般将功能(或页面)聚合成一个controller,接口的路径定义也具备行为的特征,如对订单的操作,接口的定义一般形似(如删除、ID查询也可DELETE/GET):

功能

协议

接口

参数

新增

POST

/order/save

OrderSaveRequest

修改

POST

/order/update

OrderUpdateRequest

删除

POST

/order/delete

OrderDeleteRequest

ID查询

POST

/order/getById

OrderSingletonQueryRequest

复杂查询

POST

/order/get

OrderQueryRequest

在这种模式下我们对于订单协议的封装存在一个明显的问题:订单这个资源其行为是不规范的,同样是删除,有的人员定义为POST请求,有的是GET请求,资源表现的行为没有一个统一标准。更有甚者甚至会将order的功能封装成多个路径:save/order、save/product,这对于后续协议的维护简直就是灾难级别。因此我们需要一种设计规范,将程序员对于同一资源的行为封装做到规范统一。

总结为RESTful风格的设计拥有以下特点:结构清晰、统一标准、易于理解、扩展方便。

什么是RESTful

Resource Representational State Transfer:资源具象状态传输

RESTful是一个理念,是一个设计规范,而并非什么协议,其主要关键词如下:

资源

RESTful的理念下,互联网中任意信息都可定义为资源,如上述对于订单的增删改查,在此就抽象为订单资源;资源会对应一个特定的URI,URI为每一个资源的地址或独一无二的标识符,对应订单就可抽象为:http://application/order。此时订单抽象为资源,资源对应唯一的URI,后续对此资源的操作都将遵循此URI。

表现层

针对资源对外输出的展现,这种呈现形式称之为表现层。以为本为例可以对外呈现为:json/xml/html等多种格式。

状态转化

客户端通过访问服务端,进行增删改查操作,从而对资源状态产生变化,这个过程便是:资源的状态转化。以http协议为例(RESTful不仅使用HTTP协议,只不过是经常以HTTP协议为衬托),客户端可通过一些操作让服务端的资源进行变化。整个过程即为:表现层状态转化。而HTTP协议中常见操作方式:GET/POST/PUT/DELETE

如何使用RESTful

资源

GET

PUT

POST

DELETE

一组资源的URI,比如http://example.com/resources/

列出URI,以及该资源组中每个资源的详细信息(后者可选)

使用给定的一组资源替换当前整组资源

在本组资源中创建/追加一个新的资源。该操作往往返回新资源的URL

删除整组资源

单个资源的URI,比如http://example.com/resources/142

获取指定的资源的详细信息,格式可以自选一个合适的网络媒体类型(比如:XML、JSON等)

替换/创建指定的资源。并将其追加到相应的资源组中。

把指定的资源当做一个资源组,并在其下创建/追加一个新的元素,使其隶属于当前资源。

删除指定资源

RESTful使用进阶

上面对于RESTful的理解和使用我们有了一个认知,但是如果不能在涉及之初就对资源进行合理的划分,RESTful将变成只是针对现有功能的包路径调整。因此我们最好可以在设计之初就引入对应的资源概念。

1.架构中引入资源(Resource)的概念

最常见的错误就是在URI中包含动词,比如URI=http://example.com/getOrder?orderId=1234,其实「资源」表示一种实体,所以应该是名词,动词应该放在HTTP协议中。而与此同时URI也有可能破坏HTTP GET的安全性和幕等性,比如某个客户端在http://example.com/updateOrder?id=1234&coffee=latte上执行GET(而不是POST),就能创建一笔新的咖啡订单(一个资源),按理来说GET请求不能改变服务的任何状态。

2.每一个URI代表一种资源,支持HTTP动词

此时使用多个URI的话,需要让不同的URI代表不同的资源(多个URI可能指向同一个Resource,而一个URI不能指向不同Resource),同时使用多个HTTP方法操作这些资源,例如使用POST/GET/PUT/DELET分别进行CRUD操作。这时候HTTP头和有效载荷都包含业务逻辑,例如HTTP方法对应CRUD操作,HTTP状态码对应操作结果的状态。我们现在看到的大多数所谓RESTful API做到的也就是这个级别。

相关文章
|
4月前
|
安全 数据库 数据安全/隐私保护
1.RememberMe简介及用法
RememberMe功能并非简单记住用户名密码,而是通过服务端生成令牌(Token)实现持久登录。用户勾选后,浏览器会携带该令牌自动认证,避免重复登录。为提升安全性,可将Token持久化至数据库并增加二次校验机制,防止泄露风险。
|
4月前
|
前端开发 安全 Java
1.自定义认证前端页面
本文介绍Spring Security前后端整合实现登录认证的完整流程。包含前端login.html页面引入、后端HelloController接口定义及SecurityConfig安全配置类详解,重点讲解权限控制、表单登录、CSRF关闭等核心配置,并通过启动验证展示访问控制效果,帮助快速掌握基础安全防护机制。(238字)
|
4月前
|
安全 Java 开发工具
1.工程搭建与验证
本文介绍如何使用阿里云脚手架快速搭建SpringBoot工程,并整合Spring Security。内容涵盖项目创建、代码导入、Web依赖配置及安全验证,启动后自动跳转登录页,使用默认用户即可访问受保护资源,附完整代码仓库地址。
|
4月前
|
安全 Java 数据安全/隐私保护
2.通用权限管理模型
本文介绍了ACL和RBAC两种常见的权限模型。ACL通过直接为用户或角色授权,实现简单但管理复杂;RBAC则基于角色分配权限,结构清晰、易于维护,并细分为RBAC0至RBAC3四个等级,逐步引入角色继承与职责分离机制,提升系统安全与灵活性。
|
4月前
|
Java Maven
3. 打包
本文介绍Java项目打包部署的两种方式:一是将所有内容打包进单一JAR文件,通过Maven配置、打包命令及运行指令实现快速启动与后台运行;二是将主JAR、依赖与配置文件分离,提升灵活性与维护性,并提供端口查询与进程终止方法,便于服务管理。
3. 打包
|
4月前
|
存储 JSON NoSQL
3-MongoDB常用命令
本文介绍MongoDB数据库操作,包括创建与删除数据库、集合的显式与隐式创建、文档的增删改查、批量操作、分页查询及排序统计等基本CRUD操作,适用于文章评论数据管理。
|
4月前
|
存储 缓存 安全
1-常用过滤器介绍
本文介绍了Spring Security中的核心过滤器链,涵盖SecurityContextPersistenceFilter、CsrfFilter、LogoutFilter等15个关键过滤器的作用,解析其在认证、授权、会话管理等方面的功能,并说明过滤器的加载具有配置依赖性,非固定不变。
|
4月前
|
SQL 监控 Java
微服务技术栈
本知识库由“油炸小波”精心整理,涵盖微服务技术栈全貌,包括SpringCloud、Dubbo、Zookeeper等核心框架,以及Java基础、JVM、MySQL、MongoDB等关键技术。内容持续更新,聚焦生产发布、缺陷管理、SQL监控、单元测试等实战场景,助力开发者提升技术能力与工程规范。
|
4月前
|
存储 安全 Java
6.鉴权
本文介绍基于Spring Security与JWT的客户端Token认证方案,涵盖实现思路、核心代码及完整流程。通过自定义过滤器与认证组件,结合RBAC权限模型,实现安全的Token生成与验签,保护Spring Boot应用接口。
|
4月前
|
JSON API 数据格式
4. 不定参数入参
本文介绍了API接口中参数传递的两种方式:非JSON格式与JSON格式入参。前者支持基本类型、封装对象等直接绑定,后者通过@RequestBody接收JSON数据,可结合@Valid进行参数校验,提升接口安全性与稳定性。