Django-Xadmin

xadmin是Django的第三方擴展，比使用Django的admin站點更強大也更方便。

文檔：https://xadmin.readthedocs.io/en/latest/index.html

一. 安裝

　　通過如下命令安裝xadmin的最新版

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

　　下載完成后，在配置文件中注冊如下應用

# Application definition

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

    'xadmin',
    'crispy_forms',
    'reversion',

    'app01.apps.App01Config',
]

# 修改使用中文界面
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

二. 使用

• xadmin不再使用Django的admin.py，而是需要編寫代碼在adminx.py文件中。

• xadmin的站點管理類不用繼承 admin.ModelAdmin，而是直接繼承object即可。

　　例如：在子應用中創建adminx.py文件。（注意：不要創建xadmin.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一致。

from .models import Book


class BookAdminModel(object):
    # 控制列表展示的字段 設置默認展示字段
    list_display = ['title', 'price', 'pub_date', 'publish', 'authors']  
    # 控制可以通過搜索框搜索的字段名稱，xadmin使用的是模糊查詢
    search_fields = ['id', 'title', 'price']  
    # 可以進行過濾操作的列，對於分類、性別、狀態
    list_filter = ['id', 'title', 'price', 'publish']  
    # 排序，默認升序
    ordering = ['-price']  
    # 展示詳情信息的字段
    show_detail_fields = ['title']  
    # 設置允許直接在展示頁編輯的字段
    list_editable = ['price']  
    # 設置列表頁的刷新頻率
    refresh_times = [3, 6, 30, 60]  
    # 控制列表頁導出數據的可選格式，設置None來禁用數據導出功能
    list_export = ['xls', 'csv', 'json']  
    # 控制是否顯示書簽功能，False表示關閉
    show_bookmarks = True  
    # 顯示圖表數據
    data_charts = {
        'price_total': {
            'title': '書籍單價曲線圖',
            'x-field': 'id',
            'y-field': 'price',
            'order': ('id',),
        },
        # 可以有多個圖表
        # 'price_total2': {
        #     'title': '書籍單價曲線圖2',
        #     'x-field': 'id',
        #     'y-field': 'price',
        #     'order': ('id',),
        # }
    }
    # 控制菜單的圖標（圖標的設置可以參考boostrap的圖標css名稱）
    model_icon = 'fa fa-gift'
    # 設置編輯頁中只讀字段
    readonly_fields = ['title']
    # 設置在編輯頁隱藏的字段
    exclude = ['pub_date']


xadmin.site.register(Book, BookAdminModel)