Java RESTful风格编程和 RESTful架构详解

ゞ浴缸里的玫瑰 2022-07-16 00:16 231阅读 0赞

首先看下restful风格编程和非restful风格编程 url 区别：

rest风格可能是 [ http://blog.csdn.net/yuxin6866/article/details/52305132][http_blog.csdn.net_yuxin6866_article_details_52305132]  
如果是非rest风格有可能是[http://blog.csdn.net/yuxin6866?viewmode=list][http_blog.csdn.net_yuxin6866_viewmode_list]

# 理解RESTful架构 #

越来越多的人开始意识到，网站即软件，而且是一种新型的软件。

这种"互联网软件"采用客户端/服务器模式，建立在分布式体系上，通过互联网通信，具有高延时（high latency）、高并发等特点。

网站开发，完全可以采用软件开发的模式。但是传统上，软件和网络是两个不同的领域，很少有交集；软件开发主要针对单机环境，网络则主要研究系统之间的通信。互联网的兴起，使得这两个领域开始融合，现在我们必须考虑，如何开发在互联网环境中使用的软件。

![bg2011091202.jpg][]

RESTful架构，就是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用。

但是，到底什么是RESTful架构，并不是一个容易说清楚的问题。下面，我就谈谈我理解的RESTful架构。

一、起源

REST这个词，是[Roy Thomas Fielding][]在他2000年的[博士论文][Link 1]中提出的。

![bg2011091201.jpg][]

Fielding是一个非常重要的人，他是HTTP协议（1.0版和1.1版）的主要设计者、Apache服务器软件的作者之一、Apache基金会的第一任主席。所以，他的这篇论文一经发表，就引起了关注，并且立即对互联网开发产生了深远的影响。

他这样介绍论文的写作目的：

> "本文研究计算机科学两大前沿----软件和网络----的交叉点。长期以来，软件研究主要关注软件设计的分类、设计方法的演化，很少客观地评估不同的设计选择对系统行为的影响。而相反地，网络研究主要关注系统之间通信行为的细节、如何改进特定通信机制的表现，常常忽视了一个事实，那就是改变应用程序的互动风格比改变互动协议，对整体表现有更大的影响。我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、适宜通信的架构。"
> 
> (This dissertation explores a junction on the frontiers of two research disciplines in computer science: software and networking. Software research has long been concerned with the categorization of software designs and the development of design methodologies, but has rarely been able to objectively evaluate the impact of various design choices on system behavior. Networking research, in contrast, is focused on the details of generic communication behavior between systems and improving the performance of particular communication techniques, often ignoring the fact that changing the interaction style of an application can have more impact on performance than the communication protocols used for that interaction. My work is motivated by the desire to understand and evaluate the architectural design of network-based application software through principled use of architectural constraints, thereby obtaining the functional, performance, and social properties desired of an architecture. )

二、名称

Fielding将他对互联网软件的架构原则，定名为REST，即Representational State Transfer的缩写。我对这个词组的翻译是"表现层状态转化"。

如果一个架构符合REST原则，就称它为RESTful架构。

要理解RESTful架构，最好的方法就是去理解Representational State Transfer这个词组到底是什么意思，它的每一个词代表了什么涵义。如果你把这个名称搞懂了，也就不难体会REST是一种什么样的设计。

三、资源（Resources）

REST的名称"表现层状态转化"中，省略了主语。"表现层"其实指的是"资源"（Resources）的"表现层"。

所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。

所谓"上网"，就是与互联网上一系列的"资源"互动，调用它的URI。

四、表现层（Representation）

"资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式，叫做它的"表现层"（Representation）。

比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。

URI只代表资源的实体，不代表它的形式。严格地说，有些网址最后的".html"后缀名是不必要的，因为这个后缀名表示格式，属于"表现层"范畴，而URI应该只代表"资源"的位置。它的具体表现形式，应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对"表现层"的描述。

五、状态转化（State Transfer）

访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态的变化。

互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"（State Transfer）。而这种转化是建立在表现层之上的，所以就是"表现层状态转化"。

客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。

六、综述

综合上面的解释，我们总结一下什么是RESTful架构：

（1）每一个URI代表一种资源；

（2）客户端和服务器之间，传递这种资源的某种表现层；

（3）客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

七、误区

RESTful架构有一些典型的设计误区。

最常见的一种设计错误，就是URI包含动词。因为"资源"表示一种实体，所以应该是名词，URI不应该有动词，动词应该放在HTTP协议中。

举例来说，某个URI是/posts/show/1，其中show是动词，这个URI就设计错了，正确的写法应该是/posts/1，然后用GET方法表示show。

如果某些动作是HTTP动词表示不了的，你就应该把动作做成一种资源。比如网上汇款，从账户1向账户2汇款500元，错误的URI是：

> 　　POST /accounts/1/transfer/500/to/2

正确的写法是把动词transfer改成名词transaction，资源不能是动词，但是可以是一种服务：

> 　　POST /transaction HTTP/1.1  
> 　　Host: 127.0.0.1  
> 　　  
> 　　from=1&to=2&amount=500.00

另一个设计误区，就是在URI中加入版本号：

> 　　http://www.example.com/app/1.0/foo
> 
> 　　http://www.example.com/app/1.1/foo
> 
> 　　http://www.example.com/app/2.0/foo

因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URI。版本号可以在HTTP请求头信息的Accept字段中进行区分（参见[Versioning REST Services][]）：

> 　　Accept: vnd.example-com.foo+json; version=1.0
> 
> 　　Accept: vnd.example-com.foo+json; version=1.1
> 
> 　　Accept: vnd.example-com.foo+json; version=2.0

（完）

### 文档信息 ###

*  版权声明：自由转载-非商用-非衍生-保持署名（[创意共享3.0许可证][3.0]）
 *  发表日期： 2011年9月12日
 *  更多内容： [档案][Link 2] » [开发者手册][Link 3]
 *  购买文集：[![Image 1][] 《如何变得有思想》][Image 1_]
 *  社交媒体：[![Image 1][] twitter][Image 1_ twitter]，[![Image 1][] weibo][Image 1_ weibo]
 *  Feed订阅： [![Image 1][]][Image 1 1]

## 相关文章 ##

*  2016.09.13: [Content Security Policy 入门教程][Content Security Policy]
    
    跨域脚本攻击 XSS 是最常见、危害最大的网页安全漏洞。
 *  2016.09.10: [亚马逊如何变成 SOA（面向服务的架构）？][SOA]
    
    上一篇文章，我摘录了《程序员的呐喊》。这本书有趣的内容太多，今天再摘录一段。
 *  2016.09.08: [程序员小测试：保守派 vs 自由派][vs]
    
    最近，我在阅读 Steve Yegg 的文集《程序员的呐喊》。
 *  2016.09.03: [软件架构入门][Link 4]
    
    软件架构（software architecture）就是软件的基本结构。

## 广告[（购买广告位）][Link 5] ##

[![饥人谷][sup-jirengu.jpg]][sup-jirengu.jpg 1]

## 留言（109条） ##

[徐杰][Link 6] 说：

关注博主的博客有一段时间了。我想问下博主这个博文网站用什么技术实现的。最近在学网站开发语言，博主能否说的详细点，感激不尽！

2011年9月12日 16:49 | [\#][Link 7] | [引用][Link 8]

darasion 说：

设计误区里边列出的，很多都这么设计啊。有什么不好吗？

2011年9月12日 17:20 | [\#][Link 9] | [引用][Link 8]

lanisle 说：

简洁有力，表述连贯且清晰。谢谢阮兄。  
祝中秋快乐！

2011年9月12日 17:36 | [\#][Link 10] | [引用][Link 8]

[崔大鹏][Link 11] 说：

网站即软件，我也早意识到这个问题了。阮兄中秋快乐！

2011年9月12日 21:19 | [\#][Link 12] | [引用][Link 8]

ssddi456 说：

按我的理解：  
这种交互模式相当于设计一个函数，函数内部（服务器）过程对客户端不可见，客户端只传递参数接受结果。  
URI的设计就好象设计参数形式，函数的功能已经包含在网站本身不言自明，不需要再列出来。

2011年9月12日 22:53 | [\#][Link 13] | [引用][Link 8]

风海迷沙 说：

asp.net mvc程序员路过，area/controller/view/pram 谁用谁知道。

2011年9月12日 23:16 | [\#][Link 14] | [引用][Link 8]

[张翼][Link 15] 说：

一直都有听说rest这个东西，但是没有认真研究过。这篇文章给了一个不错的入门介绍。谢谢！

能够再列出一些你找到的关于rest的网上的资源？我想再详细了解一下。

中秋快乐！

2011年9月13日 04:46 | [\#][Link 16] | [引用][Link 8]

liws 说：

>     引用风海迷沙的发言：
> 
> asp.net mvc程序员路过，area/controller/view/pram 谁用谁知道。

这种URL是最不友好的，全是程序员按照自己的编程思路定制的URL,很多都不符合产品要求

2011年9月13日 09:29 | [\#][Link 17] | [引用][Link 8]

乱发吹风 说：

用".html", ".json", ".xml"来表示表述类型, 以及在URI上加入版本号, 在实际使用中会更简单直观一些.

因为网站管理员检查HTTP日志时, 大多数(一般为GET)情况下直接看URI就可以了解问题所在.  
而这对于RESTful接口的应用开发者, 也会更方便一些

你的博客内容感觉比较偏科普一些, 其实可以写得再深入一些, 或者可以把你的资料来源也列出来, 方便有兴趣进一步学习的读者去查阅.

2011年9月13日 09:53 | [\#][Link 18] | [引用][Link 8]

[ls zhao][] 说：

网站，基于网络的应用软件，基于PC的本地应用软件...  
那整个互联网可以看成是一个软件，分为不同的部分

2011年9月13日 12:39 | [\#][Link 19] | [引用][Link 8]

[limu][] 说：

感谢分享.有两个问题,  
1.post和put的区别,何时用put?我看文章里说更新用哪个都可以,新增用post.为什么?  
2.关于最后版本处理那块,JavaScript操作http的accept值还是有些困难,有没有替代方案,放在URL参数中么?另外httpserver支持通过accept版本决定投递什么资源么?浏览器支持按不同的accept分别缓存资源么?

2011年9月13日 13:27 | [\#][Link 20] | [引用][Link 8]

[linyang][] 说：

楼主的理解非常的好, 有一些我想补充, 顺别回答其它一些朋友的问题.

根据理查德森模型 (http://martinfowler.com/articles/richardsonMaturityModel.html), REST架构的成熟度有3个等级:  
Level 0 POX (这个就不算REST了)  
Level 1 Resources  
Level 2 Http verbs  
Level 3 Hypermedia Controls

楼主所表述的模型在level 2上, 这也是目前大多数RESTful的应用所在的成熟度.

Level 0 POX  
这类应用只有一个URI上的上帝接口, 根据交换的XML内容操作所有的资源. 往往导致上帝接口越来越复杂, 越来越难以维护.

Level 1 Resources  
这一级别主要解决了上帝接口的问题, 使得各种资源有了自己相应的URI, 虽然仍然是POX的交互方式, 但是每一个接口都更加紧凑和内聚, 相应的容易维护起来.  
这里的主要问题是URI templating和URI tunneling.  
URI templating带来的结果是服务器端和客户端的紧耦合, 任何时候服务器段想改变自身的URL schema的时候, 都要break已经存在的客户端应用.  
URI tunneling带来的问题包含URI templating, 而且放弃了使用http协议标准带来的任何好处, level 2中详述.  
早期的rails routes就是url templating/tunneling. Rails3中已经更加靠近level 2了.

2011年9月13日 14:07 | [\#][Link 21] | [引用][Link 8]

[linyang][] 说：

Level 2 Http verbs  
这一级别使用http verbs来对各种资源进行crud操作, 使得应用程序的接口更加的统一, 语义更加明确. 同时, 因为遵照http的标准进行交互, 很多http提供的好处几乎可以免费的得到.

1. Cache  
按照HTTP协议, GET操作是安全的, 幂等(Idempotent)的. 任意多次对同一资源的GET操作, 都不会导致资源的状态变化. 所以GET的结果是可以安全的cache. 所有http提供的cache facilities 都可以被利用起来, 大幅度提高应用程序的性能. 甚至你仅仅只在response里加上cache directives就可以免费获得网络上各级的缓存服务器, 代理服务器, 以及用户客户端的缓存支持. 互联网上几乎所有的应用你都可以粗略统计得到Get VS Non-Get的请求比例约为 4:1. 如果你能为GET操作加上缓存, 那将极大提供你的程序的性能.  
2. Robust  
在HTTP常用的几个动词里, HEAD, GET, PUT, DELETE 是安全的,幂等的. 因为对同一资源的任意多次请求, 永远代表同一个语义. 所以任何时候客户端发出去这些动词的时候, 如果服务器没有响应, 或者返回错误代码, 客户端都可以非常安全的再次执行同一操作而不用担心重复操作带来不同的语义及最终结果. POST, PATCH操作就不是安全的, 因为当客户端向服务器端发出请求后, 服务器没有响应或者返回错误代码, 客户端是不能安全的重复操作的. 一定只能重新与服务器确认现在的资源状态才能决定下一步的操作.

绝大部分的RESTful应用就停在这里了, 当然也满足绝大多的需求.

2011年9月13日 14:07 | [\#][Link 22] | [引用][Link 8]

[linyang][] 说：

Level 3  
RESTful的架构本意是"在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、适宜通信的架构。"  
这个世界上规模最大的, 耦合度最低, 最稳定的, 性能最好的分布式网络应用是什么? 就是WEB本身.  
规模,稳定,性能都不用说了. 为什么说耦合度低呢? 想一想每个人上网的经历, 你几乎不需要任何培训就可以上一个新的网络购物平台挑选商品,用信用卡付款,邮寄到自己家里.  
把网站的程序想像成一个状态机, 用户在一系列状态转换中完成自己的目标. 这中间的每一步, 应用程序都告诉你当前的状态和可能的下一步操作, 最终引导用户从挑选商品,挑选更多商品,到支付页面,到输入信用卡信息,最终完成付费,到达状态机的终点.

这种service discoverablility和self-documenting就是level 3想解决的问题

在这里面, 告诉用户当前状态以及各种下一步操作的东西, 比如链接, 按钮等等, 就是Hypermedia Controls. Hypermedia Controls 就是这个状态机的引擎.

Level 3的REST架构就是希望能够统一这一类的Hypermedia Controls, 赋予他们标准的, 高度可扩展的标准语义及表现形式, 使得甚至无人工干预的机器与机器间的通用交互协议边的可能. 比如你可以告诉一个通用的购物客户端, "给我买个最便宜的xbox", 客户端自动连上google进行搜索, 自动在前10个购物网站进行搜索, 进行价格排序, 然后自动挑选最便宜的网站, 进行一系列操作最终完成用信用卡付费, 填写个人收件地址然后邮寄.

这些都依赖于Hypermedia Controls带来的这种service discoverablility和self-documenting

更多的关于REST的细节及其应用和实现, 请参考Rest in Practice. 非常非常棒的一本书, 把REST讲的非常透彻.

个人的理解难免有所偏颇, 还请大家批评指正

转自：http://www.ruanyifeng.com/blog/2011/09/restful.html

> 在了解Angularjs和Backbonejs这些前端框架的时候，发现这些先进的前端框架都是支持REST风格的服务端API。目前本人只是对REST有个大概的了解，希望能够把新的比较先进的架构引入到手头上的项目，但是有一个疑问：REST风格能不能应对数据结构还不成熟，开发期需要频繁增加数据库字段的情况。

[http_blog.csdn.net_yuxin6866_article_details_52305132]: http://blog.csdn.net/yuxin6866/article/details/52305132
[http_blog.csdn.net_yuxin6866_viewmode_list]: http://blog.csdn.net/yuxin6866?viewmode=list
[bg2011091202.jpg]: http://image.beekka.com/blog/201109/bg2011091202.jpg
[Roy Thomas Fielding]: http://en.wikipedia.org/wiki/Roy_Fielding
[Link 1]: http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm
[bg2011091201.jpg]: http://image.beekka.com/blog/201109/bg2011091201.jpg
[Versioning REST Services]: http://www.informit.com/articles/article.aspx?p=1566460
[3.0]: http://creativecommons.org/licenses/by-nc-nd/3.0/deed.zh
[Link 2]: http://www.ruanyifeng.com/blog/archives.html
[Link 3]: http://www.ruanyifeng.com/blog/developer/
[Image 1]: 
[Image 1_]: http://www.ruanyifeng.com/blog/2014/12/my-blog-book.html
[Image 1_ twitter]: https://twitter.com/ruanyf
[Image 1_ weibo]: http://weibo.com/ruanyf
[Image 1 1]: http://www.ruanyifeng.com/feed.html
[Content Security Policy]: http://www.ruanyifeng.com/blog/2016/09/csp.html
[SOA]: http://www.ruanyifeng.com/blog/2016/09/how_amazon_take_soa.html
[vs]: http://www.ruanyifeng.com/blog/2016/09/conservative_vs_liberal_programmer.html
[Link 4]: http://www.ruanyifeng.com/blog/2016/09/software-architecture.html
[Link 5]: http://www.ruanyifeng.com/support.html
[sup-jirengu.jpg]: http://www.ruanyifeng.com/blog/images/sup-jirengu.jpg
[sup-jirengu.jpg 1]: /images/20220716/e0e6ed754610420b8b5649d2ba5c5d0c.png
[Link 6]: http://user.qzone.qq.com/306072706/infocenter
[Link 7]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227765
[Link 8]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-text
[Link 9]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227767
[Link 10]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227768
[Link 11]: http://www.cuidapeng.cn/
[Link 12]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227777
[Link 13]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227783
[Link 14]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227785
[Link 15]: http://www.litetea.com/
[Link 16]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227802
[Link 17]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227815
[Link 18]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227817
[ls zhao]: http://cutenotes.wordpress.com/
[Link 19]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227827
[limu]: http://limu.iteye.com/
[Link 20]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227830
[linyang]: http://linyang/
[Link 21]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227832
[Link 22]: http://www.ruanyifeng.com/blog/2011/09/restful.html#comment-227833