Python Web框架Tornado运行和部署

运行和部署

由于Tornado内置了本身的HTTPServer，运行和部署它与其余Python web框架不太同样。你须要写一个main()函数来启动服务，而不是配置一个WSGI容器来运行你的应用:

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

if __name__ == '__main__':
    main()

配置你的操做系统或者进程管理器来运行这个程序以启动服务。注意，增长每一个进程容许打开的最大文件句柄数是多是必要的(为了不“Too many open files” 的错误)。为了增长这个上限(例如设置为50000 ) 你可使用ulimit命令，修改/etc/security/limits.conf 或者设置minfds 在你的supervisord配置中。

进程和端口

因为Python的GIL(全局解释器锁)，为了充分利用多CPU的机器，运行多个Python 进程是颇有必要的。一般，最好是每一个CPU运行一个进程。

Tornado包含了一个内置的多进程模式来一次启动多个进程，这须要一个在main 函数上作点微小的改变:

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 实例是重要的(甚至是间接的)。其次，在这个模型中，很难作到零停机 (zero-downtime)更新。最后，由于全部的进程共享相同的端口，想单独监控它们就更加困难了。

对更复杂的部署，建议启动独立的进程，并让它们各自监听不一样的端口， supervisord 的“进程组(process groups)”功能是一个很好的方式。当每一个进程使用不一样的端口，一个外部的负载均衡器，例如HAProxy或nginx一般须要对外向访客提供一个单一的地址。

运行在负载均衡器后面

当运行在一个负载均衡器例如nginx，建议传递xheaders=True 给 HTTPServer 的构造器。这将告诉Tornado使用相似 X-Real-IP 这样的HTTP头来获取用户的IP地址而不是把全部流量都认为来自于负载均衡器的IP地址。

这是一份原始的nginx配置文件，在结构上相似于咱们在FriendFeed所使用的配置。这是假设nginx和Tornado server运行在同一台机器上的，而且四个 Tornado server 正运行在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;
        }
    }
}

静态文件和文件缓存

Tornado中，你能够经过在应用程序中指定特殊的 static_path 来提供静态文件服务：

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/ 开头的请求交由static目录，例如http://localhost:8888/static/foo.png 将会经过指定的static目录提供 foo.png 文件。咱们也会自动从static目录提供 /robots.txt 和 /favicon.ico (尽管它们并无以 /static/ 前缀开始)。

在上面的设置中，咱们明确的配置Tornado从 StaticFileHandler 根下获取 apple-touch-icon.png 文件，虽然文件在static文件目录中。(正则表达式捕获组必须告诉 StaticFileHandler 请求的文件名，调用捕获组把文件名做为方法的参数传递给处理程序) 你能够作一样的事情，好比从网站的根提供 sitemap.xml 文件。 固然，你也能够经过在你的HTML中使用 <link /> 标签来避免伪造根目录的 apple-touch-icon.png 。

为了改善性能，一般状况下，让浏览器主动缓存静态资源是个好主意， 这样浏览器就不会发送没必要要的可能在渲染页面时阻塞的 If-Modified-Since 或 Etag 请求了， Tornado使用 静态内容版本(static content versioning) 来支持此项功能。

为了使用这些功能，在你的模板中使用 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() 函数将把相对路径翻译成一个URI相似于 /static/images/logo.png?v=aae54.其中的 v 参数是 logo.png 内容的哈希(hash)，而且它的存在使得Tornado服务向用户的浏览器发送缓存头，这将使浏览器无限期的缓存内容。

由于参数 v 是基于文件内容的，若是你更新一个文件并重启服务，它将发送一个新的 v 值，因此用户的浏览器将会自动的拉去新的文件。若是文件的内容没有改变，浏览器将会继续使用本地缓存的副本，而不会从服务器检查更新，显著的提升了渲染性能。

在生产中，你可能想提供静态文件经过一个更优的静态服务器， 好比nginx，你能够配置任何web服务器识别经过 static_url() 提供的版本标签并相应的设置缓存头。下面是咱们在 FriendFeed 使用的nginx相关配置的一部分:

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

Debug模式和自动重载

若是传递 debug=True 配置给 Application 的构造函数，应用程序将会运行在debug/开发模式。 在这个模式下，为了方便于开发的一些功能将被启用( 每个也能够做为独立的标签使用，若是它们都被专门指定，那它们都将得到独立的优先级):

• autoreload=True: 应用程序将会观察它的源文件是否改变，而且当任何文件改变的时候便重载它本身。这减小了在开发中须要手动重启服务的需求。然而，在debug模式下，某些错误(例如import的时候有语法错误)会致使服务 关闭，而且没法自动恢复。
• compiled_template_cache=False: 模板将不会被缓存。
• static_hash_cache=False: 静态文件哈希 (被 static_url 函数使用) 将不会被缓存。
• serve_traceback=True: 当一个异常在 RequestHandler 中没有捕获，将会生成一个包含调用栈信息的错误页。

自动重载(autoreload)模式和 HTTPServer 的多进程模式不兼容，你不能给 HTTPServer.start 传递 1 之外的参数(或者调用 tornado.process.fork_processes) 当你使用自动重载模式的时候。

debug模式的自动重载功能可做为一个独立的模块位于 tornado.autoreload。如下二者能够结合使用，在语法错误之时提供额外的健壮性: 设置 autoreload=True 能够在app运行时检测文件修改，还有启动 python -m tornado.autoreload myserver.py 来捕获任意语法错误或者其余的启动时错误。

重载会丢失任何Python解释器命令行参数(-u). 由于它使用 sys.executable 和 sys.argv 从新执行Python。此外，修改这些变量将形成重载错误。

在一些平台(包括Windows 和Mac OSX 10.6以前)，进程不能被“原地”更新，因此当检测到代码更新，旧服务就会退出而后启动一个新服务。这已经被公知来混淆一些IDE。

WSGI和Google App Engine

Tornado一般是独立运行的，不须要一个WSGI容器。然而，在一些环境中 (例如Google App Engine)，只运行WSGI，应用程序不能独立运行本身的服务。在这种状况下，Tornado支持一个有限制的操做模式，不支持异步操做但容许一个Tornado’s功能的子集在仅WSGI环境中。如下功能在WSGI模式下是不支持的，包括协程，@asynchronous 装饰器，AsyncHTTPClient，auth 模块和WebSockets。

你可使用 tornado.wsgi.WSGIAdapter 把一个Tornado Application 转换成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)

EN：http://www.tornadoweb.org/en/stable/guide/running.html