032-Django集成应用
📚 本章概述
Django是Python最流行的Web框架之一,虽然它有自己的ORM和表单系统,但Pydantic可以为Django项目带来更强大的数据验证、序列化和类型安全功能。本章将探讨如何在Django项目中有效集成和使用Pydantic。
🎯 学习目标
- 掌握Django与Pydantic的集成方式
- 学会在Django视图中使用Pydantic模型
- 理解Django ORM与Pydantic的协作
- 掌握API序列化和数据验证
- 学会构建类型安全的Django应用
🚀 Django项目搭建
1.1 项目初始化
# 创建Django项目
django-admin startproject django_pydantic_demo
cd django_pydantic_demo
# 创建应用
python manage.py startapp users
python manage.py startapp products
python manage.py startapp orders
# requirements.txt
Django==4.2.7
pydantic==2.5.0
pydantic-settings==2.1.0
djangorestframework==3.14.0
django-cors-headers==4.3.1
django-extensions==3.2.3
psycopg2-binary==2.9.9
redis==5.0.1
celery==5.3.4
pytest-django==4.7.0
factory-boy==3.3.0
1.2 Django设置配置
# settings/base.py
from pydantic import BaseSettings, Field
from typing import List, Optional
import os
from pathlib import Path
class DjangoSettings(BaseSettings):
"""Django配置类"""
# 基础配置
SECRET_KEY: str = Field(..., env='SECRET_KEY')
DEBUG: bool = Field(default=False, env='DEBUG')
ALLOWED_HOSTS: List[str] = Field(default_factory=list, env='ALLOWED_HOSTS')
# 数据库配置
DATABASE_URL: str = Field(..., env='DATABASE_URL')
# Redis配置
REDIS_URL: str = Field(default='redis://localhost:6379/0', env='REDIS_URL')
# 邮件配置
EMAIL_HOST: str = Field(default='localhost', env='EMAIL_HOST')
EMAIL_PORT: int = Field(default=587, env='EMAIL_PORT')
EMAIL_HOST_USER: str = Field(default='', env='EMAIL_HOST_USER')
EMAIL_HOST_PASSWORD: str = Field(default='', env='EMAIL_HOST_PASSWORD')
EMAIL_USE_TLS: bool = Field(default=True, env='EMAIL_USE_TLS')
# JWT配置
JWT_SECRET_KEY: str = Field(..., env='JWT_SECRET_KEY')
JWT_ALGORITHM: str = Field(default='HS256', env='JWT_ALGORITHM')
JWT_EXPIRATION_HOURS: int = Field(default=24, env='JWT_EXPIRATION_HOURS')
# 文件上传配置
MEDIA_ROOT: str = Field(default='media', env='MEDIA_ROOT')
MAX_UPLOAD_SIZE: int = Field(default=10*1024*1024, env='MAX_UPLOAD_SIZE') # 10MB
class Config:
env_file = '.env'
case_sensitive = True
# 实例化配置
django_settings = DjangoSettings()
# Django settings.py
BASE_DIR = Path(__file__).resolve().parent.parent
SECRET_KEY = django_settings.SECRET_KEY
DEBUG = django_settings.DEBUG
ALLOWED_HOSTS = django_settings.ALLOWED_HOSTS
# 应用配置
DJANGO_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
]
THIRD_PARTY_APPS = [
'rest_framework',
'corsheaders',
'django_extensions',
]
LOCAL_APPS = [
'users',
'products',
'orders',
'core',
]
INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS
MIDDLEWARE = [
'corsheaders.middleware.CorsMiddleware',
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
'core.middleware.PydanticValidationMiddleware',
]
ROOT_URLCONF = 'django_pydantic_demo.urls'
# 数据库配置
import dj_database_url
DATABASES = {
'default': dj_database_url.parse(django_settings.DATABASE_URL)
}
# 国际化
LANGUAGE_CODE = 'zh-hans'
TIME_ZONE = 'Asia/Shanghai'
USE_I18N = True
USE_TZ = True
# 静态文件
STATIC_URL = '/static/'
STATIC_ROOT = BASE_DIR / 'staticfiles'
MEDIA_URL = '/media/'
MEDIA_ROOT = BASE_DIR / django_settings.MEDIA_ROOT
# DRF配置
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': [
'core.authentication.JWTAuthentication',
],
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.IsAuthenticated',
],
'DEFAULT_PAGINATION_CLASS': 'core.pagination.CustomPagination',
'PAGE_SIZE': 20,
'DEFAULT_RENDERER_CLASSES': [
'rest_framework.renderers.JSONRenderer',
],
'EXCEPTION_HANDLER': 'core.exceptions.custom_exception_handler',
}
# CORS配置
CORS_ALLOWED_ORIGINS = [
"http://localhost:3000",
"http://127.0.0.1:3000",
]
# Celery配置
CELERY_BROKER_URL = django_settings.REDIS_URL
CELERY_RESULT_BACKEND = django_settings.REDIS_URL
# 缓存配置
CACHES = {
'default': {
'BACKEND': 'django_redis.cache.RedisCache',
'LOCATION': django_settings.REDIS_URL,
'OPTIONS': {
'CLIENT_CLASS': 'django_redis.client.DefaultClient',
}
}
}
# 日志配置
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'verbose': {
'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}',
'style': '{',
},
},
'handlers': {
'file': {
'level': 'INFO',
'class': 'logging.FileHandler',
'filename': 'django.log',
'formatter': 'verbose',
},
'console': {
'level': 'INFO',
'class': 'logging.StreamHandler',
'formatter': 'verbose',
},
},
'root': {
'handlers': ['console', 'file'],
'level': 'INFO',
},
}
🔧 Pydantic模型集成
2.1 核心数据模型
# core/models.py
from pydantic import BaseModel, Field, ConfigDict, validator
from typing import Optional, List, Dict, Any, Union
from datetime import datetime, date
from enum import Enum
import uuid
class BaseEntity(BaseModel):
"""基础实体模型"""
model_config = ConfigDict(
validate_assignment=True,
use_enum_values=True,
extra='forbid',
json_encoders={
datetime: lambda v: v.isoformat(),
date: lambda v: v.isoformat(),
uuid.UUID: str
}
)
id: Optional[str] = Field(
default_factory=lambda: str(uuid.uuid4()),
description="唯一标识符"
)
created_at: Optional[datetime] = Field(
default_factory=datetime.now,
description="创建时间"
)
updated_at: Optional[datetime] = Field(
default=None,
description="更新时间"
)
class PaginationRequest(BaseModel):
"""分页请求模型"""
model_config = ConfigDict(extra='forbid')
page: int = Field(default=1, ge=1, description="页码")
page_size: int = Field(default=20, ge=1, le=100, description="每页大小")
ordering: Optional[str] = Field(default=None, description="排序字段")
search: Optional[str] = Field(default=None, description="搜索关键词")
class PaginationResponse(BaseModel):
"""分页响应模型"""
model_config = ConfigDict(extra='forbid')
count: int = Field(..., description="总记录数")
page: int = Field(..., description="当前页码")
page_size: int = Field(..., description="每页大小")
total_pages: int = Field(..., description="总页数")
has_next: bool = Field(..., description="是否有下一页")
has_previous: bool = Field(..., description="是否有上一页")
results: List[Any] = Field(..., description="数据列表")
class APIResponse(BaseModel):
"""统一API响应模型"""
model_config = ConfigDict(extra='forbid')
success: bool = Field(default=True, description="请求是否成功")
message: str = Field(default="操作成功", description="响应消息")
data: Optional[Any] = Field(default=None, description="响应数据")
errors: Optional[Dict[str, List[str]]] = Field(default=None, description="错误信息")
timestamp: datetime = Field(
default_factory=datetime.now,
description="响应时间戳"
)
class FilterRequest(BaseModel):
"""通用筛选请求模型"""
model_config = ConfigDict(extra='forbid')
filters: Dict[str, Any] = Field(default_factory=dict, description="筛选条件")
date_from: Optional[date] = Field(default=None, description="开始日期")
date_to: Optional[date] = Field(default=None, description="结束日期")
@validator('date_to')
def validate_date_range(cls, v, values):
"""验证日期范围"""
if v and 'date_from' in values and values['date_from']:
if v < values['date_from']:
raise ValueError('结束日期不能早于开始日期')
return v
2.2 用户模型
# users/schemas.py
from pydantic import BaseModel, Field, EmailStr, validator
from typing import Optional, List
from enum import Enum
from datetime import datetime, date
import re
from core.models import BaseEntity
class Gender(str, Enum):
"""性别枚举"""
MALE = "male"
FEMALE = "female"
OTHER = "other"
class UserRole(str, Enum):
"""用户角色枚举"""
ADMIN = "admin"
STAFF = "staff"
USER = "user"
class UserStatus(