คุณเขียน validation แบบกำหนดเองใน Pydantic ได้อย่างไร?

Question

Accepted Answer

นอกเหนือจาก constraints ที่มีมาให้ในตัว Pydantic ยังให้คุณเขียน **logic การตรวจสอบแบบกำหนดเอง** ด้วย field validators (ตรวจสอบหนึ่ง field) และ model validators (ตรวจสอบข้ามหลาย fields) — สำหรับกฎที่ constraints ธรรมดาไม่สามารถแสดงได้ (ไวยากรณ์ที่แสดงคือ Pydantic v2)

## Field validators — ตรวจสอบ/แปลงค่าหนึ่ง field

```python
from pydantic import BaseModel, field_validator

class User(BaseModel):
    username: str
    password: str

@field_validator("username")
    @classmethod
    def username_alphanumeric(cls, v: str) -> str:
        if not v.isalnum():
            raise ValueError("username must be alphanumeric")   # → a 422 error
        return v.lower()                                         # can also TRANSFORM the value
```

`@field_validator` ทำงาน logic แบบกำหนดเองกับ field: raise `ValueError` เพื่อปฏิเสธ input ที่ไม่ถูกต้อง (FastAPI จะแปลงเป็น error 422 ที่ชัดเจน) หรือ return ค่าที่แปลงแล้ว (เช่น normalize เป็นตัวพิมพ์เล็ก)

## Model validators — การตรวจสอบข้าม field

```python
from pydantic import model_validator

class SignupForm(BaseModel):
    password: str
    confirm_password: str

@model_validator(mode="after")
    def passwords_match(self):
        if self.password != self.confirm_password:    # compare MULTIPLE fields
            raise ValueError("passwords do not match")
        return self
```

`@model_validator(mode="after")` ทำงานหลังจากตรวจสอบทุก field แล้ว โดยเข้าถึงทั้ง model ได้ — ใช้สำหรับกฎที่เกี่ยวข้องกับ **หลาย fields** (เช่น ยืนยันว่ารหัสผ่านตรงกัน หรือว่าวันที่เริ่มต้นมาก่อนวันที่สิ้นสุด)

## การตรวจสอบที่มีมาในตัวมักเพียงพอเป็นอันดับแรก

```python
class Product(BaseModel):
    price: float = Field(gt=0)          # use Field constraints for simple rules
    sku: str = Field(pattern=r"^[A-Z]{3}-\d+$")
    email: EmailStr                      # specialized types for formats
# reach for custom validators only when constraints/types can't express the rule
```

เลือกใช้ `Field` constraints และชนิดเฉพาะทางสำหรับกฎง่าย ๆ ก่อน ใช้ custom validators สำหรับ logic ทางธุรกิจที่แท้จริง

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

การตรวจสอบ Pydantic แบบกำหนดเองมีความสำคัญสำหรับการบังคับใช้กฎทางธุรกิจที่เกินกว่าการตรวจสอบชนิดและ constraints ธรรมดา — และเนื่องจากการตรวจสอบมีความสำคัญต่อ **ความปลอดภัยและความถูกต้องของข้อมูล** การสามารถแสดงกฎใด ๆ ได้จึงมีคุณค่า **Field validators** จัดการ logic แบบ field เดียว (การตรวจสอบรูปแบบแบบกำหนดเอง, การ normalize/แปลงค่า) ขณะที่ **model validators** จัดการความต้องการที่พบบ่อยในการ **ตรวจสอบข้าม field** (รหัสผ่านตรงกัน, ช่วงวันที่, ข้อกำหนดแบบมีเงื่อนไข) ที่กฎระดับ field ไม่สามารถแสดงได้

Validators ทำงานร่วมกับ FastAPI ได้อย่างไร้รอยต่อ — `ValueError` ที่ถูก raise จะกลายเป็น response 422 ที่ชัดเจนโดยอัตโนมัติ

การเข้าใจว่าเมื่อใดควรใช้ constraints/types ที่มีในตัว (สำหรับกฎง่าย ๆ) เทียบกับ custom validators (สำหรับ logic ทางธุรกิจจริง) และ field กับ model validators ต่างกันอย่างไร ช่วยให้คุณมั่นใจได้ว่าข้อมูลที่เข้ามาเป็นไปตามข้อกำหนดของแอปพลิเคชันอย่างครบถ้วน ทำให้นี่เป็นความรู้สำคัญในการสร้าง API ที่แข็งแกร่งและถูกต้อง