Django stark組件使用及原理詳解

更新時(shí)間：2019年08月22日 10:39:32 作者：Clara51

這篇文章主要介紹了Django stark組件使用及原理詳解,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下

stark組件是仿照django的admin模塊開(kāi)發(fā)的一套組件，它的作用是在網(wǎng)頁(yè)上對(duì)注冊(cè)的數(shù)據(jù)表進(jìn)行增刪改查操作

一、配置

1、創(chuàng)建stark應(yīng)用，在settings.py中注冊(cè)stark應(yīng)用

stark APP專門用于存放自定義組件的核心代碼。

manage.py@stark_demo > startapp stark

在settings.py文件注冊(cè)stark:

INSTALLED_APPS = [
  'django.contrib.admin',
  'django.contrib.auth',
  'django.contrib.contenttypes',
  'django.contrib.sessions',
  'django.contrib.messages',
  'django.contrib.staticfiles',
  'app01.apps.App01Config',
  'stark.apps.StarkConfig',
]

2、項(xiàng)目啟動(dòng)加載每一個(gè)app下的所有stark文件

在stark項(xiàng)目的apps.py文件加上下面的代碼，ready函數(shù)的作用是讓Django在啟動(dòng)時(shí)自動(dòng)掃描每一個(gè)app下面的stark.py文件

from django.apps import AppConfig
from django.utils.module_loading import autodiscover_modules 
class StarkConfig(AppConfig):
  name = 'stark'   
  # 程序啟動(dòng)時(shí)，掃描app下得指定文件（stark.py）并執(zhí)行
  def ready(self):
    autodiscover_modules('stark')

3、app01/models.py中創(chuàng)建模型

class UserInfo(models.Model):
  name=models.CharField(max_length=32)
  age=models.IntegerField() 
  def __str__(self):
    return self.name 
class Book(models.Model):
  title=models.CharField(max_length=32) 
  def __str__(self):
    return self.title

執(zhí)行數(shù)據(jù)遷移和創(chuàng)建超級(jí)用戶操作：

makemigrations
migrate 
createsuperuser （yuan yuan1234）

4、admin.py配置

from django.contrib import admin
# Register your models here.
from .models import *
class UserAdmin(admin.ModelAdmin):
  list_display = ["pk",'name','age']
  list_filter = ['name','age'] 
  # 定制action具體方法
  def func(self,request,queryset):
    queryset.update(age=44)
   func.short_description = "批量初始化操作"
  actions = [func] 
admin.site.register(UserInfo, UserAdmin)
admin.site.register(Book)

5、程序運(yùn)行顯示效果　

二、stark組件開(kāi)發(fā)

1、首先創(chuàng)建一個(gè)Python包，創(chuàng)建一個(gè)stark.py文件

2、stark/service/stark.py（單例）

class ModelStark(object):
  list_display=[] 
  def __init__(self,model,site):
    self.model=model
    self.site=site 
class StarkSite(object):
  def __init__(self):
    self._registry = {} 
  def register(self, model, stark_class=None, **options):
    if not stark_class:
      # 如果注冊(cè)的時(shí)候沒(méi)有自定義配置類,執(zhí)行
      stark_class = ModelStark  # 配置類
 
    # 將配置類對(duì)象加到_registry字典中，鍵為模型類
    self._registry[model] = stark_class(model, self)  # _registry={'model':stark_class(model)}
site = StarkSite()

（1）在使用admin組件的時(shí)候，是在我們注冊(cè)時(shí)候調(diào)用一個(gè)單例對(duì)象site進(jìn)行注冊(cè)。stark中同樣生成了一個(gè)site單例對(duì)象。然后在app01的stark文件導(dǎo)入：

from stark.service.stark import site

這樣就通過(guò)使用python模塊的方式實(shí)現(xiàn)了單例模式。

（2）通過(guò)單例對(duì)象site調(diào)用注冊(cè)方法，所以需要在StarkSite類創(chuàng)建一個(gè)register方法?！　?/p>

3、app01/stark.py

from app01 import models
from stark.service.stark import site, ModelStark
# 自定義配置類
class UserConfig(ModelStark):
  pass 
site.register(models.UserInfo, UserConfig)
site.register(models.Book) 
print("_registry", site._registry)

注冊(cè)之后，啟動(dòng)項(xiàng)目就會(huì)將我們注冊(cè)的模型類添加到字典_registry中.

