REST及RESTFUL入门

作者: 穿石小水滴 | 来源:发表于2018-05-17 16:16 被阅读62次

    REST -- Representational State Transfer (表现层状态转移),全称是 Resource Representational State Transfer,描述的是在网络中client和server的一种交互形式,即资源在网络中以某种表现形式进行状态转移,引用知乎大V的一句精辟概括:URL定位资源,用HTTP动词(GET,POST,DELETE,DETC)描述操作。
    Resource:资源,即数据;
    Representational:某种表现形式,比如用JSON,XML,JPEG等;
    State Transfer:状态变化。通过HTTP动词实现。
    REST出自于Roy Fielding的毕业论文。他曾参与设计HTTP协议,也是Apache Web Server项目(可惜现在已经是 nginx 的天下)的co-founder。
    论文地址:Architectural Styles and the Design of Network-based Software Architectures
    REST章节:Fielding Dissertation: CHAPTER 5: Representational State Transfer (REST)

    REST本身不实用,实用的是如何设计 RESTful API(REST风格的网络接口)。

    RESTFUL有什么用呢?
    随着移动互联网的发展,各种类型的Client层出不穷,如Web,iOS和Android,RESTFUL可以通过一套统一的接口为它们提供服务。另外对于像Facebook platform,微博开放平台,微信公共平台等广大平台,RESTFUL可以做出一套提供统一服务的接口,不需要显式的前端。

    RESTFUL的设计有以下原则:
    1.Server提供的RESTFUL API中,URL中只使用名词来指定资源,原则上不使用动词。“资源”是REST架构或者说整个网络处理的核心。比如:
    http://api.qc.com/v1/news: 获取新闻;
    http://api.qc.com/v1/friends: 获取好友列表;
    http://api.qc.com/v1/profile: 获取个人信息;
    2.用HTTP协议里的动词来实现资源的添加,修改,删除等操作。即通过HTTP动词来实现资源的状态扭转:
    GET 用来获取资源,
    POST 用来新建资源(也可以用于更新资源),
    PUT 用来更新资源,
    DELETE 用来删除资源。比如:
    DELETE http://api.qc.com/v1/friends: 删除某人的好友 (在http parameter指定好友id)
    POST http://api.qc.com/v1/friends: 添加好友
    UPDATE http://api.qc.com/v1/profile: 更新个人资料
    禁止使用: GET http://api.qc.com/v1/deleteFriend 这种前后都有动词的形式。
    3.Server和Client之间传递某资源的一个表现形式,比如用JSON,XML传输文本,或者用JPG,WebP传输图片等。当然还可以压缩HTTP传输时的数据(on-wire data compression)。
    4.用 HTTP Status Code传递Server的状态信息。比如最常用的 200 表示成功,500 表示Server内部错误等。

    总体来说呢,要有一个思想:Web端不再用之前典型的PHP或JSP架构,而是改为前端渲染和附带处理简单的商务逻辑(比如AngularJS或者BackBone的一些样例)。Web端和Server只使用上述定义的API来传递数据和改变数据状态。格式一般是JSON。对于iOS和Android是一样的道理。就是说,Web,iOS,Android和第三方开发者变为平等的角色通过一套API来共同消费Server提供的服务。

    另外,开发RESTFUL API时要养成好的习惯:
    1. URL root:
    https://example.org/api/v1/*
    https://api.example.com/v1/*
    2. API versioning:
    可以放在URL里面,也可以用HTTP的header:
    /api/v1/
    3. URI使用名词而不是动词,且推荐用复数。
    BAD

    • /getProducts
    • /listOrders
    • /retrieveClientByOrder?orderId=1

    GOOD

    • GET /products : will return the list of all products
    • POST /products : will add a product to the collection
    • GET /products/4 : will retrieve product #4
    • PATCH/PUT /products/4 : will update product #4

    4. 保证 HEAD 和 GET 方法是安全的,不会对资源状态有所改变(污染)。比如严格杜绝如下情况:
    GET /deleteProduct?id=1
    5. 资源的地址推荐用嵌套结构。比如:
    GET /friends/101751213/profile
    UPDATE /profile/primaryAddress/city6. 警惕返回结果的大小。如果过大,及时进行分页(pagination)或者加入限制(limit)。HTTP协议支持分页(Pagination)操作,在Header中使用 Link 即可。
    7. 使用正确的HTTP Status Code表示访问状态:HTTP/1.1: Status Code Definitions
    8. 在返回结果用明确易懂的文本(String。注意返回的错误是要给人看的,避免用 1001 这种错误信息),而且适当地加入注释。
    9. 关于安全:自己的接口就用https,加上一个key做一次hash放在最后即可。考虑到国情,HTTPS在无线网络里不稳定,可以使用Application Level的加密手段把整个HTTP的payload加密。有兴趣的朋友可以用手机连上电脑的共享Wi-Fi,然后用Charles监听微信的网络请求(发照片或者刷朋友圈)。
    如果是平台的API,可以用成熟但是复杂的OAuth2,新浪微博这篇:授权机制说明

    各端的具体实现
    如上面的图所示,Server统一提供一套RESTful API,web+ios+android作为同等公民调用API。各端发展到现在,都有一套比较成熟的框架来帮开发者事半功倍。

    -- Server --
    推荐: Spring MVC 或者 Jersey 或者 Play Framework
    教程:
    Getting Started · Building a RESTful Web Service

    -- Android --
    推荐: RetroFit ( Retrofit ) 或者 Volley ( mcxiaoke/android-volley · GitHub Google官方的被block,就不贴了 )
    教程:
    Retrofit โ�� Getting Started and Create an Android Client
    快速Android开发系列网络篇之Retrofit

    -- iOS --
    推荐:RestKit ( RestKit/RestKit · GitHub )
    教程:
    Developing RESTful iOS Apps with RestKit

    -- Web --
    推荐随便搞!可以用重量级的AngularJS,也可以用轻量级 Backbone + jQuery 等。
    教程:http://blog.javachen.com/2015/01/06/build-app-with-spring-boot-and-gradle/

    参考:
    [1]: Some REST best practices
    [2]: GitHub API v3
    [3]: tlhunter/consumer-centric-api-design · GitHub
    [4]: https://www.zhihu.com/question/28557115

    相关文章

      网友评论

      本文标题:REST及RESTFUL入门

      本文链接:https://www.haomeiwen.com/subject/ilbbdftx.html