클래스 기반 뷰(CBV) 탐구 시리즈 ⑦ - Mixin 활용 및 권한 관리

아래 글은 Django 클래스 기반 뷰(CBV) 탐구 시리즈의 7편으로, Mixin을 활용해 공통 기능을 재사용하고, 권한 관리 및 로그인 체크를 효율적으로 구현하는 방법을 다룹니다. 지난 글(6편)에서 TemplateView와 RedirectView로 간단한 페이지 렌더링 및 리디렉션을 자동화했다면, 이제 CBV의 재사용성과 확장성을 극대화하는 방법을 알아보겠습니다.

전편 바로가기는 아래의 링크를 클릭하세요!

TemplateView & RedirectView 활용법

“Django Mixin으로 코드 재사용성을 높이고,  

간단하게 권한 및 로그인 체크를 구현하세요!”

1. Mixin, 왜 필요한가?

---

---

Django CBV는 그 자체로 강력한 재사용성을 제공하지만, 여러 뷰에서 공통적으로 필요한 기능이 있다면 어떻게 해야 할까요? 예를 들어, 특정 페이지에 접근하려면 로그인이 필요하거나, 특정 권한을 가진 사용자만 접근할 수 있게 해야 하는 경우가 많습니다. 이때 등장하는 개념이 바로 Mixin입니다.

Mixin은 다중 상속의 개념을 활용하여 여러 클래스에 동일한 메서드나 속성을 주입하는 방식입니다. Django CBV에서는 특정 기능을 구현한 Mixin 클래스를 뷰 클래스에 상속함으로써, 중복 코드를 줄이고 유지보수성을 높일 수 있습니다.

주요 Mixin 활용 예시:

1. 권한 관리: 특정 뷰에 접근하는 사용자가 로그인되어 있는지, 혹은 특정 권한을 가지고 있는지 확인.
2. 폼 처리 로직: 여러 폼에서 공통적으로 필요한 데이터 전처리 또는 후처리 로직.
3. 템플릿 컨텍스트: 모든 뷰에 공통적으로 전달되어야 하는 컨텍스트 데이터 추가.
4. 로깅: 특정 뷰의 실행 전후로 로깅 기능 추가.

2. Django의 대표적인 Mixin 활용법: LoginRequiredMixin

가장 흔하게 사용되는 Mixin 중 하나가 바로 LoginRequiredMixin입니다. 이름 그대로, 해당 뷰에 접근하려면 반드시 로그인이 되어 있어야 함을 강제하는 역할을 합니다.

2.1 LoginRequiredMixin 사용법

LoginRequiredMixin은 django.contrib.auth.mixins 모듈에 포함되어 있습니다.

# views.py
from django.views.generic import ListView
from django.contrib.auth.mixins import LoginRequiredMixin
from .models import Post # 예시 모델

class MyPostListView(LoginRequiredMixin, ListView):
    model = Post
    template_name = 'posts/my_posts.html'
    context_object_name = 'posts'

    # 로그인되지 않은 사용자가 접근 시 리디렉션될 URL 설정 (선택 사항)
    # login_url = '/accounts/login/' # settings.LOGIN_URL이 기본값
    # redirect_field_name = 'next'  # 로그인 후 원래 페이지로 돌아올 때 사용할 쿼리 파라미터 이름 (기본값)

• 상속 순서: LoginRequiredMixin을 먼저 상속하고, 그 뒤에 Django의 Generic View(여기서는 ListView)를 상속합니다. Mixin은 주로 기능 추가를 위해 사용되므로, 핵심 뷰 클래스보다 앞에 두는 것이 관례입니다.
• LoginRequiredMixin은 사용자가 로그인되어 있지 않으면 자동으로 settings.LOGIN_URL로 지정된 로그인 페이지로 리디렉션합니다. 로그인 성공 시에는 next 쿼리 파라미터를 통해 원래 요청했던 페이지로 돌아옵니다.

2.2 urls.py 연결

LoginRequiredMixin이 적용된 뷰는 일반 CBV와 동일하게 urls.py에 연결합니다.

# urls.py
from django.urls import path
from .views import MyPostListView

urlpatterns = [
    path('my-posts/', MyPostListView.as_view(), name='my_posts'),
]

이제 /my-posts/ 경로에 접근할 때, 로그인되어 있지 않으면 로그인 페이지로 이동하게 됩니다.

3. 권한 관리를 위한 Mixin: PermissionRequiredMixin & UserPassesTestMixin

---

---

LoginRequiredMixin이 로그인을 강제한다면, PermissionRequiredMixin과 UserPassesTestMixin은 특정 권한이 있거나 특정 조건을 만족해야만 접근을 허용합니다.

3.1 PermissionRequiredMixin 사용법

Django의 권한 시스템과 연동되어 특정 permission을 가진 사용자만 접근할 수 있게 합니다.

# views.py
from django.views.generic import CreateView
from django.contrib.auth.mixins import PermissionRequiredMixin
from .models import Article
from .forms import ArticleForm

