OpenStack设计与实现5——RESTful API和WSGI

Tips：文章为拜读@xingjiarong 后有感而做的分享，先对作者表示感谢，附原文地址：http://blog.csdn.net/xingjiarong

0. 引言

• 在上一篇博客中我们提到过，OpenStack每个项目内部的服务进程之间是通过消息总线来通讯的，而在各个项目之间则是通过RESTful API来进行通讯的，在这一篇博客中，我们就来详细的讨论一下OpenStack各个项目之间的通讯。

1. 什么是RESTful

• RESTful是目前最流行的一种互联网软件架构。REST（Representational State Transfer，表述性状态转移），如果一个架构符合REST原则，就称它为RESTful架构。

• RESTful架构的核心概念就是“资源”，在RESTful的世界里，网络上的所有东西都是资源，比如一段文本，一张图片都可以看作是资源。每一个资源都对应着一个特定的URI（统一资源定位符）并用它进行标记。

• 每一个资源都有多种表现形式，我们上网的过程，就是调用资源的URI，获取它不同表现形式的过程。也就是说，服务器保存了资源的各种表现形式，客户端可以使用HTTP的几个基本操作，包括GET、POST、PUT等使服务端上的资源发生“状态转化”，这就是为什么叫做“表述性状态转移”。

• OpenStack各个项目都提供了RESTful架构的API作为对外提供的接口，也就是说，OpenStack定义了很多的资源，并实现了针对这些资源的各种操作函数。OpenStack的API服务进程接收到客户端的HTTP请求时，一个所谓的”路由“模块就会将请求的URL转化成相应的资源，并路由到合适的操作函数上。

• 我们以nova list命令为例来看一下具体的流程。

  1. 首先客户端使用http发送请求，说明要调用nova list命令了。

  2. Rails是OpenStack所使用的路由模块，收到HTTP请求后，将这个请求指派到对应的Controller，并且绑定一个action。

  3. 每个Controller都对应了一个RESTful资源，代表了对该资源的操作集合，其中包含了很多Action。因为Rails指定了要执行index的action，所以该Controller就调用index函数。

2. 什么是WSGI

• RESTful只是设计风格而不是标准，而WSGI（Web Server Gateway Interface，Web 服务器网关接口）则是python语言中所定义的Web服务器和Web应用程序之间或框架之间的通用接口标准。

• WSGI就是一座桥梁，桥梁的一端称为服务端或网关端，另一端称为应用端或者框架端，WSGI的作用就是在协议之间进行转化。

• WSGI将Web组件分成了三类：Web 服务器（WSGI Server）、Web中间件（WSGI Middleware）与Web应用程序（WSGI Application）。

• Web Server接收HTTP请求，封装一系列环境变量，按照WSGI接口标准调用注册的WSGI Application，最后将响应返回给客户端。

• WSGI Application是一个可被调用的Python对象，它接受两个参数，通常为environ和start_response。比如：

  def application(environ, start_response):
  start_response('200 OK', [('Content-Type', 'text/plain')])
  yield 'Hello World\n'

• 参数environ指向一个python字典，要求里面至少包含了一些在CGI中定义的环境变量已经WSGI所定义的环境变量，WSGI应用可以从environ中获取相对应的请求及其执行上下文的所有信息。

• 参数start_response指向一个回调函数，回调函数负责执行客户端的请求并且返回结果。当有请求到来时，WSGI Server会准备好environ和start_response参数，然后调用WSGI Application获得对应请求的响应。

• WSGI中间件同时实现了服务端和应用端的API，因此可以在两端之间起协调作用。从服务器看起来，中间件就是一个WSGI应用；从应用端看起来，中间件则是一个WSGI服务器。WSGI中间件可以将客户端的HTTP请求路由给不同的应用对象，然后将应用处理后的结果返回给客户端。我们可以将WSGI中间件理解为服务端和应用端交互的一层包装，经过不同中间件的包装，便具有不同的功能。

3. Paste和Webob

• Paste和Webob是与OpenStack密切相关的两个组件。

3.1 Paste

• OpenStack使用Paste的Deploy组件来完成WSGI服务器和应用的构建，每个项目源码etc目录下都有一个Paste配置文件，例如nova中的，如下图所示。

• Paste配置文件分为过个section，每个section以type:name的格式命名，具体的可以参考官网源码。使用Paste Deploy的主要目的就是从配置文件中生成一个WSGI Application，有了配置文件之后，只需要使用下面的调用方式：

  wsgi_app = loadapp('config:/path/to/config.ini')

3.2 Webob

• Webob通过对WSGI的请求与响应进行封装来简化WSGI应用的编写。Webob中两个最重要的对象，一是webob.Request，对WSGI请求的environ参数进行封装，一是webob.Response,包含了标准WSGI响应的所有要素。来看一个例子：

• 原始的WSGI格式：
  app_iter = myfunc(environ, start_response)

• 使用webob封装之后：
  def myfunc(req):
  return webob.Response('hey there')
  resp = myfunc(req)