你應(yīng)該使用Django admin的9個(gè)理由
我現(xiàn)在要澄清這個(gè)誤解。Django 的 admin 絕對(duì)是軟件中的亮點(diǎn)，可以有效的加速你的開(kāi)發(fā)。
這里有一些我能想到的很有用的 Django 的 admin 模塊的竅門(mén)。
(對(duì)于 Django admin 不太熟悉的人，先簡(jiǎn)單解釋幾個(gè)名詞)
- Changeform 是可以編輯對(duì)象的頁(yè)面。
- Changelist 頁(yè)面可以列出指定類型的對(duì)象。你可以指定過(guò)濾對(duì)象的條件及對(duì)對(duì)象的操作。點(diǎn)擊 changelist 里的對(duì)象一般會(huì)跳轉(zhuǎn)到對(duì)象的 changeform 頁(yè)面。
為了讓這些敲門(mén)更具可操作性，我們使用了與真實(shí)問(wèn)題幾乎一致的場(chǎng)景。假設(shè)我們有一個(gè)簡(jiǎn)單的網(wǎng)站，訪客可以上傳可愛(ài)的動(dòng)物圖片并進(jìn)行評(píng)論。這是不是很流行呢?
Tip 1：Django admin 后臺(tái)不限于用 Django 開(kāi)發(fā)的網(wǎng)站
雖然 Django admin 管理界面可以非常友好的用在 Django 項(xiàng)目的其它部分，它同樣可以很容易用于其它像傳統(tǒng)的數(shù)據(jù)庫(kù)或具有一個(gè)可怕的的管理界面的網(wǎng)站。而且這也是評(píng)估 Django 是否會(huì)滿足您的需求的***途徑。
你需要做的僅是：
- 在你的 Django 項(xiàng)目中建立一個(gè)新的應(yīng)用，并確保你已經(jīng)連接好傳統(tǒng)數(shù)據(jù)庫(kù) ,通過(guò) settings.py 文件中的 DATABASES 的設(shè)置。
- 將你的數(shù)據(jù)表定義為 Django 的模型。正如它的名字所表述的，manage.py inspectdb 是一個(gè)非常有用的命令：檢測(cè)現(xiàn)有的數(shù)據(jù)庫(kù)，并打印出自動(dòng)生成的 Django 模型。
- 創(chuàng)建 admin.py 文件，并放在那里，唉，管理相關(guān)的。稍后將詳細(xì)說(shuō)明這個(gè)。
說(shuō)到我們的動(dòng)物“的網(wǎng)站，是由進(jìn)屎的腦袋寫(xiě)出來(lái)的，所以管理界面看起來(lái)像……你知道的，不是很好。為了解決這個(gè)問(wèn)題，我們通過(guò)幾個(gè) Django 模型重構(gòu)了數(shù)據(jù)庫(kù)結(jié)構(gòu)，實(shí)現(xiàn)一個(gè)簡(jiǎn)單的管理界面：
- # models.py
- class Picture(models.Model):
- DOG = 1
- CAT = 2
- ANIMAL_KIND_CHOICES = (
- (DOG, 'dog'),
- (CAT, 'cat'),
- )
- title = models.CharField(max_length=200)
- author = models.ForeignKey(Author, related_name='pictures')
- animal_kind = models.IntegerField(choices=ANIMAL_KIND_CHOICES)
- photo = models.ImageField(upload_to='animals')
- is_promoted = models.BooleanField(default=False)
- class Author(models.Model):
- name = models.CharField(max_length=100)
- email = models.EmailField()
- class Comment(models.Model):
- author = models.ForeignKey(Author, related_name='comments')
- picture = models.ForeignKey(Picture, related_name='comments')
- comment = models.TextField()
- editors_note = models.TextField()
- # admin.py
- class PictureAdmin(admin.ModelAdmin):
- list_display_fields = ('photo', 'animal_kind', 'author', 'is_promoted', )
- class AuthorAdmin(admin.ModelAdmin):
- list_display_fields = ('name', 'email', )
- class CommentAdmin(admin.ModelAdmin):
- list_display_fields = ('picture', 'author', )
Tip #2: 按你喜歡的方式篩選你的數(shù)據(jù)
很多人使用 Django admin 后臺(tái)對(duì)指定字段進(jìn)行篩選。要知道，把一個(gè)字段名放到 list_filter 列表里就可以了。同時(shí)它也非常容易地創(chuàng)建一個(gè)自定義過(guò)濾器!
假如最終你決定要推廣所有有 100+ 的帖子的作者。但是，我們?nèi)绾螀^(qū)分它們?讓我們創(chuàng)建一個(gè)過(guò)濾器，并把它添加到我們的變更列表。
- class ProductiveAuthorsFilter(admin.SimpleListFilter):
- parameter_name = 'is_productive'
- title = 'Productive author'
- YES, NO = 1, 0
- # Number of comments for an author to be considered a productive one
- THRESHOLD = 100
- def lookups(self, request, model_admin):
- return (
- (self.YES, 'yes'),
- (self.NO, 'no'),
- )
- def queryset(self, request, queryset):
- qs = queryset.annotate(Count('comments'))
- # Note the syntax. This way we avoid touching the queryset if our
- # filter is not used at all.
- if self.value() == self.YES:
- return qs.filter(comments__count__gte=self.THRESHOLD)
- if self.value() == self.NO:
- return qs.filter(comments__count__lt=self.THRESHOLD)
- return queryset
- class PictureAdmin(admin.ModelAdmin):
- list_filters = [..., ProductiveAuthorsFilter]
現(xiàn)在，我們可以很容易地選出我們的核心作者。那么我們?nèi)绾伍_(kāi)始向他們推廣呢?讓我們進(jìn)入下一部分。
Tip #3：添加動(dòng)作(操作函數(shù))到 ‘actions’
這可是內(nèi)容管理者的天賜之物。還記得在每個(gè)模型的列表頂部的“動(dòng)作”工具欄不?我們是不是非常方便的先選擇一些圖片，然后只需單擊一下就“推廣”給作者了?現(xiàn)在讓我們來(lái)實(shí)現(xiàn)它：
- class PictureAdmin(admin.ModelAdmin):
- actions = ['promote', ]
- def promote(self, request, queryset):
- queryset.update(is_promoted=True)
- self.message_user(request, 'The posts are promoted')
- promote.short_description = 'Promote the pictures'
就是這樣!不用再一個(gè)挨一個(gè)的打開(kāi)每個(gè)表單!另外，它很容易進(jìn)一步增加我們的動(dòng)作，例如，添加一個(gè)過(guò)渡表單。關(guān)于這點(diǎn)，Django 文檔 有段非常棒的講解(https://docs.djangoproject.com/en/1.8/ref/contrib/admin/actions/#actions-that-provide-intermediate-pages)。
Tip #4: 搜索你需要的所有字段
好吧，過(guò)濾器是很酷，但讓我們關(guān)注了一下就搜索工具。在幾乎所有的安裝我見(jiàn)過(guò)的搜索框是用來(lái)在一個(gè)模型中的字段搜索。但是，當(dāng)你意識(shí)到它可以處理關(guān)系的 Django 搜索真正的亮點(diǎn)。因此，假設(shè)我們希望它在圖片“的標(biāo)題，作者姓名和注釋”文本進(jìn)行搜索。我們?nèi)绾巫龅竭@一點(diǎn)?
- class PictureAdmin(admin.ModelAdmin):
- search_fields = ('title', 'author__name', 'comments__text', )
如果你的數(shù)據(jù)庫(kù)是夠大，不要忘記添加一些全文索引來(lái)增加搜索速度。
Tip #5: “在站點(diǎn)查看”的簡(jiǎn)單實(shí)現(xiàn)
在站點(diǎn)查看一個(gè)對(duì)象的界面是非常普及的需求，默認(rèn)情況下，你必須打開(kāi)該對(duì)象的表單，然后點(diǎn)擊按鈕“在站點(diǎn)查看”。以下代碼展示如何使此過(guò)程更容易一些：
- class PictureAdmin(admin.ModelAdmin):
- list_fields = [..., 'object_link']
- def object_link(self, item):
- url = item.get_absolute_url()
- return u'<a href={url}>open</a>'.format(url=url)
- object_link.short_description = 'View on site'
- object_link.allow_tags = True
這段代碼給列表中每個(gè)對(duì)象都添加了“在站點(diǎn)查看”的鏈接。在此，我們假定你的模型(Model)已經(jīng)實(shí)現(xiàn)了get_absolute_url()方法。如果還沒(méi)有 – 那現(xiàn)在就去實(shí)現(xiàn) ，這將為你節(jié)省很多時(shí)間。你也可能會(huì)想將這個(gè)片段轉(zhuǎn)移到一個(gè) mixin，或公用的 admin 基類。
Tip #6: 在列表頁(yè)就地編輯字段
假設(shè)我們需要給評(píng)論加一個(gè)編輯的備注。很自然，我們希望不需要對(duì)每條評(píng)論都去打開(kāi)評(píng)論的changeform。要做到這點(diǎn)，我們可以稍微修改一下ModelAdmin：
- class CommentAdmin(admin.ModelAdmin):
- list_display_fields = ('picture', 'author', 'editors_note', )
- list_editable = ('editors_note', )
這樣就搞定了，現(xiàn)在打開(kāi)評(píng)論列表，可以按照需要進(jìn)行過(guò)濾，還可以在評(píng)論上即時(shí)添加備注。
Tip #7: 根據(jù)需要自定義 total 字段
每個(gè) changelist 最下方都有一行列出總數(shù)(total)。假設(shè)我們需要把貓和狗的圖片數(shù)量區(qū)分開(kāi)來(lái)。這個(gè)功能需要的代碼稍微多一些：我們需要重載 changelist 和 html 模板(更多內(nèi)容參考模板重載)。
- from django.contrib.admin.views.main import ChangeList
- class PicturesChangeList(admin.ChangeList):
- def get_results(self, request):
- super(PicturesChangeList, self).get_results(request)
- totals = self.result_list.aggregate(
- dogs_count=Sum(Case(When(animal_kind=Picture.DOG, then=1),
- output_field=IntegerField())),
- cats_count=Sum(Case(When(animal_kind=Picture.CAT, then=1),
- output_field=IntegerField())))
- self.totals = totals
- class PictureAdmin(admin.ModelAdmin):
- def get_changelist(self, request):
- return PicturesChangeList
模板的內(nèi)容：
- {% extends 'admin/change_list.html' %}
- {% block result_list %}
- {{ block.super }}
- <p>
- There are
- <strong>
- {{ cl.totals.dogs_count|default:'none' }} dogs and
- {{ cl.totals.cats_count|default:'none' }} cats
- </strong>
- on this page.
- </p>
- {% endblock %}
Tip #8: 對(duì)某些用戶只讀的 admin 界面
啥意思?假設(shè)你的祖母打算瞅一眼這些可愛(ài)的圖片，她站在你背后，覺(jué)得 Django 的 admin 界面挺有意思。不過(guò)你能肯定，她要是使用 admin 界面，恐怕一個(gè)按鈕的點(diǎn)擊就能毀掉整個(gè)網(wǎng)站。那么，我們加上 grandma-proof™，這樣就支持只讀的 admin 界面(就是某人說(shuō)的“數(shù)據(jù)瀏覽”)：
- class GrandmaProofAdmin(admin.ModelAdmin):
- def get_readonly_fields(self, request, obj=None):
- if request.user.username == 'granny':
- return [f.name for f in self.model._meta.fields]
- else:
- return super(GrandmaProofAdmin, self).get_readonly_fields(request, obj)
- class PictureAdmin(GrandmaProofAdmin):
- ...
現(xiàn)在你可以安全的把修改圖片的權(quán)限放開(kāi)給你的祖母，這樣她就能瀏覽圖片列表。要注意這個(gè)方案肯定不能適用于所有使用場(chǎng)景，你還需要處理更多的情況。
Tip #9: 為每個(gè)對(duì)象自定義 action
有時(shí)候你需要在單個(gè)對(duì)象上執(zhí)行特定的 action。‘actions’工具當(dāng)然可以完成這個(gè)任務(wù)，不過(guò)過(guò)程會(huì)顯得很麻煩：點(diǎn)擊對(duì)象、選擇 action、再點(diǎn)擊一個(gè)按鈕……肯定有更便捷的方式，對(duì)吧?讓我們想辦法只點(diǎn)擊一次就全部搞定。
這次我們要實(shí)現(xiàn)老祖母的另一個(gè)宏達(dá)的想法。她希望能給某些編輯發(fā) email，告訴他們她喜歡的所有圖片。
- class PictureAdmin(admin.ModelAdmin):
- list_fields = (..., 'mail_link', )
- def mail_link(self, obj):
- dest = reverse('admin:myapp_pictures_mail_author',
- kwargs={'pk': obj.pk})
- return '<a href="{url}">{title}</a>'.format(url=dest, title='send mail')
- mail_link.short_description = 'Show some love'
- mail_link.allow_tags = True
- def get_urls(self):
- urls = [
- url('^(?P<pk>\d+)/sendaletter/?$',
- self.admin_site.admin_view(self.mail_view),
- name='myapp_pictures_mail_author'),
- ]
- return urls + super(PictureAdmin, self).get_urls()
- def mail_view(self, request, *args, **kwargs):
- obj = get_object_or_404(Picture, pk=kwargs['pk'])
- send_mail('Feel the granny\'s love', 'Hey, she loves your pet!',
- 'granny@yoursite.com', [obj.author.email])
- self.message_user(request, 'The letter is on its way')
- return redirect(reverse('admin:myapp_picture_changelist'))
但愿她現(xiàn)在能夠滿意?，F(xiàn)在每個(gè)對(duì)象字段加上了一個(gè)鏈接，讓她點(diǎn)一下就可以發(fā)送郵件。
Bonus Tip: 只需為 admin 添加一行代碼來(lái)減少查詢量
Django admin (Django 也是如此) 最常用也是最有用的技巧是 select_related。呃，你已經(jīng)都知道了?不就是把對(duì)象的名字傳給 ModelAdmin 的 list_select_related 屬性來(lái)實(shí)現(xiàn)相關(guān)對(duì)象的預(yù)加載嘛。但是，你知道你并沒(méi)有描述全部的相關(guān)對(duì)象嗎?只需要設(shè)置成 True，Django 就可以自動(dòng)預(yù)加載外部對(duì)象：
- class PictureAdmin(admin.ModelAdmin):
- list_select_related = True
本文到此就差不多結(jié)束了，希望你能覺(jué)得有意思。別忘了在評(píng)論里分享你的看法，告訴我們對(duì)你有幫助的技巧。
