tornado框架——入门

下载安装：

pip3安装

pip3 install tornado

源码安装

tornado-1.2.1.tar.gz

快速上手

#!/usr/bin/env python
# -*- coding:utf-8 -*-
   
import tornado.ioloop
import tornado.web
   
   
class MainHandler(tornado.web.RequestHandler):
    def get(self):
        self.write("Hello, world")
   
application = tornado.web.Application([
    (r"/index", MainHandler),
])
   
   
if __name__ == "__main__":
    application.listen(8888)
    tornado.ioloop.IOLoop.instance().start()

执行过程：

• 第一步：执行脚本，监听 8888 端口
• 第二步：浏览器客户端访问 /index --> http://127.0.0.1:8888/index
• 第三步：服务器接受请求，并交由对应的类处理该请求
• 第四步：类接受到请求之后，根据请求方式（post / get / delete ...）的不同调用并执行相应的方法
• 第五步：方法返回值的字符串内容发送浏览器

异步非阻塞示例

#!/usr/bin/env python
# -*- coding:utf-8 -*-

import tornado.ioloop
import tornado.web
from tornado import httpclient
from tornado.web import asynchronous
from tornado import gen

import uimodules as md  # 自定义UI模板模块
import uimethods as mt  # 自定义UI模板方法

class MainHandler(tornado.web.RequestHandler):
        @asynchronous
        @gen.coroutine
        def get(self):
            print 'start get '
            http = httpclient.AsyncHTTPClient()
            http.fetch("http://127.0.0.1:8008/post/", self.callback)
            self.write('end')

        def callback(self, response):
            print response.body

settings = {
    'template_path': 'template',
    'static_path': 'static',
    'static_url_prefix': '/static/',
    'ui_methods': mt,   # 注册自定义方法
    'ui_modules': md,   # 注册自定义模块
}

application = tornado.web.Application([
    (r"/index", MainHandler),
], **settings)


if __name__ == "__main__":
    application.listen(8009)
    tornado.ioloop.IOLoop.instance().start()

路由系统

路由系统其实就是 url 和 类 的对应关系，这里不同于其他框架，其他很多框架均是 url 对应 函数，Tornado中每个url对应的是一个类。

import tornado.ioloop
import tornado.web
   
   
class MainHandler(tornado.web.RequestHandler):
    def get(self):
        self.write("Hello, world")
   
class StoryHandler(tornado.web.RequestHandler):
    def get(self, story_id):
        self.write("You requested the story " + story_id)
   
class BuyHandler(tornado.web.RequestHandler):
    def get(self):
        self.write("buy.wupeiqi.com/index")
   
application = tornado.web.Application([
    (r"/index", MainHandler),   # 对应一个类(cbv)
    (r"/story/([0-9]+)", StoryHandler), # 使用正则表达式，开头为'/'。
])
   
application.add_handlers('buy.wupeiqi.com$', [  # 支持二级域名
    (r'/index',BuyHandler),
])
   
if __name__ == "__main__":
    application.listen(80)
    tornado.ioloop.IOLoop.instance().start()

Tornado中原生支持二级域名的路由

模板引擎

Tornao中的模板语言和django中类似，模板引擎将模板文件载入内存，然后将数据嵌入其中，最终获取到一个完整的字符串，再将字符串返回给请求者。

Tornado 的模板支持“控制语句”和“表达语句”，控制语句是使用 {% 和 %} 包起来的 例如 {% if len(items) > 2 %}。表达语句是使用 { { 和 }} 包起来的，例如 { { items[0] }}。

控制语句和对应的 Python 语句的格式基本完全相同。我们支持 if、for、while 和 try，这些语句逻辑结束的位置需要用 {% end %} 做标记。还通过 extends 和 block 语句实现了模板继承。这些在 template 模块 的代码文档中有着详细的描述。

注：在使用模板前需要在setting中设置模板路径："template_path" : "tplxxx"

1. 母版：

layout.html

    
    
    
    {% block CSS %}{% end %}



    


    
    
    {% block RenderBody %}{% end %}
   
    
    
    {% block JavaScript %}{% end %}

