10 drf-Xadmin的使用 - 图1

一 Xadmin的使用

xadmin是Django的第三方扩展，可是使Django的admin站点使用更方便。
文档：https://xadmin.readthedocs.io/en/latest/index.html

1.1 安装

通过如下命令安装xadmin的最新版

  1. pip install https://codeload.github.com/sshwsfc/xadmin/zip/django2

在配置文件中注册如下应用

  1. BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
  2. # 把apps目录设置环境变量中的导包路径
  3. sys.path.append( os.path.join(BASE_DIR,"luffy/apps") )
  6. INSTALLED_APPS = [
  7.     ...
  8.     'xadmin',
  9.     'crispy_forms',
  10.     'reversion',
  11.     ...
  12. ]
  14. # 修改使用中文界面
  15. LANGUAGE_CODE = 'zh-Hans'
  17. # 修改时区
  18. TIME_ZONE = 'Asia/Shanghai'

xadmin有建立自己的数据库模型类，需要进行数据库迁移

  1. python manage.py makemigrations
  2. python manage.py migrate

在总路由中添加xadmin的路由信息

  1. import xadmin
  2. xadmin.autodiscover()
  4. # version模块自动注册需要版本控制的 Model
  5. from xadmin.plugins import xversion
  6. xversion.register_models()
  8. urlpatterns = [
  9.     path(r'xadmin/', xadmin.site.urls)
  10. ]

创建超级用户

  1. python manage.py createsuperuser

1.2 使用

  • xadmin不再使用Django的admin.py，而是需要编写代码在adminx.py文件中。
  • xadmin的站点管理类不用继承admin.ModelAdmin，而是直接继承object即可。

例如：在子应用中创建adminx.py文件。

1.2.1 站点的全局配置

  1. import xadmin
  2. from xadmin import views
  4. class BaseSetting(object):
  5.     """xadmin的基本配置"""
  6.     enable_themes = True  # 开启主题切换功能
  7.     use_bootswatch = True
  9. xadmin.site.register(views.BaseAdminView, BaseSetting)
  11. class GlobalSettings(object):
  12.     """xadmin的全局配置"""
  13.     site_title = "路飞学城"  # 设置站点标题
  14.     site_footer = "路飞学城有限公司"  # 设置站点的页脚
  15.     menu_style = "accordion"  # 设置菜单折叠
  17. xadmin.site.register(views.CommAdminView, GlobalSettings)

1.2.2 站点Model管理

xadmin可以使用的页面样式控制基本与Django原生的admin一直。

  • list_display 控制列表展示的字段

    1. list_display = ['id', 'btitle', 'bread', 'bcomment']

  • search_fields 控制可以通过搜索框搜索的字段名称，xadmin使用的是模糊查询

    1. search_fields = ['id','btitle']

  • list_filter 可以进行过滤操作的列，对于分类、性别、状态

    1. list_filter = ['is_delete']

  • ordering 默认排序的字段

  • readonly_fields 在编辑页面的只读字段
  • exclude 在编辑页面隐藏的字段
  • list_editable 在列表页可以快速直接编辑的字段
  • show_detail_fields 在列表页提供快速显示详情信息

  • refresh_times 指定列表页的定时刷新

    1. refresh_times = [5, 10,30,60]  # 设置允许后端管理人员按多长时间(秒)刷新页面

  • list_export 控制列表页导出数据的可选格式

    1. list_export = ('xls', 'xml', 'json')   list_export设置为None来禁用数据导出功能
    2. list_export_fields = ('id', 'btitle', 'bpub_date')

  • show_bookmarks 控制是否显示书签功能

    1. show_bookmarks = True

  • data_charts 控制显示图表的样式

    1. data_charts = {
    2.       "order_amount": {
    3.         'title': '图书发布日期表', 
    4.         "x-field": "bpub_date", 
    5.         "y-field": ('btitle',),
    6.         "order": ('id',)
    7.       },
    8.   #    支持生成多个不同的图表
    9.   #    "order_amount": {
    10.   #      'title': '图书发布日期表', 
    11.   #      "x-field": "bpub_date", 
    12.   #      "y-field": ('btitle',),
    13.   #      "order": ('id',)
    14.   #    },
    15.   }
    • title 控制图标名称
    • x-field 控制x轴字段
    • y-field 控制y轴字段，可以是多个值
    • order 控制默认排序
  • model_icon 控制菜单的图标
    ```python class BookInfoAdmin(object): model_icon = ‘fa fa-gift’

xadmin.site.register(models.BookInfo, BookInfodmin) ```