FastAPI应用配置管理：环境变量与配置文件入门教程

引言

欢迎！如果你刚接触Web开发，特别是FastAPI，配置管理可能听起来很复杂。别担心！今天，我们将一步步学习如何使用环境变量和配置文件来管理你的应用设置。想象一下，你经营一家咖啡店：在不同的季节，你可能需要调整菜单（比如夏天卖冰咖啡，冬天卖热巧克力）。配置管理就是这样——让你的应用适应不同环境（如开发、生产）。

为什么需要配置管理？

在实际开发中，你的应用可能需要在不同的环境中运行：开发、测试、生产。每个环境可能有不同的设置，比如数据库连接、API密钥等。通过配置管理，你可以轻松切换这些设置，而无需修改代码。

生活化类比

• 环境变量：就像你家里的温度设置。冬天时，你把暖气调高；夏天时，空调调低。它们是外部参数，根据环境变化。
• 配置文件：就像餐厅的菜单。餐厅可以根据不同场合（如早餐、午餐）调整菜单，而不改变厨房的布局。

第一部分：环境变量

什么是环境变量？

环境变量是你的操作系统中的变量，用来存储配置信息。在Python中，你可以轻松读取它们。

快速上手：读取环境变量

1. 确保你安装了Python。如果没有，先安装Python。

2. 创建一个新的Python文件，比如 app.py。

3. 添加以下代码：

import os

# 读取环境变量
my_variable = os.environ.get('MY_VARIABLE', '默认值')
print(f"环境变量 MY_VARIABLE 的值是: {my_variable}")

4. 在终端设置环境变量，然后运行代码：

   • 在Windows：set MY_VARIABLE=HelloWorld
   • 在Linux/Mac：export MY_VARIABLE=HelloWorld

   然后运行 python app.py。你会看到输出，成功读取了环境变量！

在FastAPI中使用环境变量

现在，让我们集成到FastAPI。

1. 安装FastAPI和Uvicorn：

   pip install fastapi uvicorn
   

2. 创建一个新的文件 main.py：

from fastapi import FastAPI
import os

app = FastAPI()

@app.get("/")
def read_root():
    # 读取环境变量
    api_key = os.environ.get('API_KEY', '未设置')
    return {"message": f"API Key: {api_key}"}

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

3. 设置环境变量并运行：

   export API_KEY=mysecretkey
   uvicorn main:app --reload
   

访问 http://localhost:8000，你会看到JSON响应，显示你的API Key。恭喜！你成功使用了环境变量。

第二部分：配置文件

为什么使用配置文件？

配置文件提供了一种更结构化、可维护的方式来管理多个设置，而不是全部放在环境变量中。

示例配置文件

创建一个 .env 文件（这是常用格式）：

DATABASE_URL=postgresql://user:password@localhost/dbname
DEBUG=True
SECRET_KEY=mysecret

或者，一个 config.json 文件：

{
  "database_url": "postgresql://user:password@localhost/dbname",
  "debug": true,
  "secret_key": "mysecret"
}

在FastAPI中读取配置文件

1. 使用 python-dotenv 库来读取 .env 文件：

   pip install python-dotenv
   

2. 更新 main.py：

from fastapi import FastAPI
import os
from dotenv import load_dotenv

# 加载.env文件
load_dotenv()

app = FastAPI()

@app.get("/")
def read_root():
    db_url = os.environ.get('DATABASE_URL', '未设置')
    debug = os.environ.get('DEBUG', 'False')
    return {"database_url": db_url, "debug": debug}

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

3. 创建 .env 文件，设置值。

4. 运行应用：uvicorn main:app --reload

现在，你的应用从配置文件读取设置。成功！

实践示例：结合使用环境变量和配置文件

让我们创建一个更完整的例子。

创建一个 config.py 文件来管理配置：

import os
from dotenv import load_dotenv

load_dotenv()

class Config:
    DATABASE_URL = os.environ.get('DATABASE_URL')
    DEBUG = os.environ.get('DEBUG', 'False').lower() == 'true'
    SECRET_KEY = os.environ.get('SECRET_KEY', 'default_secret')

然后在 main.py 中使用：

from fastapi import FastAPI
from config import Config

app = FastAPI()

@app.get("/")
def read_root():
    return {
        "database_url": Config.DATABASE_URL,
        "debug": Config.DEBUG,
        "secret_key": Config.SECRET_KEY
    }

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

设置好环境变量或配置文件后运行。你会看到所有配置信息。

总结

通过这个教程，你学会了：

• 为什么需要配置管理。
• 如何使用环境变量和配置文件来存储设置。
• 在FastAPI应用中集成它们。

继续探索FastAPI，尝试添加更多配置项，或者使用不同的配置文件格式如YAML。

记住，实践是关键！多动手，你会越来越熟练。