django-filter로 필터링 API 우아하게 만들기

Django-filter로 API 필터링, 쉽게 해결하기! (내 경험담과 함께)

요즘 Django 기반 웹 애플리케이션 개발하면서 느낀 건데, 데이터 관리가 정말 중요하더라고요. 특히 사용자에게 딱 필요한 정보만 깔끔하게 보여주는 게 얼마나 중요한지… 그래서 제가 애용하는 필터링 도구가 바로 Django-filter입니다! Django REST framework랑 같이 쓰면 정말 효율적인데, 이걸 어떻게 활용하는지 제 경험을 바탕으로 쉽게 설명해 드릴게요. 복잡한 쿼리 씨름 안 하고도 간단하게 필터링 로직을 만들 수 있답니다.

먼저 Django-filter의 핵심 개념부터 살펴볼까요? 쉽게 말해, 모델의 필드를 기준으로 필터링 조건을 정의하는 사용자 정의 필터 클래스를 만드는 거예요. FilterSet 클래스를 상속받아서 모델의 필드랑 필터링 방식을 정의하면 되는데, 여기서 lookup expressions라고 하는 다양한 필터링 옵션을 쓸 수 있어요. 예를 들어, exact (정확히 일치), icontains (대소문자 구분 없이 포함), startswith (시작 문자열 일치), range (범위 지정) 등이 있죠. 이걸 Django REST framework와 연결하면 API 요청 파라미터로 필터링 조건을 받아서 처리할 수 있답니다.

이해가 잘 안 가시나요? 그럼 제가 실제로 썼던 코드 예제를 보여드릴게요. models.py, filters.py, serializers.py, views.py 이렇게 네 개의 파일을 만들었어요. (이름만 봐도 어떤 역할을 하는지 감이 오시죠?)

models.py (상품 모델 정의):

from django.db import models

class Product(models.Model):
    name = models.CharField(max_length=255)
    category = models.CharField(max_length=100)
    price = models.DecimalField(max_digits=10, decimal_places=2)
    stock = models.IntegerField()

    def __str__(self):
        return self.name

이건 상품 정보를 저장하는 모델이에요. 상품 이름, 카테고리, 가격, 재고량을 저장하죠. 익숙하시죠?

filters.py (필터 정의):

import django_filters
from .models import Product

class ProductFilter(django_filters.FilterSet):
    name = django_filters.CharFilter(lookup_expr='icontains')
    price = django_filters.RangeFilter()
    category = django_filters.CharFilter(lookup_expr='exact')

    class Meta:
        model = Product
        fields = ['name', 'price', 'category', 'stock']

여기서부터 Django-filter가 빛을 발하는데요. ProductFilter 클래스는 상품 이름(icontains로 부분 일치 검색), 가격(RangeFilter로 범위 지정), 카테고리(exact로 정확히 일치)를 필터링하도록 정의했어요. 실제로 제가 상품 검색 기능을 만들 때 정말 유용하게 썼던 부분이에요.

serializers.py (데이터 직렬화):

from rest_framework import serializers
from .models import Product

class ProductSerializer(serializers.ModelSerializer):
    class Meta:
        model = Product
        fields = '__all__'

이건 API 응답으로 보낼 데이터를 정리하는 부분이에요. 모든 필드를 그대로 보내도록 설정했어요.

views.py (API 뷰 정의):

from rest_framework import generics
from .models import Product
from .serializers import ProductSerializer
from .filters import ProductFilter
from django_filters.rest_framework import DjangoFilterBackend

class ProductList(generics.ListAPIView):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer
    filter_backends = [DjangoFilterBackend]
    filterset_class = ProductFilter

마지막으로, API 뷰를 정의하는데요. DjangoFilterBackend를 사용해서 ProductFilter를 적용하고, /products/?name=example&price__range=10-20&category=electronics 같은 URL로 필터링 요청을 보낼 수 있도록 설정했어요. 예를 들어, name=example은 상품 이름에 "example"이 포함된 상품을, price__range=10-20은 가격이 10~20 사이인 상품을 찾는다는 뜻이죠.

자, 이제 실제로 돌려보면 어떻게 작동하는지 바로 알 수 있을 거예요. 하지만 몇 가지 주의할 점이 있어요.

• 필터링에 쓰는 필드의 데이터 타입이랑 필터링 방식을 정확하게 맞춰야 해요. 안 그러면 예상치 못한 결과가 나올 수 있으니까요. 제가 처음에 이 부분 때문에 꽤 애먹었거든요.
• 성능이 중요하다면 prefetch_related나 select_related를 사용해서 데이터베이스 쿼리 효율을 높일 수 있어요. 데이터 양이 많다면 꼭 고려해 보세요!
• 필터링 로직이 너무 복잡해지면 필터 클래스를 여러 개로 나누는 걸 고려해 보세요. 코드 관리가 훨씬 수월해져요.
• 마지막으로, 보안을 위해 사용자 입력에 대한 유효성 검사는 필수입니다! 이 부분 꼭 잊지 마세요.

결론적으로, Django-filter는 Django 애플리케이션에서 API 필터링을 쉽고 효율적으로 구현하는 데 정말 유용한 도구입니다. 제가 설명한 방법대로 따라 해보시면 사용자에게 최적화된 API를 만들 수 있을 거예요. 복잡한 필터링 로직을 만들 때는 미리 설계를 잘 하고, 테스트를 충분히 해서 문제를 미리 방지하는 게 중요하다는 점, 꼭 기억해주세요!