用 Python、 RabbitMQ 和 Nameko 实现微服务

"微服务是一股新浪潮" - 现如今，将项目拆分成多个独立的、可扩展的服务是保障代码演变的最好选择。在 Python 的世界里，有个叫做 “Nameko” 的框架，它将微服务的实现变得简单并且强大。

微服务

在最近的几年里，“微服务架构”如雨后春笋般涌现。它用于描述一种特定的软件应用设计方式，这种方式使得应用可以由多个独立部署的服务以服务套件的形式组成。 - M. Fowler

推荐各位读一下 Fowler 的文章[1] 以理解它背后的原理。

好吧，那它究竟意味着什么呢？

简单来说，微服务架构可以将你的系统拆分成多个负责不同任务的小的（单一上下文内）功能块responsibilities blocks，它们彼此互无感知，各自只提供用于通讯的通用指向common point。这个指向通常是已经将通讯协议和接口定义好的消息队列。

这里给大家提供一个真实案例

案例的代码可以通过 github: http://github.com/rochacbruno/nameko-example 访问，查看 service 和 api 文件夹可以获取更多信息。

想象一下，你有一个 REST API ，这个 API 有一个端点（LCTT 译注：REST 风格的 API 可以有多个端点用于处理对同一资源的不同类型的请求）用来接受数据，并且你需要将接收到的数据进行一些运算工作。那么相比阻塞接口调用者的请求来说，异步实现此接口是一个更好的选择。你可以先给用户返回一个 "OK - 你的请求稍后会处理" 的状态，然后在后台任务中完成运算。

同样，如果你想要在不阻塞主进程的前提下，在计算完成后发送一封提醒邮件，那么将“邮件发送”委托给其他服务去做会更好一些。

场景描述

用代码说话

让我们将系统创建起来，在实践中理解它：

环境

我们需要的环境：

• 运行良好的 RabbitMQ（LCTT 译注：RabbitMQ[2] 是一个流行的消息队列实现）

• 由 VirtualEnv 提供的 Services 虚拟环境

• 由 VirtualEnv 提供的 API　虚拟环境

Rabbit

在开发环境中使用 RabbitMQ 最简单的方式就是运行其官方的 docker 容器。在你已经拥有 Docker 的情况下，运行：

1. docker run -d --hostname my-rabbit --name some-rabbit -p 15672:15672 -p 5672:5672 rabbitmq:3-management

在浏览器中访问 http://localhost:15672 ，如果能够使用 guest:guest 验证信息登录 RabbitMQ 的控制面板，说明它已经在你的开发环境中运行起来了。

服务环境

现在让我们创建微服务来满足我们的任务需要。其中一个服务用来执行计算任务，另一个用来发送邮件。按以下步骤执行：

在 Shell 中创建项目的根目录

1. $ mkdir myproject

2. $ cd myproject

用 virtualenv 工具创建并且激活一个虚拟环境（你也可以使用 virtualenv-wrapper）

1. $ virtualenv service_env

2. $ source service_env/bin/activate

安装 nameko 框架和 yagmail

1. (service_env)$ pip install nameko

2. (service_env)$ pip install yagmail

服务的代码

现在我们已经准备好了 virtualenv 所提供的虚拟环境（可以想象成我们的服务是运行在一个独立服务器上的，而我们的 API 运行在另一个服务器上），接下来让我们编码，实现 nameko 的 RPC 服务。

我们会将这两个服务放在同一个 python 模块中，当然如果你乐意，也可以把它们放在单独的模块里并且当成不同的服务运行：

在名为 service.py 的文件中

1. import yagmail

2. from nameko.rpc import rpc, RpcProxy

4. class Mail(object):

5.    name = "mail"

7.    @rpc

8.    def send(self, to, subject, contents):

9.        yag = yagmail.SMTP('[email protected]', 'mypassword')

10.        # 以上的验证信息请从安全的地方进行读取

11.        # 贴士: 可以去看看 Dynaconf 设置模块

