Serializer

Serializer

serializer = PostSerializer(post)
serializer = PostSerializer(data=request.data)
serializer = PostSerializer(post, data=reqeust.data)
serializer = PostSerializer(post, reqeust.data)
serializer = PostSerializer(reqeust.data) # Error

• PostSerializer를 사용할 때 post라는 instance가 먼저 나온다면 뒤에 data라는 keyword 를 써줄 필요가 없지만, instance 없이 data를 넘기기 위해서는 keyword가 꼭 필요

• data 값이 주어지면 다음과 같은 과정을 거치게 됨
  • serializer.is_valid()가 호출 되었을 때,
  • serializer.initial_data에 data 값을 넣어줌
  • 유효성 검증을 통과했다면 serializer.validated_data에 data 값을 넣어줌
  • 이후 serializer.save()가 호출될 때, data 값이 저장됨

Tip!

• serializer.errors에는 유효성 검사에서 발생한 오류가 저장됨
• serializer.data에는 유효성 검사에서 통과된 인스턴스 값이 사전형으로 저장됨

Tip! 매개변수와 인수

• 매개변수(parameter) : 함수에 입력으로 전달된 값을 받는 변수
• 인수(arguments) : 함수를 호출할 때 전달하는 입력값

def add(a, b):
    return a + b
print(add(3, 4))

# 매개변수 : a, b
# 인수 : 3, 4

serializers.Serializer

# serializers.py

class ArticleSerializer(serializers.Serializer):
    id = serializers.IntegerField(read_only=True)
    title = serializers.CharField()
    body = serializers.CharField()
    publication_date = serializers.DateField()
    active = serializers.BooleanField()
    created_at = serializers.DateTimeField(read_only=True)
    updated_at = serializers.DateTimeField(read_only=True)

    def create(self, validated_data):
        print(validated_data) # create 될 때 마다 print 실행됨
        return Article.objects.create(**validated_data)

    def update(self, instance, validated_data):
        instance.title = validated_data.get('title', instance.title)
        instance.body = validated_data.get('body', instance.body)
        instance.publication_date = validated_data.get('publication_data', 
                                                       instance.publication_date)
        instance.active = validated_data.get('active', instance.active)
        instance.save()
        return instance

def create(self, validated_data):
    return Article.objects.create(**validated_data)

serializers.ModelSerializer

# serializers.py

class ArticleSerializer(serializers.ModelSerializer):

    time_since_publication = serializers.SerializerMethodField()
    # author = serializers.StringRelatedField()   # String 타입으로 받음
    # author = JournalistSerializer(read_only=True)   # Serializer로 author가 갖고 있는 전체 데이터 받음
    
    class Meta:
        model = Article
        fields = "__all__"   # 전체 field 가져옴
        # fields = ("title", "description", "body")   # 원하는 특정 field만 가져옴
        # exclude = ("id",)   # 특정 field 제외 가능
        
    def get_time_since_publication(self, object):
        publication_date = object.publication_date
        now = datetime.now()
        time_delta = timesince(publication_date, now)
        return time_delta     

• SerializerMethodField(method_name=None)
  • SerializerMethodField()를 사용하여 쉽게 커스텀 할 수 있음
  • SerializerMethodField()는 read-only field 로 값을 저장하거나 수정할 때는 사용되지 않고 조회할 때만 사용
  • method_name으로 해당 필드값에 대해 정의하는 함수의 이름을 넘겨줄 수 있음
    • default로는 get_<field_name>로 정해짐
    • 예시: get_time_since_publication

time_since_publication = serializers.SerializerMethodField()
   
    def get_time_since_publication(self, object):
        publication_date = object.publication_date
        now = datetime.now()
        time_delta = timesince(publication_date, now)
        return time_delta

Tip! 추가 예시

# serializers.py

from rest_framework import serializers as sz

class ReviewSerializer(sz.ModelSerializer):
    username = sz.SerializerMethodField()
    
    def get_username(self, obj):
        return obj.user.nickname
      
    class Meta:
        model = Review
        fields = (
            'username',
            'content',
            'created_at'
        )

• Review 모델은 User 모델과 ForeignKey로 연결되어 있음
  • user의 id 값이 저장되어 있기 때문에 serializer로 데이터를 조회하면 id 값이 조회됨
    • id 값으로 user의 이름을 추가적으로 불러와야 하는 문제가 생김
  • get_username을 통해 username의 값을 지정해주며 obj 으로는 해당 모델의 obj가 들어오게 됨
  • 마지막으로 fields에 포함해주면 해당 값이 serializer 조회 시 함께 return하게 됨

serializer.save()

serializer.save()는 다음과 같이 **kwargs를 매개변수로 받음

def save(self, **kwargs):
    pass

• 이 경우 유효성을 통과한 validated_data와 kwargs dict가 합쳐져서 DB에 저장됨

• 이 때, self.instance 값에 따라 저장하는 방식이 다름

  • self.instance 값이 없을 때: create()를 통해 저장
  • self.instance 값이 있을 때: update()를 통해 저장