运行和部署

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

import asyncio

async def main():
    app = make_app()
    app.listen(8888)
    await asyncio.Event().wait()

if __name__ == '__main__':
    asyncio.run(main())

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

进程和端口

由于 Python GIL(全局解释器锁)的存在,需要运行多个 Python 进程才能充分利用多 CPU 机器。通常,最好为每个 CPU 运行一个进程。

最简单的方法是在 listen() 调用中添加 reuse_port=True,然后简单地运行应用程序的多个副本。

Tornado 还可以从单个父进程启动多个进程(请注意,这在 Windows 上不起作用)。这需要对应用程序启动进行一些更改。

def main():
    sockets = bind_sockets(8888)
    tornado.process.fork_processes(0)
    async def post_fork_main():
        server = TCPServer()
        server.add_sockets(sockets)
        await asyncio.Event().wait()
    asyncio.run(post_fork_main())

这是启动多个进程并让它们共享同一个端口的另一种方法,尽管它有一些限制。首先,每个子进程将拥有自己的 IOLoop,因此在 fork 之前,任何东西都不能接触全局 IOLoop 实例(即使是间接的)。其次,在此模型中很难进行零停机更新。最后,由于所有进程共享同一个端口,因此更难以单独监控它们。

对于更复杂的部署,建议独立启动进程,并让每个进程监听不同的端口。 supervisord 的“进程组”功能是组织此操作的一种好方法。当每个进程使用不同的端口时,通常需要使用 HAProxy 或 nginx 等外部负载均衡器来向外部访问者呈现单个地址。

在负载均衡器后运行

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

这是一个与我们在 FriendFeed 中使用的配置结构类似的 nginx 基本配置文件。它假设 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/ 开头的请求,并从该静态目录提供服务,例如 https://127.0.0.1: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 的多进程模式不兼容。如果您使用自动重新加载模式,则不能将除 1 以外的参数传递给 HTTPServer.start(或调用 tornado.process.fork_processes)。

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

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

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