xadmin與django-rest-framework的集成（1）

什麼是xadmin?什麼是django-rest-framework？

　　xadmin是開源的一個相似於django自帶的後臺管理系統admin的開源模塊，它基於bootstrap3框架,內置強大的插件系統,根據項目需求能夠自定義擴展，它比admin功能更加豐富，更加便於咱們項目的開發。

　　關於django-rest-framework是基於restful API標準而開發的一套針對django框架的api框架，做爲目前流行的先後端分離架構，django-rest-framework經過強大的標準api接口,以及api文檔自動撰寫功能等對咱們後端項目開發就是一種福音.

搭建開發環境

本次演示基於python3.6，django2.0（目前xadmin已經支持django2.0+)

建立虛擬環境並激活進入虛擬環境

virtualenv xadminenv
source xadminenv/bin/active

進入python環境能夠看到，咱們虛擬環境默認安裝的python環境爲3.6的

安裝django，這裏咱們加上豆瓣源，https://pypi.douban.com/simple/

pip3 install -i https://pypi.douban.com/simple/ django

使用pip list命令能夠看到，我使用的django爲2.0版本

建立項目

建立項目目錄

django-admin startproject myproj

項目結構以下：

myproj / 
    manage.py 
    myproj / 
        __init__ .py 
        setting.py 
        url.py 
        wsgi.PY

關於django的其它用法見個人關於django使用的文章，這裏咱們着重研究xadmin的使用

下面幾步僅僅是爲了演示需求

咱們建立幾個應用

python manage.py startapp users
python manage.py startapp trade
python manage.py startapp goods
python manage.py startapp user_operateion

咱們在manage.py同級建立一個apps的文件夾用於存放咱們的各個應用，同時建立一個extra_apps用於存放第三方包，將咱們的應用放入相應的包

settings.py配置

import os
import sys

# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.insert(0,os.path.join(BASE_DIR,'apps'))      #將應用包加入系統變量，便於模塊導入
sys.path.insert(0,os.path.join(BASE_DIR,'extra_apps'))


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = ')57n02l@w9p9)g(47pcp6+uofk$&-a_eqburb%r2n$#w751^fa'

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

ALLOWED_HOSTS = []


# Application definition

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'users',      #註冊app
    'goods',
    'trade',
    'user_operation',
]

一切就緒，編寫咱們的model

users/models.py

 1 from datetime import datetime
 2 
 3 from django.db import models
 4 from django.contrib.auth.models import AbstractUser
 5 
 6 # Create your models here.
 7 
 8 
 9 class UserProfile(AbstractUser):
10     """
11     用戶
12     """
13     name = models.CharField(max_length=30, null=True, blank=True, verbose_name="姓名")
14     birthday = models.DateField(null=True, blank=True, verbose_name="出生年月")
15     gender = models.CharField(max_length=6, choices=(("male", u"男"), ("female", "女")), default="female", verbose_name="性別")
16     mobile = models.CharField(null=True, blank=True, max_length=11, verbose_name="電話")
17     email = models.EmailField(max_length=100, null=True, blank=True, verbose_name="郵箱")
18 
19     class Meta:
20         verbose_name = "用戶"
21         verbose_name_plural = verbose_name
22 
23     def __str__(self):
24         return self.username
25 
26 
27 class VerifyCode(models.Model):
28     """
29     短信驗證碼
30     """
31     code = models.CharField(max_length=10, verbose_name="驗證碼")
32     mobile = models.CharField(max_length=11, verbose_name="電話")
33     add_time = models.DateTimeField(default=datetime.now, verbose_name="添加時間")
34 
35     class Meta:
36         verbose_name = "短信驗證碼"
37         verbose_name_plural = verbose_name
38 
39     def __str__(self):
40         return self.code

