什么是RESTful

简介: RESTful是一种基于资源的API设计规范,主张用URI标识资源,HTTP动词(GET、POST等)操作资源,实现统一、标准的接口风格。它解决了传统接口路径混乱、行为不统一的问题,使API结构清晰、易于理解和维护。通过将操作抽象为对资源的状态转换,提升系统可扩展性与规范性。

为什么需要RESTful
对于http接口的调用,其历程经历过原始servlet,到后面的struts,SpringMVC,对于后端的参数封装也逐渐从单个属性演变成对象封装,然而即使到现在,我们对于http接口的封装,仍有不少公司采用下述示例:
@ApiOperation("执行")
@PostMapping("/execute")
public Result 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做到的也就是这个级别。

目录
相关文章
|
10月前
|
缓存 Java 开发工具
QLExpress使用及源码分析
QLExpress是阿里巴巴开源的轻量级规则引擎,支持通过YAML配置规则脚本,结合注解实现Java方法与表达式映射。通过别名机制、AST解析和上下文赋值,实现灵活的动态逻辑执行,适用于复杂业务规则场景。
367 0
|
10月前
|
JSON 安全 Java
SpringBoot鉴权
本文介绍基于Spring Security与JWT的客户端Token认证方案,涵盖实现思路、详细配置及代码实现。通过自定义过滤器与认证逻辑,结合JWT生成与验签,保障Spring Boot应用安全,支持角色与权限控制,构建完整的RBAC权限体系。(239字)
217 0
|
10月前
|
XML 存储 SQL
SpringBoot整合Logback,滚动记录+多文件
logback-spring.xml配置文件实现日志分级输出,支持控制台、文件滚动存储,按模块(如SQL、支付、任务等)分离日志,通过LogProxy获取指定名称的Logger,便于定位问题。配置灵活,适用于多环境部署。
191 0
|
10月前
|
安全 Linux Shell
Docker镜像
镜像是包含软件运行所需代码、依赖库、配置等的轻量级可执行包。Docker利用联合文件系统实现分层结构,通过bootfs和rootfs构成镜像底层,支持镜像共享与复用。容器启动时在镜像顶层添加可写容器层,所有修改仅作用于该层,保障镜像安全与高效。
240 0
|
10月前
|
存储 Ubuntu Shell
容器命令
`docker run` 命令用于创建并启动容器,支持交互式(-it)和守护式(-d)运行。常用参数包括:--name(命名)、-p(端口映射)、-v(数据卷挂载)、-e(环境变量)等。可通过 `docker start/stop/restart` 控制容器状态,`docker exec` 进入运行中容器,`docker commit` 将容器保存为新镜像。数据卷实现持久化存储,支持容器间共享。
460 0
|
10月前
|
JSON Linux 数据格式
Registry搭建docker私仓
Docker Registry是官方提供的私有镜像仓库构建工具。通过拉取registry镜像并运行容器,可快速搭建私服。需配置daemon.json启用http支持,重启Docker后,使用tag和push命令上传镜像,通过curl验证内容,实现私有化镜像管理。
340 0
|
10月前
|
缓存 Ubuntu Linux
Docker安装
本文介绍在CentOS系统上安装Docker的完整步骤,包括卸载旧版本、配置阿里云镜像源、安装最新或指定版本的Docker引擎,并启动服务。同时涵盖Ubuntu系统的安装方法及离线安装方式,支持配置系统服务、daemon.json参数、日志管理与命令补全,最后通过`hello-world`验证安装成功。
413 0
|
10月前
|
Java 大数据 Apache
Excel工具-HUTOOL-输出Excel
基于Hutool与Apache POI,封装Excel写入功能,提供ExcelWriter和BigExcelWriter,支持List、Map、Bean等数据类型导出,可自定义样式、多Sheet操作,并避免内存溢出,适用于高效生成Excel文件及Web下载场景。
499 0
|
10月前
|
Java Maven 数据安全/隐私保护
Nexus仓库
本文介绍Nexus Repository Manager OSS在Linux环境下的安装与配置,包括JDK8安装、Nexus部署、仓库管理、用户权限设置及密码重置方法。支持通过Docker快速部署,并实现数据持久化。同时涵盖Maven、NPM、Docker等组件的私服搭建与资源上传下载配置,助力企业构建高效私有仓库体系。(239字)
856 0
|
10月前
|
Apache
Excel工具-HUTOOL-读取Excel
基于Hutool和Apache POI,封装Excel读取工具,支持读取为List、Map或Bean;提供SAX模式高效解析大文件,避免内存溢出,适用于Excel 2003/2007格式,支持按行处理数据。
440 0

热门文章

最新文章