Skip to main content

运行和部署

由于Tornado提供自己的HTTPServer,运行和部署它与其他Python Web框架有点不同。您不必配置WSGI容器来查找应用程序,而是编写一个启动服务器的 main() 函数:

def main():
    app = make_app()
    app.listen(8888)
    IOLoop.current().start()

if __name__ == '__main__':
    main()

配置操作系统或进程管理器以运行此程序来启动服务器。请注意,可能需要增加每个进程打开的文件数(以避免“打开的文件太多” - 错误)。要提高此限制(例如,将其设置为50000),可以使用ulimit命令,修改/etc/security/limits.conf或在supervisord配置中设置 minfds

进程和端口

由于Python GIL(全局解释器锁),有必要运行多个Python进程以充分利用多CPU机器。通常最好每个CPU运行一个进程。

Tornado包括一个内置的多进程模式,可以一次启动多个进程。这需要对标准主要功能稍作改动:

def main():
    app = make_app()
    server = tornado.httpserver.HTTPServer(app)
    server.bind(8888)
    server.start(0)  # forks one process per cpu
    IOLoop.current().start()

这是启动多个进程的最简单的方法,并且它们都共享同一个端口,尽管它有一些限制。首先,每个子进程将有自己的IOLoop,所以重要的是,在fork之前没有任何东西能够触及全局IOLoop实例(甚至是间接的)。第二,在这个模型中很难做零停机更新。最后,由于所有进程共享相同的端口,因此更难以单独监视它们。

对于更复杂的部署,建议独立启动进程,并让每个进程在不同的端口上侦听。 超级 的“过程组”特性是安排这个的一个好方法。当每个进程使用不同的端口时,通常需要外部负载平衡器(如HAProxy或nginx)向外部访问者提供单个地址。

在负载均衡器后面运行

当在负载平衡器(如nginx)后面运行时,建议将 xheaders=True 传递给 HTTPServer 构造函数。这将告诉Tornado使用头像 X-Real-IP 来获取用户的IP地址,而不是将所有流量归因于平衡器的IP地址。

这是一个准系统nginx配置文件,在结构上类似于我们在FriendFeed使用的。它假设nginx和Tornado服务器在同一台机器上运行,并且四个Tornado服务器在端口8000 - 8003上运行:

user nginx;
worker_processes 1;

error_log /var/log/nginx/error.log;
pid /var/run/nginx.pid;

events {
    worker_connections 1024;
    use epoll;
}

http {
    # Enumerate all the Tornado servers here
    upstream frontends {
        server 127.0.0.1:8000;
        server 127.0.0.1:8001;
        server 127.0.0.1:8002;
        server 127.0.0.1:8003;
    }

    include /etc/nginx/mime.types;
    default_type application/octet-stream;

    access_log /var/log/nginx/access.log;

    keepalive_timeout 65;
    proxy_read_timeout 200;
    sendfile on;
    tcp_nopush on;
    tcp_nodelay on;
    gzip on;
    gzip_min_length 1000;
    gzip_proxied any;
    gzip_types text/plain text/html text/css text/xml
               application/x-javascript application/xml
               application/atom+xml text/javascript;

    # Only retry if there was a communication error, not a timeout
    # on the Tornado server (to avoid propagating "queries of death"
    # to all frontends)
    proxy_next_upstream error;

    server {
        listen 80;

        # Allow file uploads
        client_max_body_size 50M;

        location ^~ /static/ {
            root /var/www;
            if ($query_string) {
                expires max;
            }
        }
        location = /favicon.ico {
            rewrite (.*) /static/favicon.ico;
        }
        location = /robots.txt {
            rewrite (.*) /static/robots.txt;
        }

        location / {
            proxy_pass_header Server;
            proxy_set_header Host $http_host;
            proxy_redirect off;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Scheme $scheme;
            proxy_pass http://frontends;
        }
    }
}

静态文件和侵略性文件缓存

您可以通过在应用程序中指定 static_path 设置来提供来自Tornado的静态文件:

settings = {
    "static_path": os.path.join(os.path.dirname(__file__), "static"),
    "cookie_secret": "__TODO:_GENERATE_YOUR_OWN_RANDOM_VALUE_HERE__",
    "login_url": "/login",
    "xsrf_cookies": True,
}
application = tornado.web.Application([
    (r"/", MainHandler),
    (r"/login", LoginHandler),
    (r"/(apple-touch-icon\.png)", tornado.web.StaticFileHandler,
     dict(path=settings['static_path'])),
], **settings)

此设置将自动使从 /static/ 开始的所有请求从该静态目录提供,例如,http://localhost:8888/static/foo.png 将从指定的静态目录提供文件 foo.png。我们还从静态目录自动提供 /robots.txt/favicon.ico (即使它们不以 /static/ 前缀开头)。

