README.md

model_serializers

常规的序列化方案：

1. 循环，如：我要获取所有的任务对象
  li = list()
  qs = Tasks.objects.all()
  for q in qs:
      data = dict(id=q.id,name=q.name)
      li.append(data)
  缺点：如果字段过多，就要写很长，代码可读性很差，如果遇到日期类型字段 JsonResponse 无法序列化, 需要特殊处理
  
2. model_to_dict
  li = list()
  qs = Tasks.objects.all()
  from django.forms.models import model_to_dict
  for q in qs:
      li.append(model_to_dict(q))
  缺点：日期类型、文件类型无法转换，并且不能指定需要序列化的字段
  
3. django 自带的序列化方案 serializers
   qs = Tasks.objects.all()
   data = serializers.serializer("josn", qs)
   缺点：只支持 queryset、 model 类型，不可序列化其他可迭代对象

projects tree

│  ├─response
│  │  └─api        // 构造一个 api 响应，如：ok、bad_request、page 等
│  │  └─base       // 封装 api 响应中的 code 值
│  │  └─pagination // 一个分页结构
│  └─serializers
│  │  └─__init__   // 扩展 json.JSONEncoder，支持序列化 Model、queryset
│  │  └─model      // Model 序列化主逻辑

development

pip install requirements.txt

usage

class Tasks(models.Model):
    """任务"""
    task_topo = models.OneToOneField("TasksTopo", related_name="tasks", on_delete=models.DO_NOTHING, null=True)
    task_name = models.IntegerField("任务名称")
    test_list = JSONField()
    test_char = models.TextField()

    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)
    
    # 也允许自定义 serialize_{field}() 开头的序列化方案
    def serialize_app(self):
        return "xxxx"

    class Serializer:
        default_fields = ["task_name", "test_list", "test_char"]
        field_groups = {
            "list": ["task_topo", "task_name", "test_list", "test_char", "app", "report"]
        }
        
    注意：id、 created_at、updated_at 默认序列化，不需要加入序列化组
    支持 ManyToManyField, ForeignKey 的反向引用，relate_name 指定的名称，如上述： report、task_topo

views.py       
  Model 对象：
      tasks = Tasks.objects.get(id=5)
      return api.ok(tasks, group="xx")

  QuerySet:
      qs = Tasks.objects.all()
      return api.page(request, qs, group="xx")

django version

Django3.1

python version

Python3.7

database

python manage.py migrate