goos/models.py

  1 from datetime import datetime
  2 
  3 from django.db import models
  4 from DjangoUeditor.models import UEditorField
  5 # Create your models here.
  6 
  7 
  8 class GoodsCategory(models.Model):
  9     """
 10     商品類別
 11     """
 12     CATEGORY_TYPE = (
 13         (1, "一級類目"),
 14         (2, "二級類目"),
 15         (3, "三級類目"),
 16     )
 17 
 18     name = models.CharField(default="", max_length=30, verbose_name="類別名", help_text="類別名")
 19     code = models.CharField(default="", max_length=30, verbose_name="類別code", help_text="類別code")
 20     desc = models.TextField(default="", verbose_name="類別描述", help_text="類別描述")
 21     category_type = models.IntegerField(choices=CATEGORY_TYPE, verbose_name="類目級別", help_text="類目級別")
 22     parent_category = models.ForeignKey("self", null=True, blank=True, verbose_name="父類目級別", help_text="父目錄",
 23                                         related_name="sub_cat",on_delete=models.CASCADE)
 24     is_tab = models.BooleanField(default=False, verbose_name="是否導航", help_text="是否導航")
 25     add_time = models.DateTimeField(default=datetime.now, verbose_name="添加時間")
 26 
 27     class Meta:
 28         verbose_name = "商品類別"
 29         verbose_name_plural = verbose_name
 30 
 31     def __str__(self):
 32         return self.name
 33 
 34 
 35 class GoodsCategoryBrand(models.Model):
 36     """
 37     品牌名
 38     """
 39     category = models.ForeignKey(GoodsCategory, related_name='brands', null=True, blank=True, verbose_name="商品類目",on_delete=models.CASCADE)
 40     name = models.CharField(default="", max_length=30, verbose_name="品牌名", help_text="品牌名")
 41     desc = models.TextField(default="", max_length=200, verbose_name="品牌描述", help_text="品牌描述")
 42     image = models.ImageField(max_length=200, upload_to="brands/")
 43     add_time = models.DateTimeField(default=datetime.now, verbose_name="添加時間")
 44 
 45     class Meta:
 46         verbose_name = "品牌"
 47         verbose_name_plural = verbose_name
 48         db_table = "goods_goodsbrand"
 49 
 50     def __str__(self):
 51         return self.name
 52 
 53 
 54 class Goods(models.Model):
 55     """
 56     商品
 57     """
 58     category = models.ForeignKey(GoodsCategory, verbose_name="商品類目",on_delete=models.CASCADE)
 59     goods_sn = models.CharField(max_length=50, default="", verbose_name="商品惟一貨號")
 60     name = models.CharField(max_length=100, verbose_name="商品名")
 61     click_num = models.IntegerField(default=0, verbose_name="點擊數")
 62     sold_num = models.IntegerField(default=0, verbose_name="商品銷售量")
 63     fav_num = models.IntegerField(default=0, verbose_name="收藏數")
 64     goods_num = models.IntegerField(default=0, verbose_name="庫存數")
 65     market_price = models.FloatField(default=0, verbose_name="市場價格")
 66     shop_price = models.FloatField(default=0, verbose_name="本店價格")
 67     goods_brief = models.TextField(max_length=500, verbose_name="商品簡短描述")
 68     goods_desc = UEditorField(verbose_name=u"內容", imagePath="goods/images/", width=1000, height=300,
 69                               filePath="goods/files/", default='')
 70     ship_free = models.BooleanField(default=True, verbose_name="是否承擔運費")
 71     goods_front_image = models.ImageField(upload_to="goods/images/", null=True, blank=True, verbose_name="封面圖")
 72     is_new = models.BooleanField(default=False, verbose_name="是否新品")
 73     is_hot = models.BooleanField(default=False, verbose_name="是否熱銷")
 74     add_time = models.DateTimeField(default=datetime.now, verbose_name="添加時間")
 75 
 76     class Meta:
 77         verbose_name = '商品'
 78         verbose_name_plural = verbose_name
 79 
 80     def __str__(self):
 81         return self.name
 82 
 83 
 84 class IndexAd(models.Model):
 85     category = models.ForeignKey(GoodsCategory, related_name='category',verbose_name="商品類目",on_delete=models.CASCADE)
 86     goods =models.ForeignKey(Goods, related_name='goods',on_delete=models.CASCADE)
 87 
 88     class Meta:
 89         verbose_name = '首頁商品類別廣告'
 90         verbose_name_plural = verbose_name
 91 
 92     def __str__(self):
 93         return self.goods.name
 94 
 95 
 96 class GoodsImage(models.Model):
 97     """
 98     商品輪播圖
 99     """
