本文详细介绍了Tornado框架的应用，包括Application的settings和路由映射，如何获取请求的查询字符串参数、请求体参数以及HTTP头信息，同时也探讨了输出数据流、cookie、header和错误处理。此外，还讲解了通过正则表达式从URI中提取信息的方法。
目录
目录
1、Application
1.1、settings
创建tornado.web.Application的对象时，传入了第一个参数——路由映射列表。实际上Application类的构造函数还接收很多关于tornado web应用的配置参数，例如：
import tornado.web
app = tornado.web.Application([], debug=True)debug，设置tornado是否工作在调试模式，默认为False即工作在生产模式。当设置debug=True 后，tornado会工作在调试/开发模式，在此种模式下，tornado为方便我们开发而提供了几种特性：
- 自动重启，tornado应用会监控我们的源代码文件，当有改动保存后便会重启程序，这可以减少我们手动重启程序的次数。需要注意的是，一旦我们保存的更改有错误，自动重启会导致程序报错而退出，从而需要我们保存修正错误后手动启动程序。这一特性也可单独通过autoreload=True设置；
- 取消缓存编译的模板，可以单独通过compiled_template_cache=False来设置；
- 取消缓存静态文件hash值，可以单独通过static_hash_cache=False来设置；
- 提供追踪信息，当RequestHandler或者其子类抛出一个异常而未被捕获后，会生成一个包含追踪信息的页面，可以单独通过serve_traceback=True来设置。
1.2、路由映射
先前我们在构建路由映射列表的时候，使用的是二元元组，如：
[(r"/", IndexHandler),]对于这个映射列表中的路由，实际上还可以传入多个信息，如：
[
(r"/", Indexhandler),
(r"/cpp", ItcastHandler, {"subject":"c++"}),
url(r"/python", ItcastHandler, {"subject":"python"}, name="python_url")
]对于路由中的字典，会传入到对应的RequestHandler的initialize()方法中：
from tornado.web import RequestHandler
class ItcastHandler(RequestHandler):
def initialize(self, subject):
self.subject = subject
def get(self):
self.write(self.subject)对于路由中的name字段，注意此时不能再使用元组，而应使用tornado.web.url来构建。name是给该路由起一个名字，可以通过调用RequestHandler.reverse_url(name)来获取该名子对应的url。
# coding:utf-8
import tornado.web
import tornado.ioloop
import tornado.httpserver
import tornado.options
from tornado.options import options, define
from tornado.web import url, RequestHandler
define("port", default=8000, type=int, help="run server on the given port.")
class IndexHandler(RequestHandler):
def get(self):
python_url = self.reverse_url("python_url")
self.write('<a href="%s">itcast</a>' %
python_url)
class ItcastHandler(RequestHandler):
def initialize(self, subject):
self.subject = subject
def get(self):
self.write(self.subject)
if __name__ == "__main__":
tornado.options.parse_command_line()
app = tornado.web.Application([
(r"/", Indexhandler),
(r"/cpp", ItcastHandler, {"subject":"c++"}),
url(r"/python", ItcastHandler, {"subject":"python"}, name="python_url")
],
debug = True)
http_server = tornado.httpserver.HTTPServer(app)
http_server.listen(options.port)
tornado.ioloop.IOLoop.current().start()2、输入
下面几节主要讲解tornado.web.RequestHandler。
回想一下，利用HTTP协议向服务器传参有几种途径？
- 查询字符串（query string)，形如key1=value1&key2=value2；
- 请求体（body）中发送的数据，比如表单数据、json、xml；
- 提取uri的特定部分，如/blogs/2016/09/0001，可以在服务器端的路由中用正则表达式截取；
- 在http报文的头（header）中增加自定义字段，如X-XSRFToken=itcast。
我们现在来看下tornado中为我们提供了哪些方法来获取请求的信息。
2.1、获取查询字符串参数
get_query_argument(name, default=_ARG_DEFAULT, strip=True)
从请求的查询字符串中返回指定参数name的值，如果出现多个同名参数，则返回最后一个的值。
default为设值未传name参数时返回的默认值，如若default也未设置，则会抛出tornado.web.MissingArgumentError异常。
strip表示是否过滤掉左右两边的空白字符，默认为过滤。
get_query_arguments(name, strip=True)
从请求的查询字符串中返回指定参数name的值，注意返回的是list列表（即使对应name参数只有一个值）。若未找到name参数，则返回空列表[]。
strip同前，不再赘述。
2.2、 获取请求体参数
get_body_argument(name, default=_ARG_DEFAULT, strip=True)
从请求体中返回指定参数name的值，如果出现多个同名参数，则返回最后一个的值。
default与strip同前，不再赘述。
get_body_arguments(name, strip=True)
从请求体中返回指定参数name的值，注意返回的是list列表（即使对应name参数只有一个值）。若未找到name参数，则返回空列表[]。
strip同前，不再赘述。
说明
对于请求体中的数据要求为字符串，且格式为表单编码格式（与url中的请求字符串格式相同），即key1=value1&key2=value2，HTTP报文头Header中的"Content-Type"为application/x-www-form-urlencoded 或 multipart/form-data。对于请求体数据为json或xml的，无法通过这两个方法获取。
2.3. 前两类方法的整合
get_argument(name, default=_ARG_DEFAULT, strip=True)
从请求体和查询字符串中返回指定参数name的值，如果出现多个同名参数，则返回最后一个的值。
default与strip同前，不再赘述。
get_arguments(name, strip=True)
从请求体和查询字符串中返回指定参数name的值，注意返回的是list列表（即使对应name参数只有一个值）。若未找到name参数，则返回空列表[]。
strip同前，不再赘述。
说明
对于请求体中数据的要求同前。 这两个方法最常用。
#coding:utf-8
import tornado.web
import tornado.ioloop
import tornado.httpserver
import tornado.options
from tornado.options import options,define
from tornado.web import RequestHandler,MissingArgumentError
define("port",default=8000,type=int,help="run server on the given port.")
class IndexHandler(RequestHandler):
def post(self):
query_arg = self.get_query_argument('a')
query_args = self.get_query_arguments('a')
body_arg = self.get_body_argument('a')
body_args = self.get_query_arguments('a')
arg = self.get_argument('a')
args = self.get_arguments('a')
default_arg = self.get_argument('b','itcast')
default_args = self.get_arguments('b')
try:
missing_arg = self.get_argument('c')
except MissingArgumentError as e:
missing_arg = 'we cached the MissingArgumentError!'
print(e)
missing_args = self.get_arguments('c')
rep = "query_arg:%s<br/>" % query_arg
rep += "query_args:%s<br/>" % query_args
rep += "body_arg:%s<br/>" % body_arg
rep += "body_args:%s<br/>" % body_args
rep += "arg:%s<br/>" % arg
rep += "args:%s<br/>" % args
rep += "default_arg:%s<br/>" % default_arg
rep += "default_args:%s<br/>" % default_args
rep += "missing_arg:%s<br/>" % missing_arg
rep += "missing_args:%s<br/>" % missing_args
self.write(rep)
if __name__ == "__main__":
tornado.options.parse_command_line()
app = tornado.web.Application([(r'/',IndexHandler),])
http_server = tornado.httpserver.HTTPServer(app)
http_server.listen(options.port)
tornado.ioloop.IOLoop.current().start()
注意：以上方法返回的都是unicode字符串
2.4. 关于请求的其他信息
RequestHandler.request 对象存储了关于请求的相关信息，具体属性有：
- method HTTP的请求方式，如GET或POST;
- host 被请求的主机名；
- uri 请求的完整资源标示，包括路径和查询字符串；
- path 请求的路径部分；
- query 请求的查询字符串部分；
- version 使用的HTTP版本；
- headers 请求的协议头，是类字典型的对象，支持关键字索引的方式获取特定协议头信息，例如：request.headers["Content-Type"]
- body 请求体数据；
- remote_ip 客户端的IP地址；
- files 用户上传的文件，为字典类型如：
{
"form_filename1":[<tornado.httputil.HTTPFile>, <tornado.httputil.HTTPFile>],
"form_filename2":[<tornado.httputil.HTTPFile>,],
...
}
tornado.httputil.HTTPFile是接收到的文件对象，它有三个属性：
- filename 文件的实际名字，与form_filename1不同，字典中的键名代表的是表单对应项的名字；
- body 文件的数据实体；
- content_type 文件的类型。 这三个对象属性可以像字典一样支持关键字索引，如request.files["form_filename1"][0]["body"]。
我们来实现一个上传文件并保存在服务器本地的小程序upload.py：
# coding:utf-8
import tornado.web
import tornado.ioloop
import tornado.httpserver
import tornado.options
from tornado.options import options, define
from tornado.web import RequestHandler
define("port", default=8000, type=int, help="run server on the given port.")
class IndexHandler(RequestHandler):
def get(self):
self.write("hello itcast.")
class UploadHandler(RequestHandler):
def post(self):
files = self.request.files
img_files = files.get('img')
if img_files:
img_file = img_files[0]["body"]
file = open("./itcast", 'w+')
file.write(img_file)
file.close()
self.write("OK")
if __name__ == "__main__":
tornado.options.parse_command_line()
app = tornado.web.Application([
(r"/", IndexHandler),
(r"/upload", UploadHandler),
])
http_server = tornado.httpserver.HTTPServer(app)
http_server.listen(options.port)
tornado.ioloop.IOLoop.current().start()
3、输出数据流
- self.write()
- 将数据写入输出缓冲区. 如果直接传入dict, 那Tornado会自动将其识别为json, 并把Content-Type设置为application/json, 如果你不想要这个Content-Type, 那么在.write()之后, 调用.set_header()重新设置就好了. 需要注意的是, 如果直接传入的是list, 考虑到安全问题(json数组会被认为是一段可执行的JavaScript脚本, 且<script src="*/secret.json">可以绕过跨站限制),list将不会被转换成json.
- self.flush()
- 将输出缓冲区的数据写入socket. 如果设置了callback, 会在完成数据写入后回调. 需要注意的是, 同一时间只能有一个”等待”的flush callback, 如果”上一次”的flush callback还没执行, 又来了新的flush, 那么”上一次”的flush callback会被忽略掉.
- self.finish()
- 完成响应, 结束本次请求. 通常情况下, 请求会在return时自动调用.finish(), 只有在使用了异步装饰器@asynchronous或其他将._auto_finish设置为False的操作, 才需要手动调用.finish().
4、cookie
def get(self):
self.write("hello qikuedu.com")
self.set_cookie("loginuser", "admin老王")
print(self.get_cookie("loginuser"))
print(self.cookies)
5、header
- .add_header() .set_header() .set_default_headers()
- 设置响应HTTP头, 前两者的不同点在于多次设置同一个项时, .add_header()会叠加参数, 而.set_header()则以最后一次为准.
- .set_default_headers()比较特殊, 是一个空方法, 可根据需要重写, 作用是在每次请求初始化RequestHandler时设置默认headers.
- .clear_header() .clear()
- .clear_header()清除指定的headers, 而.clear()清除.set_default_headers()以外所有的headers设置.
class IndexHandler(RequestHandler):
def set_default_headers(self):
# 第二种响应头设置方式
print("---------> 响应头set_default_headers()执行")
self.set_header("Content-type", "application/json; charset=utf-8")
self.set_header("qiku", "奇酷信息")
def get(self):
# 第一种操作响应头的方式：
# self.set_header("Content-type", "application/json")
print("---------->get方法执行")
self.write("{'name':'jerry'}")
self.set_header("qiku", "qikuedu.com")
6、writerror
.send_error()用于发送HTTP错误页(状态码). 该操作会调用.clear().set_status().write_error()用于清除headers, 设置状态码, 发送错误页. 重写.write_error()可以自定义错误页.
def get(self):
self.write("hello qikuedu.com")
self.send_error(404, msg="页面丢失", info="家里服务器搞对象去了")
7、正则提取uri
tornado中对于路由映射也支持正则提取uri，提取出来的参数会作为RequestHandler中对应请求方式的成员方法参数。若在正则表达式中定义了名字，则参数按名传递；若未定义名字，则参数按顺序传递。提取出来的参数会作为对应请求方式的成员方法的参数。
# coding:utf-8
import tornado.web
import tornado.ioloop
import tornado.httpserver
import tornado.options
from tornado.options import options, define
from tornado.web import RequestHandler
define("port", default=8000, type=int, help="run server on the given port.")
class IndexHandler(RequestHandler):
def get(self):
self.write("hello itcast.")
class SubjectCityHandler(RequestHandler):
def get(self, subject, city):
self.write(("Subject: %s<br/>City: %s" % (subject, city)))
class SubjectDateHandler(RequestHandler):
def get(self, date, subject):
self.write(("Date: %s<br/>Subject: %s" % (date, subject)))
if __name__ == "__main__":
tornado.options.parse_command_line()
app = tornado.web.Application([
(r"/", IndexHandler),
(r"/sub-city/(.+)/([a-z]+)", SubjectCityHandler), # 无名方式
(r"/sub-date/(?P<subject>.+)/(?P<date>\d+)", SubjectDateHandler), # 命名方式
])
http_server = tornado.httpserver.HTTPServer(app)
http_server.listen(options.port)
tornado.ioloop.IOLoop.current().start()
建议：提取多个值时最好用命名方式。
225
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
