詳解Django之admin組件的使用與原始碼剖析

不言
發布: 2018-05-04 14:26:59
原創
1714 人瀏覽過

這篇文章主要介紹了關於詳解Django之admin組件的使用和源碼剖析,有著一定的參考價值,現在分享給大家,有需要的朋友可以參考一下

admin組件使用

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

Django 自動管理工具是 django.contrib 的一部分。你可以在專案的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基本程式碼的組成部分。

啟動管理工具

通常我們在產生專案時會在urls.py 中自動設定好,

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

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

]
登入後複製

當這一切都配置好後,Django 管理工具就可以運作了。

使用管理工具

啟動開發伺服器,然後在瀏覽器中存取http://127.0.0.1:8000/admin/,得到登陸介面,你可以透過指令python manage.py createsuperuser 來建立超級使用者。

為了讓admin 介面管理某個資料模型,我們需要先註冊該資料模型到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中的某個類別註冊,即可在Admin中實現增刪改查的功能,如:

admin.site.register(models.UserInfo)
登入後複製

但是,這種方式比較簡單,如果想要進行更多的自訂操作,需要利用ModelAdmin進行操作,如:

方式一:

#
class UserAdmin(admin.ModelAdmin):
   list_display = ('user', 'pwd',)
 
admin.site.register(models.UserInfo, UserAdmin) # 第一个参数可以是列表
登入後複製

方式二:

#
@admin.register(models.UserInfo)        # 第一个参数可以是列表
class UserAdmin(admin.ModelAdmin):
  list_display = ('user', 'pwd',)
登入後複製

ModelAdmin中提供了大量的可自訂功能,如

1. list_display,列表時,自訂顯示的列。

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

2. list_display_links,清單時,自訂列可以點選跳轉。

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

3. list_filter,清單時,自訂右側快速篩選。

4. list_select_related,清單時,連表查詢是否自動select_related

5. list_editable,清單時,可以編輯的列

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

6. search_fields,列表時,模糊搜尋的功能

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  search_fields = ('user', 'pwd')
登入後複製

7. date_hierarchy,列表時,對Date和DateTime類型進行搜尋

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  date_hierarchy = 'ctime'
登入後複製

8  inlines,詳細頁面,如果有其他表格和目前表格做FK,那麼詳細頁面可以進行動態增加和刪除

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

9 action,清單時,客製化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选项都是在页面上方显示
  actions_on_top = True
  # Action选项都是在页面下方显示
  actions_on_bottom = False
 
  # 是否显示选择个数
  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,詳細頁面,針對FK和M2M欄位變成以Input框形式

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

12  fields,詳細頁面時,顯示欄位的欄位

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  fields = ('user',)
登入後複製

13 exclude,當詳細頁面時,排除的欄位

#
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  exclude = ('user',)
登入後複製

14  readonly_fields,詳細頁面時,唯讀欄位

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  readonly_fields = ('user',)
登入後複製

15 fieldsets,當詳細頁面時,使用fieldsets標籤對資料分割顯示

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  fieldsets = (
    ('基本数据', {
      'fields': ('user', 'pwd', 'ctime',)
    }),
    ('其他', {
      'classes': ('collapse', 'wide', 'extrapretty'), # 'collapse','wide', 'extrapretty'
      'fields': ('user', 'pwd'),
    }),
  )
登入後複製

16 詳細頁面時,M2M顯示時,資料移動選擇(方向:上下和左右)

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

17 ordering,列表時,資料排序規則

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

18. radio_fields,詳細頁面時,使用radio顯示選項(FK預設使用select)

radio_fields = {"ug": admin.VERTICAL} # 或admin.HORIZONTAL
登入後複製

#19 form = ModelForm,用於自訂使用者請求時候表單驗證

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 = "列資料為空時,顯示預設值"

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
  empty_value_display = "列数据为空时,默认显示"
 
  list_display = ('user','pwd','up')
 
  def up(self,obj):
    return obj.user
  up.empty_value_display = "指定列数据为空时,默认显示"
登入後複製

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选项都是在页面上方显示
  actions_on_top = True
  # Action选项都是在页面下方显示
  actions_on_bottom = False

  # 是否显示选择个数
  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) # 第一个参数可以是列表
admin.site.register(Publish,PublishAdmin)
admin.site.register(Author)
登入後複製

admin原始碼解析

單例模式