100     goods = models.ForeignKey(Goods, verbose_name="商品", related_name="images",on_delete=models.CASCADE)
101     image = models.ImageField(upload_to="", verbose_name="圖片", null=True, blank=True)
102     add_time = models.DateTimeField(default=datetime.now, verbose_name="添加時間")
103 
104     class Meta:
105         verbose_name = '商品圖片'
106         verbose_name_plural = verbose_name
107 
108     def __str__(self):
109         return self.goods.name
110 
111 
112 class Banner(models.Model):
113     """
114     輪播的商品
115     """
116     goods = models.ForeignKey(Goods, verbose_name="商品",on_delete=models.CASCADE)
117     image = models.ImageField(upload_to='banner', verbose_name="輪播圖片")
118     index = models.IntegerField(default=0, verbose_name="輪播順序")
119     add_time = models.DateTimeField(default=datetime.now, verbose_name="添加時間")
120 
121     class Meta:
122         verbose_name = '輪播商品'
123         verbose_name_plural = verbose_name
124 
125     def __str__(self):
126         return self.goods.name
127 
128 
129 class HotSearchWords(models.Model):
130     """
131     熱搜詞
132     """
133     keywords = models.CharField(default="", max_length=20, verbose_name="熱搜詞")
134     index = models.IntegerField(default=0, verbose_name="排序")
135     add_time = models.DateTimeField(default=datetime.now, verbose_name="添加時間")
136 
137     class Meta:
138         verbose_name = '熱搜詞'
139         verbose_name_plural = verbose_name
140 
141     def __str__(self):
142         return self.keywords

trade/models.py

 1 from datetime import datetime
 2 
 3 from django.db import models
 4 from django.contrib.auth import get_user_model
 5 
 6 from goods.models import Goods
 7 User = get_user_model()
 8 # Create your models here.
 9 
