Django Admin 实现外键过滤的方法
本文介绍在 Django Admin 中实现外键数据按当前登录用户过滤的方法。主要涵盖两处场景:在列表页限制可见数据,以及在新增或编辑表单中动态过滤关联外键选项。通过重写 get_queryset、save_model 以及 render_change_form 等方法,结合 get_changeform_initial_data 传递初始参数,可有效实现基于用户权限的数据隔离与过滤。
Django Admin 外键过滤实现概述
本文主要说明 Django Admin 中关于 Model 的定义与相关配置。
开发环境如下:
➜ python
Python 3.6.3 |Anaconda custom (x86_64)| (default, Oct 6 2017, 12:04:38)
[GCC 4.2.1 Compatible Clang 4.0.1 (tags/RELEASE_401/final)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import django
>>> print(django.get_version())
2.0.1
>>>
该方案于 2018年05月23日进行更新。
可以通过重写 get_changeform_initial_data 函数来传递 initial 参数,从而在表单初始化时注入特定数据。
# admin.py
@admin.register(Score)
class ScoreConfigAdmin(FilterUserAdmin):
# fields = ('id','name')
form = ScoreConfigAdminForm
def get_changeform_initial_data(self, request):
initial = super().get_changeform_initial_data(request)
initial.update({'uid': request.user.id})
return initial
# forms.py
class ScoreConfigAdminForm(forms.ModelForm):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
if not kwargs.get('initial'):
return
self.uid = kwargs.get('initial').get('uid')
class Meta:
model = Score
fields = '__all__'
假设有一个支持多用户管理的 Blog 系统(使用 django admin),每一篇 Post 都需要记录发表者是谁,并且明确属于哪个 Blog。
user 与 Blog 的关系、以及 Blog 与 Post 的关系,通常有两种定义方式:一种是使用独立的关系表,另一种是直接在 Model 中定义外键。
采用直接定义外键方式的 Model 定义如下:
from django.contrib.auth.models import User
from django.db import models
class Blog(models.Model):
'''
Blog
'''
id = models.AutoField(unique=True, primary_key = True, verbose_name="序号")
name = models.CharField(max_length=255, blank=True, null=True, verbose_name="名称")
user = models.ForeignKey(User, on_delete=models.CASCADE)
create_time = models.DateTimeField(verbose_name='添加时间', auto_now_add=True, blank=True)
class Meta:
verbose_name = 'Blog'
verbose_name_plural = 'Blog管理'
def __str__(self):
return self.name
class Post(models.Model):
'''
Post 内容
'''
id = models.AutoField(unique=True, primary_key = True, verbose_name="序号")
title = models.CharField(max_length=255, blank=True, null=True, verbose_name="标题")
content = models.TextField(max_length=1024, blank=True, null=True, verbose_name="内容")
blog = models.ForeignKey(Blog, on_delete=models.CASCADE, verbose_name="所属Blog")
user = models.ForeignKey(User, on_delete=models.CASCADE)
create_time = models.DateTimeField(verbose_name='添加时间', auto_now_add=True, blank=True)
class Meta:
verbose_name = '文章'
verbose_name_plural = '文章管理'
def __str__(self):
return self.title
Admin 配置中的两处过滤实现
接下来介绍在 Admin 中的具体实现。
Admin 配置中有两个关键过滤点:一是在 Blog 和 Post 列表中按 user 进行过滤,二是在新增 Post 时,需要根据当前 user 过滤关联的 Blog 选项。完整代码如下:
from django.contrib import admin
from django import forms
# Register your models here.
from django_summernote.admin import SummernoteModelAdmin
from .models import Team, Member, Activity, Score
from .models import Blog, Post
class FilterUserAdmin(admin.ModelAdmin):
'''
按所属用户过滤的 base, class
'''
def save_model(self, request, obj, form, change):
# TODO 需要考虑不同用户对同一数据进行修改。
obj.user = request.user
obj.save()
def get_queryset(self, request):
# For Django < 1.6, override queryset instead of get_queryset
qs = super(FilterUserAdmin, self).get_queryset(request)
# 不能加这个,加了这个会导致 superuser 更新普通用户的数据。
# if request.user.is_superuser:
# return qs
return qs.filter(user=request.user)
def has_change_permission(self, request, obj=None):
has_class_permission = super(FilterUserAdmin, self).has_change_permission(request, obj)
if not has_class_permission:
return False
if obj is not None and not request.user.is_superuser and request.user.id != obj.user.id:
return False
return True
class BlogConfigAdmin(FilterUserAdmin):
list_display = ('id','name', 'create_time')
exclude = ['user']
list_per_page = 50
admin.site.register(Blog, BlogConfigAdmin)
class PostConfigAdmin(FilterUserAdmin):
list_display = ('id','title', 'create_time')
exclude = ['user']
list_per_page = 50
def render_change_form(self, request, context, add=False, change=False, form_url='', obj=None):
# 新增 Post 时,相关联的 Blog 需要过滤,关键就在下面这句。
context['adminform'].form.fields['blog'].queryset = Team.objects.filter(user=request.user)
return super(MemberConfigAdmin, self).render_change_form(request, context, add, change, form_url, obj)
admin.site.register(Post, PostConfigAdmin)
补充说明两点。
建议在 render_change_form 方法中设置断点,直接调试可以发现更多有趣的内容和实现细节。
以上关于 Django Admin 实现外键过滤的方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持本站。
免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。









