Happy Coding, Happy Life

微服务实战(5) - HAL 101

| Comments

[如需转载,请联系本人]

过去的几个月,我作为独立咨询师,为多个传统企业提供了微服务架构的培训、咨询以及交付工作。在这些企业中,大部分的开发者对微服务的理解,以“银弹观念”为主。实际上,传统企业在过去多年的业务积累中,由于组织架构、业务发展和市场竞争等综合因素,技术体系相对封闭,缺乏快速交付的理念。因此,微服务的出现,加之社区的热捧,导致这种现象出现也是比较能理解的。

经过2015年的快速普及,微服务的优势被越来越多的传统组织和企业所认可,但由于架构相关的知识本身比较抽象,虽然各大会议上有很多互联网公司的案例分享,但开发者似乎依然很难全面了解微服务架构。

所以,希望通过本系列的文章,以一个模拟的案例为背景,以持续交付和DevOps为主线,帮助初学者理解微服务架构,并能通过动手实验,了解相关的实践以及方法论。

精彩课程已经出炉,请移步这里

综述

REST API通常作为服务间协作的轻量级通信协议(语言无关、平台无关),被微服务架构广泛采用。

在微服务架构的中,如何有效的设计REST API,如何处理API响应中资源的依赖关系,服务规模化后如何提高服务团队间的协作效率…..这些都成为微服务实践中API设计面临的挑战。

本篇将介绍REST、REST成熟度模型、为什么使用HAL以及HAL的核心。

REST 101

REST(Representational State Transfer,表述性状态传递)是近几年使用广泛的架构风格之一。在微服务架构的实践中,REST经常作为服务间协作的轻量级通信协议(语言无关、平台无关)被采用。

REST从语义层面将响应结果定义为资源,并使用HTTP协议的标准动词映射为对资源的操作,形成了一种以资源为核心、以HTTP协议为操作方式的,与语言无关、平台无关的服务间的通信机制。

通过资源表述、状态转移以及统一接口,REST将客户端的请求、服务器端的响应基于资源联系起来,形成一种以资源为核心、以HTTP协议为操作方式的,与语言无关、平台无关的通信机制。

同时,由于HTTP协议本身的无状态性,使用REST,能够有效保持服务应用的无状态型,并利于水平伸缩。

REST 成熟度模型

REST成熟度模型描述了REST在实施过程中不同的级别。

REST不是银弹

随着组织业务的不断增长,服务规模化的实施,以及响应内容复杂度的增加,REST的使用面临如下两个挑战:

  • 如何标准化资源结构

使用REST,需要将业务场景的响应抽象为资源,并基于JSON或者XML的格式,返回给客户端。随着业务复杂度的增加,响应的内容会愈发复杂。

REST架构风格,并没有定义响应结构应该遵循什么标准。这也就意味着,在企业内部,不同的部门,不同的开发团队,对同一类资源,所定义的结构可能不尽相同;

譬如,如下是服务器端对客户端获取产品请求的的响应结果,两种结构都是合理的,但存在着差异

GET http://bookstore.com/books/12 
Accept: application/json

响应结构一
{  
    "name":"Spring Boot In Action",  
    "category": "Book",  
    "price":69.00,  
    "ref": "http://bookstore.com/books/12",
    "created_at": "2015-05-01 10:00:00",
    "updated_at": "2015-06-01 11:00:00"
}  

响应结构二
{
  "basic_info":
  {
    "name":"Spring Boot In Action",
    "category":"Book"
    "price":69.00,
  },

  "ref":{
    "self": "http://bookstore.com/books/12”,
    “list": "http://bookstore.com/books"
  },

  "timestamp":{
    "created_at": "2015-05-01 10:00:00",
    "updated_at": "2015-06-01 11:00:00"
  }
}

因此,如何定义一套标准的资源响应结构,成为服务规模化后使用REST面临的一个挑战。

  • 如何处理资源的跳转链接

《Richardson Maturity Model》模型中,定义了REST API不同成熟度应该具备的特征。

对于REST API Level 3,明确提出了”资源跳转的重要性”,即HATEOAS

对于实际情况而言,大部分REST的实现,都是基于JSON作为传输格式,不过JSON最大的遗憾,正如W3C所描述的:

JSON has no built-in support for hyperlinks, which are a fundamental building block on the Web.

没有对超链接处理做内建的支持,是JSON最大的遗憾。而这部分却恰恰是互联网的基石。

这带来的潜在问题是,对于调用接口的Consumer而言,需要通过查看相关文档,才能了解如何获取相关的资源信息。譬如,某些社交系统可能会提供类似如下的接口文档,来帮助Consumer了解如何使用其提供的接口。

