Django快速开发实践:Drf框架和xadmin配置指北

步骤

既然是快速开发,那废话不多说,直接说步骤:

  • 安装 Djagno
  • 安装 Django Rest Framework
  • 定义 models
  • 定义 Rest framework 的 serializers
  • 定义 Rest framework 的 viewsets
  • 配置 Rest framework 的 router
  • 配置管理后台 admin
  • 根据需要写 template 和对应的 view

经过这些步骤就能得到一个具备完整的后端接口和后台管理界面的网站了,如果写了 template 的话还能把前端的工作也做了。

接下来按照上面提到的顺序记录一下我的开发实践。

定义 models

好像没啥好说的,Django3 多了几个新的特性,可以用 class 来定义 choices,这个比以前的元组定义方便一些,其他的好像没什么了,对了,定义 ManyToMany 最好设置一个 related_name,方便以后在代码里做反向查询。

定义 serializers

这个很简单,只要告诉框架你需要序列化 model 的哪个字段就好了。 官方文档:django-rest-framework.org[1]

代码例子如下:

from .models import *
from rest_framework import serializers

class StudentSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = ['name', 'gender', 'number', 'faculty', 'major', 'year']

附上这个 Student 的 model 代码:

class Student(models.Model):
    name = models.CharField('姓名', max_length=10)
    gender = models.IntegerField('性别', default=1, choices=GenderChoices)
    number = models.CharField('学号', max_length=20, blank=True)
    faculty = models.CharField('学院', max_length=20, blank=True)
    major = models.CharField('专业', max_length=20, blank=True)
    year = models.CharField('届别', max_length=4)

    def __str__(self):
        return self.name

定义 viewsets

就是把 queryset 和 serializers 关联起来。

贴一下代码,对应上面的 student 的 serializers。

from rest_framework import viewsets
from .models import *
from .serializers import *

class StudentViewSet(viewsets.ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentSerializer

配置 router

可以理解为 Rest Framework 的 urls 配置。

代码:

from rest_framework import routers
from core import views

router = routers.DefaultRouter()
router.register('user', views.UserViewSet)

然后再加入 Django 的 urls 配置中:

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include(router.urls)),  # 这里
    path('api-auth/', include('rest_framework.urls')),  # 和这里
]

干净利索,这个 router 应该和 urls 一样能嵌套的,不过我没有深入学 Rest Framework,所以没有了解到,以后有需要再查一下文档。

关于 drf 的简单参考文档:

配置管理后台 admin

其实这一步也可以放在前面,就是刚定义完 models 的时候就配置,这样方便管理数据。

Django 自带的这个 admin 可以说很强大了,可以省去很多中小型网站的管理后台开发工作,不过默认的界面是比较丑的,这个用过的人都懂,但是又想用,怎么办?所以要进行美化啊,以前我只知道 xadmin 这个库,国人开发的,基于 bootstrap3 界面,重写了整套 admin 代码,界面好看了不少,无奈有很多 bug,文档又几乎是没有的,很多功能实现都只能去看代码,体验极差,严重影响开发效率……(但是为了界面好看我一开始还是只能用这个了) 关于 Django 配置详情可以看刘江大大的博客,很详细,在我下面的第一个参考链接里面~

界面效果大概这样:


然后我又发现了一个新的 xadmin 替代品,叫 simpleui,号称 vue+element ui 写的,界面也不错,实际体验嘛,emmm……和 xadmin 互有千秋。不过这货搞了个 pro 版本,也就是付费版,所以开源免费版这个能用就偷着乐了,你懂的。

界面如下,还可以换主题。


有兴趣请看看官方 github:github.com/newpanjing/s[4]

安装 xadmin

现在 Django-xadmin 好像已经不维护了,至少在 github 上看到是作者去写纯前端的 xadmin 框架了,然后安装起来也是一波三折,你直接在 pip 安装也不行,因为那个是 xadmin 的 0.x 版本,支持的是 Django1.x 的,要安装 xadmin 的 django2 分支,才能支持 Django2.x,然后我一开始用上 Django3,貌似这货还和 Django3 有兼容问题……

那到底怎么安装才好啊?简单点的方法就是官方 github 说的:

pip install git+git://github.com/sshwsfc/xadmin.git@django2

不过这个方法我有时候可以有时候不行,好像是 github 被屏蔽了吧,唉,所以还有别的方法,就是安装打包好的 wheel 文件,从 xadmin 官方仓库把代码下载下来,然后 checkout 到 django2 分支,再运行命令打包成 wheel 文件,接着就可以拿去 pip 安装了,有空我上传到 pypi,方便一下有需要的同学。

