JSONField 및 Pydantic을 사용하여 Django에서 유연한 데이터 모델을 구축하는 방법

이 기사에서는 Django의 JSONField(JSON 및 JSONB 래퍼)를 사용하여 반구조화된 데이터를 모델링하는 방법과 해당 데이터에 스키마를 적용하는 방법을 안내하겠습니다. Pydantic을 사용하는 데이터 - Python 웹 개발자에게 자연스러운 접근 방식입니다.

유연한 유형 정의

예를 들어 거래 테이블과 같이 결제를 처리하는 시스템을 생각해 보겠습니다. 다음과 같이 표시됩니다.

from django.db import models

class Transaction(models.Model):
    # Other relevant fields...
    payment_method = models.JSONField(default=dict, null=True, blank=True)

우리는 Payment_method 필드에 중점을 두고 있습니다. 실제 상황에서는 기존의 결제 처리 방법을 사용합니다.

• 신용카드

• 페이팔

• 지금 구매하고 나중에 결제

• 암호화폐

우리 시스템은 일관되고 검증 가능한 구조를 유지하면서 각 결제 방법에 필요한 특정 데이터를 저장할 수 있도록 조정 가능해야 합니다.

Pydantic을 사용하여 다양한 결제 방법에 대한 정확한 스키마를 정의합니다.

from typing import Optional
from pydantic import BaseModel

class CreditCardSchema(BaseModel):
    last_four: str
    expiry_month: int
    expiry_year: int
    cvv: str


class PayPalSchema(BaseModel):
    email: EmailStr
    account_id: str


class CryptoSchema(BaseModel):
    wallet_address: str
    network: Optional[str] = None


class BillingAddressSchema(BaseModel):
    street: str
    city: str
    country: str
    postal_code: str
    state: Optional[str] = None


class PaymentMethodSchema(BaseModel):
    credit_card: Optional[CreditCardSchema] = None
    paypal: Optional[PayPalSchema] = None
    crypto: Optional[CryptoSchema] = None
    billing_address: Optional[BillingAddressSchema] = None

이 접근 방식은 다음과 같은 몇 가지 중요한 이점을 제공합니다.

1. 한 번에 하나의 결제 방법만 Null이 아닌 값을 가질 수 있습니다.

2. 복잡한 데이터베이스 마이그레이션 없이 확장이나 수정이 쉽습니다.

3. 모델 수준에서 데이터 무결성을 보장합니다.

결제 방법 필드에 스키마를 적용하기 위해 Pydantic 모델을 활용하여 필드에 전달된 모든 데이터가 정의한 스키마와 일치하는지 확인합니다.

from typing import Optional, Mapping, Type, NoReturn
from pydantic import ValidationError as PydanticValidationError
from django.core.exceptions import ValidationError

def payment_method_validator(value: Optional[dict]) -> Optional[Type[BaseModel] | NoReturn]:
    if value is None:
        return

    if not isinstance(value, Mapping):
        raise TypeError("Payment method must be a dictionary")

    try:
        PaymentMethodSchema(**value)
    except (TypeError, PydanticValidationError) as e:
        raise ValidationError(f"Invalid payment method: {str(e)}")

여기서 Pydantic이 유효성을 검사할 수 있도록 유효성 검사기에 입력된 데이터가 올바른 유형인지 확인하기 위해 몇 가지 검사를 수행합니다. 우리는 null 허용 값에 ​​대해 아무 작업도 수행하지 않으며 전달된 값이 Dict 또는 OrderedDict와 같은 매핑 유형의 하위 클래스가 아닌 경우 유형 오류를 발생시킵니다.

생성자에 전달한 값을 사용하여 Pydantic 모델의 인스턴스를 생성할 때. 값의 구조가 PaymentMethodSchema에 대해 정의된 스키마에 맞지 않으면 Pydantic은 유효성 검사 오류를 발생시킵니다. 예를 들어 PayPalSchema의 이메일 필드에 잘못된 이메일 값을 전달하면 Pydantic은 다음과 같은 유효성 검사 오류를 발생시킵니다.

