Django框架之 modelform组件

Posted 2021-01-03 hanbowen

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Django框架之 modelform组件相关的知识，希望对你有一定的参考价值。

浏览目录

创建mldelform
添加记录
编辑记录

Django框架中的modelform组件

通过名字我们可以看出来，这个组件的功能就是把model和form组合起来。

下面我们来看一个例子：

比如我们的数据库中有这样一张学生表，字段有姓名，年龄，爱好，邮箱，电话，住址，注册时间等等一大堆信息，现在让你写一个创建学生的页面，你的后台应该怎么写呢？首先我们会在前端一个一个罗列出这些字段，让用户去填写，然后我们从后天一个一个接收用户的输入，创建一个新的学生对象，保存其实，重点不是这些，而是合法性验证，我们需要在前端判断用户输入是否合法，比如姓名必须在多少字符以内，电话号码必须是多少位的数字，邮箱必须是邮箱的格式这些当然可以一点一点手动写限制，各种判断。

创建mldelform

#首先导入ModelForm
 
from django.forms import ModelForm
#在视图函数中，定义一个类，比如就叫StudentList，这个类要继承ModelForm，在这个类中再写一个原类Meta（规定写法，并注意首字母是大写的）
#在这个原类中，有以下属性（部分）：
 
class StudentList(ModelForm):
    class Meta:
        model =Student #对应的Model中的类
        fields = "__all__" #字段，如果是__all__,就是表示列出所有的字段
        exclude = None #排除的字段
        #error_messages用法：
        error_messages = {
        ‘name‘:{‘required‘:"用户名不能为空",},
        ‘age‘:{‘required‘:"年龄不能为空",},
        }
        #widgets用法,比如把输入用户名的input框给为Textarea
        #首先得导入模块
        from django.forms import widgets as wid #因为重名，所以起个别名
        widgets = {
        "name":wid.Textarea(attrs={"class":"c1"}) #还可以自定义属性
        }
        #labels，自定义在前端显示的名字
        labels= {
        "name":"用户名"
        }

　然后在url对应的视图函数中实例化这个类，把这个对象传给前端。

def student(request):
 
    if request.method == ‘GET‘:
        student_list = StudentList()
        return render(request,‘student.html‘,{‘student_list‘:student_list})

然后前端只需要 {{ student_list.as_p }} 一下，所有的字段就都出来了，可以用as_p显示全部，也可以通过for循环student_list，拿到的是一个个input框，现在我们就不用as_p，
我们手动把这些input框搞出来，因为as_p拿到的页面太丑，并且不好控制样式。
首先 for循环这个student_list，拿到student对象，直接在前端打印这个student，是个input框student.label ，拿到数据库中每个字段的verbose_name ,如果没有设置这个属性，拿到的默认就是字段名，还可以通过student.errors.0 拿到错误信息有了这些，我们就可以通过bootstrap，自己拼出来想要的样式了，比如：

