Django Stark组件开发详解：从配置到路由分发原理

听雨眠

发布时间：2026-10-13| 3人浏览过

原创

本文深入解析Django Stark组件的开发流程与核心原理。内容涵盖从创建独立stark应用、配置settings.py注册，到利用单例模式实现模型注册的全过程。重点剖析StarkSite类如何通过get_urls方法动态生成路由，并结合ModelStark定制增删改查逻辑，帮助开发者理解如何构建类似Admin的高效后台管理组件。

Stark组件概述

Stark组件是一套基于Django Admin模块理念开发的辅助工具，主要功能是在Web界面中实现对已注册数据表的增、删、改、查操作。

环境配置与初始化

一、环境配置

1. 构建Stark应用，并在settings.py中进行注册

Stark应用专门用于存放自定义组件的核心逻辑代码。


manage.py@stark_demo > startapp stark

需在settings.py文件中注册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. 项目启动时加载各App下的stark文件

在stark项目的apps.py文件中添加以下代码。ready函数的作用是在Django启动时自动扫描每个App目录下的stark.py文件并执行。


from django.apps import AppConfig
from django.utils.module_loading import autodiscover_modules 
class StarkConfig(AppConfig):
  name = 'stark'   
  # 程序启动时，扫描app下得指定文件（stark.py）并执行
  def ready(self):
    autodiscover_modules('stark')

3. 在app01/models.py中定义数据模型


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

执行数据迁移命令并创建超级用户：


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. 程序运行后的界面效果展示

Stark组件核心开发

二、Stark组件核心开发

1. 创建Python包，并在其中建立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:
      # 如果注册的时候没有自定义配置类,执行
      stark_class = ModelStark  # 配置类
 
    # 将配置类对象加到_registry字典中，键为模型类
    self._registry[model] = stark_class(model, self)  # _registry={'model':stark_class(model)}
site = StarkSite()

（1）在使用Admin组件时，注册过程会调用一个单例对象site。Stark组件同样生成了一个site单例对象，并在app01的stark文件中导入该对象：


from stark.service.stark import site

通过Python模块机制实现了单例模式。

（2）由于通过单例对象site调用注册方法，因此需要在StarkSite类中定义register方法。

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)

注册完成后，启动项目会将所有注册的模型类添加至_registry字典中。

URL路由设计与分发

三、URL路由设计

1. 编写urls.py并分析Admin的URL源码

Django项目创建后会自动生成urls文件，例如其中已配置好Admin的URL路径。


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的源码，发现urls方法带有property装饰器：


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

urls方法被property装饰器修饰，使其在启动时执行并返回属性值，内部通过get_urls()方法生成URL路由。

该方法返回三个值的元组 ([], 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):
    """注册"""
    if not stark_class:
      # 如果注册的时候没有自定义配置类,执行
      stark_class = ModelStark  # 配置类
 
    # 将配置类对象加到_registry字典中，键为模型类
    self._registry[model] = stark_class(model, self)  # _registry={'model':admin_class(model)}
 
  def get_urls(self):
    """构造一层url"""
    temp = []
    for model, stark_class_obj in self._registry.items():
      # model:一个模型表
      # stark_class_obj:当前模型表相应的配置类对象
 
      model_name = model._meta.model_name
      app_label = model._meta.app_label
 
      # 分发增删改查
      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()  # 单例对象

注意事项：

（1）StarkSite是单例类，site是单例对象，其内部变量对所有实例共享，无法单独定制信息。因此，增删改查逻辑及get_urls_2等函数不应直接放在StarkSite类中。

（2）支持用户自定义配置页面，因此需调用配置类 stark_class_obj.urls_2。


# 分发增删改查
temp.append(url(r"^%s/%s/" % (app_label, model_name), stark_class_obj.urls_2))

（3）通过self._registry获取所有注册对象，遍历时需注意提取model和对应的stark_class_obj。


def get_urls(self):
  """构造一层url"""
  temp = []
  for model, stark_class_obj in self._registry.items(): 
    # model:一个模型表
    # stark_class_obj:当前模型表相应的配置类对象
    ...

（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表示用户当前访问的具体模型表！

四、Stark路由分发流程