12.        yag.send(to=to.encode('utf-8),

13.                 subject=subject.encode('utf-8),

14.                 contents=[contents.encode('utf-8)])

16. class Compute(object):

17.    name = "compute"

18.    mail = RpcProxy('mail')    

20.    @rpc

21.    def compute(self, operation, value, other, email):

22.        operations = {'sum': lambda x, y: int(x) + int(y),

23.                      'mul': lambda x, y: int(x) * int(y),

24.                      'div': lambda x, y: int(x) / int(y),

25.                      'sub': lambda x, y: int(x) - int(y)}

26.        try:

27.            result = operations[operation](value, other)

28.        except Exception as e:

29.            self.mail.send.async(email, "An error occurred", str(e))

30.            raise

31.        else:

32.            self.mail.send.async(

33.                email,

34.                "Your operation is complete!",

35.                "The result is: %s" % result

36.            )

37.            return result

现在我们已经用以上代码定义好了两个服务，下面让我们将 Nameko RPC service 运行起来。

注意：我们会在控制台中启动并运行它。但在生产环境中，建议大家使用 supervisord 替代控制台命令。

在 Shell 中启动并运行服务

1. (service_env)$ nameko run service --broker amqp://guest:guest@localhost

2. starting services: mail, compute

3. Connected to amqp://guest:**@127.0.0.1:5672//

4. Connected to amqp://guest:**@127.0.0.1:5672//

测试

在另外一个 Shell 中（使用相同的虚拟环境），用 nameko shell 进行测试：

1. (service_env)$ nameko shell --broker amqp://guest:guest@localhost

2. Nameko Python 2.7.9 (default, Apr  2 2015, 15:33:21)

3. [GCC 4.9.2] shell on linux2

4. Broker: amqp://guest:guest@localhost

5. >>>

现在你已经处在 RPC 客户端中了，Shell 的测试工作是通过 n.rpc 对象来进行的，它的使用方法如下：

1. >>> n.rpc.mail.send("[email protected]", "testing", "Just testing")

上边的代码会发送一封邮件，我们同样可以调用计算服务对其进行测试。需要注意的是，此测试还会附带进行异步的邮件发送。

1. >>> n.rpc.compute.compute('sum', 30, 10, "[email protected]")

2. 40

3. >>> n.rpc.compute.compute('sub', 30, 10, "[email protected]")

4. 20

5. >>> n.rpc.compute.compute('mul', 30, 10, "[email protected]")

6. 300

7. >>> n.rpc.compute.compute('div', 30, 10, "[email protected]")

8. 3

在 API 中调用微服务

在另外一个 Shell 中（甚至可以是另外一台服务器上），准备好 API 环境。

用 virtualenv 工具创建并且激活一个虚拟环境（你也可以使用 virtualenv-wrapper）

1. $ virtualenv api_env

2. $ source api_env/bin/activate

安装 Nameko、 Flask 和 Flasgger

1. (api_env)$ pip install nameko

2. (api_env)$ pip install flask

3. (api_env)$ pip install flasgger

注意： 在 API 中并不需要 yagmail ，因为在这里，处理邮件是服务的职责

创建含有以下内容的 api.py 文件：

1. from flask import Flask, request

2. from flasgger import Swagger

3. from nameko.standalone.rpc import ClusterRpcProxy

5. app = Flask(__name__)

6. Swagger(app)

7. CONFIG = {'AMQP_URI': "amqp://guest:guest@localhost"}

10. @app.route('/compute', methods=['POST'])

11. def compute():

12.    """

13.    Micro Service Based Compute and Mail API

14.    This API is made with Flask, Flasgger and Nameko

15.    ---

16.    parameters:

17.      - name: body

18.        in: body

19.        required: true

20.        schema:

21.          id: data

22.          properties:

23.            operation:

24.              type: string

25.              enum:

26.                - sum

27.                - mul

28.                - sub

29.                - div

30.            email:

31.              type: string

32.            value:

33.              type: integer

34.            other:

35.              type: integer

36.    responses:

37.      200:

38.        description: Please wait the calculation, you'll receive an email with results

39.    """

40.    operation = request.json.get('operation')

41.    value = request.json.get('value')

42.    other = request.json.get('other')

43.    email = request.json.get('email')

44.    msg = "Please wait the calculation, you'll receive an email with results"

45.    subject = "API Notification"

46.    with ClusterRpcProxy(CONFIG) as rpc:

47.        # asynchronously spawning and email notification

48.        rpc.mail.send.async(email, subject, msg)

49.        # asynchronously spawning the compute task

50.        result = rpc.compute.compute.async(operation, value, other, email)

51.        return msg, 200

53. app.run(debug=True)

在其他的 shell 或者服务器上运行此文件

1. (api_env) $ python api.py

2. * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

然后访问 http://localhost:5000/apidocs/index.html 这个 url，就可以看到 Flasgger 的界面了，利用它可以进行 API 的交互并可以发布任务到队列以供服务进行消费。

注意： 你可以在 shell 中查看到服务的运行日志，打印信息和错误信息。也可以访问 RabbitMQ 控制面板来查看消息在队列中的处理情况。

Nameko 框架还为我们提供了很多高级特性，你可以从 https://nameko.readthedocs.org/en/stable/ 获取更多的信息。