Django 教程之配置后台管理页面xadmin

Dear 丶 2022-12-27 09:00 590阅读 0赞

admin是django官方提供，这里使用第三方代替，更出色

# 概述 #

项目地址：https://github.com/sshwsfc/xadmin

官方网站：http://sshwsfc.github.io/xadmin/

官方网站：http://www.xadmin.io

当前日期：20190723

当前Django版本1.11，当前xadmin版本0.6.0

参考：https://www.cnblogs.com/lyq-biu/p/9513888.html

# 特性 #

1.  基于Bootstrap3：Xadmin使用Bootstrap3.0框架精心打造。基于Bootstrap3，Xadmin天生就支持在多种屏幕上无缝浏览，并完全支持Bootstrap主题模板，让您的管理后台也动感、多样起来。
2.  内置功能丰富：Xadmin作为一款全面的后台管理系统框架，不仅提供了基本的CRUD功能，还内置了丰富的插件功能。包括数据导出、书签、图表、数据添加向导及图片相册等多种扩展功能。
3.  真心强大的插件系统：Xadmin的插件系统借鉴了其他领域成功框架的设计思想，让插件可以扩展系统的任何一个功能点。对于开发者，Xadmin的插件开发简单；对于使用者，Xadmin的插件安装方便。
4.  后台实际就是对表的增删改查，从某种程度上来讲不依赖于业务逻辑，又可以在后台对每张表管理时加入自己的后台逻辑，这也是它优于很多后台管理系统的原因。

# 安装 #

不推荐使用pip安装

pip install xadmin

推荐使用源码安装，这样可自由定制，如果遇到上面问题，请参考错误记录

1.  从github上下载源码
2.  使用命令安装依赖环境 环境要求

# 注意文件里面的内容，有些可选的选择安装 
    django >=1.9
    django-crispy-forms >=1.6.0 (For xadmin crispy forms)
    django-reversion ([OPTION] For object history and reversion feature, please select right version by your django, see changelog )
    django-formtools ([OPTION] For wizward form)
    xlwt ([OPTION] For export xls files)
    xlsxwriter ([OPTION] For export xlsx files)

将requirement.txt中的django-formtools版本改为2.1，加入requests

django>=1.9.0
    django-crispy-forms>=1.6.0
    django-import-export>=0.5.1
    django-reversion>=2.0.0
    django-formtools==2.1
    future==0.15.2
    httplib2==0.9.2
    six==1.10.0
    requests==2.22.0

安装

# 虚拟环境注意requirements.txt的位置
    pip install -r requirements.txt

1.  将xadmin文件夹复制到项目下apps文件夹内（前面已加）
2.  将apps文件夹路径加入setting.py中（前面已加）
3.  将"xadmin"和"crispy\_forms"在 setting.py中INSTALLED\_APPS下注册

INSTALLED_APPS = [
        'django.contrib.admin',
        'django.contrib.auth',
        'django.contrib.contenttypes',
        'django.contrib.sessions',
        'django.contrib.messages',
        'django.contrib.staticfiles',
        'xadmin',
        'crispy_forms',
    ]

1.  项目urls.py里面import xadmin重写url替代admin

import xadmin
    urlpatterns = [
        url(r'^admin/', xadmin.site.urls),
    ]

1.  xadmin自带默认的表，需要重新makemigrations(生成数据库脚本迁移文件)和migrate(迁移操作生成更新表)，即可在数据库中看到新表
2.  在每一个应用内创建py文件adminx.py老替换admin.py文件，以后配置后台全都更改这里
3.  adminx.py文件中进行后台应用注册同admin，要继承于基类object，Blog是models.py中的函数名

import xadmin
    from .models import Blog
    
    
    @xadmin.sites.register(Blog)
    class BlogAdmin(object):
        pass

或者

import xadmin
    from .models import Blog
    
    
    class BlogAdmin(object):
        pass
        
        
    xadmin.site.register(Blog, BlogAdmin)

我的设置

