[ISSUE]decorator를 이용한 중복작업 전처리

[22.11.26]

🍃 중복되며 각 함수의 사전에 처리되는 작업 decorator

📌 SiteBulkAPIView - 벌크 즐겨찾기, 삭제

class SiteBulkAPIView(APIView):
    """
    벌크 항목 즐겨찾기, 삭제 api
    """

    def get_list(self):

        pk_ids: list = self.request.data.get('pk_ids')
        
        return get_list_or_404(Site, id__in=pk_ids)
    
    def validate_ids(self):

        pk_ids: list = self.request.data.get('pk_ids')

        for id in pk_ids:
            get_object_or_404(Site,id=id)

        return self.get_list()

    def put(self, request):
        """
        Site 벌크 즐겨찾기 추가
        """ 

        sites = self.validate_ids()
        
        try:
            with transaction.atomic():
                '''트랜젝션 시작'''

                for site in sites:
                    site.favorite = self.request.data.get('favorite')
                    site.save()
        except:
            raise Response({'msg':'Updated failed'}, status=status.HTTP_400_BAD_REQUEST)

        return Response({'msg':'Updated successfully'}, status=status.HTTP_200_OK)

    def delete(self, request):
        """
        Site 벌크 삭제
        """        
        sites = self.get_list()

        for site in sites:
            site.delete()
    
        return Response({'msg': 'Deleted successfully'}, status=status.HTTP_200_OK)

 

📌 SiteTagsAPIView - 벌크 태그

class SiteTagsAPIView(APIView):
    """
    벌크 항목 태그 api
    """

    def get_list(self):

        pk_ids: list = self.request.data.get('pk_ids')
        
        return get_list_or_404(Site, id__in=pk_ids)
    

    def validate_ids(self):

        pk_ids: list = self.request.data.get('pk_ids')

        for id in pk_ids:
            get_object_or_404(Site,id=id)

        return self.get_list()
    
    def post(self, request, **kwards):
        """
        Site 태그 추가
        """ 
        sites          = validate_ids()
        tags           = self.request.data.get('tags')

        with transaction.atomic():
            '''트랜젝션 시작'''
            
            created_tags   = [Tag.objects.create(name=tag) for tag in tags]

            [tag.site.add(site.id) for tag in created_tags for site in sites]
        
        return Response({'msg':'Updated successfully'}, status=status.HTTP_200_OK)

 

🍃 코드 작성 시 문제점

✔️ 벌크 즐겨찾기, 삭제 Class를 코드를 작성한 후, 벌크 태그 Class 코드를 작성하는데 bulk작업이다 보니 데이터를 조회하고 검증하는 작업이 두 Class에서 반복적으로 사용이 됐다.

def get_list(self):

        pk_ids: list = self.request.data.get('pk_ids')

        return get_list_or_404(Site, id__in=pk_ids)

    def validate_ids(self):

        pk_ids: list = self.request.data.get('pk_ids')

        for id in pk_ids:
            get_object_or_404(Site,id=id)

        return self.get_list()

📌 해결방법

✔️ 반복되는 데이터 조회와 검증하는 작업을 decorator로 분리를 시키고 각 class의 api함수에서는 반복되는 코드를 줄이는 작업을 진행해보자

📌 decorator 사용

def bulk_decorator(func):

    @wraps(func)
    def exec_func(self, request) -> func:

        pk_ids: list = self.request.data.get('pk_ids')

        sites = validate_ids(pk_ids)

        return func(self, request, sites=sites)

    def get_list(pk_ids: list) -> Site:

        return get_list_or_404(Site, id__in=pk_ids)

    def validate_ids(pk_ids: list) -> Site:

        for id in pk_ids:
            get_object_or_404(Site,id=id)

        return get_list(pk_ids)

    return exec_func

✔️ bulk_decorator함수

• 데코레이터 실행 함수 exec_func를 실행할 수 있게 return으로 exec_func를 반환
• 각 Class에서 작성하던 중복되던 함수 get_list와 validate_ids함수를 bulk_decorator내부 함수로 작성
• exec_func내부에 pk_ids로 전달받은 pk(id) 배열 값을 validate_ids()함수의 매개변수로 호출하여 sites 변수에 담아 실행함수 return 값으로 전달받은 함수의 키워드 가변인자 값으로 전달해 주게 변경

✔️ @bulk_decorator 사용

 

 class SiteTagsAPIView(APIView):
     """
     벌크 항목 태그 api
     """

     **@bulk_decorator**
     def post(self, request, **kwards):
         """
         Site 태그 추가
         """ 
         sites          = **kwards['sites']**
         tags           = self.request.data.get('tags')

         with transaction.atomic():
             '''트랜젝션 시작'''

             created_tags   = [Tag.objects.get_or_create(name=tag)[0] for tag in tags]

             [tag.site.add(site.id) for tag in created_tags for site in sites]

         return Response({'msg':'Add tag successfully'}, status=status.HTTP_200_OK)

class SiteTagsAPIView(APIView):
    """
    벌크 항목 태그 api
    """

    @bulk_decorator
    def post(self, request, **kwards):
        """
        Site 태그 추가
        """ 
        sites          = kwards['sites']
        tags           = self.request.data.get('tags')

        with transaction.atomic():
            '''트랜젝션 시작'''
            
            created_tags   = [Tag.objects.get_or_create(name=tag)[0] for tag in tags]

            [tag.site.add(site.id) for tag in created_tags for site in sites]
        
        return Response({'msg':'Add tag successfully'}, status=status.HTTP_200_OK)

✔️ 반복되며 사용되던 get_list와 validate_ids함수 코드가 분리되어 @bulk_decorator로 사용이 가능해지니 간결화되고 구조화되어 재사용성이 늘어났다.