不要盲目遵循 RESTFUL 接口规范
最近在优化公司的接口规范,原有的规范文档里面规定服务端要严格遵循RESTFUL风格的接口,但是实际执行下来很多开发人员根本没有按照RESTFUL接口规范来,当然这个里面很多是执行层面问题,但是也有另外一个问题:很多业务接口根本不适应RESTFUL规范。
这两天我也翻阅了很多文章,大部分文章在讲RESTFUL规范的时候都只是停留在理论阶段,只是说到RESTFUL标准是什么(URL名词化、用GET/POST/PUT/DELETE替代URL中动作、用HTTP状态码作为返回的CODE等),很少有说到在项目中如何解决一些应用RESTFUL的实际问题,比如:登入、登出、批量增加、复杂查询、导入导出这些接口如何定义。一般实际项目中都会有很多这种不同于CRUD的API接口,这些API接口用RESTFUL标准去强行适配是不合适的。
结合网上的一些文章,我总结下自己对RESTFUL引用的一些个人观点:
1、不要盲目跪舔RESTFUL标准,RESTFUL标准并不能适用所有情况。
2、不忙从不是否定,RESTFUL在很多时候是适用的,所以在很多情况下还是要遵循RESTFUL的一些标准,比如Openapi对外的接口要求上就可以尽量遵循RESTFUL标准,保证一致性,但是对内就没必要完全遵循了。
3、针对不适应的情况,可以考虑采用JSON-RPC标准,也就是“post /命名空间/资源/动作”这种方式,这种也是我在很多项目上看到的命名规则,包括很多大厂都是这种命名方式。
所以任何规范和架构设计都要结合实际情况来,不能盲从。
上一篇: k8s 无法找到命名空间资源
下一篇: JAVA 进程和线程
推荐阅读
-
不要盲目遵循 RESTFUL 接口规范
-
玩转Java底层:JMX详解 - jconsole与自定义MBean监控工具的实际应用与区别" 在日常JVM调优中,我们熟知的jconsole工具通过JMX包装的bean以图形化形式展示管理数据,而像jstat和jmap这类内建监控工具则由JVM直接支持。本文将以jconsole为例,深入讲解其实质——基于JMX的MBean功能,包括可视化界面上的bean属性查看和操作调用。 MBeans在jconsole中的体现是那些可观察的组件属性和方法,如上图所示,通过名为"Verbose"的属性能看到其值为false,同时还能直接操作该bean的方法,例如"closeJerryMBean"。 尽管jconsole给我们提供了直观的可视化界面,但请注意,这里的MBean并非固定不变,开发者可根据JMX提供的接口将自己的自定义bean展示到jconsole。以下步骤展示了如何创建并注册一个名为"StudyJavaMBean"的自定义MBean: 1. 首先定义接口`StudyJavaMBean`,接口需遵循MBean规范,即后缀为"MBean"且包含getter方法代表属性,如`getApplicationName`,和无返回值的setter方法代表操作,如`closeJerryMBean`。 ```java public interface StudyJavaMBean { String getApplicationName(); void closeJerryMBean(); } ``` 2. 编写接口的实现类`StudyJavaMBeanImpl`,实现接口中的方法: ```java public class StudyJavaMBeanImpl implements StudyJavaMBean { @Override public String getApplicationName() { return "每天学Java"; } @Override public void closeJerryMBean() { System.out.println("关闭Jerry应用"); } } ``` 3. 在代码中注册自定义MBean,涉及的关键步骤包括: - 获取平台MBeanServer - 定义ObjectName,指定唯一的MBean标识符 - 注册MBean到服务器 - 启动RMI连接器服务,以便jconsole能够访问 ```java public void registerMBean() throws Exception { // ... 具体实现省略 ... } ``` 实际运行注册后的MBean,您将在jconsole中发现并查看自定义bean的属性和调用相关方法。然而,这种方式相较于传统的属性/日志查看和HTTP接口,实用性相对有限,可能存在潜在的安全风险。但不可否认的是,JMX及其MBean机制对于获取操作系统信息、内存状态等关键性能指标仍然具有重要价值。例如: 1. **获取操作系统信息**:通过JMX MBean,可以直接获取到诸如CPU使用率、操作系统版本等系统级信息,这对于资源管理和优化工作具有显著帮助。
-
【RESTful】 案例-数据库设计 | RESTful API 接口设计规范重新解读