Tornado框架简介

Posted 2020-11-18

--------------------Application--------------------
1、settings
1、debug=True：，设置tornado是否工作在调试模式，默认为False即工作在生产模式。当设置debug=True 后，tornado会工作在调试/开发模式，在此种模式下，可以根据设置修改tornado提供的其他几种特性

2、autoreload=True：自动重启，tornado应用会监控我们的源代码文件，当有改动保存后便会重启程序，这可以减少我们手动重启程序的次数。需要注意的是，一旦我们保存的更改有错误，自动重启会导致程序报错而退出，从而需要我们保存修正错误后手动启动程序。

3、compiled_templite_carch = False：取消缓存编译的模板

4、static_hash_cache = False：取消缓存静态文件hash值

5、server_traceback = True：提供追踪信息，当RequestHandler或者其子类抛出一个异常而未被捕获后，会生成一个包含追踪信息的页面

6、
    import tornado.web
    app = tornado.web.Application([],debug=True)

2、路由映射
1、Application中列表中的信息
app = tornado.web.Application([
(r"/", Indexhandler),
(r"/cpp", SubjectHandler, {"subject":"c++"}),
url(r"/python", StaticFileHandler, {"subject":"python"}, name="static_url")
],
debug = True
)

2、对于路由中的字典，会传入到对应的RequestHandler的initialize()方法中。
    from tornado.web import RequestHandler

    class StaticFileHandler(RequestHandler):
        def initialize(self):
            self.subject = subject

        def get(self):
            self.write(self.subject)

3、对于路由中的name字段，注意此时不能再使用元组，而应使用tornado.web.url来构建。name是给该路由起一个名字，可以通过调用RequestHandler.reverse_url(name)来获取该名子对应的url。
    def get(self):
        self.write("<a href="+RequestHandler.reverse_url(‘static_url‘)+"></a>")

--------------------输入--------------------
1、获取查询字符串参数
1、get_query_argument(name,default=_ARG_DEFAULT,strip=True)
1、name：从请求的查询字符串中返回指定参数name的值，如果出现多个同名参数，则返回最后一个的值。

    2、default：为设值未传name参数时返回的默认值，如若default也未设置，则会抛出tornado.web.MissingArgumentError异常。

    3、strip：表示是否过滤掉左右两边的空白字符，默认为过滤。

2、get_query_arguments(name,strip=True)
    1、从请求的查询字符串中返回指定参数name的值，注意返回的是list列表（即使对应name参数只有一个值）。若未找到name参数，则返回空列表[]。

2、获取请求体参数
1、get_body_argument(name,default=_ARG_DEFAULT,strip=True)
从请求体中返回指定参数name的值，如果出现多个同名参数，则返回最后一个的值。

2、get_body_argument(name,strip=True)
    从请求体中返回指定参数name的值，注意返回的是list列表（即使对应name参数只有一个值）。若未找到name参数，则返回空列表[]。

3、前两类方法的整合
1、get_argument(name,default=_ARG_DEFAULT,strip=True)
从请求体和查询字符串中返回指定参数name的值，如果出现多个同名参数，则返回最后一个的值。

2、get_argument(name,strip=True)
    从请求体和查询字符串中返回指定参数name的值，注意返回的是list列表（即使对应name参数只有一个值）。若未找到name参数，则返回空列表[]。

4、关于请求的其他信息
RequestHandler.request 对象存储了关于请求的相关信息，具体属性有：
1、method HTTP的请求方式，如GET或POST;

    2、host 被请求的主机名；

    3、uri 请求的完整资源标示，包括路径和查询字符串；

    4、path 请求的路径部分；

    5、query 请求的查询字符串部分；

    6、version 使用的HTTP版本；

    7、headers 请求的协议头，是类字典型的对象，支持关键字索引的方式获取特定协议头信息
        1、request.headers["Content-Type"]

    8、body 请求体数据；

    9、remote_ip 客户端的IP地址；

    10、files 用户上传的文件，为字典类型
        tornado.httputil.HTTPFile是接收到的文件对象，它有三个属性：
        1、filename 文件的实际名字，与form_filename1不同，字典中的键名代表的是表单对应项的名字；

        2、body 文件的数据实体；

        3、content_type 文件的类型。 这三个对象属性可以像字典一样支持关键字索引，
            request.files["form_filename1"][0]["body"]。

5、正则提取uri
tornado中对于路由映射也支持正则提取uri，提取出来的参数会作为RequestHandler中对应请求方式的成员方法参数。若在正则表达式中定义了名字，则参数按名传递；若未定义名字，则参数按顺序传递。提取出来的参数会作为对应请求方式的成员方法的参数。

    (r"/sub-city/(.+)/([a-z]+)", SubjectCityHandler), # 无名方式
    (r"/sub-date/(?P<subject>.+)/(?P<date>d+)", SubjectDateHandler), #　命名方式

    class SubjectCityHandler(RequestHandler):
        def get(self, subject, city):
            self.write(("Subject: %s<br/>City: %s" % (subject, city)))

