django admin配置以及使用

時間 2019-11-19

原文原文鏈接

django admin配置以及使用

知識預覽javascript

admin組件使用

Django 提供了基於 web 的管理工具（django 2.0+, python3.6+）。html

Django 自動管理工具是 django.contrib 的一部分。你能夠在項目的 settings.py 中的 INSTALLED_APPS 看到它：java

# Application definition
# 新建一個應用名爲mysite,註冊application

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'mysite.apps.mysiteConfig',
]

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

激活管理工具

一般咱們在生成項目時會在 urls.py 中自動設置好，git

from django.contrib import admin
from django.urls import path

urlpatterns = [
    path('admin/', admin.site.urls),
]

當這一切都配置好後，Django 管理工具就能夠運行了。web

使用管理工具

啓動開發服務器，而後在瀏覽器中訪問 http://127.0.0.1:8000/admin/，獲得登錄界面，你能夠經過命令 python manage.py createsuperuser 來建立超級用戶。django

爲了讓 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)
    publish=models.ForeignKey(to="Publish", on_delete=models.CASCADE)
    authors=models.ManyToManyField(to='Author')

    def __str__(self):
        return self.title

models.py

admin的定製

在admin.py中只須要講Mode中的某個類註冊，便可在Admin中實現增刪改查的功能，如：瀏覽器

from mysite.models import Book

admin.site.register(models.Book)

可是，這種方式比較簡單，若是想要進行更多的定製操做，須要利用ModelAdmin進行操做，如：服務器

方式一：
    class BookAdmin(admin.ModelAdmin):
        list_display = ('title', 'price',)
 
    admin.site.register(models.Book, BookAdmin) # 第一個參數能夠是列表
     
 
方式二：
    @admin.register(models.Book)                # 第一個參數能夠是列表
    class BookAdmin(admin.ModelAdmin):
        list_display = ('title', 'price',)

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

1. list_display，列表時，定製顯示的列。

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'price')

2. list_display_links，列表時，定製列能夠點擊跳轉

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'price')
    list_display_links = ('price',)

3. list_filter，列表時，定製右側快速篩選。

4. list_select_related，列表時，連表查詢是否自動select_related

5. list_editable，列表時，能夠編輯的列

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'price',)
    list_editable = ('price',)

6. search_fields，列表時，模糊搜索的功能

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    search_fields = ('title', 'price')

7. date_hierarchy，列表時，對Date和DateTime類型進行搜索

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
 
    date_hierarchy = 'publishDate'

8 inlines，詳細頁面，若是有其餘表和當前表作外鍵，那麼詳細頁面能夠進行動態增長和刪除

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

9 action，列表時，定製action中的操做

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
 
    # 定製Action行爲具體方法
    def show(self, request, queryset):
        print(self, request, queryset)
        print(request.POST.getlist('_selected_action'))
 
    func.short_description = "中文顯示自定義Actions"
    actions = [show, ]
 
    # Action選項都是在頁面上方顯示
    actions_on_top = True
    # Action選項都是在頁面下方顯示
    actions_on_bottom = False
 
    # 是否顯示選擇個數
    actions_selection_counter = True

10 raw_id_fields，詳細頁面，針對FK和M2M字段變成以Input框形式

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
 
    raw_id_fields = ('publish', 'authors',)

11 fields，詳細頁面時，顯示字段的字段

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
 
    fields = ('title', 'price')

12 exclude，詳細頁面時，排除的字段

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
 
    exclude = ('price')

13 readonly_fields，詳細頁面時，只讀字段

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
 
    readonly_fields = ('price')

14 fieldsets，詳細頁面時，使用fieldsets標籤對數據進行分割顯示

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    fieldsets = (
        ('基本數據', {
            'fields': ('title', 'price')
        }),
        ('其餘', {
            'classes': ('collapse', 'wide', 'extrapretty'),  # 'collapse','wide', 'extrapretty'
            'fields': ('title', 'price'),
        }),
    )

15 詳細頁面時，多對多顯示時，數據移動選擇（方向：上下和左右）

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
 
    filter_vertical = ('authors')

16 ordering，列表時，數據排序規則

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
    ordering = ('id',)
    # ordering = ('-id',) # 倒序
    # 或
    # def get_ordering(self, request):
    #    return ['-id', ]

17 radio_fields，詳細頁面時，使用radio顯示選項（外鍵默認使用select）

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
    
    radio_fields = {"publish": admin.VERTICAL}

18 form = ModelForm，用於定製用戶請求時候表單驗證

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