import xadmin
    from .models import Category, Tag, Article
    
    @xadmin.sites.register(xadmin.views.BaseAdminView)
    class BaseSetting(object):
        enable_themes = True
        use_bootswatch = True
    
    @xadmin.sites.register(xadmin.views.CommAdminView)
    class GlobalSetting(object):
        site_header = 'Django 博客管理后台'
        # 后台页面左上角标题
        site_title = "后台系统"
        # 底部版权显示
        site_footer = "copy right 2019"
        # 左侧列表显示格式(折叠)
        # menu_style = "accordion"
    
    
    
    @xadmin.sites.register(Category)
    class CategoryAdmin(object):
        list_display = ('name', 'id')
    
    @xadmin.sites.register(Tag)
    class TagAdmin(object):
        list_display = ('name', 'id')
    
    @xadmin.sites.register(Article)
    class ArticleAdmin(object):
        list_display = ('id', 'top', 'title', 'category', 'create_date', 'update_date')
        list_display_links = ('title')
        list_per_page = 50  # 控制每页显示的对象数量，默认是100
        style_fields = {'tags': 'm2m_transfer'}  # 给多选增加一个左右添加的框, 选择标签添加到右侧
        search_fields = ['title']  # 搜索
        # 不显示标签功能
        show_bookmarks = False
        # 筛选
        list_filter = ['category', 'update_date', 'top']

1.  在登录后台管理之前需要创建一次数据库迁移

python manage.py makemigrations
    
    python manage.py migrate

1.  在登录后台管理之前需要创建超级用户

python manage.py createsuperuser
    
    # 邮箱可以不写
    # 密码不能小于8位，不能太简单，如adminadmin
    # 可用admin/adminadmin

前面已经设置URL `url(r'^admin/', xadmin.site.urls)`，故使用浏览器登录http://127.0.0.1:8000/admin/

# xadmin添加样式 #

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

<table> 
 <thead> 
  <tr> 
   <th>关键字</th> 
   <th align="center">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>list_display</td> 
   <td align="center">控制列表展示的字段， 可通过__(双下划线)的方式制定搜索关联Model的数据</td> 
  </tr> 
  <tr> 
   <td>list_display_links</td> 
   <td align="center">配置哪些字段可以作为链接，可以点击进入，不写默认list_display的第0个索引，重写只写字段就行</td> 
  </tr> 
  <tr> 
   <td>list_filter</td> 
   <td align="center">可以进行过滤操作的列，可自定义类过滤器 可通过__(双下划线)的方式制定搜索关联Model的数据</td> 
  </tr> 
  <tr> 
   <td>search_fields</td> 
   <td align="center">控制可以通过搜索框搜索的字段名称，xadmin使用的是模糊查询 可通过__(双下划线)的方式制定搜索关联Model的数据</td> 
  </tr> 
  <tr> 
   <td>ordering</td> 
   <td align="center">默认排序的字段</td> 
  </tr> 
  <tr> 
   <td>readonly_fields</td> 
   <td align="center">在编辑页面的只读字段</td> 
  </tr> 
  <tr> 
   <td>exclude</td> 
   <td align="center">在编辑页面隐藏的字段</td> 
  </tr> 
  <tr> 
   <td>list_editable</td> 
   <td align="center">在列表页可以快速直接编辑的字段</td> 
  </tr> 
  <tr> 
   <td>show_detail_fileds</td> 
   <td align="center">在列表页提供快速显示详情信息</td> 
  </tr> 
  <tr> 
   <td>refresh_times</td> 
   <td align="center">指定列表页的定时刷新</td> 
  </tr> 
  <tr> 
   <td>list_export</td> 
   <td align="center">控制列表页导出数据的可选格式</td> 
  </tr> 
  <tr> 
   <td>show_bookmarks</td> 
   <td align="center">控制是否显示书签功能</td> 
  </tr> 
  <tr> 
   <td>data_charts</td> 
   <td align="center">控制显示图标的样式</td> 
  </tr> 
  <tr> 
   <td>model_icon</td> 
   <td align="center">控制菜单的图标</td> 
  </tr> 
  <tr> 
   <td>actions_on_top</td> 
   <td align="center">动作相关的配置，是否展示在顶部</td> 
  </tr> 
  <tr> 
   <td>actions_on_bottom</td> 
   <td align="center">动作相关的配置，是否展示在底部</td> 
  </tr> 
  <tr> 
   <td>save_on_top</td> 
   <td align="center">保存、编辑、编辑并新建按钮是否在顶部展示</td> 
  </tr> 
  <tr> 
   <td>style_fields = {‘tags’: ‘m2m_transfer’} #</td> 
   <td align="center">给多选增加一个左右添加的框, 选择标签添加到右侧</td> 
  </tr> 
 </tbody> 
</table>

