詳解Django之a(chǎn)dmin組件的使用和源碼剖析

更新時(shí)間：2018年05月04日 09:24:10 作者：人生不如戲

本篇文章主要介紹了詳解Django之a(chǎn)dmin的使用和源碼剖析，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

admin組件使用

Django 提供了基于 web 的管理工具。

Django 自動(dòng)管理工具是 django.contrib 的一部分。你可以在項(xiàng)目的 settings.py 中的 INSTALLED_APPS 看到它：

# Application definition

INSTALLED_APPS = [
  'django.contrib.admin',
  'django.contrib.auth',
  'django.contrib.contenttypes',
  'django.contrib.sessions',
  'django.contrib.messages',
  'django.contrib.staticfiles',
  "app01"
]

django.contrib是一套龐大的功能集，它是Django基本代碼的組成部分。

激活管理工具

通常我們?cè)谏身?xiàng)目時(shí)會(huì)在 urls.py 中自動(dòng)設(shè)置好，

from django.conf.urls import url
from django.contrib import admin

urlpatterns = [
  url(r'^admin/', admin.site.urls),

]

當(dāng)這一切都配置好后，Django 管理工具就可以運(yùn)行了。

使用管理工具

啟動(dòng)開(kāi)發(fā)服務(wù)器，然后在瀏覽器中訪(fǎng)問(wèn) http://127.0.0.1:8000/admin/，得到登陸界面，你可以通過(guò)命令 python manage.py createsuperuser 來(lái)創(chuàng)建超級(jí)用戶(hù)。

為了讓 admin 界面管理某個(gè)數(shù)據(jù)模型，我們需要先注冊(cè)該數(shù)據(jù)模型到 admin

from django.db import models

class Author(models.Model):

  name=models.CharField( max_length=32)
  age=models.IntegerField()

  def __str__(self):
    return self.name

class Publish(models.Model):

  name=models.CharField( max_length=32)
  email=models.EmailField()

  def __str__(self):
    return self.name


class Book(models.Model):

  title = models.CharField( max_length=32)
  publishDate=models.DateField()
  price=models.DecimalField(max_digits=5,decimal_places=2)

  publisher=models.ForeignKey(to="Publish")
  authors=models.ManyToManyField(to='Author')

  def __str__(self):
    return self.title

admin的定制

在admin.py中只需要講Mode中的某個(gè)類(lèi)注冊(cè)，即可在Admin中實(shí)現(xiàn)增刪改查的功能，如：

admin.site.register(models.UserInfo)

但是，這種方式比較簡(jiǎn)單，如果想要進(jìn)行更多的定制操作，需要利用ModelAdmin進(jìn)行操作，如：

方式一：

class UserAdmin(admin.ModelAdmin):
   list_display = ('user', 'pwd',)
 
admin.site.register(models.UserInfo, UserAdmin) # 第一個(gè)參數(shù)可以是列表

方式二：

@admin.register(models.UserInfo)        # 第一個(gè)參數(shù)可以是列表
class UserAdmin(admin.ModelAdmin):
  list_display = ('user', 'pwd',)

ModelAdmin中提供了大量的可定制功能，如

1. list_display，列表時(shí)，定制顯示的列。

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  list_display = ('user', 'pwd', 'xxxxx')
 
  def xxxxx(self, obj):
    return "xxxxx"

2. list_display_links，列表時(shí)，定制列可以點(diǎn)擊跳轉(zhuǎn)。

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  list_display = ('user', 'pwd', 'xxxxx')
  list_display_links = ('pwd',)

3. list_filter，列表時(shí)，定制右側(cè)快速篩選。

4. list_select_related，列表時(shí)，連表查詢(xún)是否自動(dòng)select_related

5. list_editable，列表時(shí)，可以編輯的列

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  list_display = ('user', 'pwd','ug',)
  list_editable = ('ug',)

6. search_fields，列表時(shí)，模糊搜索的功能

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  search_fields = ('user', 'pwd')

7. date_hierarchy，列表時(shí)，對(duì)Date和DateTime類(lèi)型進(jìn)行搜索

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  date_hierarchy = 'ctime'

8 inlines，詳細(xì)頁(yè)面，如果有其他表和當(dāng)前表做FK，那么詳細(xì)頁(yè)面可以進(jìn)行動(dòng)態(tài)增加和刪除

