什么是RESTful

简介: RESTful是一种基于资源的API设计规范,主张用URI标识资源,HTTP动词操作资源,实现统一、标准的接口风格。它解决了传统接口路径混乱、行为不规范的问题,具有结构清晰、易于理解与扩展的优势,提升前后端协作效率与系统可维护性。(238字)

为什么需要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做到的也就是这个级别。

相关文章
|
6月前
|
Java 关系型数据库 MySQL
OAuth2.0实战案例
本项目基于Spring Boot与Spring Cloud构建,实现OAuth2四种授权模式。通过父工程统一管理依赖,分别搭建资源服务器与认证服务器,集成MyBatis与MySQL实现用户及客户端信息持久化,完成授权码、简化、密码及客户端模式的认证流程,保障资源访问安全。
|
6月前
|
存储 安全 Java
RememberMe简介及用法
RememberMe功能可使用户关闭浏览器后仍保持登录状态,避免重复登录。其通过服务端生成持久化令牌(Token)并存储于Cookie实现,而非保存用户名密码。Spring Security中只需配置`.rememberMe()`并设置密钥即可启用。默认令牌存于内存,存在泄露风险,可通过数据库持久化Token并结合二次校验提升安全性,防止非法访问。
|
6月前
|
安全 Java 开发工具
工程搭建与验证
本文介绍如何基于阿里云脚手架快速搭建SpringBoot工程(选用2.7.6版本),并整合Spring Security实现基础安全控制。内容涵盖项目创建、代码导入、Web依赖添加、接口编写与验证,以及Spring Security的引入与默认登录机制测试,最终通过浏览器访问验证权限控制功能。完整代码见GitHub仓库Day01分支。
|
6月前
|
Java Shell 测试技术
Jmeter快速入门
JMeter是基于JDK的性能测试工具,需先安装并配置JDK。下载解压后,通过双击或命令行启动,注意启动较慢且不可关闭黑窗口。可设置中文语言(临时或修改jmeter.properties永久生效)。基本使用包括创建线程组、添加HTTP取样器、配置请求参数及添加监听器(如结果树、汇总报告)查看测试结果。
|
6月前
|
SQL 安全 网络协议
常见的网络攻击
恶意软件、网络钓鱼、中间人攻击、DDoS攻击、SQL注入、零日漏洞及DNS隧道等是常见网络威胁。恶意软件通过漏洞入侵,窃取数据或破坏系统;网络钓鱼伪装可信来源骗取敏感信息;中间人攻击窃听通信;DDoS利用僵尸网络泛洪流量瘫痪服务;SQL注入操控数据库;零日攻击趁漏洞未修复时下手;DNS隧道则隐蔽传输恶意数据,危害网络安全。
|
6月前
|
缓存 Java Nacos
@RefreshScope热更新原理
@RefreshScope注解通过组合@Scope("refresh")实现配置热更新,利用代理模式与缓存机制。加注解的Bean被放入自定义作用域缓存,配置变更时清空缓存,触发Spring重新创建Bean,从而注入最新配置值,实现动态刷新。
|
6月前
|
存储 缓存 Java
自定义注解
本文介绍基于Spring AOP实现自定义注解的完整流程,涵盖日志记录、权限控制等场景。通过定义注解、结合AOP切面与过滤器,演示其在Web请求中的实际应用,如方法拦截、登录鉴权等,展现其扩展性与实用性。(238字)
|
6月前
|
存储 数据库
数据库设计三范式
数据库三范式是设计规范表结构的指导原则:第一范式要求字段原子性,不可再分;第二范式要求消除部分依赖,一张表只描述一件事;第三范式要求消除传递依赖。虽有助于减少冗余与维护成本,但实际设计应结合业务需求灵活应用,不必机械遵循。
|
6月前
|
存储 安全 Java
认证源码分析与自定义后端认证逻辑
本文深入分析Spring Security认证流程,从UsernamePasswordAuthenticationFilter到AuthenticationManager、ProviderManager,最终到UserDetailsService的实现原理,揭示了自定义数据库认证的关键步骤。通过实现UserDetailsService接口并重写loadUserByUsername方法,结合配置类注册服务,即可完成基于数据库的认证逻辑。核心在于返回包含权限信息的UserDetails对象,并将其存入SecurityContext,实现安全控制。附完整代码仓库及分支供参考学习。
|
6月前
|
SQL 安全 关系型数据库
了解SQL注入
SQL注入是利用Web应用输入验证缺陷,将恶意SQL代码植入数据库查询的攻击方式,可导致身份绕过、数据泄露、篡改甚至系统沦陷。常见于登录框、搜索栏等用户输入场景。防御需结合输入验证、参数化查询及IPS等多层机制,杜绝动态拼接SQL语句,防止攻击者操控执行逻辑,保障数据安全。