https://stackoverflow.com/questions/28076974/django-xadmin-m2m-filter-horizontal-not-working

# xadmin全局配置django xadmin m2m filter\_horizontal not working #

## xadmin配置主题 ##

### 方式一（推荐） ###

应该是在任意一个应用内的adminx.py中进行设置

**这里不使用from xadmin import views是避免和当前目录views歧义，调用时就近调用，其实没影响**

注意注册方式的不同，绑定的是xadmin.views.BaseAdminView类

import xadmin
    
    class BaseSetting(object):
        enable_themes = True
        use_bootswatch = True
        
    xadmin.site.register(xadmin.views.CommAdminView, BaseSetting)

如果出现主题只有默认和bootstrap2，没有其他主题，请查看错误记录

### 方式二 ###

当然你也可以直接修改theme.py文件

大约在21行开始

...
    class ThemePlugin(BaseAdminPlugin):
    
        # enable_themes = False
        enable_themes = True
        # {'name': 'Blank Theme', 'description': '...', 'css': 'http://...', 'thumbnail': '...'}
        user_themes = None
        use_bootswatch = True
        # use_bootswatch = False
        default_theme = static('xadmin/css/themes/bootstrap-xadmin.css')
        bootstrap2_theme = static('xadmin/css/themes/bootstrap-theme.css')
    ...

## 后台页面左上角标题 ##

## 底部版权显示 ##

## 左侧列表显示格式(折叠) ##

应该是在任意一个应用内的adminx.py中进行设置

...
    class GlobalSettings(object):
        # 后台页面左上角标题
        site_title = "后台系统"
        # 底部版权显示
        site_footer = "copy right 2019"
        # 左侧列表显示格式(折叠)
        menu_style = "accordion"
        
    xadmin.site.register(xadmin.views.CommAdminView, GlobalSettings)   
    ...

## 修改左侧列表应用app显示自定义名称 ##

1.  每个应用app内的apps.py在创建app时默认已创建内容，加入verbose\_name

from django.apps import AppConfig
    
    
    class BlogConfig(AppConfig):
        name = 'blog'
        verbose_name = "博客app"

1.  应用内的\_\_init\_\_.py默认为空，加入以下内容

default_app_config = "blog.apps.BlogConfig"

default\_app\_config = 应用名称.apps.APPS文件内的类

## 设置全局图标（暂时没设置过） ##

*  https://www.cnblogs.com/lyq-biu/p/9513888.html

## 设置应用显示名称 ##

*  https://blog.csdn.net/weixin\_43330769/article/details/88805174

# 错误记录 #

## ModuleNotFoundError: No module named ‘requests’ ##

pip install requests

## ModuleNotFoundError: No module named ‘django.contrib.formtools’ ##

django-formtools 的版本是1.0太低了，卸载后安装新版本

pip install django-formtools==2.1

参考：https://www.cnblogs.com/haiton/p/11224987.html

## wizard.py报错，删除一个逗号，已不能复现，先记录下 ##

可能升级django-formtools版本就可以解决了

## 配置主题后发现主题只有默认和bootstrap2，没有其他主题 ##

*  原因是：use\_bootswatch = True 没有生效
 *  解决办法：找到 /apps\_extend/xadmin/plugins/themes.py
 *  大约在77行，将下面的content行注释掉

修改前

...
    if six.PY3:
        content = content.text.decode()
    watch_themes = json.loads(content.text)['themes']
    ...

修改后

...
    if six.PY3:
        # content = content.text.decode()
        pass
    watch_themes = json.loads(content.text)['themes']
    ...

## 登录之后出现no such table: xadmin\_usersettings ##

python manage.py makemigrations
    python manage.py migrate

## NOT NULL constraint failed: blog\_category.owner\_id ##

问题描述：非空约束错误

解决方法：重写ModelAdmin的save\_model方法

xadmin

def save_models(self):
        obj = self.new_obj
        request = self.request
        obj.owner = request.user
        # 建议直接save，super在py2和py3中用法不同
        # return同obj.save() ，必须返回
        # return super().save_models()   # python3
        # return super(CategoryAdmin, self).save_models() # python2
        obj.save()

admin

def save_model(self, request, obj, form, change):
        obj.owner = request.user
        # python2    reture super(CategoryAdmin, self).save_model(request, obj, form, change)
        # python3    reture super().save_model(request, obj, form, change)
        obj.save()