部署

注解

本节所讨论的是将 WeRoBot 作为独立服务运行情况下的部署操作。 如果你希望将 WeRoBot 集成到其他 Web 框架内,请阅读 与其他 Web 框架集成

在独立服务器上部署

使用 werobot.run 来启动 WSGI 服务器

你可以在 werobot.config 中配置好 WeRoBot 需要监听的地址和端口号, 然后使用 werobot.run 来启动服务器

  1. import werobot
  2. robot = werobot.WeRoBot(token='tokenhere')
  3. @robot.handler
  4. def echo(message):
  5. return'Hello World!'
  6. robot.config['HOST']='0.0.0.0'
  7. robot.config['PORT']=80
  8. robot.run()

注解

你需要 root 或管理员权限才能监听 1024 以下的端口。

你可以通过传递 server 参数来手动指定使用的服务器

  1. import werobot
  2. robot = werobot.WeRoBot(token='tokenhere')
  3. @robot.handler
  4. def echo(message):
  5. return'Hello World!'
  6. robot.config['HOST']='0.0.0.0'
  7. robot.config['PORT']=80
  8. robot.run(server='gevent')

server 支持以下几种:

  • cgi

  • flup

  • wsgiref

  • waitress

  • cherrypy

  • paste

  • fapws3

  • tornado

  • gae

  • twisted

  • diesel

  • meinheld

  • gunicorn

  • eventlet

  • gevent

  • rocket

  • bjoern

  • auto

当 server 为 auto 时, WeRoBot 会自动依次尝试以下几种服务器:

  • Waitress

  • Paste

  • Twisted

  • CherryPy

  • WSGIRef

所以,只要你安装了相应的服务器软件,就可以使用 werobot.run 直接跑在生产环境下。

注解

server 的默认值为 auto

注意

WSGIRef 的性能非常差, 仅能用于开发环境。 如果你要在生产环境下部署 WeRoBot , 请确保你在使用其他 server 。

通过 WSGI HTTP Server 运行 WeRoBot

werobot.wsgi 暴露了一个 WSGI Application ,你可以使用任何你喜欢的 WSGI HTTP Server 来部署 WeRoBot。 比如, 如果你想用 Gunicorn 来部署

  1. # FileName: robot.py
  2. from werobot importWeRoBot
  3. robot =WeRoBot()

那么你只需要在 Shell 下运行

  1. gunicorn robot:robot.wsgi

就可以了。

使用 Supervisor 管理守护进程

请注意, werobot.run 是跑在 非守护进程模式下 的——也就是说,一旦你关闭终端,进程就会自动退出。

我们建议您使用 Supervisor 来管理 WeRoBot 的进程。

配置文件样例:

  1. [program:wechat_robot]
  2. command = python /home/<username>/robot.py
  3. user =<username>
  4. redirect_stderr =true
  5. stdout_logfile =/home/<username>/logs/robot.log
  6. stdout_errfile =/home/<username>/logs/robot_error.log

使用 Nginx 进行反向代理

微信服务器只支持80端口的机器人——显然,你的服务器上不会只跑着一个微信机器人。对于这种情况,我们建议您使用 Nginx 来进行反向代理。

配置文件样例:

  1. server {
  2. server_name example.com;
  3. listen 80;
  4. location /{
  5. proxy_pass_header Server;
  6. proxy_redirect off;
  7. proxy_pass http://127.0.0.1:12233;
  8. }
  9. }

注解

在这个例子中, WeRoBot 的端口号为 12233。你应该在微信管理后台中将服务器地址设为 http://example.com

在SAE上部署

注意

Version 1.11.0 开始,WeRoBot 停止测试 SAE 相关部分的代码。

新浪云上的 Python 应用的入口为 index.wsgi:application ,也就是 index.wsgi 这个文件中名为 application 的 callable object。

所以,假设你在 robot.py 中使用了 WeRoBot

  1. # filename: robot.py
  2. import werobot
  3. robot = werobot.WeRoBot(token='tokenhere')
  4. @robot.handler
  5. def echo(message):
  6. return'Hello World!'

你需要再创建一个 index.wsgi 文件, 里面写

  1. import sae
  2. from robot import robot
  3. application = sae.create_wsgi_app(robot.wsgi)

然后按照 SAE 的要求编写好 config.yaml 文件就可以了。 可以参考 示例仓库

如果你希望使用 SAE 提供的 KVDB 存储 Session 数据, 可以选择 werobot.session.saekvstorage 作为你的 Session Storage.