class UserInfoInline(admin.StackedInline): # TabularInline
  extra = 0
  model = models.UserInfo
 
class GroupAdminMode(admin.ModelAdmin):
  list_display = ('id', 'title',)
  inlines = [UserInfoInline, ]

9 action，列表時(shí)，定制action中的操作

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
  # 定制Action行為具體方法
  def func(self, request, queryset):
    print(self, request, queryset)
    print(request.POST.getlist('_selected_action'))
 
  func.short_description = "中文顯示自定義Actions"
  actions = [func, ]
 
  # Action選項(xiàng)都是在頁(yè)面上方顯示
  actions_on_top = True
  # Action選項(xiàng)都是在頁(yè)面下方顯示
  actions_on_bottom = False
 
  # 是否顯示選擇個(gè)數(shù)
  actions_selection_counter = True

10 定制HTML模板

add_form_template = None
change_form_template = None
change_list_template = None
delete_confirmation_template = None
delete_selected_confirmation_template = None
object_history_template = None

11 raw_id_fields，詳細(xì)頁(yè)面，針對(duì)FK和M2M字段變成以Input框形式

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  raw_id_fields = ('FK字段', 'M2M字段',)

12 fields，詳細(xì)頁(yè)面時(shí)，顯示字段的字段

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  fields = ('user',)

13 exclude，詳細(xì)頁(yè)面時(shí)，排除的字段

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  exclude = ('user',)

14 readonly_fields，詳細(xì)頁(yè)面時(shí)，只讀字段

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  readonly_fields = ('user',)

15 fieldsets，詳細(xì)頁(yè)面時(shí)，使用fieldsets標(biāo)簽對(duì)數(shù)據(jù)進(jìn)行分割顯示

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  fieldsets = (
    ('基本數(shù)據(jù)', {
      'fields': ('user', 'pwd', 'ctime',)
    }),
    ('其他', {
      'classes': ('collapse', 'wide', 'extrapretty'), # 'collapse','wide', 'extrapretty'
      'fields': ('user', 'pwd'),
    }),
  )

16 詳細(xì)頁(yè)面時(shí)，M2M顯示時(shí)，數(shù)據(jù)移動(dòng)選擇（方向：上下和左右）

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  filter_vertical = ("m2m字段",) # 或filter_horizontal = ("m2m字段",)

17 ordering，列表時(shí)，數(shù)據(jù)排序規(guī)則

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  ordering = ('-id',)
  或
  def get_ordering(self, request):
    return ['-id', ]

18. radio_fields，詳細(xì)頁(yè)面時(shí)，使用radio顯示選項(xiàng)（FK默認(rèn)使用select）

radio_fields = {"ug": admin.VERTICAL} # 或admin.HORIZONTAL

19 form = ModelForm，用于定制用戶(hù)請(qǐng)求時(shí)候表單驗(yàn)證

from app01 import models
from django.forms import ModelForm
from django.forms import fields
 
class MyForm(ModelForm):
  others = fields.CharField()
 
  class Meta:
    model = models = models.UserInfo
    fields = "__all__"
 
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
  form = MyForm

20 empty_value_display = "列數(shù)據(jù)為空時(shí)，顯示默認(rèn)值"

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  empty_value_display = "列數(shù)據(jù)為空時(shí)，默認(rèn)顯示"
 
  list_display = ('user','pwd','up')
 
  def up(self,obj):
    return obj.user
  up.empty_value_display = "指定列數(shù)據(jù)為空時(shí)，默認(rèn)顯示"

from django.contrib import admin
# Register your models here.
from .models import *
class BookInline(admin.StackedInline): # TabularInline
  extra = 0
  model = Book

class BookAdmin(admin.ModelAdmin):
  list_display = ("title",'publishDate', 'price',"foo","publisher")
  list_display_links = ('publishDate',"price")
  list_filter = ('price',)
  list_editable=("title","publisher")
  search_fields = ('title',)
  date_hierarchy = 'publishDate'
  preserve_filters=False

  def foo(self,obj):

    return obj.title+str(obj.price)
  # 定制Action行為具體方法
  def func(self, request, queryset):
    print(self, request, queryset)
    print(request.POST.getlist('_selected_action'))

  func.short_description = "中文顯示自定義Actions"
  actions = [func, ]
  # Action選項(xiàng)都是在頁(yè)面上方顯示
  actions_on_top = True
  # Action選項(xiàng)都是在頁(yè)面下方顯示
  actions_on_bottom = False

  # 是否顯示選擇個(gè)數(shù)
  actions_selection_counter = True
