คุณจัดการ settings ด้วย Pydantic ได้อย่างไร?

Question

Accepted Answer

แอปพลิเคชัน FastAPI จัดการ configuration ด้วย **`pydantic-settings`** (`BaseSettings`) — คลาสที่อ่าน config จาก **environment variables** (และไฟล์ `.env`) พร้อม **การตรวจสอบและการแปลงชนิด** ทำให้ secrets ไม่อยู่ในโค้ดและรับประกันว่า config ถูกต้องตั้งแต่ตอน startup

## การนิยาม settings

```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` อ่านแต่ละ field จาก **environment variable** ที่ตรงกันโดยอัตโนมัติ (เช่น `DATABASE_URL`), แปลงชนิด (`"true"` → `bool`, `"10"` → `int`) และ **ตรวจสอบ** — ค่าที่จำเป็นซึ่งหายไปหรือชนิดผิดจะล้มเหลวทันทีตอน startup พร้อม error ที่ชัดเจน (fail-fast)

## การใช้ settings (ผ่าน dependency injection)

```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}
```

การ inject settings ผ่าน cached dependency ทำให้มัน **ทดสอบได้** (override ในการทดสอบได้) และรับประกัน instance เดียว

## ไฟล์ .env และ secrets

```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)
```

## ทำไมจึงสำคัญ

การจัดการ settings ที่เหมาะสมเป็นทั้ง **ความจำเป็นเชิงปฏิบัติการ** (แอปต้องการ config ที่ต่างกันใน dev/staging/production) และ **ข้อกำหนดด้านความปลอดภัย** (secrets เช่น database URLs และ keys ต้องไม่ถูก hardcode ใน source control — เป็นการรั่วไหลที่พบบ่อยและร้ายแรง)

`BaseSettings` ของ Pydantic ให้โซลูชันที่เป็นสำนวนของ FastAPI และการเข้าใจมันเป็นความรู้ในชีวิตประจำวันที่สำคัญ

ข้อได้เปรียบหลัก: การอ่าน config จาก **environment variables** (ทำให้ secrets ไม่อยู่ในโค้ด ตามแนวทาง twelve-factor) พร้อม **การแปลงชนิดและการตรวจสอบอัตโนมัติ** — ดังนั้นการตั้งค่าที่ผิดจึงล้มเหลวเร็วตอน startup พร้อม error ที่ชัดเจนแทนที่จะเป็นความล้มเหลวตอน runtime ที่สับสน

เมื่อรวมกับ dependency injection (ทำให้ settings ทดสอบได้และเป็น singleton) และแนวปฏิบัติของไฟล์ `.env` ที่ gitignored สำหรับการพัฒนาแบบ local สิ่งนี้ให้ configuration ที่ปลอดภัย ผ่านการตรวจสอบ และเหมาะสมกับสภาพแวดล้อม

การรู้วิธีนิยาม settings, ใช้มันผ่าน DI และจัดการ secrets อย่างปลอดภัยเป็นพื้นฐานสำหรับการสร้างแอป FastAPI ที่พร้อมสำหรับ production