您如何使用Pydantic管理设置？

Question

您如何使用Pydantic管理设置？

Accepted Answer

FastAPI应用程序使用**`pydantic-settings`**（`BaseSettings`）来管理配置——这是一个从**环境变量**（和`.env`文件）读取配置的类，具有**验证和类型转换**功能，将秘密保持在代码之外，并确保配置在启动时正确。

## 定义设置

```python
from pydantic_settings import BaseSettings

class Settings(BaseSettings):
    app_name: str = "My API"
    database_url: str                       # required — must be provided
    secret_key: str                          # required (a secret)
    debug: bool = False
    max_connections: int = 10

class Config:
        env_file = ".env"                    # also read from a .env file

settings = Settings()                        # reads & VALIDATES env vars at startup
```

`BaseSettings`自动从匹配的**环境变量**（例如`DATABASE_URL`）读取每个字段，转换类型（`"true"` → `bool`，`"10"` → `int`），并**验证**——缺少必需值或类型错误会在启动时立即失败，并显示清晰的错误消息（快速失败）。

## 使用设置（通过依赖注入）

```python
from functools import lru_cache
from fastapi import Depends

@lru_cache                              # create the Settings once (cached)
def get_settings():
    return Settings()

@app.get("/info")
def info(settings: Settings = Depends(get_settings)):
    return {"app": settings.app_name, "debug": settings.debug}
```

通过缓存的依赖项注入设置可使其**可测试**（在测试中覆盖）并确保单一实例。

## .env文件和秘密

```bash
# .env — local config, GITIGNORED (never commit secrets)
DATABASE_URL=postgresql://localhost/mydb
SECRET_KEY=dev-secret
DEBUG=true
```

```text
✓ Keep secrets in env vars / .env (gitignored); commit a .env.example documenting keys
✓ In production, inject config via the platform's environment / secret manager
✓ Validation at startup catches misconfiguration immediately (not deep in a request)
```

## 为什么这很重要

适当的设置管理既是**运营必需**（应用程序在开发/预发布/生产环境中需要不同的配置），也是**安全要求**（数据库URL和密钥等秘密绝不能在源代码控制中硬编码——这是常见且严重的漏洞）。

Pydantic的`BaseSettings`提供了idiomatic的FastAPI解决方案，理解它是日常必需的知识。

其主要优势包括：从**环境变量**读取配置（将秘密保持在代码之外，遵循十二因子应用方法），具有自动**类型转换和验证**——因此配置错误会在启动时快速失败并显示清晰的错误消息，而不是作为令人困惑的运行时故障。

结合依赖注入（使设置可测试且单例）和本地开发中gitignored`.env`文件的实践，这为您提供了安全、经过验证的、环境适配的配置。

了解如何定义设置、通过DI使用设置以及安全地处理秘密，对于构建生产就绪的FastAPI应用程序是基础知识。