Django点滴（2）xadmin+django-import-export导入导出的实现

Django-xadmin+django-import-export导入导出的实现

Django点滴系列是本人Django使用的一个记录，主要用于踩坑填坑，如果能帮到你，就是我荣幸！

书接上回， 上一篇博客 Django点滴（1）xadmin+rule对象级权限的实现记录了xadmin对象级权限相关应用，本篇将目光投向xadmin的导入导出功能。

---

太长不看版：
该功能已经向xadmin项目组提交了pull request，代码已经merge，下载使用最新版xadmin即可，插件使用方法请参考xadmin/plugins/importexport.py的注释

---

1. 需求vs现状

1.1 需求

要求做一个ERP后台辅助管理的程序，有以下几项基本要求：
1. 基本的增删改查功能
2. 基于对象的权限控制（如：系统用户分为平台运营人员和商家用户，商家用户小A只能查看编辑所属商家记录，而管理员可以纵览全局）
3. 数据库记录导入导出（xsl, json等），并且拥有对象级的权限控制（如：小A不能导出小B公司的信息，更不能导入小B公司信息进行更新和新增）

1.2 现状

1. 实现需求1：Django-admin让我们能够很方便的实现一个管理后台程序。django-xadmin则在拥有admin基本功能的基础上增加了更为丰富的功能、界面也更加漂亮。类似还有django-suit等，本文使用xadmin（功能更丰富）；
2. 实现需求2：django-admin，以及xadmin都只有基于model级的权限控制机制，需要自己扩展或者使用开源解决方案，如django-guardian，django-rules，本文结合django-rules实现了该功能；
3. 实现需求3：xadmin虽然自带导出功能，但是导入功能没有实现，django自带后台结合django-import-export可以很容易实现，但是xadmin并不直接兼容，只有通过xadmin的插件机制实现。

2. 功能实现

本节主要展示需求3导入导出功能实现。

2.1 安装并配置django-import-export

django-import-export主要原理是为待导入导出的model类设置一个Resource类，通过Resource类的export()方法进行导出，import_data()方法进行导入，灵活设置Resource便能实现多种文件格式数据导入导出。
pip安装:

$ pip install django-import-export

配置settings.py

# settings.py
INSTALLED_APPS = (
    ...
    'import_export',
)

2.2 建立model（同上篇）

新增CompanyUser模型表示商家账户（即对django自带user模块进行扩展，使每个账号绑定自己的公司码），新增Customer模型表示商家的客户信息并包含公司码字段，商家账号只能查看、编辑、导入、导出公司码一致的商家客户信息

# model.py
class CompanyUser(models.Model):
    user = models.OneToOneField(User, verbose_name='用户名')
    is_taixiang_admin = models.BooleanField('是否运营人员', default=False)
    company_code = models.CharField('公司码', max_length=20, blank=True, default='')

    def __unicode__(self):
        return '%s' % self.user

    class Meta:
        verbose_name = '导入账号'
        verbose_name_plural = verbose_name

class Customer(models.Model):
    name = models.CharField('客户姓名', max_length=50)
    phone = models.CharField('客户电话', max_length=12)
    type_choice = ((1, '普通'), (2, '批发'), (3, 'VIP'))
    creator = models.ForeignKey(settings.AUTH_USER_MODEL, verbose_name='创建人', blank=True, null=True)
    company_code = models.CharField('公司码', max_length=20, blank=True, null=True)

    def __unicode__(self):
        return '%s-%s-%s' % (self.company_code, self.name, self.phone1)

    class Meta:
        permissions = (
            ("simulate_import_customer", "允许模拟导入客户"),
            ("import_customer", "允许导入客户至商家系统"),
                       )
        verbose_name = "客户"
        verbose_name_plural = verbose_name

2.3 创建Resource

在model统计目录新增resources.py，配置Resource类

# resources.py
from import_export import resources
from .models import Customer

class CustomerResource(resources.ModelResource):

    class Meta:
        model = Customer
        fields = ('id', 'name', 'phone1', 'c_type', 'company_code')

2.4 原生django-admin导入导出实现

使用原生的django-admin，ModelAdminClass可以通过继承ImportExportModelAdmin类实现导入导出，继承ImportExportActionModelAdmin类实现导出action：

# admin.py
from django.contrib import admin
from .models import Customer
from import_export.admin import ImportExportModelAdmin, ImportExportActionModelAdmin
from .resources import CustomerResource


class CustomerAdmin(ImportExportActionModelAdmin, ImportExportModelAdmin):
    resource_class = CustomerResource

admin.site.register(Customer, CustomerAdmin)

2.5 django-xadmin导入导出实现（代码修改挺多的，此处展示基本思路，希望能push到xadmin项目中）

基于xadmin强大的plugin功能（参考Xadmin插件制作），这次我们开发一个importexport插件。具体实现转下章。

3. xadmin-importexport-plugin开发

开发思路：

1. 类似admin使用importexport，需要在adminx.py ModelAdmin类中设置import_export_args属性用于关联Resource类，在list页面中会显示导入和导出按钮（ImportMenuPlugin，ExportMenuPlugin生效）。

# adminx.py
class CustomerAdmin(object):

    import_export_args = {'import_resource_class': CustomerResource, 'export_resource_class': CustomerResource}
    ...

2. 点击导出按钮，会弹出若干选项，点击确定发送get请求后，触发ExportPlugin插件调用resource的export()方法进行导出。

3. 点击导入按钮，则会跳转至导入页面（ImportView），上传文件后点击导入会进行基本的检测

4. 点击确认导入（ImportProcessView）调用django-import-export导入至数据库。

3.1.1 插件部分代码

# xadmin/plugins/importexport.py

# 继承BaseAdminPlugin类
class ImportMenuPlugin(BaseAdminPlugin):
    # 使用插件时需要在ModelAdmin类中设置import_export_args属性，插件初始化时使用ModelAdmin的import_export_args进行赋值
    import_export_args = {}

    # 返回True则加载插件，在list列表中显示导入按钮
    def init_request(self, *args, **kwargs):
        return bool(self.import_export_args.get('import_resource_class'))

    def block_top_toolbar(self, context, nodes):
        has_change_perm = self.has_model_perm(self.model, 'change')
        has_add_perm = self.has_model_perm(self.model, 'add')
        if has_change_perm and has_add_perm:
            model_info = (self.opts.app_label, self.opts.model_name)
            import_url = reverse('xadmin:%s_%s_import' % model_info, current_app=self.admin_site.name)
            context = get_context_dict(context or {})  # no error!
            context.update({
                'import_url': import_url,
            })
            nodes.append(loader.render_to_string('xadmin/blocks/model_list.top_toolbar.importexport.import.html',
                                                 context=context))


class ExportMenuPlugin(BaseAdminPlugin):
    import_export_args = {}

    # Media
    def get_media(self, media):
        return media + self.vendor('xadmin.plugin.importexport.css', 'xadmin.plugin.importexport.js')

    def init_request(self, *args, **kwargs):
        return bool(self.import_export_args.get('export_resource_class'))

    def block_top_toolbar(self, context, nodes):
        formats = self.get_export_formats()
        form = ExportForm(formats)

        context = get_context_dict(context or {})  # no error!
        context.update({
            'form': form,
            'opts': self.opts,
            'form_params': self.admin_view.get_form_params({'_action_': 'export'}),
        })
        nodes.append(loader.render_to_string('xadmin/blocks/model_list.top_toolbar.importexport.export.html',
                                             context=context))


site.register_plugin(ImportMenuPlugin, ListAdminView)
site.register_plugin(ExportMenuPlugin, ListAdminView)

---