class ArticleCreateView(PermissionRequiredMixin, CreateView):
    model = Article
    form_class = ArticleForm
    template_name = 'articles/article_form.html'
    success_url = '/articles/'

    # 'app_label.permission_codename' 형식으로 권한 지정
    permission_required = 'app_label.add_article'
    # 여러 권한 중 하나라도 있으면 허용할 경우:
    # permission_required = ('app_label.add_article', 'app_label.change_article')
    # raise_exception = True # 권한 없을 시 403 Forbidden 에러 발생 (기본값은 로그인 페이지로 리디렉트)

• permission_required: 접근에 필요한 권한을 문자열(하나 또는 튜플)로 지정합니다. Django의 auth 앱에서 모델별로 자동 생성되는 권한(add_model, change_model, delete_model, view_model)을 주로 사용합니다.

3.2 UserPassesTestMixin 사용법

더욱 복잡하거나 커스텀된 조건을 검사하고 싶을 때 사용합니다. 예를 들어, 자신이 작성한 글만 수정할 수 있도록 하거나, 특정 그룹에 속한 사용자만 접근하게 하는 등의 로직에 유용합니다.

# views.py
from django.views.generic import UpdateView
from django.contrib.auth.mixins import UserPassesTestMixin
from .models import Comment
from .forms import CommentForm

class CommentUpdateView(UserPassesTestMixin, UpdateView):
    model = Comment
    form_class = CommentForm
    template_name = 'comments/comment_form.html'
    success_url = '/comments/'

    # test_func 메서드를 오버라이드하여 조건 검사
    def test_func(self):
        comment = self.get_object()
        # 현재 로그인된 사용자가 댓글 작성자인지 확인
        return self.request.user == comment.author or self.request.user.is_superuser

    # raise_exception = True # 테스트 실패 시 403 Forbidden 에러 발생

• test_func() 메서드를 오버라이드하여 True를 반환하면 접근을 허용하고, False를 반환하면 접근을 거부합니다.
• self.request.user를 통해 현재 로그인된 사용자 객체에 접근할 수 있습니다.

4. 커스텀 Mixin 만들기

Django에서 제공하는 Mixin 외에, 자신만의 Mixin을 만들어 여러 뷰에서 재사용할 수도 있습니다. 예를 들어, 모든 페이지에 공통적으로 필요한 current_year 컨텍스트를 추가하는 Mixin을 만들어 보겠습니다.

# common/mixins.py
from datetime import datetime

class CurrentYearMixin:
    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context['current_year'] = datetime.now().year
        return context

# views.py (적용 예시)
from django.views.generic import TemplateView
from .common.mixins import CurrentYearMixin

class MyCustomPageView(CurrentYearMixin, TemplateView):
    template_name = 'my_custom_page.html'

# my_custom_page.html (템플릿에서 사용)
<footer>&copy; {{ current_year }} My Website</footer>

• CurrentYearMixin은 get_context_data 메서드를 오버라이드하여 current_year를 컨텍스트에 추가합니다. super().get_context_data(**kwargs)를 호출하여 상위 클래스(또는 다른 Mixin)의 컨텍스트 데이터를 유지하는 것이 중요합니다.

5. FBV와 비교해 보기

6. 마무리 및 다음 편 예고

Mixin은 Django 클래스 기반 뷰의 진정한 힘을 발휘하게 해주는 핵심 요소입니다. 이를 통해 우리는 코드 재사용성을 극대화하고, 공통 기능을 모듈화하여 뷰 클래스의 복잡성을 줄이며, 특히 인증 및 권한 관리와 같은 웹 애플리케이션의 필수 요소를 매우 효율적으로 구현할 수 있습니다.

이제 우리는 CBV의 기본적인 사용법부터 복잡한 CRUD, 그리고 Mixin을 통한 기능 확장까지, Django CBV의 거의 모든 핵심을 살펴보았습니다.

다음 편(시리즈 8편)에서는 그동안 다룬 CBV들을 실제 프로젝트에 어떻게 적용하고, 복잡한 시나리오에서는 어떻게 조합하여 사용하는지, 그리고 CBV의 장점과 한계를 종합적으로 정리하며 시리즈를 마무리할 예정입니다.

이전 글 다시 보기

1. 클래스 기반 뷰(CBV) 탐구 시리즈 #1 – FBV에서 CBV로 가는 이유와 개발자의 자세
2. 클래스 기반 뷰(CBV) 탐구 시리즈 #2 – Django의 기본 View 클래스 이해하기
3. 클래스 기반 뷰(CBV) 탐구 시리즈 #3 – FormView로 폼 처리 쉽게 하기
4. 클래스 기반 뷰(CBV) 탐구 시리즈 #4 – ListView & DetailView 활용법
5. 클래스 기반 뷰(CBV) 탐구 시리즈 #5 – CreateView, UpdateView, DeleteView로 CRUD 구현하기
6. 클래스 기반 뷰(CBV) 탐구 시리즈 #6 – TemplateView & RedirectView 활용법

“Mixin으로 Django CBV의 잠재력을 최대한 활용하고,  

유지보수하기 쉽고 확장 가능한 웹 애플리케이션을 구축하세요!”