DRF(Django REST Framework) 란?

💡DRF란?

• Django 기반 REST API 서버 구축을 위한 라이브러리

Django와 다르게 프론트엔드를 개발하지 않기 때문에 Model과 View 그리고 Serializer가 됩니다. DRF의 구조에 대해서 지칭하는 패턴은 없습니다. 백엔드의 용도로 사용하기 때문에 Template을 사용하지 않습니다. 대신, JSON파일의 형식으로 프론트엔드와 데이터를 주고받습니다.

• Django와의 차이점

• DRF 로직

 

🧗🏻DRF 모듈 설명

DRF 모듈 설명

models.py

• 모델 정의
• 데이터베이스 테이블을 추상화한 개념
• Django ORM을 통해 파이썬 문법으로 데이터를 처리할 수 있음
• Django에서 데이터는 JSON이나 유사한 포맷이 아닌, 파이썬 객체의 형태로 저장됨
• class Product(models.Model): """ 제품 정보 모델 """ name = models.CharField(max_length=255) image = ImageField(upload_to='photos') price = models.IntegerField() quantity = models.IntegerField(default=0) description = models.TextField() pub_date = models.DateTimeField(auto_now_add = True) def __str__(self): return '{} {}'.format(self.name, self.pub_date)

views.py

• request를 받아 비즈니스 로직을 처리한 뒤 response를 반환
• 모델 데이터 불러오기 / 생성 / validation은 serializer를 사용합니다.
• 구현B. 비즈니스 로직이 복잡해지면, 별도 파일을 생성하여 구현합니다.
  • view에 모든 코드를 적으면 해당 API의 기능을 이해하기 어렵습니다.
  • 하위 함수들을 별도로 unit테스트 해야하기 때문에 별도 파일 및 함수로 구현
• A. 간단한 비즈니스 로직은 view에서 구현합니다.

# A 예시
class UserViewSet(viewsets.ModelViewSet):

    serializer_class = UserSerializer(data=request.data)
		def post(self, request):
		        serializer = self.serializer_class(data=request.data)
		
		        if serializer.is_valid(raise_exception=False):
							serializer.save()
							user = serializer.get_object()
							# 간단한 로직들.
							send_push_notification(user, '00 서비스에 오신걸 환영합니다')
							return Response(serializer.data, 200)
				    return Response('error', 400)

# B 예시
class UserViewSet(viewsets.ModelViewSet):

    serializer_class = UserSerializer(data=request.data)
		def post(self, request):
		        serializer = self.serializer_class(data=request.data)
		
		        if serializer.is_valid(raise_exception=False):
							serializer.save()
							user = serializer.get_object()
							# 복잡한 로직들
							# ex) 어드민 유저면, 00 로직/ 일반유저면 00 로직 / 일반유저 중 앱으로 가입하면 Push 알림, 웹으로 가입하면 SMS 등등 
							if user.has_role('SYSYEM_ADMIN'):
									# do_something_here
							elif ...:
									# do_something_here
							elif ...:
									# do_something_here
							elif ...:
									# do_something_here
							# do_something_here
							return Response(serializer.data, 200)
				    return Response('error', 400)

# B 복잡한 로직들을 별도로 구현한 예시
from user.service import UserService
# 또는
from user.utils import userUtils

class UserViewSet(viewsets.ModelViewSet):

    serializer_class = UserSerializer(data=request.data)
		def post(self, request):
		        serializer = self.serializer_class(data=request.data)
		
		        if serializer.is_valid(raise_exception=False):
							serializer.save()
							user = serializer.get_object()

							service = UserService(user)				
							service.check_and_set_default_role()
							service.send_notification_by_role()

							return Response(serializer.data, 200)
				    return Response('error', 400)

# 위의 UserService 또는 UserUtils 예시

class UserService:
		user = None
		DEFAULT_ROLE = "NORMAL_USER"

		def __init__(self, user):
				self.user = user

		def check_and_set_default_role(self):
				# if self.roles == [] 롤이 없으면 디폴트 롤을 넣어준다.
				...
		
		def send_notification_by_role(self):
				# ex) 어드민 유저면, 00 로직/ 일반유저면 00 로직 / 일반유저 중 앱으로 가입하면 Push 알림, 웹으로 가입하면 SMS 등등 
				# ...
				# 팁으로는, 롤 구분하는건 여기서 하겠지만 메세지 보내는 기능은 MessageService 에서 가져다 씁니다.
				if ...:
						MessageService.send_push_notification(user, '환영합니다!')
				elif ...:
						MessageService.send_SMS(user, '환영합니다!')

serializers.py

