xadmin站点管理类
9. Xadmin
xadmin是Django的第三方扩展，比使用Django的admin站点更强大也更方便。
文档：https://xadmin.readthedocs.io/en/latest/index.html
9.1. 安装
通过如下命令安装xadmin的最新版
pip install https://codeload.github.com/sshwsfc/xadmin/zip/django2
在配置文件中注册如下应用
INSTALLED_APPS = [ ... 'xadmin', 'crispy_forms', 'reversion', ... ] # 修改使用中文界面 LANGUAGE_CODE = 'zh-Hans' # 修改时区 TIME_ZONE = 'Asia/Shanghai'
xadmin有建立自己的数据库模型类，需要进行数据库迁移
python manage.py makemigrations
python manage.py migrate
在总路由中添加xadmin的路由信息
import xadmin xadmin.autodiscover() # version模块自动注册需要版本控制的 Model from xadmin.plugins import xversion xversion.register_models() urlpatterns = [ path(r'xadmin/', xadmin.site.urls), ]
如果之前没有创建超级用户，需要创建，如果有了，则可以直接使用之前的。
python manage.py createsuperuser
9.2. 使用
-
xadmin不再使用Django的admin.py，而是需要编写代码在adminx.py文件中。
-
xadmin的站点管理类不用继承
admin.ModelAdmin，而是直接继承
例如：在子应用中创建adminx.py文件。
站点的全局配置
import xadmin from xadmin import views class BaseSetting(object): """xadmin的基本配置""" enable_themes = True # 开启主题切换功能 use_bootswatch = True xadmin.site.register(views.BaseAdminView, BaseSetting) class GlobalSettings(object): """xadmin的全局配置""" site_title = "路飞学城" # 设置站点标题 site_footer = "路飞学城有限公司" # 设置站点的页脚 menu_style = "accordion" # 设置菜单折叠 xadmin.site.register(views.CommAdminView, GlobalSettings)
站点Model管理
xadmin可以使用的页面样式控制基本与Django原生的admin一直。
-
list_display 控制列表展示的字段
list_display = ['id', 'btitle', 'bread', 'bcomment'] -
search_fields 控制可以通过搜索框搜索的字段名称，xadmin使用的是模糊查询
search_fields = ['id','btitle'] -
list_filter 可以进行过滤操作的列，对于分类、性别、状态
list_filter = ['is_delete'] -
ordering 默认排序的字段
-
show_detail_fields 在列表页提供快速显示详情信息
-
list_editable 在列表页可以快速直接编辑的字段
-
refresh_times 指定列表页的定时刷新
refresh_times = [5, 10,30,60] # 设置允许后端管理人员按多长时间(秒)刷新页面
-
list_export 控制列表页导出数据的可选格式
list_export = ('xls', 'xml', 'json') list_export设置为None来禁用数据导出功能
list_export_fields = ('id', 'btitle', 'bpub_date') -
show_bookmarks 控制是否显示书签功能
show_bookmarks = True -
data_charts 控制显示图表的样式
data_charts = {
"order_amount": {
'title': '图书发布日期表',
"x-field": "bpub_date",
"y-field": ('btitle',),
"order": ('id',)
},
# 支持生成多个不同的图表
# "order_amount": {
# 'title': '图书发布日期表',
# "x-field": "bpub_date",
# "y-field": ('btitle',),
# "order": ('id',)
# },
}-
title 控制图标名称
-
x-field 控制x轴字段
-
y-field 控制y轴字段，可以是多个值
-
order 控制默认排序
-
-
model_icon 控制菜单的图标【图标的设置可以参考bootstrap的图标css名称】
class BookInfoAdmin(object):
model_icon = 'fa fa-gift'
xadmin.site.register(models.BookInfo, BookInfodmin) -
readonly_fields 在编辑页面的只读字段
-
exclude 在编辑页面隐藏的字段
# 在每一个子应用的adminx.py文件中对xadmin站点的功能进行配置 import xadmin from xadmin import views class BaseSetting(object): """xadmin的基本配置""" enable_themes = True # 开启主题切换功能 use_bootswatch = True # 引导控制菜单盘 xadmin.site.register(views.BaseAdminView, BaseSetting) class GlobalSettings(object): """xadmin的全局配置""" site_title = "路飞学城" # 设置站点标题 site_footer = "路飞学城有限公司" # 设置站点的页脚 menu_style = "accordion" # 设置菜单折叠 xadmin.site.register(views.CommAdminView, GlobalSettings) from .models import Student class StudentAdminModel(object): # 设置默认展示在列表中的字段 list_display = ["id","name","sex","age"] # 设置允许用于进行搜索查询的字段 search_fields = ['age', 'name',"id"] # 过滤 list_filter = ["age","sex"] # 默认排序[第一排序,第二排序字段...] ordering = ["-age"] # -age 表示倒序 # 展示详情信息的字段 show_detail_fields = ["id"] # 设置允许直接在编辑页直接编辑的字段 list_editable = ["name","age"] # 设置列表页的刷新频率 refresh_times = [2,3,5,10,30,60] # 设置导出数据格式 list_export = ['xls', 'csv', 'json'] # 设置是否启用书签功能 show_bookmarks = True # 显示图表数据 data_charts = { "age_total": { 'title': '学生年龄段统计表', "x-field": 'id', "y-field": ('age'), "order": ('id',) }, "age_total2": { 'title': '学生年龄段统计表2', "x-field": 'id', "y-field": ('age'), "order": ('id',) }, } # 设置自定义的模型菜单图标 model_icon = "fa fa-road" # 设置编辑页中只读字段 readonly_fields = ["age"] # 设置咋已编辑页隐藏的字段 exclude = ["sex"] xadmin.site.register(Student, StudentAdminModel)