index.html

{% extends 'layout.html'%}
{% block CSS %}
     
{% end %}

{% block RenderBody %}
    
Index

    

    {%  for item in li %}
        
{
     {item}}
    {% end %}
    

{% end %}

{% block JavaScript %}
    
{% end %}

1. 默认模板工具

在模板中默认提供了一些函数、字段、类以供模板使用：

escape: tornado.escape.xhtml_escape 的別名
xhtml_escape: tornado.escape.xhtml_escape 的別名
url_escape: tornado.escape.url_escape 的別名
json_encode: tornado.escape.json_encode 的別名
squeeze: tornado.escape.squeeze 的別名
linkify: tornado.escape.linkify 的別名
datetime: Python 的 datetime 模组
handler: 当前的 RequestHandler 对象
request: handler.request 的別名
current_user: handler.current_user 的別名
locale: handler.locale 的別名
_: handler.locale.translate 的別名
static_url: for handler.static_url 的別名
xsrf_form_html: handler.xsrf_form_html 的別名

1. 自定义UIMethod以UIModule

# uimethods.py
 
def tab(self):
    return 'UIMethod'

# uimodules.py
from tornado.web import UIModule
from tornado import escape

class custom(UIModule):

    def render(self, *args, **kwargs):
        return escape.xhtml_escape('
wupeiqi
')
        #return escape.xhtml_escape('
wupeiqi
')

注册

#!/usr/bin/env python
# -*- coding:utf-8 -*-

import tornado.ioloop
import tornado.web
from tornado.escape import linkify
import uimodules as md
import uimethods as mt

class MainHandler(tornado.web.RequestHandler):
    def get(self):
        self.render('index.html')

settings = {
    'template_path': 'template',
    'static_path': 'static',
    'static_url_prefix': '/static/',
    'ui_methods': mt,
    'ui_modules': md,
}

application = tornado.web.Application([
    (r"/index", MainHandler),
], **settings)


if __name__ == "__main__":
    application.listen(8888)
    tornado.ioloop.IOLoop.instance().start()

使用

    
    
    


    
hello
    {% module custom(123) %}
    {
     { tab() }}

静态文件

于静态文件，可以配置静态文件的目录和前段使用时的前缀，并且Tornaodo还支持静态文件缓存。

settings = {
    'template_path': 'template',
    'static_path': 'static',
    'static_url_prefix': '/static/',
}
 
application = tornado.web.Application([
    (r"/index", MainHandler),
], **settings)

使用

    
    
    


    
hello

注：静态文件缓存的实现

    def get_content_version(cls, abspath):
        """Returns a version string for the resource at the given path.

        This class method may be overridden by subclasses.  The
        default implementation is a hash of the file's contents.

        .. versionadded:: 3.1
        """
        data = cls.get_content(abspath)
        hasher = hashlib.md5()
        if isinstance(data, bytes):
            hasher.update(data)
        else:
            for chunk in data:
                hasher.update(chunk)
        return hasher.hexdigest()

cookie

Tornado中可以对cookie进行操作，并且还可以对cookie进行签名以放置伪造。

1. 基本操作

   class MainHandler(tornado.web.RequestHandler):
       def get(self):
           if not self.get_cookie("mycookie"):
               self.set_cookie("mycookie", "myvalue")
               self.write("Your cookie was not set yet!")
           else:
               self.write("Your cookie was set!")

   ​

2. 加密cookie（签名）

   Cookie 很容易被恶意的客户端伪造。加入你想在 cookie 中保存当前登陆用户的 id 之类的信息，你需要对 cookie
   作签名以防止伪造。Tornado 通过 set_secure_cookie 和 get_secure_cookie 方法直接支持了这种功能。
   要使用这些方法，你需要在创建应用时提供一个密钥，名字为 cookie_secret。 你可以把它作为一个关键词参数传入应用的设置中：

   class MainHandler(tornado.web.RequestHandler):
       def get(self):
           if not self.get_secure_cookie("mycookie"):
               self.set_secure_cookie("mycookie", "myvalue")
               self.write("Your cookie was not set yet!")
           else:
               self.write("Your cookie was set!")
   
   application = tornado.web.Application([
       (r"/", MainHandler),
   ], cookie_secret="61oETzKXQAGaYdkL5gEmGeJJFuYh7EQnp2XdTP1o/Vo=")

   签名Cookie的本质是：

   写cookie过程：

   • 将值进行base64加密
   • 对除值以外的内容进行签名，哈希算法（无法逆向解析）
   • 拼接 签名 + 加密值

   读cookie过程：

   • 读取 签名 + 加密值
   • 对签名进行验证
   • base64解密，获取值内容

   ​

   注：许多API验证机制和安全cookie的实现机制相同

   ​

   基于Cookie实现用户验证

   import tornado.ioloop
   import tornado.web
   
   
   class MainHandler(tornado.web.RequestHandler):
   
       def get(self):
           login_user = self.get_secure_cookie("login_user", None)
           if login_user:
               self.write(login_user)
           else:
               self.redirect('/login')
   
   
   class LoginHandler(tornado.web.RequestHandler):
       def get(self):
           self.current_user()
   
           self.render('login.html', **{'status': ''})
   
       def post(self, *args, **kwargs):
   
           username = self.get_argument('name')
           password = self.get_argument('pwd')
           if username == 'wupeiqi' and password == '123':
               self.set_secure_cookie('login_user', '武沛齐')
               self.redirect('/')
           else:
               self.render('login.html', **{'status': '用户名或密码错误'})
   
   settings = {
       'template_path': 'template',
       'static_path': 'static',
       'static_url_prefix': '/static/',
       'cookie_secret': 'aiuasdhflashjdfoiuashdfiuh'
   }
   
   application = tornado.web.Application([
       (r"/index", MainHandler),
       (r"/login", LoginHandler),
   ], **settings)
   
   
   if __name__ == "__main__":
       application.listen(8888)
       tornado.ioloop.IOLoop.instance().start()

   基于签名Cookie实现用户验证

   import tornado.ioloop
   import tornado.web
   
   class BaseHandler(tornado.web.RequestHandler):
   
       def get_current_user(self):
           return self.get_secure_cookie("login_user")
   
   class MainHandler(BaseHandler):
   
       @tornado.web.authenticated
       def get(self):
           login_user = self.current_user
           self.write(login_user)
   
   
   
   class LoginHandler(tornado.web.RequestHandler):
       def get(self):
           self.current_user()
   
           self.render('login.html', **{'status': ''})
   
       def post(self, *args, **kwargs):
   
           username = self.get_argument('name')
           password = self.get_argument('pwd')
           if username == 'wupeiqi' and password == '123':
               self.set_secure_cookie('login_user', '武沛齐')
               self.redirect('/')
           else:
               self.render('login.html', **{'status': '用户名或密码错误'})
   
   settings = {
       'template_path': 'template',
       'static_path': 'static',
       'static_url_prefix': '/static/',
       'cookie_secret': 'aiuasdhflashjdfoiuashdfiuh',
       'login_url': '/login'
   }
   
   application = tornado.web.Application([
       (r"/index", MainHandler),
       (r"/login", LoginHandler),
   ], **settings)
   
   
   if __name__ == "__main__":
       application.listen(8888)
       tornado.ioloop.IOLoop.instance().start()

   ​

3. JavaScript操作Cookie

   /*设置cookie，指定秒数过期*/
   function setCookie(name,value,expires){
       var temp = [];
       var current_date = new Date();
       current_date.setSeconds(current_date.getSeconds() + 5);
       document.cookie = name + "= "+ value +";expires=" + current_date.toUTCString();
   }

   对于参数：

   • domain 指定域名下的cookie
   • path 域名下指定url中的cookie
   • secure https使用

   注：jQuery中也有指定的插件 jQuery Cookie 专门用于操作cookie，猛击这里

CSRF

Tornado中的夸站请求伪造和Django中的相似，跨站伪造请求(Cross-site request forgery)

settings = {
    "xsrf_cookies": True,
}
application = tornado.web.Application([
    (r"/", MainHandler),
    (r"/login", LoginHandler),
], **settings)

前端

  {
     { xsrf_form_html() }}
  
  

使用ajax

function getCookie(name) {
    var r = document.cookie.match("\\b" + name + "=([^;]*)\\b");
    return r ? r[1] : undefined;
}

jQuery.postJSON = function(url, args, callback) {
    args._xsrf = getCookie("_xsrf");
    $.ajax({url: url, data: $.param(args), dataType: "text", type: "POST",
        success: function(response) {
        callback(eval("(" + response + ")"));
    }});
};

注：Ajax使用时，本质上就是去获取本地的cookie，携带cookie再来发送请求

上传文件

1. Form表单上传

   import tornado.ioloop
   import tornado.web

   class MainHandler(tornado.web.RequestHandler):
   def get(self):

       self.render('index.html')
   
   def post(self, *args, **kwargs):
       file_metas = self.request.files["fff"]   # 获取request中的文件对象
       # print(file_metas)
       for meta in file_metas:                  # 从对象中获取内容并保存为同名的文件
           file_name = meta['filename']
           with open(file_name,'wb') as up:
               up.write(meta['body'])

   settings = {
   'template_path': 'template',
   }

   application = tornado.web.Application([
   (r"/index", MainHandler),], **settings)

   if name == "main":
   application.listen(8000)
   tornado.ioloop.IOLoop.instance().start()
   ```

   ​

2. ajax上传

HTML部分

​html

JS部分

{# iframe（伪ajax） #} 

  

    

      
      
      
    
  

  

python 部分

import tornado.ioloop
import tornado.web

class MainHandler(tornado.web.RequestHandler):
    def get(self):

        self.render('index.html')

    def post(self, *args, **kwargs):
        file_metas = self.request.files["fff"]
        # print(file_metas)
        for meta in file_metas:
            file_name = meta['filename']
            with open(file_name,'wb') as up:
                up.write(meta['body'])

settings = {
    'template_path': 'template',
}

application = tornado.web.Application([
    (r"/index", MainHandler),
], **settings)


if __name__ == "__main__":
    application.listen(8000)
    tornado.ioloop.IOLoop.instance().start()

扩展：

基于iframe实现Ajax上传示例

jquery部分

$('#upload_iframe').load(function(){
  var iframeContents = this.contentWindow.document.body.innerText;
  iframeContents = JSON.parse(iframeContents);
})

头像本地预览功能

function bindChangeAvatar1() {
  $('#avatarImg').change(function () {
    var file_obj = $(this)[0].files[0];
    $('#prevViewImg')[0].src = window.URL.createObjectURL(file_obj)
  })
}

function bindChangeAvatar2() {
  $('#avatarImg').change(function () {
    var file_obj = $(this)[0].files[0];
    var reader = new FileReader();
    reader.readAsDataURL(file_obj);
    reader.onload = function (e) {
      $('#previewImg')[0].src = this.result;
    };
  })
}

function bindChangeAvatar3() {
  $('#avatarImg').change(function () {
    var file_obj = $(this)[0].files[0];
    var form = new FormData();
    form.add('img_upload', file_obj);

    $.ajax({
      url: '',
      data: form,
      processData: false,  // tell jQuery not to process the data
      contentType: false,  // tell jQuery not to set contentType
      success: function (arg) {

      }
    })
  })
}

function bindChangeAvatar4() {
  $('#avatarImg').change(function () {
    $(this).parent().submit();

    $('#upload_iframe').load(function () {
      var iframeContents = this.contentWindow.document.body.innerText;
      iframeContents = JSON.parse(iframeContents);
      if (iframeContents.status) {
        $('#previewImg').attr('src', '/' + iframeContents.data);
      }
    })
  })
}

转载于:https://www.cnblogs.com/lzyang121/p/8328224.html