• 직렬화/역직렬화 역할 수행
  • 모델은 데이터베이스 테이블을 추상화한 개념이며, 파이썬의 객체 형식으로 저장이 됩니다.
  • 우리는 프론트엔드와 JSON 형식으로 정보를 주고 받는데 직렬화 과정을 생략하고 데이터를 보내게 된다면 파이썬 데이터를 보내주게되고 클라이언트는 이를 읽지 못합니다.
  • 파이썬 데이터 객체를 문자열로 변환하는 작업을 직렬화(Serialize)라고 합니다.
  • 반대로 클라이언트 측에서 보내주는 데이터 역시 파이썬 객체로 변환해야하는데 이를 역직렬화(Deserialize)라고 합니다.DRF 내에서 데이터를 저장할 때 Django의 모델을 통해 저장합니다.
  • 일반적인 serializer 사용법
    1. validation
       1. 전체 validation
       2. 필드 validation - 각 필드별로 validation을 진행합니다.
       3. validation 과정에서 데이터를 정제하기도 합니다.
    2. fields
       • 필요한 필드만 지정하는 경우를 말합니다.
    3. Field 함수들
       1. ReadOnlyField - 필요한 데이터 찾기(Join)
       2. SerializerMethodField - 필요한 데이터 만들기
       3. 등등

class UserSerializer(serializers.ModelSerializer):
		is_system_admin = serializers.SerializerMethodField()
		company_name = serializers.ReadOnlyField(source='company.name', read_only=True)
		# 위처럼 정의하면 , user.company.name 을 company_name 에 담아준다.
		
		class Meta:
				model = User
				# 2. fields,
				# tip, List API 처럼 많은 데이터를 조회할 때에는 무조건 '__all__' 하기보다 딱 사용하는 필드만 쓰는게좋음.
				# SELECT * 보다 SELECT first_name, .. 이 효율적이기에. 데이터 크기도 그렇고.

				fields = [
					"last_name",
					"first_name",
					"full_name", # Model 쪽 @property는 이렇게 바로 사용 가능!
					"is_system_admin",
					"company_name"
				]
		# SerializerMethodField 는 필드명 앞에 get_ 붙여서 함수를 구현, 원하는 값을 만들 수 있음.
		def get_is_system_admin(self, obj):
				return obj.has_role('SYSTEM_USER') # 여기서는 Model function을 썼지만, 원하는대로 사용 가능.
		
		# 1-a. 전체
		def validate(self, data):
		     if data['fisrt_name'] == data['last_name']:
		        raise serializers.ValidationError("fisrt_name 과 last_name 이 같습니다. 값 확인하세요.")

				# 1-c, 만약 full_name 이 모델 필드였다면, 여기서 만들어도 됩니다.(이건 정석인지는 모르겠지만, 가끔 사용)
				if not data.get('full_name'):
						data['full_name'] = data['last_name'] + data['first_name']

		    return data
		    
		# 1-b. 필드별
		# 필드명 앞에 validate_ 붙이면 자동으로 동작, 아래는 first_name 체크하는 로직.
		def validate_fist_name(self, value):
		    if len(value) < 10:
		        raise serializers.ValidationError("first_name should be less than 10 characters")

				# 1-c, 만약 first_name에 공백을 제외하는 규칙이라면, 여기서 처리해도 됩니다(이건 정석인지는 모르겠지만, 가끔 사용)
				value = value.replace(" ", "")
				return value

urls.py

• 프로젝트와 앱의 url 주소를 등록하는 파일
• as_views를 사용하는 경우와 router를 사용하는 경우가 있습니다.

# as_view 사용
from snippets.views import SnippetViewSet, UserViewSet, api_root
from rest_framework import renderers

snippet_list = SnippetViewSet.as_view({
    'get': 'list',
    'post': 'create'
})
snippet_detail = SnippetViewSet.as_view({
    'get': 'retrieve',
    'put': 'update',
    'patch': 'partial_update',
    'delete': 'destroy'
})
snippet_highlight = SnippetViewSet.as_view({
    'get': 'highlight'
}, renderer_classes=[renderers.StaticHTMLRenderer])
user_list = UserViewSet.as_view({
    'get': 'list'
})
user_detail = UserViewSet.as_view({
    'get': 'retrieve'
})

# format_suffix_patterns이 필수는 아닙니다. 제거하고 리스트 형식으로만 넘겨도 좋습니다.
urlpatterns = format_suffix_patterns([
    path('', api_root),
    path('snippets/', snippet_list, name='snippet-list'),
    path('snippets/<int:pk>/', snippet_detail, name='snippet-detail'),
    path('snippets/<int:pk>/highlight/', snippet_highlight, name='snippet-highlight'),
    path('users/', user_list, name='user-list'),
    path('users/<int:pk>/', user_detail, name='user-detail')
])

