项目一：CRM(客户关系管理系统)--9---自定制action

现在该来添加前面提到的Action功能了，强大的它能干什么，先来体验一下原生admin中的效果。

1. 原生admin体验

默认的删除功能是可以进行批量删除的！

可以在后台进行自定义功能

在CRM应用目录下的admin.py中添加：

from django.contrib import admin
from CRM import models
from django.shortcuts import render
# Register your models here.
 
#自定义操作
class CustomerAdmin(admin.ModelAdmin):
    list_display = ('name', 'id','qq','source','consultant','content','status','date')
    list_filter = ('source','consultant','date')
    search_fields = ('qq','name')
    raw_id_fields = ('consult_course',)
    filter_horizontal = ('tags',)
    list_editable = ('status',)
    #添加如下内容
    actions = ("test_action", )
 
    def test_action(self,request,arg2):
        print('test action:',self,request,arg2)
        return render(request,"king_admin/table_index.html")

效果图：

跳转到指定的页面：

2. 重写action

2.1基类中添加字段

第一件事还是跟以前一样，需要在基类中添加对应的字段选项：

king_admin_base.py文件中：

class ModelAdmin(object):
    list_display = []
    list_filter = []
    search_fields = []
    ordering = None
    filter_horizontal = []
    actions = []  #添加该字段
    list_per_page = 10

2.2 添加默认的批量删除

我还要在基类中添加默认情况下的批量删除功能，这个同原生admin中定义的方式一样。需要在基类下面定义个批量删除功能的函数。

在king_admin_base.py文件中添加要定义的功能函数：

from  django.shortcuts import render
 
#创建基类
class ModelAdmin(object):
    list_display = []
    list_filter = []
    search_fields = []
    ordering = None
    filter_horizontal = []
    actions = ['delete_many_objects']
    list_per_page = 10
 
 
    def delete_many_objects(self, request, selected_objects):
        return render(request, 'king_admin/table_object_delete.html')
 
...

2.3 模板文件编写

2.3.1 模板文件中显示功能

要在模板文件中显示这个功能函数，我们必须在table_objs.html文件中添加，只需要简单的添加一些标签：

