django-admin源码解析,以及组件使用

 

本文转载自cnblog.com/yuanchenqi博客

 

我们之所以要在这里取了解admin里面的源码以及各种功能的实现机制,是因为我们后期会需要自己去写一些组件,就是类似于我们的admin里面的各种功能,所以我们首先需要了解我们的admin里面都有哪些功能,先知道需求是什么,然后再去根据需求去倒推,倒推这些都是怎么实现的,使用了哪些知识点,整个的流程以及思路是什么,针对每个功能都去按照这个流程倒推,然后我们就可以慢慢理清思路,有大概的方向,从哪里开始着手,由浅入深,逐步全面化,细节化,这是一整套的流程跟逻辑,里面的很多的功能都是我们之前做练习的时候遇到的,都解决过的,只不过我们在了解需求的时候,把这些东西都捡起来然后整合到一起而已,还有一点就是我们的admin里面的源码,我们要洞悉里面的逻辑流程,从而更加深刻地理解每个功能的实现机制,为后期我们自己写组件打好基础

 

笔记整理:

仿照admin组件开发独立组件

admin:组件应用：后台数据表进行增删改查


     为每一个app下的每一个model表进行增删改查
     
     
    class UserInfoConfig(admin.ModelAdmin):
    
        list_display = ["id", "name", "email"]
        list_display_links = ('name',"email")
        ordering=["id",]
        search_fields=["name",]    # userinfo.objects.filter(name__contains=keyword)



    action="foo"
    selected_id=[1,2,3]
    
    queryset=UserInfo.objects.filter(pk__in=selected_id)
    foo(request,queryset)
    





admin实现流程：
     
     
    一 注册 
    
     1 当django项目启动时，admin应用首先扫描（加载）每一个app下面的admin.py文件
     
     2 (1)from django.contrib import admin 
     
          加载admin -->sites---->site = AdminSite()    （单例对象）
       
       (2)
            admin.site.register(Book)
          
          
            class AdminSite(): 
            
                def __init__(self, name='admin'):
                    self._registry = {} 
            
                def register(self, model, admin_class=None,):
                    if not admin_class:
                        admin_class = ModelAdmin
                        
                    
                     self._registry[model] = admin_class(model, self)
                     
                     
            self._registry:   {Book:ModelAdmin(Book),}
                {

                <class 'django.contrib.auth.models.Group'>: <django.contrib.auth.admin.GroupAdmin object at 0x0000000003E56AC8>, 
                <class 'django.contrib.auth.models.User'>: <django.contrib.auth.admin.UserAdmin object at 0x0000000003E88828>, 
                <class 'app01.models.Book'>: <django.contrib.admin.options.ModelAdmin object at 0x0000000003E88898>, 
                <class 'rbac.models.UserInfo'>: <rbac.admin.UserInfoConfig object at 0x0000000003E9E550>, 
                <class 'rbac.models.Role'>: <rbac.admin.RoleConfig object at 0x0000000003E9E588>, 
                <class 'rbac.models.PermissionGroup'>: <rbac.admin.PermissionGroupConfig object at 0x0000000003E9E630>,
                <class 'rbac.models.Menu'>: <rbac.admin.Menuconfig object at 0x0000000003E9E6D8>,  <class 'rbac.models.Permission'>: <rbac.admin.PermissionConfig object at 0x0000000003E9E780>
                }
                    
     
    二 url配置
        
        为每个app下的model创建对应的增删改查的url
         



知识点：
    1 同一个模块重复调用时，文件只加载一次。

    2 基于模块的单例模式
    
    
       


     
    3 url(r'^admin/', admin.site.urls),    

 

我们先来了解一下这个admin,它是django自带的组件,我们只要创建一个项目,就会在里面自动带上这个admin组件,我们在项目的setting文件里面可以看到它,在apps里面:

在url里面:

 

我们的admin组件,它的每一个页面都是有规律的,都是一套模板,格式和主体样式基本一致,对于数据的增删改查操作是不同的页面,也就意味着配有不同的url,我们的models里面有n个表格,那么就会有n*4个url,这都是固定的,我们先来看各个页面的所实现的功能,后期会有对于url的具体剖析

我们先从基本的简单的功能开始入手,

我们在app里面的admin文件里面把我们的所有models里面的表格给注册上,在这个admin里面注册表格的时候,有很多的可扩展功能,下面来看一下:

from django.contrib import admin

# Register your models here.
print("rbac.............")

from .models import *