單例模式(Singleton Pattern)是常用的軟體設計模式,此模式的主要目的是確保某一個類別只有一個實例存在。當你希望在整個系統中,某個類別只能出現一個實例時,單例物件就能派上用場。

例如,某個伺服器程式的設定資訊存放在一個檔案中,客戶端透過一個 AppConfig 的類別來讀取設定檔的資訊。如果在程式運行期間,有很多地方都需要使用設定檔的內容,也就是說,很多地方都需要創建AppConfig 對象的實例,這就導致系統中存在多個AppConfig 的實例對象,而這樣會嚴重浪費內存資源,尤其是在個人資料內容很多的情況下。事實上,類似 AppConfig 這樣的類,我們希望在程式運行期間只存在一個實例物件。

在Python 中,我們可以用多種方法來實作單例模式:

  1. #使用模組

  2. ##使用  __new__

  3. 使用裝飾器(decorator)

  4. #使用元類別(metaclass)

(1 )使用__new__

#

为了使类只能出现一个实例,我们可以使用 __new__ 来控制实例的创建过程,代码如下:

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
登入後複製

在上面的代码中,我们将类的实例和一个类变量 _instance 关联起来,如果 cls._instance 为 None 则创建实例,否则直接返回 cls._instance 。

执行情况如下:

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

(2)使用模块

其实, Python 的模块就是天然的单例模式 ,因为模块在第一次导入时,会生成 .pyc 文件,当第二次导入时,就会直接加载 .pyc 文件,而不会再次执行模块代码。因此,我们只需把相关的函数和数据定义在一个模块中,就可以获得一个单例对象了。如果我们真的想要一个单例类,可以考虑这样做:

# 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执行流程

<1> 循环加载执行所有已经注册的app中的admin.py文件

def autodiscover():
  autodiscover_modules(&#39;admin&#39;, register_to=site)
登入後複製

<2> 执行代码

#admin.py
class BookAdmin(admin.ModelAdmin):
  list_display = ("title",&#39;publishDate&#39;, &#39;price&#39;)

admin.site.register(Book, BookAdmin) 
admin.site.register(Publish)
登入後複製

<3> admin.site

这里应用的是一个单例模式,对于AdminSite类的一个单例模式,执行的每一个app中的每一个admin.site都是一个对象

<4> 执行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)
登入後複製

到这里,注册结束!

<5> admin的URL配置

urlpatterns = [
  url(r&#39;^admin/&#39;, admin.site.urls),
]
登入後複製

class AdminSite(object):  
   def get_urls(self):
    from django.conf.urls import url, include   
    urlpatterns = []
    # Add in each model&#39;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&#39;^%s/%s/&#39; % (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(), &#39;admin&#39;, self.name
登入後複製

<6> url()方法的扩展应用

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

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

urlpatterns = [
  url(r&#39;^admin/&#39;, admin.site.urls),
  url(r&#39;^yuan/&#39;, ([
          url(r&#39;^test01/&#39;, test01),
          url(r&#39;^test02/&#39;, test02),

          ],None,None)),

]
登入後複製

扩展优化

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&#39;^admin/&#39;, admin.site.urls),
  url(r&#39;^yuan/&#39;, (url_list,None,None)),
]
登入後複製

仿admin的url路径分发

#############models.py###########
from django.db import models
class Book(models.Model):
  title = models.CharField(max_length=32)
  author = models.ForeignKey(to=&#39;Author&#39;)
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(&#39;add&#39;)
def change(request,id):
  return HttpResponse(&#39;change&#39;)
def delete(request,id):
  return HttpResponse(&#39;delete&#39;)
def show(request):
  return HttpResponse(&#39;show&#39;)
################url.py##############
def get_urls2():
  tmp = []
  tmp.append(url(r&#39;^add/&#39;,add))
  tmp.append(url(r&#39;^(\d+)/change/&#39;,change))
  tmp.append(url(r&#39;^(\d+)/delete/&#39;,delete))
  tmp.append(url(r&#39;^&#39;,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&#39;^{}/{}/&#39;.format(app_label,model_name),(get_urls2(),None,None))) #[url(r&#39;^app01/book/&#39;,),]
  return temp

urlpatterns = [
  url(r&#39;^admin/&#39;, (get_urls(), None, None)),
  url(r&#39;^admin/&#39;, admin.site.urls),
]
登入後複製

以上是詳解Django之admin組件的使用與原始碼剖析的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
作者最新文章
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板