# router 사용
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from snippets import views

# Create a router and register our viewsets with it.
router = DefaultRouter()
router.register(r'snippets', views.SnippetViewSet,basename="snippet")
router.register(r'users', views.UserViewSet,basename="user")

# The API URLs are now determined automatically by the router.
urlpatterns = [
    path('', include(router.urls)),
]

개발 순서

• models → serializers → views → urls 순서대로 개발하는 것이 일반적입니다.
• 아래 그림은 DRF에서 사용하는 모듈을 나열한 것입니다.

 

DRF 심화개념

1. User 모델 커스터마이징

• User 모델을 커스터마이징 하는 이유
  • 확장 - 제공되는 기능 외의 기능을 다루기 위해서
  • 변경 - 제공되는 기능을 내가 필요한 기능으로 변경하기 위해서
• 앞서 설명한 내용대로 User 모델을 구현하는 방법은 다양합니다. 로그인 하기 위한 수단으로 id를 사용하는 곳이 있고, 이메일을 사용하는 곳이 있듯이 우리가 원하는 방향으로 개발을 진행하기 위해서 모델 커스터마이징을 진행합니다.
• 코드는 제공되지 않습니다. 스스로 모델을 커스터마이징해서 과제를 풀어보시기 바랍니다.

# permissions.py
class IsOwnerOrReadOnly(BasePermission):

    """
    작성자 외 읽기 권한만 부여
    JWT 토큰을 decode, obj의 user와 해당 user가 일치하는지 확인
    ERR03
    """
    
    message = "[Access Denied: ERR03] 게시글 수정, 삭제 권한이 없습니다."
    

    def has_object_permission(self, request, view, obj):
    
        if request.method in SAFE_METHODS:
            return True
            
        else:
            token = request.headers.get('Authorization').split(" ")[1]
            payload = jwt.decode(token, settings.SECRET_KEY, algorithms=settings.ALGORITHM)
            token_user = payload.get('user_id')

            return obj.user.id == token_user

2. Permission, Test, Statistic, Logging

• 권한(Permission) - Github
  • 우리는 앱을 만들 때 권한을 제어해야합니다.
  • DRF에서는 권한에 관한 여러 클래스가 있습니다.
  • BasePermission을 상속받아 권한 설정을 커스터마이징할 수 있습니다.
  • 아래에는 jwt를 HTTP 요청 헤더에 Authorization으로 넣었을 때, Owner만 읽을 수 있도록하는 커스텀 코드입니다.
• 테스트(Test)
  • TDD(Test Driven Development) - 테스트 주도 하 개발이라는 뜻으로 개발에 있어 그 진행을 담당하는 주체를 테스트에 두고 있습니다.
  • 테스트의 종류는 여러가지가 있으나, 내용이 방대하여 “소프트웨어 개발 방법론”이라는 주제로 직접 검색하여 보시기 바랍니다.
  • 아래의 테스트는 django 패키지를 사용하는 경우입니다. 추가적으로 DRF의 테스트 기능을 사용해보고 싶으시다면 DRF Testing을 확인해주시길 바랍니다.
  • TDD 프로세스
    1. 구현하려는 기능에 대한 테스트 코드를 작성한다.
    2. 테스트를 실행시키고, 기능이 없으니 실패한다.
    3. 테스트를 통과할 수 있는 최소한의 기능을 구현한다.
    4. 테스트를 실행시키고, 통과시키면 코드를 정리한다.
    5. 모든 기능을 구현할 때까지 이를 반복한다.
  • 예시
    • 모델에 관한 테스트입니다. 작성이 끝나면 아래 명령어를 통해 테스트를 진행합니다.
    • 아무것도 없기 때문에 통과하지 못할 것입니다. 이제 테스트를 통과할 수 있는 모델을 작성합니다.

    from django.db import models
    
    class Book(models.Model):
        title = models.CharField(max_length=128)
        author = models.CharField(max_length=128)
    

    • migration을 진행합니다.

    $ python manage.py makemigrations
    $ python manage.py migrate
    $ python manage.py test
    

    • view 테스트를 진행하도록 합니다. 테스트코드를 먼저 작성하도록 합니다.

    # tests.py
    from django.test import TestCase
    from .models import Book
    
    from rest_framework.test import APIClient
    from rest_framework import status
    
    class ModelTest(TestCase):
        def setUp(self):
            self.book_title = "My Book"
            self.book_author = "Hyeonsoo"
            self.book = Book(title=self.book_title, author=self.book_author)
    
        def test_model_can_create_a_bucketlist(self):
            old_count = Book.objects.count()
            self.book.save()
            new_count = Book.objects.count()
            self.assertNotEqual(old_count, new_count)
    
    class ViewTest(TestCase):
        def setUp(self):
            self.client = APIClient()
            self.book_data = {'title': 'My Book 2', 'author': 'Hyeonsoo'}
            self.response = self.client.post('/api/books/',
                                             self.book_data,
                                             format="json")
    
        def test_api_can_create_a_book(self):
            print(self.response.content)
            self.assertEqual(self.response.status_code, status.HTTP_201_CREATED)
    

    • 역시나 아무것도 작성되어 있지 않아서 통과할 수 없을 것입니다. 이제 나머지 코드를 작성합니다.

    # serializers.py
    from rest_framework import serializers
    from .models import Book
    
    class BookSerializer(serializers.ModelSerializer):
        class Meta:
            model = Book
            fields = ('id', 'title', 'author')
    

    # views.py
    from rest_framework import generics
    from .serializers import BookSerializer
    from .models import Book
    
    class CreateView(generics.CreateAPIView):
        queryset = Book.objects.all()
        serializer_class = BookSerializer
    
        def perform_create(self, serializer):
            serializer.save()
    

    # urls.py
    from django.urls import path
    from .views import CreateView
    
    urlpatterns = [
        path('books/', CreateView.as_view()),
    ]
    