ValidationError: 1 validation error for PaymentMethodSchema
paypal.email
  value is not a valid email address: An email address must have an @-sign. [type=value_error, input_value='Check me out on LinkedIn: https://linkedin.com/in/daniel-c-olah', input_type=str]

이 유효성 검사는 두 가지 방법으로 시행할 수 있습니다.

1. 사용자 정의 검증 방법

   저장 프로세스 중에 결제 방법이 예상 스키마와 일치하는지 확인하기 위해 유효성 검사 기능을 호출합니다.
   

   from django.db import models
   
   class Transaction(models.Model):
       # ... other fields ...
       payment_method = models.JSONField(null=True, blank=True)
       def save(self, *args, **kwargs):
           # Override save method to include custom validation
           payment_method_validator(self.payment_method)
           super().save(*args, **kwargs)
   

   이 접근 방식은 효과적이지만 Django에서는 번거롭고 덜 관용적이 될 수 있습니다. 코드를 더 깔끔하게 만들기 위해 동일한 작업을 수행하는 클래스 메소드로 함수를 대체할 수도 있습니다.

2. 필드 유효성 검사기 사용

   이 방법은 Django에 내장된 필드 유효성 검사 메커니즘을 활용합니다.
   

   from django.db import models
   
   class Transaction(models.Model):
       # Other relevant fields...
       payment_method = models.JSONField(default=dict, null=True, blank=True)
   

   이 접근 방식은 Payment_method 필드에 저장된 값에 대한 유연성과 제어의 균형을 유지합니다. 이를 통해 해당 분야의 기존 데이터 무결성을 손상시키지 않고 향후 요구 사항 변화에 적응할 수 있습니다. 예를 들어 Paystack 스키마에 Paystack ID 필드를 포함할 수 있습니다. 복잡한 데이터베이스 마이그레이션을 처리할 필요가 없으므로 이러한 변경은 원활하게 이루어질 것입니다.

향후에는 번거로움 없이 나중에 결제 방식을 추가할 수도 있습니다. 필드 유형도 변경될 수 있으며 정수 기본 키에서 UUID 기본 키로 마이그레이션할 때 발생하는 것과 같은 데이터베이스 필드 마이그레이션 제약 조건에 직면하지 않습니다. 개념을 완전히 이해하려면 여기에서 전체 코드를 확인하세요.

비정규화

비정규화에는 성능과 확장성을 최적화하기 위해 여러 문서 또는 컬렉션에 걸쳐 의도적으로 데이터를 복제하는 작업이 포함됩니다. 이 접근 방식은 기존 관계형 데이터베이스에 사용되는 엄격한 정규화와 대조되며, NoSQL 데이터베이스는 유연한 문서 중심 스토리지 패러다임을 도입하여 비정규화를 대중화하는 데 중요한 역할을 했습니다.

제품과 주문에 대한 별도의 테이블이 있는 전자상거래 시나리오를 생각해 보세요. 고객이 주문할 때 장바구니에 포함된 제품 세부 정보의 스냅샷을 캡처하는 것이 중요합니다. 업데이트나 삭제로 인해 시간이 지남에 따라 변경될 수 있는 현재 제품 기록을 참조하는 대신 제품 정보를 주문 내에 직접 저장합니다. 이를 통해 주문이 원래의 맥락과 무결성을 유지하고 구매 당시 제품의 정확한 상태를 반영하도록 보장합니다. 비정규화는 이러한 일관성을 달성하는 데 중요한 역할을 합니다.

한 가지 가능한 접근 방식은 주문 테이블의 일부 제품 필드를 복제하는 것입니다. 그러나 이 방법은 확장성 문제를 야기하고 주문 스키마의 응집력을 손상시킬 수 있습니다. 보다 효과적인 솔루션은 관련 제품 필드를 JSON 구조로 직렬화하여 주문이 외부 쿼리에 의존하지 않고 제품의 자체 포함된 기록을 유지할 수 있도록 하는 것입니다. 다음 코드는 이 기술을 보여줍니다.

