Django的modelform
简介
通过名字我们可以看出来,这个组件的功能就是把model和form组合起来,先来一个简单的例子来看一下这个东西怎么用:比如我们的数据库中有这样一张学生表,字段有姓名,年龄,爱好,邮箱,电话,住址,注册时间等等一大堆信息,现在让你写一个创建学生的页面,你的后台应该怎么写呢?首先我们会在前端一个一个罗列出这些字段,让用户去填写,然后我们从后天一个一个接收用户的输入,创建一个新的学生对象,保存其实,重点不是这些,而是合法性验证,我们需要在前端判断用户输入是否合法,比如姓名必须在多少字符以内,电话号码必须是多少位的数字,邮箱必须是邮箱的格式这些当然可以一点一点手动写限制,各种判断,这毫无问题,除了麻烦我们现在有个更优雅(以后在Python相关的内容里,要多用“优雅”这个词,并且养成习惯)的方法:ModelForm先来简单的,生硬的把它用上,再来加验证条件。
创建modelform
# 在项目中可以建一个modelform.py的文件,也可以写在视图函数中。只要在调用它的地方能够引入就好。 # 在这里面也要把model中的类引入到该文件中 # 首先导入ModelForm和model from django.forms import ModelForm # 把midel中的所有的类都导入或者导入你要的类, from app01.models import * # 定义一个类,比如就叫StudentList,这个类要继承ModelForm,在这个类中再写一个元类Meta(规定写法,并注意首字母是大写的) # 在这个元类中,有以下属性(部分): class StudentList(ModelForm): class Meta: model = Student # 对应的Model中的类 fields = "__all__" # 字段,如果是__all__,就是表示列出所有的字段 # 也可以自己定制直接写fields=['name','age']只要这些字段 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": "用户名" }
上面是一个.py的文件,如labels={}后面不能加逗号(',')。
使用modelform
我们在视图函数中使用modelform
from django.shortcuts import render # Create your views here. def student(request): if request.method == 'GET': # 实例化这个类 student_list = StudentList() # 把这个实例传到前段 return render(request,'student.html',{'student_list':student_list}) # return render(request,'student.html',locals()) 和上面的效果一样
在前段我们可以和form组件一样拿取数据{{ 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,自己拼出来想要的样式了,比如:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>欢迎注册</title> <link rel="stylesheet" href="/static/bootstrap/css/bootstrap.min.css"> <link rel="stylesheet" href="/static/mystyle.css"> </head> <body> <div class="container"> <div class="row"> <div class="col-md-6 col-md-offset-3"> <form novalidate autocomplete="off" action="/reg/" method="post" class="form-horizontal reg-form" enctype="multipart/form-data"> {% csrf_token %} {# {{ student_list.as_p }}#} {% for student in student_list %} <div class="form-group"> <label for="{{ student.id_for_label}}"class="col-sm-2 control-label">{{ student.label }}</label> <div class="col-sm-8">{{ student }}<span class="help-block">{{ student.errors.0 }}</span> </div> </div> {% endfor %} <div class="form-group"> <label class="col-sm-2 control-label">头像</label> <div class="col-sm-8"> <label for="id_avatar"><img id="avatar-img" src="/static/img/default.png" alt=""></label> <input accept="image/*" type="file" name="avatar" id="id_avatar" style="display: none"> <span class="help-block"></span> </div> </div> <div class="form-group"> <div class="col-sm-offset-2 col-sm-10 col-md-offset-3"> <button type="button" class="btn btn-success" id="reg-submit">注册</button> </div> </div> </form> </div> </div> </div> </body> </html>
现在还缺一个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): student_list = StudentList(request.POST) if request.method == 'POST': student_list = StudentList(request.POST) if student_list.is_valid(): student_list.save() return redirect(request, 'student_list.html', {'student_list': student_list}) return render(request,'student.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 #默认排除的字段为None labels = None #默认提示信息为None help_texts = None #默认帮助提示信息为None widgets = None #默认自定义插件为None error_messages = None #默认自定义错误信息为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): student_list = StudentList(request.POST) if request.method == 'POST': student_list = StudentList(request.POST) if student_list.is_valid(): student_list.save() return redirect(request, 'student_list.html', {'student_list': student_list}) 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 == 'POST': student_list = StudentList(request.POST, instance=obj) if student_list.is_valid(): student_list.save() return redirect(request, 'student_list.html', {'student_list': student_list}) student_list = StudentList(instance=obj) return render(request, 'student_edit.html', {'student_list': student_list})
总结: 从上边可以看到ModelForm用起来是非常方便的,比如增加修改之类的操作。但是也带来额外不好的地方,model和form之间耦合了。如果不耦合的话,mf.save()方法也无法直接提交保存。 但是耦合的话使用场景通常局限用于小程序,写大程序就最好不用了。