https://api.example.com/users/1234567890      GET 获取用户明细
https://api.example.com/users/[ID]/friends    GET 获取用户相关的好友
https://api.example.com/users/[ID]/posts      GET 获取用户相关的文章

HAL 101

HAL(Hypertext Application Language)是一种轻量级超文本应用描述协议。HAL的实现基于REST,并对REST中资源结构无法标准化和不支持资源间跳转链接做了有效的互补。

目前,越来越多的企业和组织开始使用HAL提供标准化的服务接口,譬如

更多案例请可以参考HAL官方网站

HAL的核心

在HAL中,任何响应都被定义成一种资源(Resource),这是遵循REST原则对资源的定义标准。 同REST不同的是,在每个资源中,HAL又将其分成了如下三个标准的部分:

  • 状态(Resource State) - 通常指资源本身固有的属性,如之前提到的book的title、price等
  • 链接(Links) - 定义了与当前资源相关的资源链接的集合
  • 子资源(Embedded Resource) - 描述在当前资源的内部,其嵌套的资源。

使用HAL定义单一资源(Resource)

对于单一资源而言,如果没有使用HAL,通常我们会定义成这样:

GET - /api/users/wldandan
Content-Type: application/json

{
    "id": "wldandan",
    "name": "Wang Lei",
    "email": "useremail@email.com",
    "wechat": "abcdefg"
}   

如果要访问用户相关的联系人资源,则可能需要查看文档获取相应的API接口,或者将相关信息放在之前返回的结果里:

{
    "id": "wldandan",
    "name": "Wang Lei",
    "email": "useremail@email.com",
    "wechat": "abcdefg",
    "contacts": [
        {
            "id": "chenyue",
            "name": "Chen Yue"
            "link": "/api/users/chenyue"
        },
        {
            "id": "kouxi",
            "name": "Kou Xi"
            "link": "/api/users/chenyue"
        }
    ]
}   

如果基于HAL,则可以使用_links描述相关链接,同时使用_embedded描述嵌套资源,类似如下:

{
    "_links": {
        "self": {
            "href": "http://example.org/api/users/wldandan"
        }
    },
    "id": "wldandan",
    email: 'useremail@email.com',
    "name": "Wang Lei"
    wechat: 'abcdefg',

    "_embedded": {
        "contacts": [
        {
            "_links": {
                "self": {
                    "href": "http://example.org/api/users/chenyue"
                }
            },
            "id": "chenyue",
            "name": "Chen Yue"
        },
        {
            "_links": {
                "self": {
                    "href": "http://example.org/api/users/kouxi"
                }
            },
            "id": "kouxi",
            "name": "Kou Xi"
        }
        ]
    }
}

使用HAL定义集合资源(Collection Resource)

对于集合资源而言,如果没有使用HAL,通常我们会定义成这样:

GET - /api/users
Content-Type: application/json

{
    total: 10
    page: 5
    page_size: 2
    users: [
    {
        id: 'wldandan',
        name: 'Wang Lei'
    },
    {
        id: 'chenyue',
        name: 'Chen Yue'
    },
    ]
}

基于HAL,则使用_links描述相关链接,同时使用_embedded描述嵌套资源,类似则如下所示:

{
    "_links": {
        "self": {
            "href": "http://example.org/api/users?page=3"
        },
        "first": {
            "href": "http://example.org/api/users"
        },
        "prev": {
            "href": "http://example.org/api/users?page=2"
        },
        "next": {
            "href": "http://example.org/api/users?page=4"
        },
        "last": {
            "href": "http://example.org/api/users?page=5"
        }
    },
    "page_size": 2,
    "total": 10,
    "page": 5,
    "_embedded": {
        "users": [
            {
                "_links": {
                    "self": {
                        "href": "http://example.org/api/users/wldandan"
                    }
                },
                "id": "wldandan",
                "name": "Wang Lei"
            },
            {
                "_links": {
                    "self": {
                        "href": "http://example.org/api/user/chenyue"
                    }
                },
                "id": "chenyue",
                "name": "Chen Yue"
            }
        ]
    }
}

所以,HAL的最大价值,帮助我们标准化定义了Resource的结构,并同时实现了HATEOAS。

关于课程更多内容,请看这里

参考资料

Hypertext Application Language

JSON Linking with HAL

Creating Service Contract with AutoRest, Swagger and HAL

Implementing HAL hypermedia REST API using Spring HATEOAS

HAL Specification

hal-discuss@google groups

HAL+JSON

Documenting REST APIs – a tooling review

HAL Primer

Comments

comments powered by Disqus