10 
11 class ShoppingCart(models.Model):
12     """
13     購物車
14     """
15     user = models.ForeignKey(User, verbose_name=u"用戶",on_delete=models.CASCADE)
16     goods = models.ForeignKey(Goods, verbose_name=u"商品",on_delete=models.CASCADE)
17     nums = models.IntegerField(default=0, verbose_name="購買數量")
18 
19     add_time = models.DateTimeField(default=datetime.now, verbose_name=u"添加時間")
20 
21     class Meta:
22         verbose_name = '購物車'
23         verbose_name_plural = verbose_name
24         unique_together = ("user", "goods")
25 
26     def __str__(self):
27         return "%s(%d)".format(self.goods.name, self.nums)
28 
29 
30 class OrderInfo(models.Model):
31     """
32     訂單
33     """
34     ORDER_STATUS = (
35         ("TRADE_SUCCESS", "成功"),
36         ("TRADE_CLOSED", "超時關閉"),
37         ("WAIT_BUYER_PAY", "交易建立"),
38         ("TRADE_FINISHED", "交易結束"),
39         ("paying", "待支付"),
40     )
41 
42     user = models.ForeignKey(User, verbose_name="用戶",on_delete=models.CASCADE)
43     order_sn = models.CharField(max_length=30, null=True, blank=True, unique=True, verbose_name="訂單號")
44     trade_no = models.CharField(max_length=100, unique=True, null=True, blank=True, verbose_name=u"交易號")
45     pay_status = models.CharField(choices=ORDER_STATUS, default="paying", max_length=30, verbose_name="訂單狀態")
46     post_script = models.CharField(max_length=200, verbose_name="訂單留言")
47     order_mount = models.FloatField(default=0.0, verbose_name="訂單金額")
48     pay_time = models.DateTimeField(null=True, blank=True, verbose_name="支付時間")
49 
50     # 用戶信息
51     address = models.CharField(max_length=100, default="", verbose_name="收貨地址")
52     signer_name = models.CharField(max_length=20, default="", verbose_name="簽收人")
53     singer_mobile = models.CharField(max_length=11, verbose_name="聯繫電話")
54 
55     add_time = models.DateTimeField(default=datetime.now, verbose_name="添加時間")
56 
57     class Meta:
58         verbose_name = u"訂單"
59         verbose_name_plural = verbose_name
60 
61     def __str__(self):
62         return str(self.order_sn)
63 
64 class OrderGoods(models.Model):
65     """
66     訂單的商品詳情
67     """
68     order = models.ForeignKey(OrderInfo, verbose_name="訂單信息", related_name="goods",on_delete=models.CASCADE)
69     goods = models.ForeignKey(Goods, verbose_name="商品",on_delete=models.CASCADE)
70     goods_num = models.IntegerField(default=0, verbose_name="商品數量")
71 
72     add_time = models.DateTimeField(default=datetime.now, verbose_name="添加時間")
73 
74     class Meta:
75         verbose_name = "訂單商品"
76         verbose_name_plural = verbose_name
77 
78     def __str__(self):
79         return str(self.order.order_sn)

user_operation/models.py

from datetime import datetime

from django.db import models
from django.contrib.auth import get_user_model

from goods.models import Goods
# Create your models here.
User = get_user_model()


class UserFav(models.Model):
    """
    用戶收藏
    """
    user = models.ForeignKey(User, verbose_name="用戶",on_delete=models.CASCADE)
    goods = models.ForeignKey(Goods, verbose_name="商品", help_text="商品id",on_delete=models.CASCADE)
    add_time = models.DateTimeField(default=datetime.now, verbose_name=u"添加時間")

    class Meta:
        verbose_name = '用戶收藏'
        verbose_name_plural = verbose_name
        unique_together = ("user", "goods")

    def __str__(self):
        return self.user.username


class UserLeavingMessage(models.Model):
    """
    用戶留言
    """
    MESSAGE_CHOICES = (
        (1, "留言"),
        (2, "投訴"),
        (3, "詢問"),
        (4, "售後"),
        (5, "求購")
    )
    user = models.ForeignKey(User, verbose_name="用戶",on_delete=models.CASCADE)
    message_type = models.IntegerField(default=1, choices=MESSAGE_CHOICES, verbose_name="留言類型",
                                      help_text=u"留言類型: 1(留言),2(投訴),3(詢問),4(售後),5(求購)")
    subject = models.CharField(max_length=100, default="", verbose_name="主題")
    message = models.TextField(default="", verbose_name="留言內容", help_text="留言內容")
    file = models.FileField(upload_to="message/images/", verbose_name="上傳的文件", help_text="上傳的文件")
    add_time = models.DateTimeField(default=datetime.now, verbose_name="添加時間")

    class Meta:
        verbose_name = "用戶留言"
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.subject


class UserAddress(models.Model):
    """
    用戶收貨地址
    """
    user = models.ForeignKey(User, verbose_name="用戶" ,on_delete=models.CASCADE)
    province = models.CharField(max_length=100, default="", verbose_name="省份")
    city = models.CharField(max_length=100, default="", verbose_name="城市")
    district = models.CharField(max_length=100, default="", verbose_name="區域")
    address = models.CharField(max_length=100, default="", verbose_name="詳細地址")
    signer_name = models.CharField(max_length=100, default="", verbose_name="簽收人")
    signer_mobile = models.CharField(max_length=11, default="", verbose_name="電話")
    add_time = models.DateTimeField(default=datetime.now, verbose_name="添加時間")

    class Meta:
        verbose_name = "收貨地址"
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.address

