「Django 功能开发」xadmin常用功能汇总大全，开发常伴使用

我会带着你远行 2022-09-11 11:19 888阅读 0赞

### 文章目录 ###

*  内容介绍
 *  Xadmin下载使用
 *  配置settings.py
 *  配置urls.py
 *  Models管理
 *  站点的全局配置
 *  app名称的修改
 *  自定义导航菜单顺序
 *  设置只读字段
 *  list\_display显示自定义函数
 *  设置页面跳转，需自定义函数
 *  模型编辑多模型内部关联同时编辑
 *  重载显示样式
 *  model 分不同情况管理
 *  获取当前的user表model
 *  卸载注册的model
 *  替换默认的注册 user(继承了abstractuser)
 *  表单根据用户显示不同的字段内容
 *  模型编辑页面Field分区显示
 *  获取用户信息并填充模型字段
 *  根据登录用户或组过滤数据
 *  外键下拉框添加过滤
 *  save\_models和delete\_model
 *  定制HTML模板
 *  自定义actions
 *  boolean的属性并赋值为显示为on/off的图标
 *  字段设置颜色
 *  页面显示的列 ‘跳转’——显示自定义的html代码

# 内容介绍 #

汇总Python开发中使用xadmin中常用的功能汇总数十项，在Django开发使用xadmin中的全部内容。

# Xadmin下载使用 #

创建extra\_apps文件夹，将DjangoUeditor和xadmin插件包直接复制进去即可。

推荐用Python3，因为Django3.x后面的版本很多功能Python2都不支持了。  
下面的插件地址是根据DjangoUeditor和xadmin基于Python2环境修改的，可以完美运行。

[基于Python3的插件下载地址][Python3]

# 配置settings.py #

INSTALLED_APPS = [
        ....
        'xadmin',
        'crispy_forms',
        'reversion', 
    ]
    ALLOWED_HOSTS = ['*', ]
    
    LANGUAGE_CODE = 'zh-Hans'
    
    TIME_ZONE = 'Asia/Shanghai'

# 配置urls.py #

# -*- coding: utf-8 -*-
    # from django.conf.urls import include, url
    from django.urls import include, path
    
    # Uncomment the next two lines to enable the admin:
    import xadmin
    xadmin.autodiscover()
    
    # version模块自动注册需要版本控制的 Model
    from xadmin.plugins import xversion
    xversion.register_models()
    
    from django.contrib import admin
    
    urlpatterns = [
        path(r'xadmin/', xadmin.site.urls)
    ]

# Models管理 #

