flask send_file 发送内存文件|极客教程

flask send_file 发送内存文件

在Web开发中，有时候我们需要从服务器端发送内存中的文件给客户端，这个过程称为发送内存文件。在使用Flask框架进行Web开发时，我们可以使用send_file函数来实现这个功能。

本文将详细介绍如何使用send_file函数发送内存文件，并提供一些示例代码帮助您更好地理解这个过程。

1. send_file 函数简介

在Flask框架中，send_file是一个用于发送文件的函数。它可以接受文件路径、文件对象或者字节流作为参数，并将这些文件发送给客户端。

send_file函数的基本语法如下：

from flask import send_file

send_file(filename_or_fp, mimetype=None, as_attachment=False, attachment_filename=None, cache_timeout=None, conditional=False, etag=None, last_modified=None, max_age=None)

其中，参数的含义如下：

filename_or_fp：要发送的文件路径、文件对象或者字节流。
mimetype：文件的MIME类型。
as_attachment：是否作为附件发送，默认为False。
attachment_filename：如果作为附件发送，指定文件名。
cache_timeout：缓存超时时间。
conditional：是否启用条件响应。
etag：ETag值。
last_modified：最后修改时间。
max_age：最大缓存时间。

2. 发送文件路径

首先，我们来看一个示例，演示如何使用send_file函数发送文件路径。

from flask import Flask, send_file

app = Flask(__name__)

@app.route('/download')
def download_file():
    return send_file('path/to/file.txt')

if __name__ == '__main__':
    app.run()

在这个示例中，我们定义了一个路由/download，当用户访问这个路由时，会发送文件路径path/to/file.txt给客户端。

3. 发送文件对象

除了发送文件路径，send_file函数还可以发送文件对象。下面是一个示例代码：

from flask import Flask, send_file
import io

app = Flask(__name__)

@app.route('/download')
def download_file():
    file_obj = io.BytesIO(b'hello world')
    return send_file(file_obj, mimetype='text/plain')

if __name__ == '__main__':
    app.run()

在这个示例中，我们创建了一个内存中的文件对象file_obj，然后使用send_file函数将这个文件对象发送给客户端。

4. 发送字节流

除了发送文件路径和文件对象，send_file函数还可以发送字节流。下面是一个示例代码：

from flask import Flask, send_file

app = Flask(__name__)

@app.route('/download')
def download_file():
    file_content = b'hello world'
    return send_file(io.BytesIO(file_content), mimetype='text/plain')

if __name__ == '__main__':
    app.run()

在这个示例中，我们创建了一个字节流file_content，然后使用send_file函数将这个字节流发送给客户端。

5. 其他参数

除了上述示例中介绍的参数外，send_file函数还支持其他参数。下面是一个示例代码：

from flask import Flask, send_file

app = Flask(__name__)

@app.route('/download')
def download_file():
    file_content = b'hello world'
    return send_file(io.BytesIO(file_content), mimetype='text/plain', as_attachment=True, attachment_filename='file.txt', cache_timeout=60, conditional=True, etag='123456', last_modified='Sun, 06 Dec 2020 00:00:00 GMT', max_age=60)

if __name__ == '__main__':
    app.run()

在这个示例中，我们使用了send_file函数的各个参数来发送文件，并设置了一些附加的参数，比如作为附件发送、缓存超时时间、启用条件响应等。