模型編寫完成，設置一下咱們的數據庫配置，我這裏使用mysql

myproj/settings.py

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'myproj',
        'USER':'root',
        'PASSWORD':'123456',
        'HOST':'localhost',
        'POSRT':'3306',
        'OPTIONS': {
           'init_command': 'SET default_storage_engine=INNODB',
        }
    }
}

AUTH_USER_MODEL = 'users.UserProfile'    #因爲咱們在users/models.py繼承了django的AbstractUser，因此須要在settings.py中指定咱們自定義的user模型,不然建立模型會報E304錯誤

執行如下命令，生成咱們的數據庫遷移腳本並生成數據庫模型

python manage.py makemigrations
python mange.py migrate

若是報錯，顯示如下錯誤信息

由於咱們未安裝數據庫鏈接驅動

pip3 install -i https://pypi.douban.com/simple/ mysqlclient

編輯myproj/__init__.py

import pymysql

pymysql.install_as_MySQLdb()   #由於mysqldb不支持3.5及以上版本，這裏咱們使用pymysql,這句話意思是將pymysql包傳入mysqldb進行初始化

 此時仍然報錯，由於咱們在建立goods/models.py裏面的模型時候，使用了DjangoUeditorapp，但咱們實際上還未導入這個包,由於這個屬於第三方包，咱們使用源碼導入，並將其放置在extra_apps目錄下,源碼下載路徑:http://ueditor.baidu.com/website/ 

在myproj/settings.py中註冊此app

此時再執行數據庫遷移命令，以下

此時，數據庫遷移模型已經生成，咱們只需再執行migrate命令同步數據庫便可

此時數據庫中已經有咱們的數據表模型了

 

以上步驟都完成之後就能夠開始着手建立系統管理後臺了，關於django自帶的admin這裏再也不闡述，咱們直接開始xadmin的集成

xadmin的集成

導入xadmin，這裏咱們選擇源碼導入，https://github.com/sshwsfc/xadmin/tree/django2下載django2對應的源碼到本地，將xadmin文件夾總體拷貝到咱們的extra_apps目錄下,並在settings.py文件中註冊

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'users',      #註冊app
    'goods',
    'trade',
    'user_operation',
    'DjangoUeditor',
    'xadmin'   #註冊xadmin
]

根據xadmin源碼，因爲xadmin模塊須要依賴其它包，咱們在這裏一一安裝

pip3 install -i https://pypi.douban.com/simple/ django-crispy-forms>=1.6.0 django-import-export>=0.5.1 django-reversion>=2.0.0 django-formtools==2.0 future==0.15.2 httplib2==0.9.2 six==1.10.0

在settings.py中註冊crispy_forms

建立超級管理員

python manage.py createsuperuser

配置xadminurl

import xadmin

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

配置完以後，須要同步如下數據庫，生成xadmin須要的數據庫表

此時，運行項目,訪問，localhost:8000/xadmin

 

 

 至此，咱們的xadmin後臺就初步搭建完成了，下面咱們註冊咱們的各個app項目

在以前apps下面的app中分別建立adminx.py文件,裏面用來定義xadmin的定製類

users/adminx.py

#!/usr/bin/env python
# encoding: utf-8

import xadmin
from xadmin import views
from .models import VerifyCode


class BaseSetting(object):
    enable_themes = True
    use_bootswatch = True


class GlobalSettings(object):    
    site_title = "後臺管理"      #設置頭標題
    site_footer = "shopping center"      #設置腳標題
    # menu_style = "accordion"


class VerifyCodeAdmin(object):
    list_display = ['code', 'mobile', "add_time"]