xadmin 可以使用的页面样式控制基本与Django原生的admin一致。
    # 列表展示的字段
    list_display 
    # 默认情况下，当你对目标进行创建、编辑或删除操作后，页面会依然保持原来的过滤状态。将preserve_filters设为False后，则会返回未过滤状态。
    preserve_filters  
    # 设置预填充字段。不接收DateTimeField、ForeignKey和ManyToManyField类型的字段。
    prepopulated_fields  
    # 这个属性可以控制是否在admin页面显示“View site”的链接。这个链接主要用于跳转到你指定的URL页面。
    view_on_site  
    # 默认为 True , 指定是否可以自由搜索. 如果开启自由搜索, 用户可以通过 url 参数来进行特定的搜索
    free_query_filter
    # 可以通过搜索框搜索的字段名称，xadmin使用的是 模糊查询，同 list_filter 一样 注意：只能包括 字符类型，不能有 非字符类型 如：SBBH-20180515-0002
    search_fields 
    # 可以进行过滤操作的列，例如：存在外键字段class ---》student__class 获取值
    list_filter      
    # 默认排序的字段 
    ordering     
    # 在编辑页面的只读字段 
    readonly_fields    
    # 在编辑页面隐藏的字段 
    exclude  
    # 在列表页可以快速直接编辑的字段 
    list_editable     
    # 在列表页显示详情信息 
    show_detail_fileds  
    # 指定列表页的数据定时刷新 例如：refresh_times=(3,5) 
    refresh_times     
    # 控制列表页导出数据的类型 
    list_export  
    # 控制是否显示书签功能 
    show_bookmarks  
    # 控制显示图标的样式 
    data_charts       
    # 配置表的图标，可以在 awesome 上下载最新的font-awesome.css 替换，并寻找相应的icon书写 
    model_icon     
    # 详细页面时，使用fieldsets标签对数据进行分割显示 
    fieldsets 
    empty_value_display = "列数据为空时，显示默认值"
    # 列聚合，可用的值："count","min","max","avg", "sum"
    aggregate_fields = { "expire": "max"}
    # 显示还原按钮，删除修改的信息可以还原
    reversion_enable = True
    # 添加数据时候，一步一步提供数据
    wizard_form_list = [
        ("基础信息", ("name", "contact", "telphone", "address")),
        ("其它信息", ("customer_id", "expire", "description")),
    ]
    # 表单显示内容, 不包含在内的字段不能编辑
    fields          
    # 从‘多选框’的形式改变为‘过滤器’的方式，水平排列过滤器 ，必须是一个 ManyToManyField类型，且不能用于 ForeignKey字段，默认地，管理工具使用下拉框 来展现外键 字段 
    filter_horizontal    
    # 将ForeignKey字段从‘下拉框’改变为‘文本框’显示
    raw_id_fields     
    # 后台自定义不是下拉选择框，而是搜索框（解决了为什么用户不是下拉框的问题。。） relfield_style = 'fk-ajax' 
    relfield_style  
    # 在编辑和查看列表时指定不显示的字段 
    exclude          
    # 列表显示的时候，指定的字段可以直接页面一键编辑 
    list_editable   
    # 设置默认可编辑字段 
    list_display_links  
    # 每页显示20个 
    list_per_page = 20   
    # 在类中自定义的函数方法
    actions = ('ocr_action', 'excel_action', 'auto_excel_action') 
    # 函数名描述
    auto_excel_action.short_description='自动化导入数据文件'  
    # 自定义页面 
    object_list_template = "test.html"   
    # 图表，该属性为dict类型，key为图表的标示名称，value为图表的具体设置属性 
    data_charts = { 
            "user_count": { 'title': u"约运动",
                           "x-field": "sport_time", # 图表的 X 轴数据列, 一般是日期, 时间等
                           "y-field": ("people_nums",), # 图表的 Y 轴数据列, 该项是一个 list, 可以同时设定多个列, 这样多个列的数据会在同一个图表中显示
                           "order": "time", #排序信息, 如果不写则使用数据列表的排序
                           },
        }
    # 导出类型
    list_export = ('xls', 'xml', 'json')   list_export设置为None来禁用数据导出功能
    # 导出字段
    list_export_fields = ('start_people', 'sport', 'sport_time')
    # 字段样式
    style_fields = { 
    	'level':'字段名', # model 一对多字段
    	'm2m_transfer':'字段名', # 多对多穿梭框
    	'ueditor':'字段名', # 富文本编辑器
    	'filter_horizontal':'字段名', # 多对多模式支持过滤
    }

# 站点的全局配置 #

