[250203] Serializer 정리~

Serializer란?

1. Serializer 정의

Serializer(직렬화)는 Django REST Framework(DRF)에서 Python 객체(QuerySet, Model 인스턴스 등)를

JSON 형식으로 변환하거나(JSON 직렬화), 반대로 JSON 데이터를 Python 객체로 변환하는 기능(역직렬화)을

수행하는 클래스입니다.

 

✅ 쉽게 말하면:

• Python 객체 → JSON 변환 (`직렬화`)
• JSON → Python 객체 변환 (`역직렬화`)

📌 Serializer를 사용하는 이유

1. API에서 데이터를 JSON 형태로 주고받기 위해 필요
2. Django의 모델을 쉽게 JSON 응답으로 변환 가능
3. 클라이언트에서 받은 JSON 데이터를 검증 및 변환하여 안전하게 DB 저장 가능

---

2. Serializer 기본 사용법

Serializer를 만들려면 `serializers.Serializer` 또는 `serializers.ModelSerializer`를 사용합니다.

✅ `serializers.Serializer` 기본 사용

from rest_framework import serializers

class UserSerializer(serializers.Serializer):
    username = serializers.CharField(max_length=100)
    email = serializers.EmailField()
    is_active = serializers.BooleanField()

✔ `serializers.Serializer`를 상속받아 클래스를 정의
✔ `CharField`, `EmailField`, `BooleanField` 등의 필드 지정

데이터 직렬화 (Python 객체 → JSON)

user_data = {"username": "john_doe", "email": "john@example.com", "is_active": True}
serializer = UserSerializer(user_data)
print(serializer.data)  
# {'username': 'john_doe', 'email': 'john@example.com', 'is_active': True}

✔ `.data` 속성을 사용하면 JSON 형식으로 변환됨

데이터 역직렬화 (JSON → Python 객체)

json_data = {'username': 'john_doe', 'email': 'john@example.com', 'is_active': True}
serializer = UserSerializer(data=json_data)

if serializer.is_valid():  # 유효성 검사
    print(serializer.validated_data)
    # {'username': 'john_doe', 'email': 'john@example.com', 'is_active': True}
else:
    print(serializer.errors)

✔ `data` 매개변수로 JSON 데이터를 넣고, `is_valid()`로 검증 후 `validated_data`에서 변환된 데이터 확인 가능

---

3. ModelSerializer 사용하기 (더 쉬운 방법!)

Django의 Model과 연결된 Serializer를 만들려면 `serializers.ModelSerializer`를 사용합니다.
👉 `ModelSerializer`를 사용하면 모델의 필드에 맞는 Serializer를 자동으로 생성해줌

✅ `ModelSerializer` 기본 사용

from rest_framework import serializers
from myapp.models import User  # Django 모델 불러오기

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ['id', 'username', 'email', 'is_active']  # 사용할 필드 지정

✔ `ModelSerializer`는 `Meta` 클래스를 사용해 모델과 필드를 자동으로 설정
✔ 장점: 모델 필드에 맞는 Serializer를 자동으로 생성하여 코드량이 줄어듦

ModelSerializer로 직렬화

user = User.objects.get(id=1)
serializer = UserSerializer(user)
print(serializer.data)
# {'id': 1, 'username': 'john_doe', 'email': 'john@example.com', 'is_active': True}

✔ ORM 객체를 JSON으로 변환해줌

ModelSerializer로 역직렬화

json_data = {'username': 'john_doe', 'email': 'john@example.com', 'is_active': True}
serializer = UserSerializer(data=json_data)

if serializer.is_valid():
    user = serializer.save()  # 데이터 저장
    print(user)  # User 모델 인스턴스 생성됨

✔ `save()`를 사용하면 데이터를 DB에 저장 가능

---

4. Serializer에서 추가 기능 활용

✅ 필드의 기본 값 설정

class UserSerializer(serializers.ModelSerializer):
    username = serializers.CharField(default="guest")  # 기본값 설정

    class Meta:
        model = User
        fields = '__all__'

✔ `default="guest"`를 설정하면 값이 없을 경우 기본값 적용

 

✅ 필드 읽기 전용 / 쓰기 전용 설정

class UserSerializer(serializers.ModelSerializer):
    id = serializers.IntegerField(read_only=True)  # 읽기 전용
    username = serializers.CharField(write_only=True)  # 쓰기 전용

    class Meta:
        model = User
        fields = '__all__'

✔ `read_only=True` → 클라이언트가 값을 변경할 수 없음
✔ `write_only=True` → 클라이언트가 요청할 때만 사용, 응답에는 포함되지 않음

 

✅ 필드 추가 & 커스텀 필드 생성

class UserSerializer(serializers.ModelSerializer):
    full_name = serializers.SerializerMethodField()  # 커스텀 필드 추가

    class Meta:
        model = User
        fields = ['id', 'username', 'email', 'full_name']

    def get_full_name(self, obj):  # obj는 User 인스턴스
        return f"{obj.first_name} {obj.last_name}"

✔ `SerializerMethodField()`를 사용하면 모델에 없는 필드도 추가 가능
✔ `get_<필드명>(self, obj)` 메서드를 정의하여 값 설정

---

5. Serializer의 유효성 검사 (Validation)

Serializer에서 데이터를 저장할 때 유효성 검사(Validation)를 추가할 수 있음

✅ 필드별 기본 유효성 검사

class UserSerializer(serializers.ModelSerializer):
    email = serializers.EmailField(required=True)  # 필수 입력
    username = serializers.CharField(min_length=3)  # 최소 길이 제한

    class Meta:
        model = User
        fields = '__all__'

✔ `required=True` → 필수 입력 필드 지정
✔ `min_length=3` → 최소 3자 이상 입력해야 함

 

✅ 커스텀 유효성 검사 (validate_필드명)

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = '__all__'

    def validate_username(self, value):
        if "admin" in value.lower():
            raise serializers.ValidationError("username에 'admin'을 포함할 수 없습니다.")
        return value

✔ `validate_<필드명>` 메서드를 사용하면 해당 필드에 대한 유효성 검사 가능

 

✅ 객체 수준의 유효성 검사 (`validate()`)

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = '__all__'

    def validate(self, data):
        if data['password'] != data['password_confirm']:
            raise serializers.ValidationError("비밀번호가 일치하지 않습니다.")
        return data

✔ `validate(self, data)`를 사용하면 여러 필드를 함께 검증 가능

---

6. Serializer 정리

기능	`serializers.Serializer`	`serializers.ModelSerializer`
사용 방식	수동으로 필드 정의	모델과 연결하여 필드를 자동 생성
코드량	많음	적음
유효성 검사	validate_<필드명> 사용	동일
데이터 저장	직접 `save()` 구현해야 함	`serializer.save()` 사용 가능

---

🔹 결론

•  Serializer는 Django의 모델 데이터를 JSON으로 변환하고, JSON을 모델 데이터로 변환하는 역할
• `serializers.Serializer`는 직접 필드를 정의해야 하지만, `ModelSerializer`는 모델 기반으로 자동 설정 가능
•  유효성 검사 기능을 활용하여 데이터를 검증하고, 안전하게 API와 연동할 수 있음
•  Serializer를 사용하면 Django 데이터를 쉽게 API로 만들 수 있음