三、設(shè)計(jì)url

1、編寫urls.py并查看admin的url源碼

Django項(xiàng)目建起來(lái)之后就會(huì)自動(dòng)創(chuàng)建一個(gè)url文件，如：其中admin的url就已經(jīng)配置好了

from django.contrib import admin
from django.urls import path
from django.conf.urls import url
from stark.service.stark import site
urlpatterns = [
  path('admin/', admin.site.urls),
  # path('stark/', site.urls),
  url(r'^stark/', site.urls),
]

查看admin.site.urls源碼，發(fā)現(xiàn)urls方法有property裝飾器：

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

urls方法有property裝飾器，會(huì)將函數(shù)裝飾成一個(gè)屬性，它會(huì)在項(xiàng)目的啟動(dòng)的時(shí)候就執(zhí)行，將內(nèi)部的url進(jìn)行分發(fā)，生成url的方法就是get_urls()。

return三個(gè)值以元組的形式返回 ([], None, None )。

2、自定義url（stark/service/stark.py）

from django.conf.urls import url
from django.shortcuts import HttpResponse,render 
class ModelStark(object):
  """定制配置類"""
  list_display = []
 
  def __init__(self, model, site):
    self.model = model
    self.site = site
 
  def add(self, request):
    return HttpResponse("add")
 
  def delete(self, request, id):
    return HttpResponse("delete")
 
  def change(self, request, id):
    return HttpResponse("change")
 
  def list_view(self, request):
    return HttpResponse("list_view")
 
  def get_urls_2(self):
    temp = []
    temp.append(url(r"^add/", self.add))
    temp.append(url(r"^(\d+)/delete/", self.delete))
    temp.append(url(r"^(\d+)/change/", self.change))
    temp.append(url(r"^$", self.list_view))
    return temp
 
  @property
  def urls_2(self):
    return self.get_urls_2(), None, None # [], None, None
 
class StarkSite(object):
  """site單例類"""
  def __init__(self):
    self._registry = {}
 
  def register(self, model, stark_class=None, **options):
    """注冊(cè)"""
    if not stark_class:
      # 如果注冊(cè)的時(shí)候沒(méi)有自定義配置類,執(zhí)行
      stark_class = ModelStark  # 配置類
 
    # 將配置類對(duì)象加到_registry字典中，鍵為模型類
    self._registry[model] = stark_class(model, self)  # _registry={'model':admin_class(model)}
 
  def get_urls(self):
    """構(gòu)造一層url"""
    temp = []
    for model, stark_class_obj in self._registry.items():
      # model:一個(gè)模型表
      # stark_class_obj:當(dāng)前模型表相應(yīng)的配置類對(duì)象
 
      model_name = model._meta.model_name
      app_label = model._meta.app_label
 
      # 分發(fā)增刪改查
      temp.append(url(r"^%s/%s/" % (app_label, model_name), stark_class_obj.urls_2))
      """
        path('app01/userinfo/',UserConfig(Userinfo,site).urls2),
        path('app01/book/',ModelStark(Book,site).urls2),
      """
    return temp
 
  @property
  def urls(self):
    return self.get_urls(), None, None
 
site = StarkSite()  # 單例對(duì)象

注意：

（1）StarkSite是單例類，site是單例對(duì)象，放在里面的變量都是相同的，無(wú)法定制任何信息。因此不能把增刪改查和get_urls_2等函數(shù)都放在StarkSite類中。

（2）用戶可以自定制配置頁(yè)面，所以調(diào)用配置類 stark_class_obj.urls_2

# 分發(fā)增刪改查
temp.append(url(r"^%s/%s/" % (app_label, model_name), stark_class_obj.urls_2))

（3）self._registry拿到所有的注冊(cè)對(duì)象，注意遍歷拿到的model和stark_class_obj

def get_urls(self):
  """構(gòu)造一層url"""
  temp = []
  for model, stark_class_obj in self._registry.items(): 
    # model:一個(gè)模型表
    # stark_class_obj:當(dāng)前模型表相應(yīng)的配置類對(duì)象
    ...

（4）不同的model表，顯示不同的url

（5）在ModelStark中self.model是什么?

def list_view(self, request):
  print("self.model:", self.model)  # self.model: <class 'app01.models.UserInfo'>
  return render(request, "list_view.html", locals())

self.model是用戶當(dāng)前訪問(wèn)的模型表??！

四、stark路由分發(fā)流程