19 empty_value_display = "列數據爲空時，顯示默認值"

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    empty_value_display = "列數據爲空時，默認顯示"
 
    list_display = ('title','price','publish')
 
    def up(self,obj):
        return obj.publish
    up.empty_value_display = "指定列數據爲空時，默認顯示"

from django.contrib import admin

from mysite.models import *


class BookInline(admin.StackedInline): # TabularInline
    extra = 0
    model = Book

class BookAdmin(admin.ModelAdmin):

    list_display = ("title",'publishDate', 'price',"foo","publish")
    list_display_links = ('publishDate',"price")
    list_filter = ('price',)
    list_editable=("title","publish")
    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)

admins

admin源碼解析

單例模式

單例模式（Singleton Pattern）是一種經常使用的軟件設計模式，該模式的主要目的是確保某一個類只有一個實例存在。當你但願在整個系統中，某個類只能出現一個實例時，單例對象就能派上用場。

好比，某個服務器程序的配置信息存放在一個文件中，客戶端經過一個 AppConfig 的類來讀取配置文件的信息。若是在程序運行期間，有不少地方都須要使用配置文件的內容，也就是說，不少地方都須要建立 AppConfig 對象的實例，這就致使系統中存在多個 AppConfig 的實例對象，而這樣會嚴重浪費內存資源，尤爲是在配置文件內容不少的狀況下。事實上，相似 AppConfig 這樣的類，咱們但願在程序運行期間只存在一個實例對象。

在 Python 中，咱們能夠用多種方法來實現單例模式：

使用模塊
使用 __new__
使用裝飾器（decorator）
使用元類（metaclass）

（1）使用 `new`

爲了使類只能出現一個實例，咱們可使用 __new__ 來控制實例的建立過程，代碼以下：

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

class MyClass(Singleton):  
    a = 1
    
one_single = MyClass()
two_single = MyClass()

print(id(one_single), id(two_single))

# 32423121 32423121

在上面的代碼中，咱們將類的實例和一個類變量 _instance 關聯起來，若是 cls._instance 爲 None 則建立實例，不然直接返回 cls._instance。

（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

class AdminSite:
    ...

# This global object represents the default admin site, for the common case.
# You can provide your own AdminSite using the (Simple)AdminConfig.default_site
# attribute. You can also instantiate AdminSite in your own code to create a
# custom admin site.
site = DefaultAdminSite()

這裏應用的是一個單例模式，對於AdminSite類的一個單例模式，執行的每個app中的每個admin.site都是一個對象

<4> 執行register方法

# admin.py

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 = [
    path('admin/', admin.site.urls),
]

class AdminSite(object):
    def get_urls(self):
        from django.urls import include, path, re_path
        # Since this module gets imported in the application's root package,
        # it cannot import models from other applications at the module level,
        # and django.contrib.contenttypes.views imports ContentType.
        from django.contrib.contenttypes import views as contenttype_views

        def wrap(view, cacheable=False):
            def wrapper(*args, **kwargs):
                return self.admin_view(view, cacheable)(*args, **kwargs)
            wrapper.admin_site = self
            return update_wrapper(wrapper, view)

        # Admin-site-wide views.
        urlpatterns = [
            path('', wrap(self.index), name='index'),
            path('login/', self.login, name='login'),
            path('logout/', wrap(self.logout), name='logout'),
            path('password_change/', wrap(self.password_change, cacheable=True), name='password_change'),
            path(
                'password_change/done/',
                wrap(self.password_change_done, cacheable=True),
                name='password_change_done',
            ),
            path('jsi18n/', wrap(self.i18n_javascript, cacheable=True), name='jsi18n'),
            path(
                'r/<int:content_type_id>/<path:object_id>/',
                wrap(contenttype_views.shortcut),
                name='view_on_site',
            ),
        ]

        # 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 += [
                path('%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)

        # If there were ModelAdmins registered, we should have a list of app
        # labels for which we need to allow access to the app_index view,
        if valid_app_labels:
            regex = r'^(?P<app_label>' + '|'.join(valid_app_labels) + ')/$'
            urlpatterns += [
                re_path(regex, wrap(self.app_index), name='app_list'),
            ]
        return urlpatterns

    @property
    def urls(self):
        return self.get_urls(), 'admin', self.name

class AdminSite

<6> url()方法的擴展應用

from django.contrib import admin
from django.urls import path

from django.shortcuts import HttpResponse


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

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


urlpatterns = [
    path('admin/', admin.site.urls),
    path("test/", ([
        path('test1/', test1),
        path('test2/', test2),
                   ], None, None))
]