文章/答案/技术大牛

发布

社区首页 >专栏 >tornado基础

tornado基础

星哥玩云

发布于 2022-09-14 11:08:31

52800

代码可运行

文章被收录于专栏：开源部署开源部署

运行总次数：0

代码可运行

一、第一个tornado程序

新建文件manage.py 代码如下

<span class="hljs-keyword">import</span> tornado.web
<span class="hljs-keyword">import</span> tornado.ioloop

<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">IndexHandler</span><span class="hljs-params">(tornado.web.RequestHandler)</span>:</span>
    <span class="hljs-string">"""主路由处理类"""</span>
    <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get</span><span class="hljs-params">(self)</span>:</span>
        <span class="hljs-string">"""对应http的get请求方式"""</span>
        self.write(<span class="hljs-string">"Hello Lucky!"</span>)

<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">"__main__"</span>:
    app = tornado.web.Application([
        (<span class="hljs-string">r"/"</span>, IndexHandler),
    ])
    app.listen(<span class="hljs-number">8000</span>)
    tornado.ioloop.IOLoop.current().start()

运行

python manage.py

请求

打开浏览器，输入网址127.0.0.1:8000（或localhost:8000）

代码讲解

tornado.web

tornado的基础web框架模块

RequestHandler

封装了对应一个请求的所有信息和方法，write(响应信息)就是写响应信息的一个方法；对应每一种http请求方式（get、post等），把对应的处理逻辑写进同名的成员方法中（如对应get请求方式，就将对应的处理逻辑写在get()方法中），当没有对应请求方式的成员方法时，会返回“405: Method Not Allowed”错误。

我们将代码中定义的get()方法更改为post()后，再用浏览器重新访问（浏览器地址栏中输入网址访问的方式为get请求方式）

示例

<span class="hljs-keyword">import</span> tornado.web
<span class="hljs-keyword">import</span> tornado.ioloop

<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">IndexHandler</span><span class="hljs-params">(tornado.web.RequestHandler)</span>:</span>
      <span class="hljs-string">"""主路由处理类"""</span>
      <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">post</span><span class="hljs-params">(self)</span>:</span> <span class="hljs-comment"># 修改方式为POST</span>
          <span class="hljs-string">"""对应http的post请求方式"""</span>
          self.write(<span class="hljs-string">"Hello Lucky!"</span>)

<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">"__main__"</span>:
      ...

访问

Application Tornado Web框架的核心应用类，是与服务器对接的接口，里面保存了路由信息表，其初始化接收的第一个参数就是一个路由信息映射元组的列表；其listen(端口)方法用来创建一个http服务器实例，并绑定到给定端口注意：此时服务器并未开启监听
tornado.ioloop tornado的核心io循环模块，封装了Linux的epoll和BSD的kqueue，tornado高性能的基石
IOLoop.current() 返回当前线程的IOLoop实例
IOLoop.start() 启动IOLoop实例的I/O循环,同时服务器监听被打开。
步骤
- 创建web应用实例对象，第一个初始化参数为路由映射列表
- 定义实现路由映射列表中的handler类
- 创建服务器实例，绑定服务器端口
- 启动当前线程的IOLoop

二、httpserver

概述

之前我们通过创建了一个http服务器示例并绑定到给定端口（tornado.web.Application.listen(800)）接下来进行手动实现

代码

<span class="hljs-keyword">import</span> tornado.web
<span class="hljs-keyword">import</span> tornado.ioloop
<span class="hljs-keyword">import</span> tornado.httpserver  <span class="hljs-comment"># 导入httpserver模块</span>

<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">IndexHandler</span><span class="hljs-params">(tornado.web.RequestHandler)</span>:</span>
    <span class="hljs-string">"""主路由处理类"""</span>
    <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get</span><span class="hljs-params">(self)</span>:</span>
        <span class="hljs-string">"""对应http的get请求方式"""</span>
        self.write(<span class="hljs-string">"Hello Lucky!"</span>)

<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">"__main__"</span>:
    app = tornado.web.Application([
        (<span class="hljs-string">r"/"</span>, IndexHandler),
    ])

    <span class="hljs-comment"># 我们修改这个部分</span>
    <span class="hljs-comment"># app.listen(8000)</span>
    http_server = tornado.httpserver.HTTPServer(app) 
    http_server.listen(<span class="hljs-number">8000</span>)
    
    tornado.ioloop.IOLoop.current().start()

说明

在当前代码中，我们引入了tornado.httpserver模块，顾名思义，它就是tornado的HTTP服务器实现

我们创建了一个HTTP服务器实例http_server，因为服务器要服务于我们刚刚建立的web应用，将接收到的客户端请求通过web应用中的路由映射表引导到对应的handler中，所以在构建http_server对象的时候需要传出web应用对象app。http_server.listen(8000)将服务器绑定到8000端口

实际上一版代码中app.listen(8000)正是对这一过程的简写

三、单进程与多进程

我们刚刚实现的都是单进程，可以通过命令来查看进程

ps -ef | grep manage.py

启动多个进程修改代码如下