<body>
<div class="container">
    <h1>student</h1>
    <form method="POST" novalidate>
        {% csrf_token %}
        {# {{ student_list.as_p }}#}
        {% for student in student_list %}
            <div class="form-group col-md-6">
                {# 拿到数据字段的verbose_name,没有就默认显示字段名 #}
                <label class="col-md-3 control-label">{{ student.label }}</label>
                <div class="col-md-9" style="position: relative;">{{ student }}</div>
            </div>
        {% endfor %}
        <div class="col-md-2 col-md-offset-10">
            <input type="submit" value="提交" class="btn-primary">
        </div>
    </form>
</div>
</body>

现在还缺一个input框的form-contral样式，可以考虑在后台的widget里面添加。
比如这样：　　　

from django.forms import widgets as wid #因为重名，所以起个别名
widgets = {
"name":wid.TextInput(attrs={‘class‘:‘form-control‘}),
"age":wid.NumberInput(attrs={‘class‘:‘form-control‘}),
"email":wid.EmailInput(attrs={‘class‘:‘form-control‘})
}

当然也可以在js中，找到所有的input框，加上这个样式，也行。　　　

添加记录

保存数据的时候，不用挨个取数据了，只需要save一下。。

def student(request):
 
    if request.method == ‘GET‘:
         student_list = StudentList()
         return render(request,‘student.html‘,{‘student_list‘:student_list})
    else:
         student_list = StudentList(request.POST)
         if student_list.is_valid():
         student_list.save()
         return redirect(request,‘student_list.html‘,{‘student_list‘:student_list})

编辑记录

如果不用ModelForm，编辑的时候得显示之前的数据吧，还得挨个取一遍值，如果ModelForm，只需要加一个instance=obj（obj是要修改的数据库的一条数据的对象）就可以得到同样的效果。
保存的时候要注意，一定要注意有这个对象（instance=obj），否则不知道更新哪一个数据
代码示例：

from django.shortcuts import render,HttpResponse,redirect
from django.forms import ModelForm
# Create your views here.
from app01 import models
def test(request):
    # model_form = models.Student
    model_form = models.Student.objects.all()
    return render(request,‘test.html‘,{‘model_form‘:model_form})
 
class StudentList(ModelForm):
    class Meta:
        model = models.Student #对应的Model中的类
        fields = "__all__" #字段，如果是__all__,就是表示列出所有的字段
        exclude = None #排除的字段
        labels = None #提示信息
        help_texts = None #帮助提示信息
        widgets = None #自定义插件
        error_messages = None #自定义错误信息
        #error_messages用法：
        error_messages = {
        ‘name‘:{‘required‘:"用户名不能为空",},
        ‘age‘:{‘required‘:"年龄不能为空",},
        }
        #widgets用法,比如把输入用户名的input框给为Textarea
        #首先得导入模块
        from django.forms import widgets as wid #因为重名，所以起个别名
        widgets = {
        "name":wid.Textarea
        }
        #labels，自定义在前端显示的名字
        labels= {
        "name":"用户名"
        }
def student(request):
    if request.method == ‘GET‘:
        student_list = StudentList()
        return render(request,‘student.html‘,{‘student_list‘:student_list})
    else:
        student_list = StudentList(request.POST)
        if student_list.is_valid():
            student_list.save()
            return render(request,‘student.html‘,{‘student_list‘:student_list})
 
def student_edit(request,pk):
    obj = models.Student.objects.filter(pk=pk).first()
    if not obj:
        return redirect(‘test‘)
    if request.method == "GET":
        student_list = StudentList(instance=obj)
        return render(request,‘student_edit.html‘,{‘student_list‘:student_list})
    else:
        student_list = StudentList(request.POST,instance=obj)
        if student_list.is_valid():
            student_list.save()
            return render(request,‘student_edit.html‘,{‘student_list‘:student_list})

总结：从上边可以看到ModelForm用起来是非常方便的，比如增加修改之类的操作。但是也带来额外不好的地方，model和form之间耦合了。如果不耦合的话，mf.save()方法也无法直接提交保存。但是耦合的话使用场景通常局限用于小程序，写大程序就最好不用了。　　

示例：简单书籍管理

新建表

from django.db import models


# Create your models here.


# 书籍表
class Book(models.Model):
    title = models.CharField(max_length=32)
    price = models.DecimalField(max_digits=8, decimal_places=2)  # 999999.99
    date = models.DateField()
    publish = models.ForeignKey("Publish")
    authors = models.ManyToManyField("Author")

    def __str__(self):
        return self.title

# 出版社表
class Publish(models.Model):
    name = models.CharField(max_length=32)

    def __str__(self):
        return self.name

# 作者表
class Author(models.Model):
    name = models.CharField(max_length=32)

    def __str__(self):
        return self.name

通过admin在表中添加数据

from app01 import models


admin.site.register(models.Book)
admin.site.register(models.Author)
admin.site.register(models.Publish)

构建表数据增删改查页面

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<a href="/book/add"><button>添加书籍</button></a>
<hr>
<table border="1">
    {% for book in book_list %}
       <tr>
           <td>{{ book.title }}</td>
           <td>{{ book.price }}</td>
           <td>{{ book.date|date:"Y-m-d" }}</td>
           <td>{{ book.publish.name }}</td>
           <td>{{ book.authors.all }}</td>
            <td><a href="/book/edit/{{book.pk}}"><button>编辑</button></a></td>
            <td><a href="/book/delete/{{book.pk}}"><button>删除</button></a></td>
       </tr>
    {% endfor %}

</table>


</body>
</html>

<form action="" method="post" novalidate>
{% csrf_token %}

     {% for field in form %}
        <div>
         {{ field.label }}
         {{ field }} <span>{{ field.errors.0 }}</span>
        </div>
     {% endfor %}

    <input type="submit">
</form>

{#导入bootstrap样式#}
    <link rel="stylesheet" href="https://cdn.bootcss.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">



{#样式#}
<h2>添加页面</h2>
<div class="row">
    <div class="col-md-4 col-md-offset-3">
         {% include "menu.html" %}
    </div>
</div>

{#导入bootstrap样式#}
    <link rel="stylesheet" href="https://cdn.bootcss.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">


{#样式#}
<h2>编辑页面</h2>
<div class="row">
    <div class="col-md-4 col-md-offset-3">
         {% include "menu.html" %}
    </div>
</div>

生成路径

from app01 import views

urlpatterns = [
    url(r‘^admin/‘, admin.site.urls),
    url(r‘^book_list/‘, views.books),    #书籍列表
    url(r‘^book/add/‘, views.add_book),   #添加书籍
    url(r‘^book/edit/(d+)‘, views.edit_book),  #编辑书籍
    url(r‘^book/delete/(d+)‘, views.delete_book), #删除书籍
]

视图函数

from django.shortcuts import render,HttpResponse,redirect

# Create your views here.

from django.forms import ModelForm
from django.forms import widgets as wid
from django import forms
from .models import *


class BookForm(ModelForm):
    class Meta:
        model = Book            #绑定book表
        fields = "__all__"
        labels={"title":"书籍名称","price":"价格","date":"出版时间","publish":"出版社","authors":"作者"}
        error_messages = {
            ‘name‘: {‘required‘: "用户名不能为空", },
            ‘age‘: {‘required‘: "年龄不能为空", },
        }
        widgets={
            "title":wid.TextInput(attrs={"class":"form-control"}),
            "price":wid.TextInput(attrs={"class":"form-control"}),
            "date":wid.DateInput(attrs={"class":"form-control","type":"date"}),
            "publish":wid.Select(attrs={"class":"form-control"}),
            "author":wid.SelectMultiple(attrs={"class":"form-control"}),

        }



# 书籍列表
def books(request):
    book_list = Book.objects.all()  #取到所有的书籍对象，传给书籍列表
    return render(request, "book_list.html", locals())


# 添加书籍
def add_book(request):
    if request.method=="POST":
        form=BookForm(request.POST)   #取到各个字段中的值
        if form.is_valid():         #校验数据是否正确
            form.save()             #BookForm中model = Book 绑定book表，所以save将数据提交保存到book表中
            return redirect("/book_list/") #提交成功，跳转到书籍列表页面
        else:
            return render(request, "add.html", locals())  #数据匹配不成功
    form=BookForm()  #get请求方式
    return render(request,"add.html",locals())


# 编辑书籍
def edit_book(request,edit_book_id):

    edit_obj=Book.objects.filter(pk=edit_book_id).first()  #取到要编辑的书籍对象
    if request.method=="POST":
        form=BookForm(request.POST,instance=edit_obj)   #取到字段中绑定要编辑的对象之前的数据
        if form.is_valid():  #校验通过
            form.save()     #提交
            return redirect("/book_list/")
        else:
            return render(request, "edit.html", locals())   #有错误信息，停留到编辑页面
    form = BookForm(instance=edit_obj)  #get请求方式，取到字段中绑定要编辑的对象之前的数据
    return render(request,"edit.html",locals())


# 删除书籍
def delete_book(request,delete_book_id):
    delete_obj=Book.objects.get(pk=delete_book_id).delete() #根据传过来的id在数据库中取到匹配对象

    return redirect("/book_list/")
    # return HttpResponse("删除成功")

以上是关于Django框架之 modelform组件的主要内容，如果未能解决你的问题，请参考以下文章

django之ModelForm组件

Django之ModelForm组件

Django之modelform组件