Tornado Web Framework

1 基本使用

import json
import os

import tornado.ioloop
import tornado.web

BASE_DIR = os.path.dirname(__file__)


settings = {
    "template_path": os.path.join(BASE_DIR, "templates"),  # 存放模板的文件夹 html
    "static_path": os.path.join(BASE_DIR, "static"),  # 存放静态文件的文件夹 css js
    "debug": True,
    "autoreload": True,
    "cookie_secret": "TozDU7esgEUTqQy0M6c5II8==",  # 安全cookie
    "xsrf_cookies": False,
}


class IndexHandler(tornado.web.RequestHandler):
    def get(self):
        result = {"hello": "world"}
        # self.render("index.html")
        self.write(json.dumps(result))


if __name__ == '__main__':
    application = tornado.web.Application(
        [
            (r"/index", IndexHandler),
        ],
        **settings)
    application.listen(8888)
    tornado.ioloop.IOLoop.instance().start()

2 常规配置

debug或者autoreload为True时，修改源文件代码将会自动重启服务，相当于Django的重启功能

3 身份/验证/安全

4 模板设置

5 静态文件

6 路由和参数匹配

在tornado中，一个url对应一个处理类。

6.1 无名分组

使用正则分组()解析出资源请求地址的一些参数。匹配到的参数会通过位置传参的形式传递给控制器处理函数，所以接收参数可以任意命名，因此你可以通过 *args 接收到所有匹配的参数

import tornado.ioloop
import tornado.web

settings = {"debug": True}
# http://127.0.0.1:8888/register1/soloman
# http://127.0.0.1:8888/register2/soloman


class RegisterHandler1(tornado.web.RequestHandler):
    def get(self, *args):
        self.write(str(args))  # ('soloman',)

        
class RegisterHandler2(tornado.web.RequestHandler):
    def get(self, params):
        self.write(params)   # soloman


application = tornado.web.Application([
    (r"^/register1/(\w+)", RegisterHandler1),
    (r"^/register2/(\w+)", RegisterHandler2),
], **settings)


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

6.2 有名分组

使用正则的有名分组(?P<组名>规则)解析出资源请求地址的一些参数。匹配到的参数会通过关键字传参的形式传递给控制器处理函数，所以接收参数必须与组名相同，因此你可以通过**kwargs接收到所有匹配的参数

import tornado.ioloop
import tornado.web

settings = {"debug": True}
# http://127.0.0.1:8888/register1/soloman
# http://127.0.0.1:8888/register2/soloman


class RegisterHandler1(tornado.web.RequestHandler):
    def get(self, **kwargs):
        self.write(str(kwargs))  # {'username': 'soloman'}

        
class RegisterHandler2(tornado.web.RequestHandler):
    def get(self, username):
        self.write(username)  # soloman


application = tornado.web.Application([
    (r"^/register1/(?P<username>\w+)", RegisterHandler1),
    (r"^/register2/(?P<username>\w+)", RegisterHandler2),
], **settings)


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

注意：路由匹配的参数捕捉，不允许无名分组和有名分组的混合使用，这会引发一个异常

6.3 反向解析

反向解析要与路由命名配合使用

import tornado.ioloop
import tornado.web

settings = {"debug": True}
# http://127.0.0.1:8888/register


class RegisterHandler(tornado.web.RequestHandler):
    def get(self):
        print(self.reverse_url("reg"))  # /register
        self.write("注册页面")


# 使用tornado.web.url来进行添加路由规则
application = tornado.web.Application([
    tornado.web.url(r'/register', RegisterHandler, name="reg")
], **settings)


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

7 请求处理类

在tornado中，请求处理类都继承了一个叫做tornado.web.RequestHandler的类。以下是常用的获取相关属性以及方法

8 HTTP 响应

响应一般就分为以下几种，返回单纯的字符串，返回一个模板页面，返回JSON格式数据，返回一个错误，以及重定向

self.write("OK")

self.render("templatePath", **kwargs)  # 传递给模板的数据

import json
json_data = json.dumps({"k1": "v1"})
self.write(json_data)

self.send_error(404) 
self.finish()  # 结束本次请求

self.redirect("www.soloman.vip", status=301)

# 设置响应头
self.set_header("k1", 1)
self.add_header("k2", 2)
self.clear_header("k1") 

在响应处理类中定义钩子函数

class APIHandler(tornado.web.RequestHandler):
    def set_default_headers(self):
        print("first--设置headers")

    def initialize(self):
        print("second--初始化")

    def prepare(self):
        print("third--准备工作")

    def get(self):
        print("fourth--处理get请求")

    def post(self):
        print('fourth--处理post请求')

    def write_error(self, status_code, **kwargs):
        print("fifth--处理错误")

    def on_finish(self):
        print("sixth--处理结束,释放资源--")

9 模板语法

Tornado 大部分模板语法和 Django 类似。模板传参可以通过k=v的方式传递，也可以通过**dict的方式进行解包传递

class APIHandler(tornado.web.RequestHandler):
    def get(self):
        context = {
            "name": "Soloman",
            "age": 18,
            "hobby": ["篮球", "唱歌", "跳舞"]
        }
        self.render("api.html", **context)
        # self.render("api.html", name="Soloman", age=18, hobby=["篮球", "唱歌", "跳舞"])

模板中有两种表现形式，一种是以双层{}进行包裹，另一种是命令形式以% 命令 %包裹。注意：tornado的模板语法的结束标识是% end %，不是Django或jinja2的% endblock %

tornado中的模板语言允许导入Python包、模块

% import time %
{ time.time() }

% from util.modify import mul %
{mul(6,6)}

9.1 ui_modules

ui_modules定义一些公用的组件，在这里返回的字符串将默认关闭HTML字符转义功能。

10 cookies

10.1 基本操作

class APIHandler(tornado.web.RequestHandler):
    def get(self):
        if self.get_cookie("access"):
            self.write("你来访问过了")
        else:
            self.set_cookie("access","yes")
            self.write("七天内可再次访问")

10.2 加密 cookies

在application的配置项中设定一个加密的盐cookie_secret，然后使用下面的两个方法进行加密cookies的操作

class APIHandler(tornado.web.RequestHandler):
    def get(self):
        if self.get_secure_cookie("access"):
            self.write("你来访问过了")
        else:
            self.set_secure_cookie("access", "yes")
            self.write("七天内可再次访问")


settings = {
    "debug": True,
    "template_path": "templates",  # 指定模板目录
    "static_path": "static",  # 指定静态文件目录
    "cookie_secret": "0dsa0D9d0a%39433**das9))|ddsa",  # cookie加密的盐
}

application = tornado.web.Application([
    tornado.web.url(r'/api', APIHandler),
], **settings)