Django-admin管理工具: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
# Create your models here.
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 = "指定列數據為空時,默認顯示"
admin源碼解析
單例模式
單例模式(Singleton Pattern)是一種常用的軟體設計模式,該模式的主要目的是確保某一個類只有一個實例存在。當你希望在整個系統中,某個類只能出現一個實例時,單例對象就能派上用場。
比如,某個伺服器程序的配置信息存放在一個文件中,客戶端通過一個 AppConfig 的類來讀取配置文件的信息。如果在程序運行期間,有很多地方都需要使用配置文件的內容,也就是說,很多地方都需要創建 AppConfig 對象的實例,這就導致系統中存在多個 AppConfig 的實例對象,而這樣會嚴重浪費內存資源,尤其是在配置文件內容很多的情況下。事實上,類似 AppConfig 這樣的類,我們希望在程序運行期間只存在一個實例對象。
在 Python 中,我們可以用多種方法來實現單例模式:
- 使用模塊
- 使用 __new__
- 使用裝飾器(decorator)
- 使用元類(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(admin, register_to=site)
<2> 執行代碼
#admin.py
class BookAdmin(admin.ModelAdmin):
list_display = ("title",publishDate, price)
admin.site.register(Book, BookAdmin)
admin.site.register(Publish)
<3> admin.site