Django Rest Framework 如何为Google Sheets创建自定义序列化器
多Google Sheet对接Django DRF实现方案指引
1. 先封装多Sheet元数据配置模型
你不需要把业务数据存在Django数据库,只需要做一个配置模型存不同Google Sheet的基础信息,就能解决原有django-gsheets固定绑定单份文档的问题:
# models.py from django.db import models class GSheetConfig(models.Model): name = models.CharField(max_length=100, unique=True, help_text="业务场景命名,如存储设备表、服务器设备表") sheet_id = models.CharField(max_length=100, help_text="Google Sheet的文档ID") tab_name = models.CharField(max_length=50, help_text="要读取的工作表名称") # 如果全局用一套Google API授权,也可以把授权配置放到settings里,不用存在库中 auth_config = models.JSONField(help_text="Google API授权配置") is_active = models.BooleanField(default=True) def __str__(self): return self.name
后续新增Sheet文档直接在后台新增这个模型的实例即可,无需修改代码。
2. 封装SheetFu通用数据处理工具
写一个通用工具类,传入配置实例就能拉取对应Sheet的数据,同时内置筛选、搜索的基础逻辑:
# utils/sheetfu_adapter.py from sheetfu import SpreadsheetApp from django.conf import settings def fetch_sheet_data(sheet_config, filters=None, search_keyword=None): # 初始化SheetFu客户端,授权逻辑按你自己的实现调整 sa = SpreadsheetApp(settings.GOOGLE_SERVICE_ACCOUNT_JSON) spreadsheet = sa.open_by_id(sheet_config.sheet_id) sheet = spreadsheet.get_sheet_by_name(sheet_config.tab_name) # 读取全量数据转字典格式 data_range = sheet.get_data_range() raw_data = data_range.get_values() # 表头统一转下划线格式的字段名 headers = [h.strip().lower().replace(" ", "_") for h in raw_data[0]] rows = [dict(zip(headers, row)) for row in raw_data[1:]] # 处理精准筛选 if filters: for field, value in filters.items(): rows = [row for row in rows if str(row.get(field, "")).strip() == str(value).strip()] # 处理模糊搜索 if search_keyword: keyword = search_keyword.lower() rows = [row for row in rows if any(keyword in str(v).lower() for v in row.values())] return rows
3. 对接DRF序列化器与视图
如果不同Sheet的字段不固定,可以用动态序列化器适配,如果是固定业务场景的Sheet,也可以单独写对应业务的序列化器做更严格的字段校验:
动态序列化器示例
# serializers.py from rest_framework import serializers class DynamicSheetSerializer(serializers.Serializer): def __init__(self, *args, **kwargs): # 从上下文拿到当前Sheet的表头动态生成字段 fields = kwargs.pop("fields", None) super().__init__(*args, **kwargs) if fields: for field in fields: self.fields[field] = serializers.CharField(allow_null=True, required=False)
视图层实现
# views.py from rest_framework.views import APIView from rest_framework.response import Response from rest_framework import status from .models import GSheetConfig from .utils.sheetfu_adapter import fetch_sheet_data from .serializers import DynamicSheetSerializer class GSheetDataAPIView(APIView): def get(self, request, sheet_name): # 校验Sheet配置是否存在 try: sheet_config = GSheetConfig.objects.get(name=sheet_name, is_active=True) except GSheetConfig.DoesNotExist: return Response({"error": "请求的Sheet文档不存在"}, status=status.HTTP_404_NOT_FOUND) # 提取请求参数 query_params = request.query_params.dict() search_keyword = query_params.pop("search", None) # 拉取处理后的数据 sheet_data = fetch_sheet_data(sheet_config, filters=query_params, search_keyword=search_keyword) # 序列化返回 if sheet_data: fields = sheet_data[0].keys() serializer = DynamicSheetSerializer(sheet_data, many=True, fields=fields) return Response(serializer.data) return Response([])
路由配置
# urls.py from django.urls import path from .views import GSheetDataAPIView urlpatterns = [ path("gsheet/<str:sheet_name>/", GSheetDataAPIView.as_view(), name="gsheet-data"), ]
可选优化方向
- 加缓存:根据数据更新频率设置缓存过期时间,避免每次请求都请求Google Sheet接口,大幅提升响应速度
- 权限控制:给
GSheetConfig增加权限关联字段,不同角色只能访问有权限的Sheet数据 - 分页:数据量大的话直接接入DRF自带的分页器即可
- 写操作支持:如果需要反向写入Google Sheet,直接在SheetFu工具里补充写入逻辑即可
内容的提问来源于stack exchange,提问作者jspavs
相关产品推荐
相关产品推荐