class UserInfoConfig(admin.ModelAdmin):
    list_display = ["id", "name", "email"]
    # list_display_links = ('name',"email")  # 在浏览器页面上所显示的字段名
    # ordering=["id",]  # 把表格里面的字段id按照顺序排序,
    # search_fields=["name","email"]  # 在页面上加一个查询框,按照name和email字段查询,两者皆可
    # list_filter=["roles"]  # 按照roles字段进行过滤,过滤的菜单栏显示在页面上
    # list_editable=['name']  # 在浏览器上面把这个字段显示的时候是停留在当前的显示页面就可以编辑该字段
    # fields=["name"]  # 在新增数据页面只显示一个name字段
    # exclude=["name"]  # 在新增数据页面显示除了name以外的所有字段
    # readonly_fields=["name"]  # 这个字段以只读形式显示

    # fieldsets = (
    #     ('AAAA', {
    #         'fields': ('name', 'email')
    #     }),
    #
    #     ('其他', {
    #         'classes': ('collapse', 'wide', 'extrapretty'),  # 'collapse','wide', 'extrapretty'
    #         'fields': ('roles',),
    #     }),
    # )

    def foo(self, request, queryset):  # 我们在这里定义一个函数,是为了在action里面把我们自定义的东西加上去,这个action就是我们在批量操作数据的时候,有一个下拉框,下拉框里面默认只有一个删除操作,我们可以自定义其他的操作,就是在这里使用这个自定义函数的方法,按照这个格式去写即可,
        print(queryset)  # 我们这个queryset是一个键值对,是queryset集合的键值对,如下是打印效果:<QuerySet [<UserInfo: egon>, <UserInfo: banana>]>,userinfo是表名,后面是我们使用models建表的时候定义的一个def__str__(self)方法,它反射的是name字段,所以它显示的是name值,我们在这个函数里面是queryset进行处理的,所以逻辑要符合queryset的用法,否则会报错的,
        queryset.update(email="yuan@qq.com")  # 这里的update是queryset的用法,email是该表格的字段,所以我们在这里就是把批量操作设定为了所有选中的项都要把email字段更新为我们这里所设定的"yuan@qq.com",

    foo.short_description = "中文显示自定义Actions"  # 这里就是字面意思,把这个函数的具体操作做一个简述,让用户知道如果点击它会发生什么,
    actions = [foo,]  # 这里是把我们自定义的函数名放到这个列表里面,列表的名字是固定的,admin内置的
admin.site.register(UserInfo,UserInfoConfig)  # 最后我们把自己定义的这个类名放到register里面用这种固定格式,



class RoleConfig(admin.ModelAdmin):
    list_display = ["id","title"]
admin.site.register(Role,RoleConfig)



class PermissionGroupConfig(admin.ModelAdmin):
    list_display = ["caption","menu"]
admin.site.register(PermissionGroup,PermissionGroupConfig)


class Menuconfig(admin.ModelAdmin):
    list_display = ["id","caption"]
admin.site.register(Menu,Menuconfig)



class PermissionConfig(admin.ModelAdmin):
    list_display = ["id","title","url","permission_group","code","parent"]
    ordering = ["id"]
admin.site.register(Permission,PermissionConfig)




print(admin.site._registry)

 

还有一个点是,我们不能在admin里面既把一个字段设定为a标签,同时又把它设为input输入框,此时系统无法识别操作,就会抛错:

class UserInfoConfig(admin.ModelAdmin):
    list_display = ['id', 'name', 'email']
    # list_display_links = ('email',)
    # The value of 'list_display_links' must be a list, a tuple or None
    #  也就是说我们这里可以是元祖或者是列表,如果是元祖的话,必须要有,逗号,
    ordering = ('-id',)  # 这里是倒序
    list_editable = ('email',)
    """
    <class 'rbac.admin.UserInfoConfig'>: (admin.E123) 
    The value of 'email' cannot be in both 'list_editable' and 'list_display_links'.
    我们不能把一个字段同时设为超链接的a标签,同时又把它设为可修改的input框,它不能既是input输入框同时又是a标签,
    这本身也不符合逻辑,所以我们的系统无法识别,就会抛错
    """
admin.site.register(UserInfo, UserInfoConfig)

 

下面是我们的admin文件里面类下面的其中一个自定义方法,

    # 这个功能主要实现的是我们的数据增删改查里面的增加功能,我们的表格里面如果数据过多,不想一次显示过多的字段输入框,
    # 我们可以使用下面的自定义方法,把一部分字段的输入框给折叠起来,
    fieldsets = (
        ('fred', {  # 这里是在上面显示的单独的输入框
                'fields': ('roles', 'email')
            }),
        ('something_else', {  # 这里是折叠的输入框
            'classes': ('collapse', 'wide', 'extrapretty',),  # 这里是我们内置的参数,是固定的,不可改动,它是源码里面需要的参数,不可动
            'fields': ('name',),
        }),
    )

 

单例模式:

我所理解的就是我们的单例模式下的类实例化出来的对象都是指向同一个内存地址,同一个值,我们的这个类实例化出来的两个对象,他们指向同一个内存空间,他们的值也一样,这就是单例模式

 

举例说明:

# class Bird(object):
#     def __init__(self,name,age):
#         self.name=name
#         self.age=age
#
# a=Bird("小鸟",2)
# b=Bird("企鹅",23)
# c=Bird("鸵鸟",2)

# class Config(object):
#     def __init__(self):
#         pass
#
# c1=Config()
# c2=Config()

# 基于__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


c1=MyClass()
c2=MyClass()

c1.a=11
print(c2.a)

 