from typing import Optional
from pydantic import BaseModel

class CreditCardSchema(BaseModel):
    last_four: str
    expiry_month: int
    expiry_year: int
    cvv: str


class PayPalSchema(BaseModel):
    email: EmailStr
    account_id: str


class CryptoSchema(BaseModel):
    wallet_address: str
    network: Optional[str] = None


class BillingAddressSchema(BaseModel):
    street: str
    city: str
    country: str
    postal_code: str
    state: Optional[str] = None


class PaymentMethodSchema(BaseModel):
    credit_card: Optional[CreditCardSchema] = None
    paypal: Optional[PayPalSchema] = None
    crypto: Optional[CryptoSchema] = None
    billing_address: Optional[BillingAddressSchema] = None

이전 섹션에서 대부분의 개념을 다루었으므로 이 모든 것에서 Pydantic의 역할을 이해하기 시작해야 합니다. 위의 예에서는 Pydantic을 사용하여 주문에 연결된 제품 목록을 확인합니다. 제품 구조에 대한 스키마를 정의함으로써 Pydantic은 주문에 추가된 모든 제품이 예상 요구 사항을 충족하는지 확인합니다. 제공된 데이터가 스키마를 준수하지 않는 경우 Pydantic은 유효성 검사 오류를 발생시킵니다.

Django에서 JSONField 쿼리하기

Django 필드에서 검색을 수행하는 것과 동일한 방식으로 JSONField 키를 쿼리할 수 있습니다. 다음은 사용 사례에 따른 몇 가지 예입니다.

from typing import Optional, Mapping, Type, NoReturn
from pydantic import ValidationError as PydanticValidationError
from django.core.exceptions import ValidationError

def payment_method_validator(value: Optional[dict]) -> Optional[Type[BaseModel] | NoReturn]:
    if value is None:
        return

    if not isinstance(value, Mapping):
        raise TypeError("Payment method must be a dictionary")

    try:
        PaymentMethodSchema(**value)
    except (TypeError, PydanticValidationError) as e:
        raise ValidationError(f"Invalid payment method: {str(e)}")

JSON 필드 필터링에 대해 자세히 알아보려면 설명서를 확인하세요.

결론

PostgreSQL에서 JSON 및 JSONB를 사용하면 관계형 데이터베이스에서 반구조화된 데이터 작업에 탁월한 유연성을 제공합니다. Pydantic 및 Django의 JSONField와 같은 도구는 데이터 구조에 대한 규칙을 적용하여 정확성을 유지하고 변경 사항에 적응하는 것을 더 쉽게 해줍니다. 그러나 이러한 유연성은 신중하게 사용해야 합니다. 적절한 계획이 없으면 시간이 지남에 따라 데이터가 변경되므로 성능이 저하되거나 불필요한 복잡성이 발생할 수 있습니다.

Django에서 필드 유효성 검사기는 full_clean()이 명시적으로 호출될 때만 트리거됩니다. 이는 일반적으로 Django Forms를 사용하거나 DRF 직렬 변환기에서 is_valid()를 호출할 때 발생합니다. 자세한 내용은 Django 유효성 검사기 문서를 참조하세요.

이 문제를 해결하기 위한 보다 진보된 접근 방식은 내부적으로 JSON 데이터의 직렬화 및 유효성 검사를 모두 처리하기 위해 Pydantic을 통합하는 사용자 정의 Django 필드를 구현하는 것입니다. 이는 전용 기사를 보장하지만 지금은 이 문제에 대한 기성 솔루션을 제공하는 라이브러리를 탐색할 수 있습니다(예: django-pydantic-jsonfield

).

위 내용은 JSONField 및 Pydantic을 사용하여 Django에서 유연한 데이터 모델을 구축하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!