admin源碼解析及自定義stark組件

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

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

 <4> 執行register方法

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

默認admin配置類：ModelAdmin

 注意：admin.site.registry(xx),註冊時，_registry{}字典保存的鍵是model 中的類名，值是model的管理類的AdminClass類

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)

那麼，在app的stark.py中加上（同理可在每個app的admin.py中測試）

print(site._registry)   ＃ stark.py，執行結果？
print(admin.site._registry)   ＃ admin.py，執行結果？

結果：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time    : 2018/07/23 9:53
# @Author  : MJay_Lee
# @File    : stark.py
# @Contact : limengjiejj@hotmail.com

from app01 import models
from stark.service.stark import site,ModelStark
from django.utils.safestring import mark_safe

class BookConfig(ModelStark):

    list_display = ["title","price","publish"]

site.register(models.Book,BookConfig)

site.register(models.Author)
site.register(models.AuthorDetail)
site.register(models.Publish)

print("my_stark.app01===>\n",site._registry)
# 打印結果
'''
my_stark.app01===>
 {<class 'app01.models.Book'>: <app01.stark.BookConfig object at 0x0000018D0A372748>, <class 'app01.models.Author'>: <stark.service.stark.ModelStark object at 0x0000018D0A372A58>, <class 'app01.models.AuthorDetail'>: <stark.service.stark.ModelStark object at 0x0000018D0A372AC8>, <class 'app01.models.Publish'>: <stark.service.stark.ModelStark object at 0x0000018D0A37D1D0>}
'''

打印結果

到這裏，註冊結束！

 <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()方法的擴展應用

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)),

]

擴展優化

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)),
]

stark組件開發

仿照Django內置的admin組件自定義一個後臺管理組件，實現數據的CRUD

準備工做

首先，咱們須要新建一個Django項目，一個方便組織代碼的APP應用，一個stark APP用於存放自定義組件的核心代碼。

建立成功以後到settings.py文件對app進行註冊

啓動

在stark應用下的apps.py文件添加一下代碼，加載每個app下的全部stark文件

from django.apps import AppConfig
from django.utils.module_loading import autodiscover_modules


class StarkConfig(AppConfig):
    name = 'stark'

    # 在項目啓動的時候加載全部的stark模塊
    def ready(self):
        autodiscover_modules('stark')

註冊

咱們在使用Django內置的admin組件的時候，首先就是要對咱們建立的Model（模型表）進行註冊，至於註冊事後咱們才能夠對錶的數據進行CRUD操做。

首先，建立一個Python Package包，建立一個stark文件

正如本篇開頭所述，咱們在使用admin組件的時候，是在咱們註冊時候調用一個單例對象site進行註冊

class StarkSite(object):
        def __init__(self):
            self._registry = {}

site = StarkSite()

而後在app01的stark文件中導入

from stark.service.stark import site

生成一個單例對象

經過單例對象site調用註冊方法，因此須要在StarkSite類建立一個register方法

# service\stark.py
def register(self, model, admin_class=None, **options):
    # 若是註冊的時候沒有自定義配置類,執行
    if not admin_class:
        admin_class = ModelStark   # 配置類
    # 將配置類對象加到_registry字典中，鍵爲模型類
    self._registry[model] = admin_class(model) # _registry={'model':admin_class(model)}

在對應app中的註冊方法：

# app01\stark.py


from app01 import models
from stark.service.stark import site,ModelStark

# 自定義配置類
class BookConfig(ModelStark):
    pass

site.register(models.Book,BookConfig)
site.register(models.Author)
site.register(models.AuthorDetail)
site.register(models.Publish)

註冊以後，啓動項目就會將咱們註冊的模型類添加到字典_registry中

設計URL

Django項目建起來以後就會自動建立一個url文件，如：其中admin的url就已經配置好了

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

進入源碼看一眼，會發現url方法有property裝飾器，會將函數裝飾成一個屬性

它會在項目的啓動的時候就執行，將內部的url進行分發，生成url的方法就是get_urls()

自定義url

def get_urls(self):
        temp = []
        for model,config_obj in self._registry.items():
            model_name = model._meta.model_name # 拿到模型類的名字
            app_label = model._meta.app_label # 拿到當前類所在app的名字
            # 第一路由
            temp.append(url(r'^%s/%s/'%(app_label, model_name),config_obj.urls))

        return temp

    @property
    def urls(self):
        return self.get_urls(),None,None

這樣就能夠對每個app下面的每個模型類進行url分發，可是還要對每個模型進行數據的增刪改查，因此就須要進行第二級的分發

二級url分發實現:

def get_urls(self):
    temp = []
    model_name = self.model._meta.model_name
    app_label = self.model._meta.app_label

    temp.append(url("^$", self.list_view,name="%s_%s_list"%(app_label,model_name)))
    temp.append(url("^add/$",self.add_view,name="%s_%s_add"%(app_label,model_name)))
    temp.append(url("^(\d+)/change/",self.change_view,name="%s_%s_change"%(app_label,model_name)))
    temp.append(url("^(\d+)/delete/",self.delete_view,name="%s_%s_delete"%(app_label,model_name)))
    return temp

@property
def urls(self):

    return self.get_urls(),None,None