单例模式(Single 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()
# tow = MyClass()
# print(one == tow)  # True
# print(one is tow)  # True
# one.a = 11
# print(tow.a)  # 11
# print(id(one), id(tow))  # 42703784 42703784

 

(2)使用模块

其实,python的模块就是天然的单例模式,因为模块在第一次导入时,会生成.pyc文件,当第二次导入时,就会直接加载.pyc文件,而不会再次执行模块代码,因此,我们只需要把相关的函数和数据定义在一个模块中,就可以获得一个单例对象了,如果我们真的想要一个单例类可以考虑这样做:

# mysingleton.py
class My_singleton(object):
    def foo(self):
        pass

just=My_singleton()

我们把上面的代码保存在文件mysingleton中,像这样用:
from mysingleton import My_singleton,just  
# 我们可以引用文件的时候把文件名写在import前面然后把该文件里面的变量名都写入到import后面,前提是我们要用到它,否则没有必要浪费内存
just.foo()

 

 

 

admin执行流程,源码时间:

<1>循环加载执行所有已经注册的App中的admin.py文件:

我们在admin.py文件里面有一句话在最上面,系统自动加载的

from django.contrib import admin 

我们把admin点进去,就会进入一个init文件,在这个init文件里面有一个函数:

def autodiscover():
    autodiscover_modules('admin',register_to=site)

它里面有一个autodiscover_modules,可以点进去,有一个函数,专门实现了循环加载的功能:

def autodiscover_modules(*args, **kwargs):
    """
    Auto-discover INSTALLED_APPS modules and fail silently when
    not present. This forces an import on them to register any admin bits they
    may want.

    You may provide a register_to keyword parameter as a way to access a
    registry. This register_to object must have a _registry instance variable
    to access it.
    """
    from django.apps import apps

    register_to = kwargs.get('register_to')
    for app_config in apps.get_app_configs():
        for module_to_search in args:
            # Attempt to import the app's module.
            try:
                if register_to:
                    before_import_registry = copy.copy(register_to._registry)

                import_module('%s.%s' % (app_config.name, module_to_search))
            except Exception:
                # Reset the registry to the state before the last import
                # as this import will have to reoccur on the next request and
                # this could raise NotRegistered and AlreadyRegistered
                # exceptions (see #8245).
                if register_to:
                    register_to._registry = before_import_registry

                # Decide whether to bubble up this error. If the app just
                # doesn't have the module in question, we can ignore the error
                # attempting to import it, otherwise we want it to bubble up.
                if module_has_submodule(app_config.module, module_to_search):
                    raise

 

<2>执行代码

# admin.py

# admin.py
class PermissionGroupConfig(admin.ModelAdmin):
    list_display = ['caption', 'menu']  # 我们这里的 list_display里面
admin.site.register(PermissionGroup, PermissionGroupConfig)

 

<3>admin.site

 

 

 

 

这里应用的是一个单例模式,对于AdminSite类的一个单例模式,执行的每一个App中的每一个admin.site都是一个对象

 

<4>执行register方法

admin.site.register(Book,BookAdmin)

admin.site.register(Pulish)

class ModelAdmin(BaseModelAdmin): pass

class AdminSite(object):
    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
        sefl._registry[model]=admin_class(model,self)

在每一个App的admin.py中加上一句话

print(admin.site._registry) 

打印结果如下所示:

{<class 'django.contrib.auth.models.Group'>: <django.contrib.auth.admin.GroupAdmin object at 0x0000000004533B00>,
 <class 'django.contrib.auth.models.User'>: <django.contrib.auth.admin.UserAdmin object at 0x0000000004560DD8>, 
 <class 'rbac.models.UserInfo'>: <rbac.admin.UserInfoConfig object at 0x0000000004574710>,
 <class 'rbac.models.Role'>: <django.contrib.admin.options.ModelAdmin object at 0x0000000004574748>,
 <class 'rbac.models.Menu'>: <django.contrib.admin.options.ModelAdmin object at 0x0000000004574780>,
 <class 'rbac.models.PermissionGroup'>: <rbac.admin.PermissionGroupConfig object at 0x00000000045747F0>, 
 <class 'rbac.models.Permission'>: <rbac.admin.PermissionConfig object at 0x0000000004574898>}
{<class 'django.contrib.auth.models.Group'>: <django.contrib.auth.admin.GroupAdmin object at 0x0000000004633B38>,
 <class 'django.contrib.auth.models.User'>: <django.contrib.auth.admin.UserAdmin object at 0x0000000004660E10>, 
 <class 'rbac.models.UserInfo'>: <rbac.admin.UserInfoConfig object at 0x0000000004674748>,
 <class 'rbac.models.Role'>: <django.contrib.admin.options.ModelAdmin object at 0x0000000004674780>, 
 <class 'rbac.models.Menu'>: <django.contrib.admin.options.ModelAdmin object at 0x00000000046747B8>, 
 <class 'rbac.models.PermissionGroup'>: <rbac.admin.PermissionGroupConfig object at 0x0000000004674828>, 
 <class 'rbac.models.Permission'>: <rbac.admin.PermissionConfig object at 0x00000000046748D0>}

是我们所有的在models里面注册的表格,其中Group表格和User表格是我们的django自带的表格,由于我们的程序是debug模式,所以它会打印两遍,如果不是error模式就不会打印两遍了