安装完运行可能还会报错:TypeError: render() got an unexpected keyword argument 'renderer',原因是集成 DjangoUeditor 时出错,需要需要修改虚拟环境下的 boundfield.py 文件,位置在venv/lib/python3.6/site-packages/django/forms/boundfield.py,修改内容:

89        return widget.render(
90            name=self.html_initial_name if only_initial else self.html_name,
91            value=self.value(),
92            attrs=attrs,
93            # renderer=self.form.renderer,(93行处注释掉,就能正常运行了)
94        )

xadmin 配置

xadmin 的配置和 Django 的差不多,但是也有一点小区别,不过还好它支持 Django 的 messages 框架,simpleui 好像不支持……有毒

Django admin 的配置是写在每个 app 下面的 admin.py 文件的,xadmin 得写在 adminx.py 里,然后好像也没法像 Django 一样用装饰器注册 admin 类,下面的代码展示了注册 admin 方法:

xadmin.site.register(model类, admin类)

注意 xadmin 的 admin 类还不能像 Django 一样继承ModelAdmin类,只能继承BaseAdminObject或干脆不写,我看 xadmin 的源码是继承自object的(跟不写一样)

下面这个例子就很全了,各种属性的配置。

class CourseAdmin(object):
    '''课程'''
    list_display = [ 'name','desc','detail','degree','learn_times','students']   #显示的字段
    search_fields = ['name', 'desc', 'detail', 'degree', 'students']             #搜索字段
    list_filter = [ 'name','desc','detail','degree','learn_times','students']    #过滤字段
    model_icon = 'fa fa-book'            #自定义图标
    ordering = ['-click_nums']           #排序功能
    readonly_fields = ['click_nums']     #只读字段,不能编辑
    exclude = ['fav_nums']               #不显示的字段
    inlines = [LessonInline,CourseResourceInline]    #增加章节和课程资源
    list_editable = ['degree','desc'] #在列表页可以直接编辑的
    list_display = ['get_zj_nums']  #直接使用函数名作为字段显示
    list_display = ['go_to']  # 跳转到上面定义的地址
    refresh_times = [3,5]           #自动刷新(里面是秒数)可选3或5秒

admin 类的属性详情

  • model_icon:图标用的是 font awesome 图标,不过这个网站国内好像访问不了,所以我们用国内版的网站替代,fontawesome.com.cn/icon[5]
  • inlines 的配置和 Django 的差不多,不过不能像 Django 一样集成 xxxinline 的父类……要定义的话参考下面的代码:
class LessonInline(object):
    model = Lesson
    extra = 0

class CourseResourceInline(object):
    model = CourseResource
    extra = 0
  • 还有一个图表功能,不过我觉得没啥用,主要是 x 坐标换成 char 字段就显示不出来了,很恶心,例子:
data_charts = {
        "user_count": {'title': u"course_num", "x-field": "addtime", "y-field": ("course_num"),
                       "order": ('addtime',)
        }
}

效果这样:


admin 类的一些方法覆盖

为啥要覆盖?当然是要自定义一些操作啊,比如你要保存用户信息的时候验证某些字段,通过才给保存,不通过就给出提示,咋搞,覆盖父类函数呀!

代码例子:

class ExamineAdmin(BaseAdminObject):
    .......

    def save_models(self):
        # 获取保存的新对象
        obj = self.new_obj
        # 获取原来的对象,如果是创建新对象,则org_obj为空
        org_obj = self.org_obj

        if 不满足条件:
            self.message_user(message="不满足xxx条件", level='error')
        else:
            return super().save_models()

大概就这样,显示信息的话基本能满足,不过就算显示了“不满足 xxx 条件”的信息,不保存这个 model 对象,也还会出来一个保存成功信息,xadmin 似乎没有提供 api 关掉,文档啥也没写,要解决这个问题还是自己啃 xadmin 代码吧,不然靠搜索和文档完全就是黑箱操作……无力吐槽

参考:

写在最后

不得不说,使用 Python Django 开发网站效率太高了,很方便就做出一套可以用的 API+后台管理系统,拿来应付各种课程设计、需求简单的外包都是绰绰有余,而且相关资料也很多,有心学习的话花点时间掌握开发商业网站项目完全不在话下!至于有人质疑 Python 的性能,人家 Instagram 的后台就是全套 Django 开发的,这亿级的用户量可不是闹着玩的,了解一门技术之后好好深入学习提高比整天跟风搞些花里胡哨的有用得多了……

不过最近看了很多 net core 的博客和知乎问题,我还是看好这个 net core5 的未来,接下来花点时间继续学我的 C#,虽然工作可能用 C++比较多……(逃

欢迎交流

交流问题请在微信公众号后台留言,每一条信息我都会回复哈~

编辑于 01-01

文章被以下专栏收录