Tornado5.11官方文档翻译(8)-用户手册-运行与部署

导航

用户指南

运行与部署

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

1
2
3
4
5
6
7
def main():
app = make_app()
app.listen(8888)
IOLoop.current().start()

if __name__ == '__main__':
main()

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

进程和端口

由于Python GIL(Global Interpreter Lock 全局解释器锁),需要时可以运行多个Python进程以充分利用多核机器性能。通常,每个CPU最好运行一个进程。 Tornado包含一个内置的多进程模式,可以同时启动多个进程。 这需要对标准主要功能稍作改动:

1
2
3
4
5
6
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实例是很重要的。 其次,在此模型中很难进行不停机更新。最后,由于所有进程共享同一个端口,因此很难对它们进行独立的监控。 对于更复杂的部署,建议单独启动进程,并让每个进程侦听不同的端口。supervisord的“进程组”功能是实现此功能的一种好方法。当每个进程使用不同的端口时,通常需要外部负载均衡器(如HAProxy或nginx)向外部访问者提供统一的地址。

运行于负载均衡器之后

在像nginx这样的负载均衡器后面运行时,建议将xheaders = True传递给HTTPServer构造函数。这将告诉Tornado使用像X-Real-IP这样的标头来获取用户的IP地址,而不是将所有流量识别为负载均衡服务器的IP地址。 这是一个准系统nginx配置文件,其结构类似于我们在FriendFeed上使用的配置文件。它假定nginx和Tornado服务器在同一台机器上运行,并且四个Tornado服务器分别运行于端口8000 - 8003:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
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中的静态文件:

1
2
3
4
5
6
7
8
9
10
11
12
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/前缀开头)。 在上面的设置中,我们已经明确地使用StaticFileHandler将Tornado配置为从根路径即可访问到apple-touch-icon.png,尽管实际上该文件存放在静态文件目录中。 (为了告诉StaticFileHandler所请求的文件名,正则表达式中的匹配组是必需的;请记住,匹配组将作为方法参数传递给处理程序。)你可以执行相同的操作来访问站点根目录的sitemap.xml。 当然,您也可以通过在HTML中使用相应的<link />标记来避免伪造从根目录访问apple-touch-icon.png。 为了提高性能,浏览器通常会主动地缓存静态资源,因此浏览器不会发送不必要的If-Modified-SinceEtag请求,因为这些可能阻止页面的渲染。TornadoTornado支持这种开箱即用的静态内容版本控(static content versioning)。。 要使用此功能,请在模板中使用static_url方法,而不是直接在HTML中键入静态文件的URL:

1
2
3
4
5
6
7
8
<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配置:

1
2
3
4
5
6
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.executable和sys.argv重新执行Python。 此外,修改这些变量将导致重新加载出错。 在某些平台(包括Windows和10.6之前的Mac OSX)上,该过程无法“就地”更新,因此当检测到代码更改时,旧服务器退出并启动新服务器。 众所周知,这会混淆一些IDE。

WSGI和Google App Engine

Tornado通常并不使用WSGI容器,而是独立运行。 但是,在某些环境(例如Google App Engine)中,只允许WSGI,并且应用程序无法运行自己的服务器。 在这种情况下,Tornado支持有限的操作模式,该模式不支持异步操作,但允许在仅WSGI环境中使用Tornado功能的子集。 WSGI模式中不允许的功能包括协程,@ asynchronous装饰器,AsyncHTTPClientauth模块和WebSockets。 你可以使用tornado.wsgi.WSGIAdapter将Tornado应用程序转换为WSGI应用程序。 在此示例中,配置WSGI容器以查找应用程序对象:

1
2
3
4
5
6
7
8
9
10
11
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应用程序。


Tornado5.11官方文档翻译(8)-用户手册-运行与部署
https://www.shangyexin.com/2019/01/17/deploy/
作者
Yasin
发布于
2019年1月17日
许可协议