Flask进阶系列(五)–文件和流

当我们要往客户端发送大量的数据,比如一个大文件时,将它保存在内存中再一次性发到客户端开销很大。比较好的方式是使用流,本篇就要介绍怎么在Flask中通过流的方式来将响应内容发送给客户端。此外,我们还会演示如何实现文件的上传功能,以及如何获取上传后的文件。

系列文章

响应流的生成

Flask响应流的实现原理就是通过Python的生成器,也就是大家所熟知的yield的表达式,将yield的内容直接发送到客户端。下面就是一个简单的实现:

这段代码会生成一个5万行100M的csv文件,每一行会通过yield表达式分别发送给客户端。运行时你会发现文件行的生成与浏览器文件的下载是同时进行的,而不是文件全部生成完毕后再开始下载。这里我们用到了响应类”flask.Response”,它是”werkzeug.wrappers.Response”类的一个包装,它的初始化方法第一个参数就是我们定义的生成器函数,第二个参数指定了响应类型。

我们将上述方法应用到模板中,如果模板的内容很大,怎么采用流的方式呢?这里我们要自己写个流式渲染模板的方法。

这段代码的核心,就是通过”app.jinja_env”来访问Jinja2的Environment对象,这个我们在Jinja2系列中有介绍,然后调用Environment对象的”get_template()”方法来获得模板对象,再调用模板对象的”stream()”方法生成一个”StreamTemplate”的对象。这个对象实现了”__next__()”方法,可以作为一个生成器使用,如果你看了Jinja2的源码,你会发现模板对象的”stream()”方法的实现就是使用了yield表达式,所以原理同上例一样。另外,我们启用了缓存”enable_buffering()”来避免客户端发送过于频繁,其参数的默认值就是5。

现在我们就可以在视图方法中,采用”stream_template()”,而不是以前介绍的”render_template()”来渲染模板了:

上例的代码会将本地的”server.log”日志文件内容传入模板,并以流的方式渲染在页面上。

另外注意,在生成器中是无法访问请求上下文的。不过Flask从版本0.9开始提供了”stream_with_context()”方法,它允许生成器在运行期间获取请求上下文:

因为我们初始化Response对象时调用了”stream_with_context()”方法,所以才能在yield表达式中访问request对象。

文件上传

我们分下面4个步骤来实现文件上传功能:

  1. 首先建立一个让用户上传文件的页面,我们将其放在模板”upload.html”中
  2. 这里主要就是一个enctype=”multipart/form-data”的form表单;一个类型为file的input框,即文件选择框;还有一个提交按钮。

  3. 定义一个文件合法性检查函数
  4. 这样避免用户上传脚本文件如js或php文件,来干坏事!

  5. 文件提交后,在POST请求的视图函数中,通过request.files获取文件对象
  6. 这个request.files是一个字典,字典的键值就是之前模板中文件选择框的”name”属性的值,上例中是”file”;键值所对应的内容就是上传过来的文件对象。

  7. 检查文件对象的合法性后,通过文件对象的save()方法将文件保存在本地
  8. 我们将第3和第4步都放在视图函数中,代码如下:

    解释都写在注释里了,应该很容易看懂。重点要介绍的就是:

    1. Flask的MAX_CONTENT_LENGTH配置项可以限制请求内容的大小
    2. 默认是没有限制,上例中我们设为5M。

    3. 必须调用”werkzeug.secure_filename()”来使文件名安全
    4. 比如用户上传的文件名为”../../../../home/username/.bashrc”,”secure_filename()”方法可以将其转为”home_username_.bashrc”。还是用来避免用户干坏事!

    5. Flask处理文件上传的方式
    6. 如果上传的文件很小,那么会把它直接存在内存中。否则就会把它保存到一个临时目录下,通过”tempfile.gettempdir()”方法可以获取这个临时目录的位置。

另外Flask从0.5版本开始提供了一个简便的方法来让用户获取已上传的文件:

这个帮助方法”send_from_directory()”可以安全地将文件发送给客户端,它还可以接受一个参数”mimetype”来指定文件类型,和参数”as_attachment=True”来添加响应头”Content-Disposition: attachment”。

本篇中的示例代码可以在这里下载

转载请注明出处: 思诚之道

《Flask进阶系列(五)–文件和流》有2个想法

发表评论

电子邮件地址不会被公开。 必填项已用*标注