• 통계(Statistic)
  • 우리는 ORM을 사용하여 Database와 연동하고 데이터를 생성, 수정, 조회, 삭제합니다.
  • DB에 저장된 데이터를 기반으로 파이썬에서 쿼리문을 작성하여 데이터의 통계를 출력할 수 있습니다.
  • 예시

  # views.py
  class UserGenderStatisticsView(APIView):
      """
      유저의 남녀 수를 확인합니다.
      """
      def get(self, request):
          male_cnt = User.objects.filter(gender="Male").count()
          female_cnt = User.objects.filter(gender="Female").count()
          return Response({"male_count": male_cnt, "female_count": female_cnt}, status=status.HTTP_200_OK)
  
  class NoticeBoardGenderStatisticsView(APIView):
      """
      공지사항 게시판에서 남녀의 분포를 확인합니다.
      """
      def get(self, request):
          male_cnt = NoticeBoard.objects.filter(user__gender="Male").count()
          female_cnt = NoticeBoard.objects.filter(user__gender="Female").count()
          return Response({"male_count": male_cnt, "female_count": female_cnt}, status=status.HTTP_200_OK)
  

• 로그(Logging)
  • 로그 데이터는 기록의 의미를 가집니다. IT인프라에서 발생하는 모든 상황의 데이터라고 할 수 있습니다.
  • 사고나 장애가 발생 시, 원인을 파악하고 대처할 수 있는 근거를 제공하기 때문에 중요하다고 할 수 있습니다.
  • 또한 기록된 고객의 로그데이터를 활용하여 데이터를 분석하거나 ML 모델에 활용할 수도 있습니다.
  • 관련 모듈
    • drf-tracking
    • # views.py from rest_framework import generics from rest_framework.response import Response from rest_framework_tracking.mixins import LoggingMixin class SampleView(LoggingMixin): def get(self, request): return Response('with logging')
    • django-request-logging

      # loggings.py
      import logging
      
      logger = logging.getLogger(__name__)
      
      def some_view(request):
          ...
          if some_risky_state:
              logger.warning('Platform is running at risk')
      

    • Logging in JSON formatter 레퍼런스
      • velebit AI Tech Blog
      • 체계적인 Python Logging Blog
      • pypi python-json-logger
      • Logging HOWTO 공식문서
      • python-json-logger Github
      • Django+json-log-formatter
    • Logging 최종 목적의 형태
      • JSON 형식

3. 권한 설정된 기능을 사용하는 방법

• JWT Signin(또는 Login) 기능을 통해 부여받은 ACCESS_KEY를 HTTP 헤더에 Authorization이라는 KEY 값을 추가한 후 VALUE에는 Bearer {키값} 의 형태로 넣어주시면 됩니다.
  • 여기서 {}를 제거한 형태로 키값만 입력해주시면 됩니다.

DRF 설치 및 초기 설정

1. DRF 패치키를 설치합니다.

$ pip install djangorestframework

 

2. INSTALLED APP에 추가해줍니다.

# settings.py
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework', # 앱에 등록합니다.
]

# DRF setting - 예시입니다.
REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',
    ],
    'DEFAULT_PARSER_CLASSES': [
        'rest_framework.parsers.JSONParser',
    ]
}

TIME_ZONE = 'Asia/Seoul'

• REST_FRAMEWORK 라는 환경변수 안에서 다양한 설정을 할 수 있습니다.
  • 레퍼런스