Django仿Admin定制插件(一)

程序启动时查找所有注册了的apps.py 会执行def ready方法
MyAdmin.apps.py:
def ready(self):
super(MyadminConfig,self).ready()

from django.utils.module_loading import autodiscover_modules
autodiscover_modules('reg')

这里应该是收集所有的reg文件。执行reg.py中的注册函数
app01.reg.py:
from app01 import models
from MyAdmin.service import v1
#执行v1.site.register方法，将model_class传入
v1.site.register(models.UserInfo)
v1.site.register(models.Role)

MyAdmin.service.v1.py:
#site为MySite对象
site = MySite()
#通过执行并传入model的register函数,生成一个字典并保存：
ret={
"UserInfo":BaseAdmin(UserInfo,site)
"Role":BaseAdmin(Role,site)
}
def register(self,model_class,xxx = BaseAdmin):
self._registry[model_class] = xxx(model_class,self)


Django.urls.py:
from django.conf.urls import url
from MyAdmin.service import v1
urlpatterns = [
url(r'^md/', v1.site.urls),
]
当Django启动后，这里使用路由分发的原理 v1.site.urls 分发了预设的url以及
根据app名称跟类名拼接生成的url,在此基础上再次分发，使每个类都有
4个url：changelist、add、delete、change
MyAdmin.service.v1.py class

@property
1. def urls(self):
return self.get_urls(),self.app_name,self.namespace


2. def get_urls(self):
from django.conf.urls import url,include
ret = [
url(r'^login/',self.login,name='login'),
url(r'^logout/',self.login,name='logout'),
]
"""
model_cls为models类，admin_obj为BaseAdmin(model类， MySite()即site )，即传入2个参数的BaseAdmin对象，
admin_obj.urls则执行BaseAdmin的urls方法
"""
for model_cls,admin_obj in self._registry.items():
app_label = model_cls._meta.app_label
model_name = model_cls._meta.model_name

ret.append(url(r'^%s/%s' % (app_label,model_name),include(admin_obj.urls)))

return ret

3.@property
def urls(self):
from django.conf.urls import url,include
info = self.model_class._meta.app_label,self.model_class._meta.model_name
"""

　　

这里的self.model_class为之前传入的model类，所以一样可以取得app和model类名,由此设置别名，
方便后续反向生成url.
"""
urlpatterns = [
url(r'^$',self.changelist_view,name='%s_%s_changelist' % info),
url(r'^add/$',self.add_view,name='%s_%s_add' % info),
url(r'^(.+)/delete/$',self.delete_view,name='%s_%s_delete' % info),
url(r'^(.+)/change/$',self.change_view,name='%s_%s_change' % info),
]
return urlpatterns

生成url后，我们需要对每个url指定不同的操作，以changelist为例子,每个类定义的字段，以及字段名都不同，我们又不可能为每一个类的url做单独的模版，假如有几十个类，这样增删改查工作量太大，因此我们需要为每个类的增删改查做统一的视图模版.

阶段一代码：

1.目录结构：

2.代码：

from django.http import HttpResponse
from django.shortcuts import render

class BaseAdmin(object):
    list_display = "__all__"

    def __init__(self,model_class,site):
        self.model_class = model_class
        self.site = site
        self.request = None

    @property
    def urls(self):
        from django.conf.urls import url
        """
        这里的self.model_class为之前传入的model类，所以一样可以取得app和model类名,由此设置别名，
        方便后续反向生成url.
        """
        info = self.model_class._meta.app_label,self.model_class._meta.model_name
        urlpatterns = [
            url(r'^$',self.changelist_view,name='%s_%s_changelist' % info),
            url(r'^add/$',self.add_view,name='%s_%s_add' % info),
            url(r'^(.+)/delete/$',self.delete_view,name='%s_%s_delete' % info),
            url(r'^(.+)/change/$',self.change_view,name='%s_%s_change' % info),
        ]
        return urlpatterns

    def add_view(self,request):
        """
        新增数据
        :param request:
        :return:
        """
        info = self.model_class._meta.app_label,self.model_class._meta.model_name
        data = "%s_%s_add" % info
        return HttpResponse(data)

    def delete_view(self,request,pk):
        """
        删除数据
        :param request:
        :return:
        """
        # self.model_class.objects.filter(id=pk).delete()
        info = self.model_class._meta.app_label, self.model_class._meta.model_name
        data = "%s_%s_del" % info
        return HttpResponse(data)

    def change_view(self,request,pk):
        """
        修改数据
        :param request:
        :return:
        """
        info = self.model_class._meta.app_label, self.model_class._meta.model_name
        data = "%s_%s_change" % info
        return HttpResponse(data)

    def changelist_view(self,request):
        """
        查看列表
        :param request:
        :return:
        """
        self.request = request
        result_list = self.model_class.objects.all()
        context = {
            'result_list':result_list,
            'list_display':self.list_display,
            'admin_obj':self  #此处self为自定制的Admin-models类对象
        }
        return render(request,'md/change_list.html',context)