...

                  <button type="SUBMIT" class="btn btn-success">search</button>
                  </div>
                </form>
               </div>
                {# 添加action #}
                <div class="row" style="margin-top: 10px">
                      <div class="col-lg-2">
                          <select id="action_list" name="action" class="form-control" style="margin-left:15px">
                              <option value="">---------</option>
                              {% for action in admin_class.actions %}
                                  <option value="{{ action }}">{{ action }}</option>
                              {% endfor %}
                          </select>
                      </div>
                      <div class="col-lg-1">
                        <button type="submit" class="btn  " >Go</button>
                      </div>
                </div>
              {#具体的表格内容展示 #}

...

显示效果如下：

有的朋友会问：你没有传admin_class变量？是的，这里没有必要再传了，因为在该模板文件中已经存在了！

2.3.2 模板中添加表单功能

上面只是简单的显示了功能，并没有实现具体的功能。然而实现具体的功能我们需要进行传递一些必要的值，传输这些值就需要表单组件来提供功能。

还是上面的代码，套一层表单标签即可：

 </div>
                </form>
               </div>
                {# 添加action #}
                <div class="row" style="margin-top: 10px">
                    <form onsubmit="return ActionSubmit(this)" method="POST">
                      {% csrf_token %}
                      <div class="col-lg-2">
                          <select id="action_list" name="action" class="form-control" style="margin-left:15px">
                              <option value="">---------</option>
                              {% for action in admin_class.actions %}
                                  <option value="{{ action }}">{{ action }}</option>
                              {% endfor %}
                          </select>
                      </div>
                      <div class="col-lg-1">
                        <button type="submit" class="btn">Go</button>
                      </div>
                    </form>
                </div>
              {#具体的表格内容展示 #}

2.3.3 中文显示功能

说到中文显示，我们就不得不用到自定义标签了。但在使用之前先来看看原生的admin是怎么实现中文显示的吧：

...
 
    def test_action(self,request,arg2):
        print('test action:',self,request,arg2)
        return render(request,"king_admin/table_index.html")
    test_action.short_description = '测试'  #添加这行代码
 
...

显示效果：

开始我们自己的中文显示吧，就为我们刚刚写到默认批量删除功能添加显示中文：

...
class ModelAdmin(object):
    list_display = []
    list_filter = []
    search_fields = []
    ordering = None
    filter_horizontal = []
    actions = ['delete_many_objects']
    list_per_page = 10


    def delete_many_objects(self, request, queryset):
        return render(request, 'king_admin/table_object_delete.html')
    delete_many_objects.short_description = '批量删除'
...

模板文件修改如下：　　

{# 添加action #}
                <div class="row" style="margin-top: 10px">
                    <form onsubmit="return ActionSubmit(this)" method="POST">
                      {% csrf_token %}
                      <div class="col-lg-2">
                          <select id="action_list" name="action" class="form-control" style="margin-left:15px">
                              <option value="">---------</option>
                              {% for action in admin_class.actions %}
                                  <option value="{{ action }}">{% get_action_name admin_class action %}</option>
                              {% endfor %}
                          </select>
                      </div>

在templates/tags.py文件中，添加的内容如下：

...
 
<------------------------显示默认action中文--------------------------
@register.simple_tag
def get_action_name(admin_class, action):
    action_func = getattr(admin_class, action)
    if hasattr(action_func, 'short_description'):
        return action_func.short_description
    else:
        return action

渲染后的效果：

2.4 视图函数

上面我们已经查不到将模板文件所需要的都已经编写完毕，接下来就是数据的收发，涉及到数据的收发我们必须要用到视图。这里是在table_objs.html文件基础上添加的功能，视图中，我们同样要使用它来接收来自该模板文件的数据请求。

2.4.1 模板文件的数据发送

前面刚刚建立了表单功能，向后台提交数据就需要使用POST方式进行，同时我们还要将那些选中的checkbox中的行id一同传送到后端。

在前面建立表单的时候，已经添加了传送方式和提交的函数：<form onsubmit="return ActionSubmit(this)" method="POST">，这里将具体的提交函数编写一下：

...
 
        function  ActionSubmit(self) {
            var selected_ids = [];
            $("input[tag='object_checkbox']:checked").each(function () {
                selected_ids.push($(this).val());
            });
            var selected_action = $("#action_list").val();
            if  (selected_ids.length == 0){
                alert("No object got selected!");
                return;
            }
            if (!selected_action){
                alert("No action got selected!");
            }
           //添加隐藏标签，用来存储提交的数据key/value
            var selected_ids_ele = "<input  name='selected_ids' type='hidden' value='" + selected_ids.toString() + "'>";
            $(self).append(selected_ids_ele);
            return true;
        }

这些脚本同样放在该文件的最下面。

2.4.2 视图函数的数据接收

上面的数据已经发送，该接收数据了。接收数据的功能函数我们使用display_objects(request, app_name, table_name)即可，我们只需要添加几行代码：

...
 
def display_objects(request, app_name, table_name):
    #获取自定义的admin_class
    admin_class = site.enabled_admins[app_name][table_name]
    #数据查询
    #query_set = admin_class.model.objects.all()
 
    <------------------接收action数据----------------------------
    if request.method == 'POST':
        #获取提交的数据
        selected_ids = request.POST.get("selected_ids")
        action = request.POST.get("action")
        #后台判断
        if selected_ids:
            selected_objs = admin_class.model.objects.filter(id__in=selected_ids.split(','))
        else:
            raise KeyError("No object selected.")
        if hasattr(admin_class, action):
            action_func = getattr(admin_class, action)
            #将action存储在请求体中便于调用
            request._admin_action = action
            return action_func(admin_class, request, selected_objs)
 
...

2.5 编写具体批量删除功能

还记得之前编写的删除功能吗？这里我们要复用一下，在此基础上简单的添加一标签用来提交数据。

2.5.1 批量删除功能编写

继续填补之前编写的批量删除功能的架子，默认情况的GET请求页面获取，在king_admin_base.py中：

...
    def delete_many_objects(self, request, selected_objects):
        app_name = self.model._meta.app_label
        table_name = self.model._meta.model_name
        selected_ids = ','.join([str(i.id) for i in selected_objects])
        return render(request, 'king_admin/table_object_delete.html',{'selected_objects': selected_objects,
                                                                      'action': request._admin_action,
                                                                      'selected_ids': selected_ids,
                                                                      'app_name': app_name,
                                                                      'table_name': table_name})
    delete_many_objects.short_description = '批量删除'

2.5.2 复用编辑页面的删除功能主页面

在table_object_delete.html文件中修改如下：

{% extends 'king_admin/table_index.html' %}
{% load tags %}

{% block body-content %}

    {% if not action %}
        {# 显示映射关系 #}
        {% display_object_related object_list %}
        {# 表单提交  #}
        <form method="post">
            {% csrf_token %}
            <input type="submit" class="btn btn-danger" value="Yes,I'm sure">
            <input type="hidden" value="yes" name="delete_confirm">
            <a class="btn btn-info" href="{% url 'king_admin:table_object_edit' app_name table_name object_id %}">No,Take me back</a>
        </form>
    {% else %}
        {# 显示映射关系 #}
        {% display_object_related selected_objects %}
        {# 批量删除 #}
        <form method="post">
        {% csrf_token %}
            <input type="submit" class="btn btn-danger" value="Yes,I'm sure">
            <input type="hidden" value="yes" name="delete_confirm">
            <input type="hidden" value="{{ action }}" name="action"/>
            <input type="hidden" value="{{ selected_ids }}" name="selected_ids"/>
            <a class="btn btn-info" href="/king_admin/{{ app_name }}/{{ table_name }}/?page={{ get_page }}">No,Take me back</a>
        </form>
    {% endif %}
{% endblock %}

2.5.3 删除数据

上面完成了数据的发送与接收，最后剩下的就是数据的删除：

king_admin_base.py文件的函数修改：

...
    def delete_many_objects(self, request, selected_objects):
        app_name = self.model._meta.app_label
        table_name = self.model._meta.model_name
        selected_ids = ','.join([str(i.id) for i in selected_objects])
        #添加如下判断
        if request.method == 'POST':
            if request.POST.get('delete_confirm') == 'yes':
                selected_objects.delete()
                return redirect('/king_admin/{app_name}/{table_name}'.format(app_name=app_name,
                                                                             table_name=table_name))
        return render(request, 'king_admin/table_object_delete.html',{'selected_objects': selected_objects,
                                                                      'action': request._admin_action,
                                                                      'selected_ids': selected_ids,
                                                                      'app_name': app_name,
                                                                      'table_name': table_name,
                                                                      'get_page': request.GET.get('page')})
    delete_many_objects.short_description = '批量删除'

...

效果查看：

Good！批量删除功能搞定了，同时也意味着action的告终。如果你想要实现其他功能，基本的流程就是这样的，仅供参考。

大致的思路如下：

1. modeladmin中需要定义自定义action，同时将该action的函数定义需要写在这里；

from CRM import models
from django.shortcuts import render, HttpResponse, redirect


class BaseAdmin(object):
    """构建后台管理的基类，模仿dango的admin"""
    list_display = []
    list_filter = []
    list_per_page = 10
    search_fields = []
    filter_horizontal = []
    model = None
    ordering = None
    actions = []


# 构建字典数据结构，存储的数据类型是：
# {'CRM': {'customerinfo': <class 'kingadmin.kingadmin.CustomerInfoAdmin'>}}
# {'app名称': {'数据表名' : 管理界面需要显示的数据表类}
enabled_admins = {}


def register(model_class, admin_class=None):
    """
    注册管理类(管理界面要显示的数据表类)，主要是将数据表定义类与后台管理数据表定义类进行关联；
    将所有的数据表与项目名称做一个关联，存储在全局变量中：enabled_admins；
    :param model_class: 数据表的定义类
    :param admin_class: 后台管理数据表定义类
    :return:
    """
    if model_class._meta.app_label not in enabled_admins:
        enabled_admins.update({model_class._meta.app_label: {}})
    # 给后台管理数据表定义类添加一个model属性，该属性就是数据表的定义类，
    # 方便以后通过后台管理数据表定义类取相关的数据表的定义类中的先关信息
    admin_class.model = model_class
    # model_class._meta.app_label 当前数据表所在的APP的名称
    # model_class._meta.model_name 当前数据表的名称
    enabled_admins[model_class._meta.app_label][model_class._meta.model_name] = admin_class


class CustomerInfoAdmin(BaseAdmin):
    """客户信息表管理类"""
    list_display = ['id', 'qq', 'name', 'refer_path', 'consultant', 'consult_course', 'date', 'status', 'tags']
    list_filter = ['refer_path', 'consultant', 'consult_course', 'status']
    list_per_page = 10
    search_fields = ['qq', 'name', 'consult_course__name']
    ordering = 'date'
    filter_horizontal = ['tags', ]
    actions = ['delete_many_objects', ]

    def delete_many_objects(self, request, selected_objects):
        """

        :param request:
        :param selected_objects:
        :return:
        """
        print(self, request, selected_objects)
        app_name = self.model._meta.app_label
        table_name = self.model._meta.model_name
        object_ids = ','.join([str(i.id) for i in selected_objects])
        print(app_name, table_name, object_ids, selected_objects, request._admin_action)
        # 添加如下判断
        if request.method == 'POST':
            if request.POST.get('delete_confirm') == 'yes':
                selected_objects.delete()
                return redirect('/kingadmin/{0}/{1}'.format(app_name, table_name))
        return render(request, 'kingadmin/table_object_delete.html', {'app_name': app_name,
                                                                      'table_name': table_name,
                                                                      'object_id': object_ids,
                                                                      'object_list': selected_objects,
                                                                      'action': request._admin_action,
                                                                      })
    delete_many_objects.short_description = '批量删除'

这其中需要注意的问题是在该函数定义中，如果需要返回一个模板文件，需要将对应的view处理函数需要的参数传递进去，如果不传递的话，系统会报错。

因此，这里是有可能引起urls.py的变动的，目前我的urls.py如下：

from django.conf.urls import url, include
from django.contrib import admin
from . import views

urlpatterns = [
    url(r'^$', views.default),
    url(r'^(w+)/(w+)$', views.table_list, name='table_list'),
    url(r'^(w+)/(w+)/((d+\,*)+)/delete$', views.table_object_delete, name='table_object_delete'),
    url(r'^(w+)/(w+)/((d+\,*)+)/edit$', views.table_object_edit, name='table_object_edit'),
    url(r'^(w+)/(w+)/add$', views.table_object_add, name='table_object_add'),

2. views.py需要做相应的变动，需要将POST和GET请求进行分开处理：

def table_object_edit(request, app_name, table_name, object_id, form_object):
    """
    编辑表中的一条数据
    :param request:
    :param app_name:
    :param table_name:
    :param object_id:
    :param form_object:
    :return:
    """
    admin_class = kingadmin.enabled_admins[app_name][table_name]
    model_form = create_model_form(request, admin_class)
    object_list = admin_class.model.objects.get(id=object_id)
    query_sets, filter_conditions = table_filter(request, admin_class)
    page = request.GET.get('page', default='')
    order = request.GET.get('o', '')
    search_text = table_search(request, admin_class, query_sets)[1]
    filter_conditions = custom_filter(request, admin_class)[1]
    filter_text = filters_to_text(filter_conditions)
    if request.method == 'POST':
        form_object = model_form(request.POST, instance=object_list)
        if form_object.is_valid():
            form_object.save()
            return redirect('/kingadmin/{0}/{1}?page={2}&o={3}&_q={4}&{5}'.format(
                app_name,
                table_name,
                page,
                order,
                search_text,
                filter_text,
            ))
        # else:                  # 目前可以删除(无论检验成功与否都是要返回table_object_edit.html)
        #     return render(request, 'kingadmin/table_object_edit.html', {'form_object': form_object,
        #                                                                 'admin_class': admin_class,
        #                                                                 'app_name': app_name,
        #                                                                 'table_name': table_name,
        #                                                                 })              # 目前可以删除
    else:
        form_object = model_form(instance=object_list)
    return render(request, 'kingadmin/table_object_edit.html', {'app_name': app_name,
                                                                'table_name': table_name,
                                                                'object_id': object_id,
                                                                'form_object': form_object,
                                                                'admin_class': admin_class,
                                                                })


def table_object_add(request, app_name, table_name):
    """
    添加页面
    :param request:
    :param app_name:
    :param table_name:
    :return:
    """
    admin_class = kingadmin.enabled_admins[app_name][table_name]
    model_form = create_model_form(request, admin_class)

    query_string = request.META.get('QUERY_STRING', '')
    redirect_url = '/kingadmin/{0}/{1}?{2}'.format(app_name, table_name, query_string)
    if request.method == 'POST':
        form_object = model_form(request.POST)
        if form_object.is_valid():
            form_object.save()
            return redirect(redirect_url)
    else:
        form_object = model_form()
    return render(request, 'kingadmin/table_object_add.html', {'app_name': app_name,
                                                               'table_name': table_name,
                                                               'admin_class': admin_class,
                                                               'form_object': form_object,
                                                               })


def table_object_delete(request, app_name, table_name, object_id):
    """

    :param request:
    :param app_name:
    :param table_name:
    :param object_id:
    :return:
    """
    admin_class = kingadmin.enabled_admins[app_name][table_name]
    object_list = admin_class.model.objects.filter(id=object_id)
    if request.method == 'POST':
        # print(dir(request.POST))
        # print(request.POST)
        if request.POST.get('delete_confirm', '') == 'yes':
            object_list.delete()
            return redirect('/kingadmin/{app_name}/{table_name}'.format(
                app_name=app_name,
                table_name=table_name,
            ))
    return render(request, 'kingadmin/table_object_delete.html', {'app_name': app_name,
                                                                  'table_name': table_name,
                                                                  'object_id': object_id,
                                                                  'object_list': object_list,
                                                                  })

需要特别注意的是：

def table_list(request, app_name, table_name):
    """
    列出数据表中的所有数据
    :param request:
    :param app_name: app名称
    :param table_name: 数据表名称
    :return:
    """
    # app_name & table_name都存在enabled_admins中，取出其中的数据
    # for item in request.GET.items():
    #     print(item)
    if app_name in kingadmin.enabled_admins.keys() and 
            table_name in kingadmin.enabled_admins[app_name].keys():
        admin_class = kingadmin.enabled_admins[app_name][table_name]

        # 检索过滤数据
        # query_sets = admin_class.model.objects.all()
        query_sets, filter_conditions_customer = custom_filter(request, admin_class)
        # 搜索过滤数据
        query_sets, search_text = table_search(request, admin_class, query_sets)
        # query_sets 排序
        query_sets, order_before, order_after = table_sort(request, admin_class, query_sets)
        filter_conditions_preset = admin_class.list_filter

        if request.method == 'POST':
            # 获取提交数据
            selected_ids = request.POST.get("selected_ids")
            action = request.POST.get("selected_action")
            print(selected_ids, action)
            if selected_ids:
                selected_objs = admin_class.model.objects.filter(id__in=selected_ids.split(','))
            else:
                raise KeyError('No object selected')
            if hasattr(admin_class, action):
                action_func = getattr(admin_class, action)
                # 将action存储在请求体中便于调用
                request._admin_action = action
                return action_func(admin_class, request, selected_objs)
        else:
            # list_display中的所有字段对应的verbose_name
            field_verbose_names = []
            field_names = []
            fields = []
            for field_name in admin_class.list_display:
                for field in admin_class.model._meta.get_fields():
                    if field.name == field_name:
                        fields.append(field)
                        # field_names.append(field_name)
                        # field_verbose_names.append(field.verbose_name)

            # 分页
            page = request.GET.get('page', '')

            paginator = Paginator(query_sets, admin_class.list_per_page)
            # 检索参数
            filter_text = filters_to_text(filter_conditions_customer)
            try:
                contacts = paginator.page(page)
            except PageNotAnInteger:
                # If page is not an integer, deliver first page.
                contacts = paginator.page(1)
            except EmptyPage:
                # If page is out of range (e.g. 9999), deliver last page of results.
                contacts = paginator.page(paginator.num_pages)
            contacts_count = len(contacts)
            return render(request, 'kingadmin/table_list.html', {'app_name': app_name,
                                                                 'table_name': table_name,
                                                                 'query_sets': query_sets,
                                                                 'admin_class': admin_class,
                                                                 # 'field_verbose_names': field_verbose_names,
                                                                 # 'field_names': field_names,
                                                                 'order_before': order_before,
                                                                 'order_after': order_after,
                                                                 'fields': fields,
                                                                 'contacts': contacts,
                                                                 'contacts_count': contacts_count,
                                                                 'filter_conditions': filter_conditions_preset,
                                                                 'filter_conditions_customer': filter_conditions_customer,
                                                                 'search_text': search_text,
                                                                 'page': page,
                                                                 'filter_text': filter_text,
                                                                 })
    # app_name | table_name不存在enabled_admin中，就返回错误信息
    else:
        error = '应用名称或数据表名称不存在或未注册'
        return render(request,
                      'kingadmin/table_list.html',
                      {'error': error,
                       'app_name': app_name,
                       'table_name': table_name,
                       })

selected_ids与selected_action都是通过POST方法返回的，在模板文件中进行确认的时候，隐藏字段的值也需要一一对应，否则，获取到的selected_ids/selected_action都是None,系统就会出错。

3. 模板文件做相应的修改：

{% extends 'project/head.html' %}
{% load tags %}
{% block main %}
    {% if not action %}
        {% get_relationships object_list %}
        <form method="post">
            {% csrf_token %}
            <input type="submit" class="btn btn-danger" value="Yes, I'm sure">
            <input type="hidden" value="yes" name="delete_confirm">
            <a class="btn btn-info" href="{% url 'table_object_edit' app_name table_name object_id %}">No, Take me
                back</a>
        </form>
    {% else %}
        {% get_relationships object_list %}
        <form method="post">
            {% csrf_token %}
            <input type="submit" class="btn btn-danger" value="Yes, I'm sure">
            <input type="hidden" value="yes" name="delete_confirm">
            <input type="hidden" value="{{ action }}" name="selected_action">
            <input type="hidden" value="{{ object_id }}" name="selected_ids">
            <a class="btn btn-info" href="/kingadmin/{{ app_name }}/{{ table_name }}">No, Take me
                back</a>
        </form>
    {% endif %}

{% endblock %}