python - 如何在 Flask 中提供静态文件

Question

所以这很尴尬。我在 Flask 中有一个应用程序，现在它只是提供一个静态 HTML 页面，其中包含一些指向 CSS 和 JS 的链接。而且我找不到文档 Flask 描述返回静态文件的位置。是的，我可以使用 render_template 但我知道数据没有模板化。我原以为 send_file 或 url_for 是正确的，但我无法让它们工作。与此同时，我正在打开文件、阅读内容并使用适当的 mimetype 装配 Response:

import os.path

from flask import Flask, Response


app = Flask(__name__)
app.config.from_object(__name__)


def root_dir():  # pragma: no cover
    return os.path.abspath(os.path.dirname(__file__))


def get_file(filename):  # pragma: no cover
    try:
        src = os.path.join(root_dir(), filename)
        # Figure out how flask returns static files
        # Tried:
        # - render_template
        # - send_file
        # This should not be so non-obvious
        return open(src).read()
    except IOError as exc:
        return str(exc)


@app.route('/', methods=['GET'])
def metrics():  # pragma: no cover
    content = get_file('jenkins_analytics.html')
    return Response(content, mimetype="text/html")


@app.route('/', defaults={'path': ''})
@app.route('/<path:path>')
def get_resource(path):  # pragma: no cover
    mimetypes = {
        ".css": "text/css",
        ".html": "text/html",
        ".js": "application/javascript",
    }
    complete_path = os.path.join(root_dir(), path)
    ext = os.path.splitext(path)[1]
    mimetype = mimetypes.get(ext, "text/html")
    content = get_file(complete_path)
    return Response(content, mimetype=mimetype)


if __name__ == '__main__':  # pragma: no cover
    app.run(port=80)

有人想为此提供代码示例或网址吗？我知道这将非常简单。

Answer 1

在生产环境中，在您的应用程序前面配置 HTTP 服务器(Nginx、Apache 等)以处理对 /static 的请求从静态文件夹。专用的 Web 服务器非常擅长高效地提供静态文件，尽管您可能不会注意到与 Flask 在低容量下的区别。

Flask 自动创建一个 /static/<path:filename>将服务于任何 filename 的路线下static定义 Flask 应用程序的 Python 模块旁边的文件夹。使用url_for链接到静态文件:url_for('static', filename='js/analytics.js')

您也可以使用 send_from_directory 从您自己的路径中的目录提供文件。这需要一个基本目录和一个路径，并确保路径包含在目录中，这样可以安全地接受用户提供的路径。这在您想在提供文件之前检查某些内容的情况下很有用，例如登录的用户是否有权限。

from flask import send_from_directory

@app.route('/reports/<path:path>')
def send_report(path):
    return send_from_directory('reports', path)

不要不要使用send_file或 send_static_file使用用户提供的路径。这将使您接触到 directory traversal attacks . send_from_directory旨在安全地处理已知目录下的用户提供的路径，如果路径试图转义该目录，则会引发错误。

如果您在内存中生成文件而不将其写入文件系统，则可以传递 BytesIO反对 send_file 像文件一样提供它。您需要将其他参数传递给 send_file在这种情况下，因为它无法推断文件名或内容类型等内容。