Tornado 4.3文檔翻譯: 用戶指南-運行和部署

時間 2019-11-15

標籤 tornado 4.3 文檔翻譯用戶指南運行部署欄目 Python 简体版

原文原文鏈接

譯者說

Tornado 4.3於2015年11月6日發佈，該版本正式支持Python3.5的async/await關鍵字，而且用舊版本CPython編譯Tornado一樣可使用這兩個關鍵字，這無疑是一種進步。其次，這是最後一個支持Python2.6和Python3.2的版本了，在後續的版本了會移除對它們的兼容。如今網絡上尚未Tornado4.3的中文文檔，因此爲了讓更多的朋友能接觸並學習到它，我開始了這個翻譯項目，但願感興趣的小夥伴能夠一塊兒參與翻譯，項目地址是tornado-zh on Github，翻譯好的文檔在Read the Docs上直接能夠看到。歡迎Issues or PR。javascript

運行和部署

由於Tornado內置了本身的HTTPServer, 運行和部署它與其餘Python web框架不太同樣. 你須要寫一個main()函數來啓動服務, 而不是配置一個WSGI容器來運行你的應用:css

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配置中.html

進程和端口

因爲Python的GIL(全局解釋器鎖), 爲了充分利用多CPU的機器, 運行多個Python
進程是頗有必要的. 一般, 最好是每一個CPU運行一個進程.java

Tornado包含了一個內置的多進程模式來一次啓動多個進程. 這須要一個在main
函數上作點微小的改變:node

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)更新. 最後, 由於全部的進程共享相同的端口, 想單獨監控它們就更加困難了.python

對更復雜的部署, 建議啓動獨立的進程, 並讓它們各自監聽不一樣的端口. supervisord的"進程組(process groups)"功能是一個很好的方式來安排這些. 當每一個進程使用不一樣的端口, 一個外部的負載均衡器例如HAProxy 或nginx一般須要對外向訪客提供一個單一的地址.nginx

運行在負載均衡器後面

當運行在一個負載均衡器例如nginx, 建議傳遞xheaders=True 給.HTTPServer 的構造器. 這將告訴Tornado使用相似 X-Real-IP這樣的HTTP頭來獲取用戶的IP地址而不是把全部流量都認爲來自於負載均衡器的IP地址.git

這是一份原始的nginx配置文件, 在結構上相似於咱們在FriendFeed所使用的配置. 這是假設nginx和Tornado server運行在同一臺機器上的, 而且四個Tornado server正運行在8000 - 8003端口:github

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 來提供靜態文件服務:web

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目錄進行提供,e.g.,http://localhost:8888/static/foo.png 將會經過指定的static目錄提供 foo.png 文件. 咱們也自動的會從static目錄提供 /robots.txt和 /favicon.ico (儘管它們並無以 /static/ 前綴開始).

在上面的設置中, 咱們明確的配置Tornado 提供 apple-touch-icon.png文件從 .StaticFileHandler 根下, 雖然文件在static文件目錄中.(正則表達式捕獲組必須告訴 .StaticFileHandler 請求的文件名; 調用捕獲組把文件名做爲方法的參數傳遞給處理程序.) 你能夠作一樣的事情 e.g.從網站的根提供 sitemap.xml 文件. 固然, 你也能夠經過在你的HTML中使用<link /> 標籤來避免僞造根目錄的 apple-touch-icon.png .

爲了改善性能, 一般狀況下, 讓瀏覽器主動緩存靜態資源是個好主意, 這樣瀏覽器就不會發送沒必要要的可能在渲染頁面時阻塞的 If-Modified-Since 或Etag 請求了. Tornado使用 靜態內容版本(static content versioning)來支持此項功能.

爲了使用這些功能, 在你的模板中使用 ~.RequestHandler.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 <.TCPServer.start> 傳遞1之外的參數(或者調用tornado.process.fork_processes) 當你使用自動重載模式的時候.

debug模式的自動重載功能可做爲一個獨立的模塊位於tornado.autoreload.如下二者能夠結合使用, 在語法錯誤之時提供額外的健壯性: 設置autoreload=True 能夠在app運行時檢測文件修改, 還有啓動python -m tornado.autoreload myserver.py 來捕獲任意語法錯誤或者其餘的啓動時錯誤.

重載會丟失任何Python解釋器命令行參數(e.g. -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 把一個TornadoApplication 轉換成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 example application 以瞭解AppEngine在Tornado上開發的完整功能.