xadmin.site.register(VerifyCode, VerifyCodeAdmin)
xadmin.site.register(views.BaseAdminView, BaseSetting)
xadmin.site.register(views.CommAdminView, GlobalSettings)

goos/adminx.py

#!/usr/bin/env python
# encoding: utf-8
import xadmin
from .models import Goods, GoodsCategory, GoodsImage, GoodsCategoryBrand, Banner, HotSearchWords
from .models import IndexAd

class GoodsAdmin(object):
    list_display = ["name", "click_num", "sold_num", "fav_num", "goods_num", "market_price",
                    "shop_price", "goods_brief", "goods_desc", "is_new", "is_hot", "add_time"]
    search_fields = ['name', ]
    list_editable = ["is_hot", ]
    list_filter = ["name", "click_num", "sold_num", "fav_num", "goods_num", "market_price",
                   "shop_price", "is_new", "is_hot", "add_time", "category__name"]
    style_fields = {"goods_desc": "ueditor"}

    class GoodsImagesInline(object):
        model = GoodsImage
        exclude = ["add_time"]
        extra = 1
        style = 'tab'

    inlines = [GoodsImagesInline]


class GoodsCategoryAdmin(object):
    list_display = ["name", "category_type", "parent_category", "add_time"]
    list_filter = ["category_type", "parent_category", "name"]
    search_fields = ['name', ]


class GoodsBrandAdmin(object):
    list_display = ["category", "image", "name", "desc"]

    def get_context(self):
        context = super(GoodsBrandAdmin, self).get_context()
        if 'form' in context:
            context['form'].fields['category'].queryset = GoodsCategory.objects.filter(category_type=1)
        return context


class BannerGoodsAdmin(object):
    list_display = ["goods", "image", "index"]


class HotSearchAdmin(object):
    list_display = ["keywords", "index", "add_time"]


class IndexAdAdmin(object):
    list_display = ["category", "goods"]


xadmin.site.register(Goods, GoodsAdmin)
xadmin.site.register(GoodsCategory, GoodsCategoryAdmin)
xadmin.site.register(Banner, BannerGoodsAdmin)
xadmin.site.register(GoodsCategoryBrand, GoodsBrandAdmin)

xadmin.site.register(HotSearchWords, HotSearchAdmin)
xadmin.site.register(IndexAd, IndexAdAdmin)

trade/adminx.py

# -*- coding: utf-8 -*-
__author__ = 'bobby'

import xadmin
from .models import ShoppingCart, OrderInfo, OrderGoods

class ShoppingCartAdmin(object):
    list_display = ["user", "goods", "nums", ]


class OrderInfoAdmin(object):
    list_display = ["user", "order_sn",  "trade_no", "pay_status", "post_script", "order_mount",
                    "order_mount", "pay_time", "add_time"]

    class OrderGoodsInline(object):
        model = OrderGoods
        exclude = ['add_time', ]
        extra = 1
        style = 'tab'

    inlines = [OrderGoodsInline, ]


xadmin.site.register(ShoppingCart, ShoppingCartAdmin)
xadmin.site.register(OrderInfo, OrderInfoAdmin)

user_operation/adminx.py

#!/usr/bin/env python
# encoding: utf-8
import xadmin
from .models import UserFav, UserLeavingMessage, UserAddress


class UserFavAdmin(object):
    list_display = ['user', 'goods', "add_time"]


class UserLeavingMessageAdmin(object):
    list_display = ['user', 'message_type', "message", "add_time"]


class UserAddressAdmin(object):
    list_display = ["signer_name", "signer_mobile", "district", "address"]

xadmin.site.register(UserFav, UserFavAdmin)
xadmin.site.register(UserAddress, UserAddressAdmin)
xadmin.site.register(UserLeavingMessage, UserLeavingMessageAdmin)

 

 

到此，咱們的項目app都已經集成到xadmin後臺中,至於xadmin自定義字段表示的意思，能夠查詢相關文檔