change_list_template="my_change_list_template.html"
class PublishAdmin(admin.ModelAdmin):
   list_display = ('name', 'email',)
   inlines = [BookInline, ]
admin.site.register(Book, BookAdmin) # 第一個(gè)參數(shù)可以是列表
admin.site.register(Publish,PublishAdmin)
admin.site.register(Author)

admin源碼解析

單例模式

單例模式（Singleton Pattern）是一種常用的軟件設(shè)計(jì)模式，該模式的主要目的是確保某一個(gè)類(lèi)只有一個(gè)實(shí)例存在。當(dāng)你希望在整個(gè)系統(tǒng)中，某個(gè)類(lèi)只能出現(xiàn)一個(gè)實(shí)例時(shí)，單例對(duì)象就能派上用場(chǎng)。

比如，某個(gè)服務(wù)器程序的配置信息存放在一個(gè)文件中，客戶(hù)端通過(guò)一個(gè) AppConfig 的類(lèi)來(lái)讀取配置文件的信息。如果在程序運(yùn)行期間，有很多地方都需要使用配置文件的內(nèi)容，也就是說(shuō)，很多地方都需要?jiǎng)?chuàng)建 AppConfig 對(duì)象的實(shí)例，這就導(dǎo)致系統(tǒng)中存在多個(gè) AppConfig 的實(shí)例對(duì)象，而這樣會(huì)嚴(yán)重浪費(fèi)內(nèi)存資源，尤其是在配置文件內(nèi)容很多的情況下。事實(shí)上，類(lèi)似 AppConfig 這樣的類(lèi)，我們希望在程序運(yùn)行期間只存在一個(gè)實(shí)例對(duì)象。

在 Python 中，我們可以用多種方法來(lái)實(shí)現(xiàn)單例模式：

使用模塊
使用 __new__
使用裝飾器（decorator）
使用元類(lèi)（metaclass）

（1）使用 __new__

為了使類(lèi)只能出現(xiàn)一個(gè)實(shí)例，我們可以使用 __new__ 來(lái)控制實(shí)例的創(chuàng)建過(guò)程，代碼如下：

class Singleton(object):
  _instance = None
  def __new__(cls, *args, **kw):
    if not cls._instance:
      cls._instance = super(Singleton, cls).__new__(cls, *args, **kw) 
    return cls._instance 

class MyClass(Singleton): 
  a = 1

在上面的代碼中，我們將類(lèi)的實(shí)例和一個(gè)類(lèi)變量 _instance 關(guān)聯(lián)起來(lái)，如果 cls._instance 為 None 則創(chuàng)建實(shí)例，否則直接返回 cls._instance 。

執(zhí)行情況如下：

>>> one = MyClass()
>>> two = MyClass()
>>> one == two
True
>>> one is two
True
>>> id(one), id(two)
(4303862608, 4303862608)

（2）使用模塊

其實(shí)， Python 的模塊就是天然的單例模式，因?yàn)槟K在第一次導(dǎo)入時(shí)，會(huì)生成 .pyc 文件，當(dāng)?shù)诙螌?dǎo)入時(shí)，就會(huì)直接加載 .pyc 文件，而不會(huì)再次執(zhí)行模塊代碼。因此，我們只需把相關(guān)的函數(shù)和數(shù)據(jù)定義在一個(gè)模塊中，就可以獲得一個(gè)單例對(duì)象了。如果我們真的想要一個(gè)單例類(lèi)，可以考慮這樣做：

# mysingleton.py
class My_Singleton(object):
  def foo(self):
    pass
 
my_singleton = My_Singleton()

將上面的代碼保存在文件 mysingleton.py 中，然后這樣使用：

from mysingleton import my_singleton
my_singleton.foo()

admin執(zhí)行流程

<1> 循環(huán)加載執(zhí)行所有已經(jīng)注冊(cè)的app中的admin.py文件

def autodiscover():
  autodiscover_modules('admin', register_to=site)

<2> 執(zhí)行代碼

＃admin.py
class BookAdmin(admin.ModelAdmin):
  list_display = ("title",'publishDate', 'price')

admin.site.register(Book, BookAdmin) 
admin.site.register(Publish)