<span class="hljs-keyword">import</span> tornado.web
<span class="hljs-keyword">import</span> tornado.ioloop
<span class="hljs-keyword">import</span> tornado.httpserver 

<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">IndexHandler</span><span class="hljs-params">(tornado.web.RequestHandler)</span>:</span>
    <span class="hljs-string">"""主路由处理类"""</span>
    <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get</span><span class="hljs-params">(self)</span>:</span>
        <span class="hljs-string">"""对应http的get请求方式"""</span>
        self.write(<span class="hljs-string">"Hello lucky!"</span>)

<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">"__main__"</span>:
    app = tornado.web.Application([
        (<span class="hljs-string">r"/"</span>, IndexHandler),
    ])
    http_server = tornado.httpserver.HTTPServer(app) 
    <span class="hljs-comment"># 修改</span>
    http_server.bind(<span class="hljs-number">8000</span>)
    http_server.start(<span class="hljs-number">0</span>)
 
    tornado.ioloop.IOLoop.current().start()

代码是说明

http_server.bind(port)方法是将服务器绑定到指定端口
http_server.start(num_processes=1)方法指定开启几个进程
- 参数num_processes默认值为1，即默认仅开启一个进程
- num_processes为None或者<=0，则自动根据机器硬件的cpu核芯数创建同等数目的子进程
- num_processes>0，则创建num_processes个子进程

上段代码中，我们使用http_server.start(0)，而我的Mac cpu核数为8

演示结果

注意

我们在前面写的http_server.listen(8000)实际上就等同于

http_server.bind(8000)
http_server.start(1)

四、注意

关于app.listen()

app.listen()这个方法只能在单进程模式中使用

对于app.listen()与手动创建HTTPServer实例

http_server = tornado.httpserver.HTTPServer(app) 
http_server.listen(<span class="hljs-number">8000</span>)

这两种方式，建议大家先使用后者即创建HTTPServer实例的方式，因为其对于理解tornado web应用工作流程的完整性有帮助，便于大家记忆tornado开发的模块组成和程序结构；在熟练使用后，可以改为简写

关于多进程

虽然tornado给我们提供了一次开启多个进程的方法，但是由于：

每个子进程都会从父进程中复制一份IOLoop实例，如过在创建子进程前我们的代码动了IOLoop实例，那么会影响到每一个子进程，势必会干扰到子进程IOLoop的工作
所有进程是由一个命令一次开启的，也就无法做到在不停服务的情况下更新代码
所有进程共享同一个端口，想要分别单独监控每一个进程就很困难

不建议使用这种多进程的方式，而是手动开启多个进程，并且绑定不同的端口

五、options

说明

在前面的示例中我们都是将服务端口的参数写死在程序中，很不灵活

tornado为我们提供了一个便捷的工具，tornado.options模块——全局参数定义、存储、转换

tornado.options.define()

说明用来定义options选项变量的方法，定义的变量可以在全局的tornado.options.options中获取使用
参数
- name 选项变量名，须保证全局唯一性，否则会报"Option ‘xxx’ already defined in …"的错误
- default 选项变量的默认值，如不传默认为None
- type 选项变量的类型，从命令行或配置文件导入参数的时候tornado会根据这个类型转换输入的值，转换不成功时会报错，可以是str、float、int、datetime、timedelta中的某个，若未设置则根据default的值自动推断，若default也未设置，那么不再进行转换。可以通过利用设置type类型字段来过滤不正确的输入
- multiple 选项变量的值是否可以为多个，布尔类型，默认值为False，如果multiple为True，那么设置选项变量时值与值之间用英文逗号分隔，而选项变量则是一个list列表（若默认值和输入均未设置，则为空列表[]）
- help 选项变量的帮助提示信息，在命令行启动tornado时，通过加入命令行参数 --help　可以查看所有选项变量的信息（注意，代码中需要加入tornado.options.parse_command_line()）

tornado.options.options

说明全局的options对象，所有定义的选项变量都会作为该对象的属性。

tornado.options.parse_command_line()

说明

转换命令行参数，并将转换后的值对应的设置到全局options对象相关属性上。追加命令行参数的方式是–myoption=myvalue

使用

新建manage2.py，我们用代码来看一下如何使用

<span class="hljs-keyword">import</span> tornado.web
<span class="hljs-keyword">import</span> tornado.ioloop
<span class="hljs-keyword">import</span> tornado.httpserver
<span class="hljs-keyword">import</span> tornado.options <span class="hljs-comment"># 新导入的options模块</span>

tornado.options.define(<span class="hljs-string">"port"</span>, default=<span class="hljs-number">8000</span>, type=int, help=<span class="hljs-string">"run server on the given port."</span>) <span class="hljs-comment"># 定义服务器监听端口选项</span>
tornado.options.define(<span class="hljs-string">"lucky"</span>, default=[], type=str, multiple=<span class="hljs-keyword">True</span>, help=<span class="hljs-string">"lucky is a good man"</span>) <span class="hljs-comment"># 无意义，演示多值情况</span>