import xadmin
    from xadmin import viewsclass 
    BaseSetting(object):
        """xadmin的基本配置"""
        enable_themes = True      # 开启主题切换功能
        use_bootswatch = True     # 支持切换主题
    
    xadmin.site.register(views.BaseAdminView, BaseSetting)
    
    class GlobalSettings(object):
        """xadmin的全局配置"""
        site_title = "xxx后台管理系统"   # 设置站点标题
        site_footer = "xxxxxxx"     # 设置站点的页脚
        menu_style = "accordion"    # 设置菜单折叠，在左侧，默认的
        # 设置models的全局图标, UserProfile, Sports 为表名
        global_search_models = [UserProfile, Sports]
        global_models_icon = { 
            UserProfile: "glyphicon glyphicon-user", Sports: "fa fa-cloud"
    
    xadmin.site.register(views.CommAdminView, GlobalSettings)  # 全局设置加载
    xadmin.site.register(views.BaseAdminView, BaseSetting)  # 注册主体风格切换

# app名称的修改 #

from django.apps import AppConfig
    
    
    class UsersConfig(AppConfig):
        # 设置app图标
        app_icon = 'fa fa-line-chart'
        # app名
        name = 'users'
        verbose_name = u'用户管理'
    
    # __init__.py
    
    default_app_config='users.apps.UsersConfig'

# 自定义导航菜单顺序 #

from xadmin import views
    
    class GlobalSetting(object):
         def get_site_menu(self):
         	MenuList =   { 'title': '列表名', 'menus': (
                    { 'title': '栏目信息', 'url': self.get_model_url(model1, 'changelist')},
                    { 'title': '栏目信息', 'url': self.get_model_url(model2, 'changelist')},
                )},
            return (MenuList,) # 这里注意要有个,
             
    xadmin.site.register(views.CommAdminView, GlobalSetting)

# 设置只读字段 #

在使用xadmin的时候，ModelAdmin默认只有对于model的增删改查，但是总是有些字段是不希望用户来编辑的。而 readonly\_fields 设置之后不管是admin还是其他用户都会变成只读，而我们通常只是想限制普通用户。 这时我们就可以通过重写 get\_readonly\_fields 方法来实现对特定用户的只读显示。

class UserInfoAdmin():
     
        def get_readonly_fields(self, **kwargs):
            """ 重新定义此函数，限制普通用户所能修改的字段 """
            print(self.org_obj)
            if self.user.is_superuser:
                self.readonly_fields = []
            return self.readonly_fields
         
        readonly_fields = ('user_email',)

# list\_display显示自定义函数 #

list_display = ['colum_name']
    
    # 需要在自定义的函数下加上如下内容
    def get_chapter_num(self):   
        return self.chapter_set.all().count()
    get_chapter_num.short_description= '名称'

# 设置页面跳转，需自定义函数 #

def go_to(self): # 设置列表页跳转
        from django.utils.safestring import mark_safe
        return mark_safe('<a href="http://www.fishc.com.cn">跳转</a>')
        go_to.short_description = '友情链接'

# 模型编辑多模型内部关联同时编辑 #

class ChapterInline:
        model = Chapter
        extra = 0
    
    # 在ModelXadmin 添加 
    inlines = [ChapterInline]

# 重载显示样式 #

from xadmin.layout import Main,Fieldset,Row,Side
     def get_form_layout(self):
        if self.org_obj:
            self.form_layout = (
                Main(
                    Fieldset('',
                             'username', 'password',
                             css_class='unsort no_title'
                             ),
                    Fieldset(_('Personal info'),
                             Row('first_name', 'last_name'),  # 显示在一行
                             'email'
                             ),
                    Fieldset(_('Permissions'),
                             'groups', 'user_permissions'
                             ),
                    Fieldset(_('Important dates'),
                             'last_login', 'date_joined'
                             ),
                    ),
                Side(
                    Fieldset(_('Status'),
                             'is_active', 'is_staff', 'is_superuser',
                   ),
                )
    
            )
        return super(UserAdmin, self).get_form_layout()子主题

# model 分不同情况管理 #

class Model1(models.Model):
        pass
    
    class BannerCourse(Model1):  # 继承父类 Model1
        class Meta:
            verbose_name = '轮播课程'
            verbose_name_plural = verbose_name
            proxy = True  # 不会生成新的表
    
    # 注册新的表
    class CourseSourceAdmin(object):
        list_display = ['name', 'add_time', 'download']
        list_filter = ['name', 'add_time', 'download']
        search_fields = ['name', 'download']
    
        def queryset(self):
            qs = super(Model1Admin, self).queryset()
            qs = qs.filter(is_banner=False)
            return qs

# 获取当前的user表model #

from django.contrib.auth import get_user_model  (获取当前的user表model)
        User = get_user_model()
        site.register(User,Useradmin)

# 卸载注册的model #

from django.contrib.auth.models import User
    
    xadmin.site.unregister(User)

# 替换默认的注册 user(继承了abstractuser) #

xadmin.site.unregister(get_user_model())    # 注销 user
    xadmin.site.register(UserInfo,UserInfoAdmin) # 注册新的 user

# 表单根据用户显示不同的字段内容 #

**get\_model\_form**

import xadmin
    # Register your models here.
     
    from .models import User
    from xadmin.plugins import auth
     
     
    class UserAdmin(auth.UserAdmin):
        list_display = ['id', 'username', 'mobile', 'email', 'date_joined']
        readonly_fields = ['last_login', 'date_joined']
        search_fields = ('username', 'first_name', 'last_name', 'email', 'mobile')
        style_fields = { 'user_permissions': 'm2m_transfer', 'groups': 'm2m_transfer'}
     
        # 表单根据用户显示不同的字段内容
        def get_model_form(self, **kwargs):
            if self.org_obj is None:
                self.fields = ['username', 'mobile', 'is_staff']
            return super().get_model_form(**kwargs)
     
    xadmin.site.unregister(User)
    xadmin.site.register(User, UserAdmin)

# 模型编辑页面Field分区显示 #

**form\_layout**

class DeviceAdmin(object):
      ...
      form_layout = (
        Main(
            Fieldset('基础信息',
                     'site', 'device_name', 'device_id', 'device_type', 'account', 'password'),
            Fieldset('EXTRA',
                     'device_model', 'supplier', 'responsible_by', 'device_ip', 'sn_number'),
        ),
        Side(
            Fieldset('其它',
                     'buy_date', 'expire_date', 'note', 'attachment', 'date'),
        )
    )

# 获取用户信息并填充模型字段 #

**save\_models**

class DeviceAdmin(object):
      ...
      def save_models(self):
    　　 obj = self.new_obj
        self.new_obj.area_company = Group.objects.get(user=self.request.user)
        super().save_models()

# 根据登录用户或组过滤数据 #

**queryset**

class ModelAdmin(object):
    ...
    def queryset(self):
        """函数作用：使当前登录的用户只能看到自己负责的设备"""
        qs = super(ModelAdmin, self).queryset()
        if self.request.user.is_superuser:
            return qs
        return qs.filter(area_company=Group.objects.get(user=self.request.user))

# 外键下拉框添加过滤 #

重写formfield\_for\_dbfield方法。

class ModelAdmin(object):
        ...
        def formfield_for_dbfield(self, db_field, **kwargs):
            if not self.request.user.is_superuser:
                if db_field.name == "site":
                     kwargs["queryset"] = Site.objects.filter(area_company=Group.objects.get(user=self.request.user))
            return super(ModelAdmin, self).formfield_for_dbfield(db_field, **kwargs)

# save\_models和delete\_model #

def save_models(self):
        # 新的对象
        obj = self.new_obj
        # 可以在这里面写些逻辑
        # 保存该对象
        obj.save()
    
    def delete_model(self):
        # 删除数据对象
        obj = self.obj
        # 相应的操作
        obj.delete()

# 定制HTML模板 #

add_form_template = None
    change_form_template = None
    change_list_template = None
    delete_confirmation_template = None
    delete_selected_confirmation_template = None
    object_history_template = None

# 自定义actions #

# 首先要创建一个 Action 类, 该类需要继承 BaseActionView. BaseActionView 是 ModelAdminView 的子类。
    from xadmin.plugins.actions import BaseActionView
    
    class MyAction(BaseActionView):
        # 这里需要填写三个属性
        action_name = "my_action"    #: 相当于这个 Action 的唯一标示, 尽量用比较针对性的名字
        description = _(u'Test selected %(verbose_name_plural)s') #: 描述, 出现在 Action 菜单中, 可以使用 ``%(verbose_name_plural)s`` 代替 Model 的名字.
        model_perm = 'change'    #: 该 Action 所需权限
        # 而后实现 do_action 方法
        def do_action(self, queryset):
            # queryset 是包含了已经选择的数据的 queryset
            for obj in queryset:
                # obj 的操作
                ...
            # 返回 HttpResponse
            return HttpResponse(...)
    # 然后在 Model 的 OptionClass 中使用这个 Action:
    class MyModelAdmin(object):
        actions = [MyAction, ]
    # 这样就完成了自己的 Action。

# boolean的属性并赋值为显示为on/off的图标 #

from django.db import models
    from django.contrib import admin
    
    class Person(models.Model):
        first_name = models.CharField(max_length=50)
        birthday = models.DateField()
    
        def born_in_fifties(self):
            return self.birthday.strftime('%Y')[:3] == '195'
        # 关键在这里
        born_in_fifties.boolean = True
    
    class PersonAdmin(admin.ModelAdmin):
        # 官方文档这里有错，将'name'改为'first_name' 
        list_display = ('first_name', 'born_in_fifties')

# 字段设置颜色 #

from django.db import models
    from django.contrib import admin
    from django.utils.html import format_html
     
    class Person(models.Model):
        first_name = models.CharField(max_length=50)
        last_name = models.CharField(max_length=50)
        color_code = models.CharField(max_length=6)
     
        def colored_name(self):
            return format_html(
                '<span style="color: #{};">{} {}</span>',
                self.color_code,
                self.first_name,
                self.last_name,
            )
     
    class PersonAdmin(admin.ModelAdmin):
        list_display = ('first_name', 'last_name', 'colored_name')

# 页面显示的列 ‘跳转’——显示自定义的html代码 #

# models.py
    class Model(models.Model):
    	......
        def go_to(self):
            from django.utils.safestring import mark_safe
            #mark_safe后就不会转义
            return mark_safe("<a href='https://www.baidu.com/'>跳转</a>")
        go_to.short_description = "跳转"
    # adminx.py
    class ModelAdmin(object):
        list_display = ['go_to']

[Python3]: https://github.com/Escaflowne1985/Django3Tools