--------------------输出--------------------
1、write(chunk)
class IndexHandler(RequestHandler):
def get(self):
self.write("hello itcast!")

2、set_header(name, value)
利用set_header(name, value)方法，可以手动设置一个名为name、值为value的响应头header字段
self.set_header("Content-Type", "application/json; charset=UTF-8")

3、set_default_headers()
该方法会在进入HTTP处理方法前先被调用，可以重写此方法来预先设置默认的headers
class IndexHandler(RequestHandler):
def set_default_headers(self):
print "执行了set_default_headers()"

设置get与post方式的默认响应体格式为json

        self.set_header("Content-Type", "application/json; charset=UTF-8")
        # 设置一个名为webServer、值为Hello的header
        self.set_header("webServer", "Hello")

4、set_status(status_code, reason=None)
1、status_code int类型，状态码，若reason为None，则状态码必须为下表中的。

2、reason string类型，描述状态码的词组，若为None，则会被自动填充为下表中的内容。

5、redirect(url)
class IndexHandler(RequestHandler):
"""对应/"""
def get(self):
self.write("主页")

class LoginHandler(RequestHandler):
    """对应/login"""
    def get(self):
        self.write(‘<form method="post"><input type="submit" value="登陆"></form>‘)

    def post(self):
        self.redirect("/")

6、send_error(status_code=500, **kwargs)
抛出HTTP错误状态码status_code，默认为500，kwargs为可变命名参数。使用send_error抛出错误后tornado会调用write_error()方法进行处理，并返回给浏览器处理后的错误页面。
class IndexHandler(RequestHandler):
def get(self):
err_code = self.get_argument("code", None) # 注意返回的是unicode字符串，下同
err_title = self.get_argument("title", "")
err_content = self.get_argument("content", "")
if err_code:
self.send_error(err_code, title=err_title, content=err_content)
else:
self.write("主页")

7、write_error(status_code, kwargs)
用来处理send_error抛出的错误信息并返回给浏览器错误信息页面。可以重写此方法来定制自己的错误显示页面
def write_error(self, status_code, kwargs):
self.write(u"<h1>出错了，程序员GG正在赶过来！</h1>")
self.write(u"<p>错误名：%s</p>" % kwargs["title"])
self.write(u"<p>错误详情：%s</p>" % kwargs["content"])

--------------------Tornado接口与调用顺序--------------------
1、initialize()
对应每个请求的处理类Handler在构造一个实例后首先执行initialize()方法。在讲输入时提到，路由映射中的第三个字典型参数会作为该方法的命名参数传递

class ProfileHandler(RequestHandler):
    def initialize(self, database):
        self.database = database

    def get(self):
        ...

app = Application([
    (r‘/user/(.*)‘, ProfileHandler, dict(database=database)),
    ])

2、perpare()
预处理，即在执行对应请求方式的HTTP方法（如get、post等）前先执行，注意：不论以何种HTTP方式请求，都会执行prepare()方法。

def prepare(self):
    if self.request.headers.get("Content-Type").startswith("application/json"):
        self.json_dict = json.loads(self.request.body)
    else:
        self.json_dict = None

3、HTTP方法
1、get：请求指定的页面信息，并返回实体主体。

2、head：类似get请求，只不过返回的响应中没有具体的内容，用于获取报头。

3、post：向指定资源提交数据进行处理请求（例如提交表单或上传文件）。数据被包含在请求体中。POST请求可能会导致新的资源的建立和/或已有资源的修改。

4、delete：请求服务器删除指定的内容。

5、patch：请求修改局部数据。

6、put：从客户端向服务器传送的数据取代指定的文档的内容。

7、options：返回给定URL支持的所有HTTP方法

4、on_finish()
在请求处理结束后调用，即在调用HTTP方法后调用。通常该方法用来进行资源清理释放或处理日志等。注意：请尽量不要在此方法中进行响应输出。

5、set_default_headers()

6、write_error()

7、调用顺序
1、测试
class IndexHandler(RequestHandler):

    def initialize(self):
        print "调用了initialize()"

    def prepare(self):
        print "调用了prepare()"

    def set_default_headers(self):
        print "调用了set_default_headers()"

    def write_error(self, status_code, **kwargs):
        print "调用了write_error()"

    def get(self):
        print "调用了get()"

    def post(self):
        print "调用了post()"
        self.send_error(200)  # 注意此出抛出了错误

    def on_finish(self):
        print "调用了on_finish()"

2、在正常情况未抛出错误时，调用顺序为：
    1、set_defautl_headers()

    2、initialize()

    3、prepare()

    4、HTTP方法

    5、on_finish()

3、在有错误抛出时，调用顺序为：
    1、set_default_headers()

    2、initialize()

    3、prepare()

    4、HTTP方法

    5、set_default_headers()

    6、write_error()

    7、on_finish()