<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">IndexHandler</span><span class="hljs-params">(tornado.web.RequestHandler)</span>:</span>
    <span class="hljs-string">"""主路由处理类"""</span>
    <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">get</span><span class="hljs-params">(self)</span>:</span>
        <span class="hljs-string">"""对应http的get请求方式"""</span>
        self.write(<span class="hljs-string">"Hello Itcast!"</span>)

<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">"__main__"</span>:
    tornado.options.parse_command_line()
    print(tornado.options.options.lucky) <span class="hljs-comment"># 输出多值选项</span>
    print(tornado.options.options.port) <span class="hljs-comment"># 输出多值选项</span>

    app = tornado.web.Application([
        (<span class="hljs-string">r"/"</span>, IndexHandler),
    ])
    http_server = tornado.httpserver.HTTPServer(app)
    http_server.listen(tornado.options.options.port)
    tornado.ioloop.IOLoop.current().start()

执行如下命令开启程序：

python manage2.py --port=<span class="hljs-number">9000</span> --lucky=handsome,Sunshine,Sunshine

查看帮助

python manage2.py --help

效果如下：

tornado.options.parse_config_file(path)

从配置文件导入option，配置文件中的选项格式如下

myoption = <span class="hljs-string">"myvalue"</span>
myotheroption = <span class="hljs-string">"myothervalue"</span>

我们用代码来看一下如何使用，新建配置文件config.py，注意字符串和列表按照python的语法格式：

port = <span class="hljs-number">8000</span>
lucky = [<span class="hljs-string">"handsome"</span>,<span class="hljs-string">"Sunshine"</span>,<span class="hljs-string">"Sunshine"</span>]

修改manage2.py文件：

	...
<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">"__main__"</span>:
    <span class="hljs-comment"># 仅仅修改了此处</span>
    tornado.options.parse_config_file(<span class="hljs-string">"./config.py"</span>) 
	...

六、日志与配置

日志当我们在代码中调用parse_command_line()或者parse_config_file()的方法时，tornado会默认为我们配置标准logging模块，即默认开启了日志功能，并向标准输出（屏幕）打印日志信息

如果想关闭tornado默认的日志功能，可以在命令行中添加–logging=none 或者在代码中执行如下操作

<span class="hljs-keyword">from</span> tornado.options <span class="hljs-keyword">import</span> parse_command_line
parse_command_line()

命令

python manage.py --logging=none

添加在代码中关闭logging

<span class="hljs-keyword">from</span> tornado.options <span class="hljs-keyword">import</span> options
options.logging = <span class="hljs-keyword">None</span>

配置文件

我们看到在使用prase_config_file()的时候，配置文件的书写格式仍需要按照python的语法要求，其优势是可以直接将配置文件的参数转换设置到全局对象tornado.options.options中；然而，其不方便的地方在于需要在代码中调用tornado.options.define()来定义选项，而且不支持字典类型，故而在实际应用中大都不使用这种方法。

在使用配置文件的时候，通常会新建一个python文件（如config.py），然后在里面直接定义python类型的变量（可以是字典类型）；在需要配置文件参数的地方，将config.py作为模块导入，并使用其中的变量参数。

config.py文件：

<span class="hljs-comment"># Redis配置</span>
redis_options = {
    <span class="hljs-string">'redis_host'</span>:<span class="hljs-string">'127.0.0.1'</span>,
    <span class="hljs-string">'redis_port'</span>:<span class="hljs-number">6379</span>,
    <span class="hljs-string">'redis_pass'</span>:<span class="hljs-string">''</span>,
}

<span class="hljs-comment"># Tornado app配置</span>
settings = {
    <span class="hljs-string">'template_path'</span>: os.path.join(os.path.dirname(__file__), <span class="hljs-string">'templates'</span>),  <span class="hljs-comment"># html文件</span>
    <span class="hljs-string">'static_path'</span>: os.path.join(os.path.dirname(__file__), <span class="hljs-string">'statics'</span>), <span class="hljs-comment"># 静态文件（css,js,img）</span>
    <span class="hljs-string">'cookie_secret'</span>:<span class="hljs-string">'0Q1AKOKTQHqaa+N80XhYW7KCGskOUE2snCW06UIxXgI='</span>, <span class="hljs-comment"># cookie自定义字符串加盐</span>
    <span class="hljs-string">'xsrf_cookies'</span>:<span class="hljs-keyword">False</span>, <span class="hljs-comment"># 防止跨站伪造</span>
    <span class="hljs-string">'login_url'</span>:<span class="hljs-string">'/login'</span>,
    <span class="hljs-string">'debug'</span>:<span class="hljs-keyword">True</span>,
}



<span class="hljs-comment"># 日志</span>
log_path = os.path.join(os.path.dirname(__file__), <span class="hljs-string">'logs/log'</span>)

使用config.py的模块中导入config，如下

<span class="hljs-comment"># conding:utf-8</span>

<span class="hljs-keyword">import</span> tornado.web
<span class="hljs-keyword">import</span> config

<span class="hljs-keyword">if</span> __name__ = <span class="hljs-string">"__main__"</span>:
    app = tornado.web.Application([], **config.settings)
...