在上面的设置中,我们已经明确配置了Tornado从根目录为 StaticFileHandler 服务 apple-touch-icon.png,尽管它在物理上位于静态文件目录中。 (该正则表达式中的捕获组必须告诉 StaticFileHandler 所请求的文件名;请记住捕获组作为方法参数传递给处理程序。)您可以执行同样的操作。 sitemap.xml 从站点根。当然,您也可以通过在HTML中使用适当的 <link /> 标记来避免伪造根 apple-touch-icon.png

为了提高性能,浏览器通常积极地缓存静态资源,以便浏览器不会发送可能阻止页面呈现的不必要的 If-Modified-SinceEtag 请求,这是一个好主意。 Tornado支持这种开箱即用的 静态内容版本控制

要使用此功能,请在模板中使用 static_url 方法,而不要直接在HTML中键入静态文件的URL:

<html>
   <head>
      <title>FriendFeed - {{ _("Home") }}</title>
   </head>
   <body>
     <div><img src="{{ static_url("images/logo.png") }}"/></div>
   </body>
 </html>

static_url() 函数将该相对路径翻译为看起来像 /static/images/logo.png?v=aae54 的URI。 v 参数是 logo.png 中内容的哈希,它的存在使Tornado服务器向用户的浏览器发送缓存头,这将使浏览器无限期地缓存内容。

由于 v 参数是基于文件的内容,如果您更新文件并重新启动服务器,它将开始发送新的 v 值,因此用户的浏览器将自动获取新文件。如果文件的内容不更改,浏览器将继续使用本地缓存的副本,而不会检查服务器上的更新,从而显着提高呈现性能。

在生产中,您可能希望从一个更优化的静态文件服务器(如 nginx)提供静态文件。您可以配置大多数任何Web服务器以识别 static_url() 使用的版本标记,并相应地设置缓存标题。这里是我们在FriendFeed使用的nginx配置的相关部分:

location /static/ {
    root /var/friendfeed/static;
    if ($query_string) {
        expires max;
    }
 }

调试模式和自动重新加载

如果将 debug=True 传递给 Application 构造函数,应用程序将以调试/开发模式运行。在此模式下,将启用用于方便开发的几个功能(每个功能也可用作单个标志;如果指定了两个功能,则单个标志优先):

  • autoreload=True:应用程序将监视其源文件的更改,并在任何更改时重新加载。这减少了在开发期间手动重新启动服务器的需要。但是,某些故障(例如导入时的语法错误)仍然可能导致服务器停机,调试模式目前无法从中恢复。

  • compiled_template_cache=False:模板不会被缓存。

  • static_hash_cache=False:静态文件哈希值(由 static_url 函数使用)不会被缓存

  • serve_traceback=True:当 RequestHandler 中的异常未被捕获时,将生成包括堆栈跟踪的错误页面。

自动重新加载模式与 HTTPServer 的多进程模式不兼容。如果使用自动重新加载模式,则不能给 HTTPServer.start 1以外的参数(或调用 tornado.process.fork_processes)。

调试模式的自动重新加载功能作为 tornado.autoreload 中的独立模块提供。这两个可以组合使用,以提供额外的鲁棒性对语法错误:设置 autoreload=True 在应用程序内检测更改,而它正在运行,并启动它与 python -m tornado.autoreload myserver.py 捕获任何语法错误或其他错误在启动时。

重载会丢失任何Python解释器命令行参数(例如 -u),因为它使用 sys.executablesys.argv 重新执行Python。此外,修改这些变量将导致重新加载的行为不正确。

在某些平台(包括10.6和10.6之前的Windows和Mac OSX)上,进程不能“就地”更新,因此当检测到代码更改时,旧服务器退出并启动新的。这已知为混淆一些IDE。

WSGI和Google App Engine

Tornado通常意在自己运行,没有WSGI容器。但是,在某些环境(例如Google App Engine)中,只允许WSGI,应用程序无法运行自己的服务器。在这种情况下,Tornado支持有限的操作模式,它不支持异步操作,但允许在仅WSGI环境中使用Tornado的功能子集。在WSGI模式中不允许的功能包括协同程序,@asynchronous 装饰器,AsyncHTTPClientauth 模块和WebSockets。

您可以将Tornado Application 转换为具有 tornado.wsgi.WSGIAdapter 的WSGI应用程序。在此示例中,配置您的WSGI容器以查找 application 对象:

import tornado.web
import tornado.wsgi

class MainHandler(tornado.web.RequestHandler):
    def get(self):
        self.write("Hello, world")

tornado_app = tornado.web.Application([
    (r"/", MainHandler),
])
application = tornado.wsgi.WSGIAdapter(tornado_app)

请参阅 appengine示例应用程序 了解在Tornado上构建的全功能AppEngine应用程序。