class MySite(object):
    def __init__(self):
        self._registry = {}
        self.namespace = 'MyAdmin'
        self.app_name = 'MyAdmin'

    def register(self,model_class,xxx = BaseAdmin):
        self._registry[model_class] = xxx(model_class,self)
        """{
        modle类:BaseAdmin(model类， MySite()即site )
        }
        """

    def get_urls(self):
        from django.conf.urls import url,include
        ret = [
            url(r'^login/',self.login,name='login'),
            url(r'^logout/',self.login,name='logout'),
        ]
        #通过循环items获得每一个model类所在的app名，以及小写的类名
        for model_cls,admin_obj in self._registry.items():
            """
            model_cls为models类，admin_obj为BaseAdmin(model类， MySite()即site )，即传入2个参数的BaseAdmin对象，
            admin_obj.urls则执行BaseAdmin的urls方法
            """
            app_label = model_cls._meta.app_label
            model_name = model_cls._meta.model_name
            # print(app_label,model_name)
            #拼接生成url，如/md/app01/userinfo/,再次分发拿到最终的/md/app01/userinfo/change_list等url
            ret.append(url(r'^%s/%s' % (app_label,model_name),include(admin_obj.urls)))

        return ret

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

    def login(self,request):
        return HttpResponse('login')

site = MySite()

MyAdmin.templates.md.change_list.html:

{% load md_list %}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1>数据列表</h1>
    {% func result_list list_display admin_obj%}
</body>
</html>

MyAdmin.templates.md.md.html:

<table border="1">
    <thead>

    </thead>
    <tbody>
    {% for item in res %}
        <tr>
            {% for val in item %}
                <td>{{ val }}</td>
            {% endfor %}
        </tr>
    {% endfor %}
    </tbody>
</table>

 MyAdmin.templatetags.md_list.py:

from django.template import Library
from types import FunctionType

register = Library()

def table_body(result_list,list_display,admin_obj):
    """
    循环自定制的列表，生成对应的标签数据
    :param result_list: 数据表所有数据
    :param list_display: 自定制列表  ['id','name',fun]
    :param admin_obj: 继承自BaseAdmin的models类对象，如:AdminUserInfo()
    :return:
    """
    for row in result_list:
        yield [name(admin_obj,row) if isinstance(name,FunctionType) else getattr(row,name) for name in list_display]

@register.inclusion_tag("md/md.html")
def func(result_list,list_dispaly,admin_obj):
    """
    inclusion_tag，调用这个tag的模版，首先会将数据交给md.html根据html渲染出标签，
    然后替换到调用这个tag的位置。
    :param result_list:
    :param list_dispaly:
    :param admin_obj:
    :return:
    """
    v = table_body(result_list,list_dispaly,admin_obj)

    return {'res':v}

　　

MyAdmin.apps.py:

from django.apps import AppConfig

class MyadminConfig(AppConfig):
    name = 'MyAdmin'
    def ready(self):
        super(MyadminConfig,self).ready()

        from django.utils.module_loading import autodiscover_modules
        autodiscover_modules('reg')

　　

app01.reg.py:

from app01 import models
from MyAdmin.service import v1
from django.utils.safestring import mark_safe

class AdminUserInfo(v1.BaseAdmin):

    def func(self,obj):
        """
        反向生成url，使每一条数据可以跳转到详细页执行change视图
        :param obj: 数据表行数据
        :return: 编辑按钮跳转url
        """
        from django.urls import reverse
        #反向生成url,需要namespace,app跟类名称在注册时传入
        name = "{0}:{1}_{2}_change".format(self.site.namespace,self.model_class._meta.app_label,self.model_class._meta.model_name)
        #obj为查询出的数据表每一行数据
        url = reverse(name, args=(obj.pk,))
        return mark_safe("<a href='{0}'>编辑</a>".format(url))

    def checkbox(self,obj):
        """
        生成checkbox标签
        :param obj: 行数据
        :return: 带有数据行id的checkbox标签
        """
        tag = "<input type='checkbox' value='{0}' />".format(obj.pk)
        return mark_safe(tag)

    list_display = [checkbox,'id','username',func]

"""
这里注册后,self._registry[model_class] = xxx(model_class,self)
原来的字典就变为{UserInfo:AdminUserInfo(UserInfo,site)},
因此传过去的context字典中的admin_obj不再是BaseAdmin对象，而是这里的AdminUserInfo对象，它除了能继承
BaseAdmin类的各种方法，还有自己定制的func 以及checkbox方法.
"""
v1.site.register(models.UserInfo,AdminUserInfo)

class AdminRole(v1.BaseAdmin):
    list_display = ['id', 'name']

v1.site.register(models.Role,AdminRole)

　　

settings配置文件：

"""
Django settings for Admin自定制 project.

Generated by 'django-admin startproject' using Django 1.11.2.

For more information on this file, see
https://docs.djangoproject.com/en/1.11/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/1.11/ref/settings/
"""

import os

# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = '@bfz%(znqs&m2907_q0ck%ly2=ghs^p@nptcwdrr^333vw%xl9'

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

ALLOWED_HOSTS = []


# Application definition

INSTALLED_APPS = [
    # 'django.contrib.admin',
    # 'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    # 'django.contrib.messages',
    'django.contrib.staticfiles',
    'app01',
    'MyAdmin.apps.MyadminConfig'
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    # 'django.contrib.auth.middleware.AuthenticationMiddleware',
    # 'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

ROOT_URLCONF = 'Admin自定制.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')]
        ,
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                # 'django.contrib.auth.context_processors.auth',
                # 'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

WSGI_APPLICATION = 'Admin自定制.wsgi.application'


# Database
# https://docs.djangoproject.com/en/1.11/ref/settings/#databases

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    }
}


# Password validation
# https://docs.djangoproject.com/en/1.11/ref/settings/#auth-password-validators

AUTH_PASSWORD_VALIDATORS = [
    # {
    #     'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    # },
    # {
    #     'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
    # },
    # {
    #     'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
    # },
    # {
    #     'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
    # },
]


# Internationalization
# https://docs.djangoproject.com/en/1.11/topics/i18n/

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/1.11/howto/static-files/

STATIC_URL = '/static/'