Flask中的send_from_directory方法详解|极客笔记

Flask中的send_from_directory方法详解

在Flask中，send_from_directory是一个常用的函数，用于发送指定目录中的文件给客户端。本文将详细介绍send_from_directory的用法及相关注意事项。

send_from_directory的基本用法

send_from_directory函数的基本用法如下：

from flask import Flask, send_from_directory

app = Flask(__name)

@app.route('/download/<path:filename>')
def download_file(filename):
    return send_from_directory(directory='/path/to/directory', filename=filename)

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

在上面的示例中，我们首先导入了Flask和send_from_directory模块，然后创建了一个Flask应用程序。接着定义了一个路由/download/，当客户端访问该路由时，会执行download_file函数。在download_file函数中，我们使用send_from_directory函数发送指定目录中的文件给客户端。

send_from_directory的参数说明

send_from_directory函数接受三个参数：directory、filename和mimetype。

directory：指定要发送文件的目录
filename：指定要发送的文件名
mimetype：指定要发送的文件类型

如果不指定mimetype参数，send_from_directory会根据文件扩展名自动推断文件类型。

send_from_directory的注意事项

在使用send_from_directory函数时，需要注意以下几点：

安全性：send_from_directory函数应该仅用于发送静态文件，避免发送用户上传的文件或敏感文件。
目录路径：directory参数应该是绝对路径，确保发送的文件确实存在于指定目录中。
文件名安全性：避免直接将用户提供的文件名传递给send_from_directory函数，应该对文件名进行验证和过滤，确保安全性。

示例

假设我们有一个名为files的目录，其中包含一个名为example.txt的文件。我们可以使用send_from_directory函数发送该文件给客户端。

from flask import Flask, send_from_directory

app = Flask(__name)

@app.route('/download')
def download_file():
    return send_from_directory(directory='/path/to/files', filename='example.txt')

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

在这个示例中，访问/download路由将返回example.txt文件。