Python在 FastAPI 中配置静态文件服务的实现及应用详解_Python

随着现代 web 开发的进步，前端和后端的分工越来越明确，静态文件的管理和提供已经成为后端服务的重要组成部分。在 fastapi 框架中，如何有效地提供静态文件服务成为了许多开发者关心的问题。

1. fastapi 的基本概念

fastapi 是一个现代、快速（高性能）的 web 框架，用于构建 api，基于 python 3.6+ 标准库类型提示（type hints）。它以快速开发、性能优异以及自动生成文档的特性获得了广泛的应用。fastapi 的设计理念之一是易于使用，但同时又具备强大的功能，支持 restful api、websocket 连接、异步编程等。

fastapi 本身并没有为文件服务器提供内置的静态文件路由功能，但是可以通过 staticfiles 中间件来方便地配置静态文件的访问。

2. 项目需求

假设我们有一个 fastapi 应用，该应用需要提供静态文件服务，允许用户访问位于 files 目录下的图片文件。目标是让用户能够通过路径 http://127.0.0.1:8888/test/default/files/img.png 来访问图片文件。此时，我们需要为 fastapi 应用配置一个静态文件路由。

3. 分析项目结构

在 fastapi 项目中，通常会有多个文件和目录结构，其中可能包括业务逻辑、配置文件、静态文件等。以下是我们假设的项目结构：

/project
├── serverapp.py # fastapi 应用的入口文件
├── files # 静态文件目录
│ └── img.png # 需要访问的图片文件
├── manager
│ └── public_interface
│ └── __init__.py
├── config
│ └── config.yaml
└── test_static_server.py

从结构上看，files 目录下有一个名为 img.png 的图片文件。我们的目标是通过 fastapi 提供静态文件服务，允许用户访问该图片。

4. 配置 fastapi 静态文件路由

为了在 fastapi 中提供静态文件服务，我们需要使用 staticfiles 中间件。staticfiles 是 fastapi 提供的一个工具，可以将指定目录中的文件暴露为静态文件，以便客户端可以通过 http 请求访问这些文件。

在 fastapi 中配置静态文件服务，主要涉及以下步骤：

1.导入 staticfiles：首先，我们需要从 fastapi.staticfiles 模块导入 staticfiles 类。

2.配置静态文件挂载：然后，我们需要在 fastapi 应用中配置静态文件的挂载，指定文件的根目录和请求路径前缀。

假设我们要让用户通过 /test/default/files/ 路径访问 files 目录下的所有文件，那么我们需要在 serverapp.py 文件中做如下配置：

from fastapi import fastapi
from fastapi.staticfiles import staticfiles

app = fastapi()

# 挂载静态文件服务
app.mount("/test/default/files", staticfiles(directory="files"), name="static")

在上述代码中，app.mount 方法将 files 目录挂载到 /test/default/files 路径。这样，任何请求路径以 /test/default/files 开头的请求都会被路由到 files 目录中查找相应的文件。

3.启动 fastapi 应用：配置完成后，我们可以启动 fastapi 应用。在开发环境中，fastapi 提供了一个内建的开发服务器，可以使用以下命令启动：

uvicorn serverapp:app --reload

4.访问静态文件：启动服务器后，我们可以通过浏览器或 http 客户端访问静态文件。例如，要访问 img.png 文件，可以访问：http://127.0.0.1:8888/test/default/files/img.png

如果一切配置正确，浏览器会显示图片文件。

5. 无需鉴权访问

在这个示例中，我们不需要对静态文件的访问进行身份验证或权限控制。staticfiles 默认会允许任何人访问挂载的文件夹。如果需要对访问进行控制（例如，添加鉴权功能），可以在路由中加入自定义的权限控制逻辑。

例如，可以使用 fastapi 的 depends 和 oauth2passwordbearer 等方式来在文件服务路由上进行身份验证。

6. 测试静态文件服务

为了确保静态文件服务配置正确，我们可以编写一个简单的测试脚本。通过 test_static_server.py 文件，可以模拟发送 http 请求并验证静态文件是否能够正确响应。

import requests

# 测试静态文件访问
url = "http://127.0.0.1:8888/test/default/files/img.png"
response = requests.get(url)

if response.status_code == 200:
    print("图片文件访问成功！")
else:
    print("图片文件访问失败！")

在测试脚本中，我们通过 requests.get 发送一个 get 请求，访问图片文件。如果返回的状态码为 200，表示文件访问成功。