▎
Django Serializers: Related Fields in Serializerوقتی با مدلهای مرتبط در Django کار میکنیم، نمایش اطلاعات کامل آنها در سریالایزرها میتواند چالشبرانگیز باشد. خوشبختانه، Django REST Framework (DRF) ابزارهای قدرتمندی برای این کار در اختیار ما قرار میدهد.
سریالایزر DRF بهطور پیشفرض برای فیلدهای مرتبط در هنگام سریالسازی دادهها از مقدار primary key استفاده میکند. به عنوان مثال:
class Author(models.Model):
name = models.CharField()
last_name = models.CharField()
class Blog(models.Model):
title = models.CharField()
author = models.ForeignKey(Author, on_delete=models.CASCADE)
class BlogSerializer(serializers.ModelSerializer):
class Meta:
model = Blog
fields = "__all__"
خروجی
BlogSerializer
به شکل زیر خواهد بود:
{
"title": "black python",
"author": 3
}
حالا اگر بخواهیم به جای PK، اطلاعات اضافی از Author نمایش دهیم، چند راه حل وجود دارد:
▎
1. استفاده از depth
:با تنظیم پارامتر 1 = depth در Meta کلاس سریالایزر، میتوانید مشخص کنید که تا چه عمقی از روابط مدلها سریالایز شوند. این روش ساده و سریع است، اما کنترل کمتری بر روی دادههای خروجی به شما میدهد.
class BlogSerializer(serializers.ModelSerializer):
class Meta:
model = Blog
depth = 1
خروجی
BlogSerializer
به شکل زیر خواهد بود:
{
"title": "python black",
"author": { "name": "amirhossein", "id": 1, "last_name": "some last name" }
}
▎
2. استفاده از Nested Serializers:با تعریف سریالایزرهای تو در تو، میتوانید کنترل کاملی بر روی فیلدهایی که میخواهید از مدلهای مرتبط نمایش دهید داشته باشید. این روش انعطافپذیرتر است، اما نیاز به نوشتن کد بیشتری دارد , مثال:
class AuthorSerializer(serializers.ModelSerializer):
class Meta:
model = Author
fields = ("name",)
class BlogSerializer(serializers.ModelSerializer):
author = AuthorSerializer()
class Meta:
model = Blog
fields = "__all__"
خروجی به شکل زیر خواهد بود:
{
"title": "black python",
"author": { "name": "amirhossein" }
}
▎
مشکل N + 1 در هنگام استفاده از Depth یا Nested Serializer:حتما باید در queryset خود از
select_related
یا
prefetch_related
استفاده کنید تا از بروز مشکل N + 1 جلوگیری کنید!
▎
Django Serializers: Validators1 : field level validators
برای اعتبار سنجی داده ها در سطح فیلد در drf باید از دستور زیر پیروی کنید:
class BlogSerializer(serializers.ModelSerializer):
....
def validate_<field name>(self, value): # validate_email
if vlaue in "_" :
serializers.ValidationError("some error")
return value
2 : object level validator
class BlogSerializer(serializers.ModelSerializer):
....
def validate(self, attrs):
if attrs.name == attrs.title :
serializers.ValidationError("name and title can not be same")
return value
▎
Django Serializers: to_internal_value
متود to_internal_value در ModelSerializer قبل از اجرای اعتبارسنجی داده ها به داده های خام دسترسی دارد و میتوانید برای تغییر داده ها یا اضافه کردن داده ها قبل از اعتبارسنجی از اون استفاده کنید:
class BlogSerializer(serializers.ModelSerializer):
....
def to_internal_value(self, data):
data["user"] = self.context["user"] # افزودن شی user به data
return super().to_internal_value(data)
نکته:
اقا حتما موقع return از super().to_internal_value(data) استفاده کنید و return data استفاده نکنید ; چون اینطوری باعث میشه تمام validatorهای modelSerializer که از روی مدل شما بطور پیشفرض ساخته شده , غیرفعال بشن!
▎
Django Serializers: to_representation
ما میتوانیم این رو ش را override کنیم تا قبل از داده های سریالی که نمونه سریالسازبر میگرداند،
دستکاری داده ها را انجام دهیم , مثال:
class BlogSerializer(serializers.ModelSerializer):
....
def to_representation(self, instance):
resp = super().to_representation(instance)
resp['title'] = resp['title'].upper()
return resp
برای اطلاعات بیشتر به کتاب :django in production مراجعه کنید.