<3> admin.site

這里應(yīng)用的是一個(gè)單例模式，對(duì)于AdminSite類(lèi)的一個(gè)單例模式，執(zhí)行的每一個(gè)app中的每一個(gè)admin.site都是一個(gè)對(duì)象

<4> 執(zhí)行register方法

admin.site.register(Book, BookAdmin) 
admin.site.register(Publish)

class ModelAdmin(BaseModelAdmin):pass
def register(self, model_or_iterable, admin_class=None, **options):
  if not admin_class:
      admin_class = ModelAdmin
  # Instantiate the admin class to save in the registry
  self._registry[model] = admin_class(model, self)

到這里，注冊(cè)結(jié)束！

<5> admin的URL配置

urlpatterns = [
  url(r'^admin/', admin.site.urls),
]

class AdminSite(object):  
   def get_urls(self):
    from django.conf.urls import url, include   
    urlpatterns = []
    # Add in each model's views, and create a list of valid URLS for the
    # app_index
    valid_app_labels = []
    for model, model_admin in self._registry.items():
      urlpatterns += [
        url(r'^%s/%s/' % (model._meta.app_label, model._meta.model_name), include(model_admin.urls)),
      ]
      if model._meta.app_label not in valid_app_labels:
        valid_app_labels.append(model._meta.app_label)
    return urlpatterns
  @property
  def urls(self):
    return self.get_urls(), 'admin', self.name

<6> url()方法的擴(kuò)展應(yīng)用

from django.shortcuts import HttpResponse
def test01(request):
  return HttpResponse("test01")

def test02(request):
  return HttpResponse("test02")

urlpatterns = [
  url(r'^admin/', admin.site.urls),
  url(r'^yuan/', ([
          url(r'^test01/', test01),
          url(r'^test02/', test02),

          ],None,None)),

]

擴(kuò)展優(yōu)化

from django.conf.urls import url,include
from django.contrib import admin
from django.shortcuts import HttpResponse
def change_list_view(request):
  return HttpResponse("change_list_view")
def add_view(request):
  return HttpResponse("add_view")
def delete_view(request):
  return HttpResponse("delete_view")
def change_view(request):
  return HttpResponse("change_view")
def get_urls():
  temp=[
    url(r"^$".format(app_name,model_name),change_list_view),
    url(r"^add/$".format(app_name,model_name),add_view),
    url(r"^\d+/del/$".format(app_name,model_name),delete_view),
    url(r"^\d+/change/$".format(app_name,model_name),change_view),
  ]

  return temp
url_list=[]
for model_class,obj in admin.site._registry.items():
  model_name=model_class._meta.model_name
  app_name=model_class._meta.app_label
  # temp=url(r"{0}/{1}/".format(app_name,model_name),(get_urls(),None,None))
  temp=url(r"{0}/{1}/".format(app_name,model_name),include(get_urls()))
  url_list.append(temp)

urlpatterns = [
  url(r'^admin/', admin.site.urls),
  url(r'^yuan/', (url_list,None,None)),
]

仿admin的url路徑分發(fā)

#############models.py###########
from django.db import models
class Book(models.Model):
  title = models.CharField(max_length=32)
  author = models.ForeignKey(to='Author')
class Author(models.Model):
  name = models.CharField(max_length=32)
#################admin.py###########
from app01.models import *
admin.site.register(Book)
admin.site.register(Author)
##############views.py################
from django.shortcuts import HttpResponse
def add(request):
  return HttpResponse('add')
def change(request,id):
  return HttpResponse('change')
def delete(request,id):
  return HttpResponse('delete')
def show(request):
  return HttpResponse('show')
################url.py##############
def get_urls2():
  tmp = []
  tmp.append(url(r'^add/',add))
  tmp.append(url(r'^(\d+)/change/',change))
  tmp.append(url(r'^(\d+)/delete/',delete))
  tmp.append(url(r'^',show))
  return tmp
def get_urls():
  temp = []
  for model, admin_class_obj in admin.site._registry.items():
    model_name = model._meta.model_name
    app_label = model._meta.app_label
    temp.append(url(r'^{}/{}/'.format(app_label,model_name),(get_urls2(),None,None))) #[url(r'^app01/book/',),]
  return temp

urlpatterns = [
  url(r'^admin/', (get_urls(), None, None)),
  url(r'^admin/', admin.site.urls),
]

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: