tornado框架——入門

時間  2019-12-09 標籤 tornado 框架 入門

下載安裝：javascript

pip3安裝css

pip3 install tornado

源碼安裝html

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()

執行過程：java

  • 第一步：執行腳本，監聽 8888 端口
  • 第二步：瀏覽器客戶端訪問 /index --> http://127.0.0.1:8888/index
  • 第三步：服務器接受請求，並交由對應的類處理該請求
  • 第四步：類接受到請求以後，根據請求方式（post / get / delete ...）的不一樣調用並執行相應的方法
  • 第五步：方法返回值的字符串內容發送瀏覽器

異步非阻塞示例python

#!/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對應的是一個類。jquery

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中原生支持二級域名的路由git

模板引擎

Tornao中的模板語言和django中相似，模板引擎將模板文件載入內存，而後將數據嵌入其中，最終獲取到一個完整的字符串，再將字符串返回給請求者。github

Tornado 的模板支持「控制語句」和「表達語句」，控制語句是使用 {% 和 %} 包起來的 例如 {% if len(items) > 2 %}。表達語句是使用 {{ 和 }} 包起來的，例如 {{ items[0] }}。web

控制語句和對應的 Python 語句的格式基本徹底相同。咱們支持 if、for、while 和 try，這些語句邏輯結束的位置須要用 {% end %} 作標記。還經過 extends 和 block 語句實現了模板繼承。這些在 template 模塊 的代碼文檔中有着詳細的描述。

注：在使用模板前須要在setting中設置模板路徑："template_path" : "tplxxx"

  1. 母版：

layout.html

<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>老男孩</title>
    <link href="{{static_url("css/common.css")}}" rel="stylesheet" />
    {% block CSS %}{% end %}
</head>
<body>

    <div class="pg-header">

    </div>
    
    {% block RenderBody %}{% end %}
   
    <script src="{{static_url("js/jquery-1.8.2.min.js")}}"></script>
    
    {% block JavaScript %}{% end %}
</body>
</html>

index.html

{% extends 'layout.html'%}
{% block CSS %}
    <link href="{{static_url("css/index.css")}}" rel="stylesheet" /> 
{% end %}

{% block RenderBody %}
    <h1>Index</h1>

    <ul>
    {%  for item in li %}
        <li>{{item}}</li>
    {% end %}
    </ul>

{% 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('<h1>wupeiqi</h1>')
        #return escape.xhtml_escape('<h1>wupeiqi</h1>')
註冊
#!/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()
使用
<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title></title>
    <link href="{{static_url("commons.css")}}" rel="stylesheet" />
</head>
<body>
    <h1>hello</h1>
    {% module custom(123) %}
    {{ tab() }}
</body>

靜態文件

於靜態文件，能夠配置靜態文件的目錄和前段使用時的前綴，而且Tornaodo還支持靜態文件緩存。

settings = {
    'template_path': 'template',
    'static_path': 'static',
    'static_url_prefix': '/static/',
}
 
application = tornado.web.Application([
    (r"/index", MainHandler),
], **settings)
使用
<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title></title>
    <link href="{{static_url("commons.css")}}" rel="stylesheet" />
</head>
<body>
    <h1>hello</h1>
</body>
</html>
注：靜態文件緩存的實現
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()

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)

前端

<form action="/new_message" method="post">
  {{ xsrf_form_html() }}
  <input type="text" name="message"/>
  <input type="submit" value="Post"/>
</form>

使用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表單上傳

    <!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>上傳文件</title>
</head>
<body>
    <form id="my_form" name="form" action="/index" method="POST"  enctype="multipart/form-data" >
        <input name="fff" id="my_file"  type="file" />
        <input type="submit" value="提交"  />
    </form>
</body>
</html>
    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 <input type="file" id="img" /> <input type="button" onclick="UploadFile();" />

JS部分
<script>
// 原生ajax
function UploadFile(){
  var fileObj = document.getElementById("img").files[0];

  var form = new FormData();
  form.append("k1", "v1");
  form.append("fff", fileObj);

  var xhr = new XMLHttpRequest();
  xhr.open("post", '/index', true);
  xhr.send(form);
}

// jquery
function UploadFile(){
  var fileObj = $("#img")[0].files[0];
  var form = new FormData();
  form.append("k1", "v1");
  form.append("fff", fileObj);

  $.ajax({
    type:'POST',
    url: '/index',
    data: form,
    processData: false,  // tell jQuery not to process the data
    contentType: false,  // tell jQuery not to set contentType
    success: function(arg){
      console.log(arg);
    }
  })
}
</script>

{# iframe（僞ajax） #} 
<body>
  <form id="my_form" name="form" action="/index" method="POST"  enctype="multipart/form-data" >
    <div id="main">
      <input name="fff" id="my_file"  type="file" />
      <input type="button" name="action" value="Upload" onclick="redirect()"/>
      <iframe id='my_iframe' name='my_iframe' src=""  class="hide"></iframe>
    </div>
  </form>

  <script>
    function redirect(){
      document.getElementById('my_iframe').onload = Testt;
      document.getElementById('my_form').target = 'my_iframe';
      document.getElementById('my_form').submit();
    }
    function Testt(ths){
      var t = $("#my_iframe").contents().find("body").text();
      console.log(t);
    }
  </script>
</body>
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上傳示例
<script type="text/javascript">

  $(document).ready(function () {

    $("#formsubmit").click(function () {

      var iframe = $('<iframe name="postiframe" id="postiframe" style="display: none"></iframe>');

      $("body").append(iframe);

      var form = $('#theuploadform');
      form.attr("action", "/upload.aspx");
      form.attr("method", "post");

      form.attr("encoding", "multipart/form-data");
      form.attr("enctype", "multipart/form-data");

      form.attr("target", "postiframe");
      form.attr("file", $('#userfile').val());
      form.submit();

      $("#postiframe").load(function () {
        iframeContents = this.contentWindow.document.body.innerHTML;
        $("#textarea").html(iframeContents);
      });

      return false;

    });

  });

</script>

<form id="theuploadform">
  <input id="userfile" name="userfile" size="50" type="file" />
  <input id="formsubmit" type="submit" value="Send File" />
</form>

<div id="textarea"></div>
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);
      }
    })
  })
}
联系我们 沪ICP备2021010478号-7