Django 之 ModelForm

时间 2019-12-08

原文原文链接

一 Django的form组件

二 Django的model form组件

这是一个神奇的组件，经过名字咱们能够看出来，这个组件的功能就是把model和form组合起来，先来一个简单的例子来看一下这个东西怎么用：好比咱们的数据库中有这样一张学生表，字段有姓名，年龄，爱好，邮箱，电话，住址，注册时间等等一大堆信息，如今让你写一个建立学生的页面，你的后台应该怎么写呢？首先咱们会在前端一个一个罗列出这些字段，让用户去填写，而后咱们从后天一个一个接收用户的输入，建立一个新的学生对象，保存其实，重点不是这些，而是合法性验证，咱们须要在前端判断用户输入是否合法，好比姓名必须在多少字符之内，电话号码必须是多少位的数字，邮箱必须是邮箱的格式这些固然能够一点一点手动写限制，各类判断，这毫无问题，除了麻烦咱们如今有个更优雅（之后在Python相关的内容里，要多用“优雅”这个词，而且养成习惯）的方法：ModelForm先来简单的，生硬的把它用上，再来加验证条件。前端

2.1 建立modelform

# 首先导入ModelForm
from django.forms import ModelForm
from django import forms
from django.core.exceptions import ValidationError

# 在视图函数中，定义一个类，好比就叫StudentListModelForm，这个类要继承ModelForm，在这个类中再写一个原类Meta（规定写法，并注意首字母是大写的）
# 在这个原类中，有如下属性（部分）：

class StudentListModelForm(ModelForm):
    confirm_password = forms.CharField(label='确认密码')  # 若是要增长显示字段，在这里增长

    class Meta:
        model = Student  # 对应的Model中的类
        fields = "__all__"  # 字段，若是是__all__,就是表示列出全部的字段。不然用['title', 'icon']指定字段
        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 = {"name": "用户名"}  # labels，自定义在前端显示的名字
        help_texts = None  # 帮助提示信息

    def __init__(self, *args, **kwargs):  # 给每一个标签添加属性
        super().__init__(*args, **kwargs)
        for field in self.fields.values():
            field.widget.attrs['class'] = 'form-control'

    def clean_confirm_password(self):  # 钩子函数
        """
        检测密码是否一致
        :return:
        """
        password = self.cleaned_data['password']
        confirm_password = self.cleaned_data['confirm_password']
        if password != confirm_password:
            raise ValidationError('两次密码输入不一致')
        return confirm_password

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

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，本身拼出来想要的样式了，好比：django

<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里面添加
好比这样：bootstrap

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框，加上这个样式，也行。小程序

2.2 添加纪录

保存数据的时候，不用挨个取数据了，只须要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})

2.3 编辑数据

若是不用ModelForm，编辑的时候得显示以前的数据吧，还得挨个取一遍值，若是ModelForm，只须要加一个instance=obj（obj是要修改的数据库的一条数据的对象）就能够获得一样的效果
保存的时候要注意，必定要注意有这个对象（instance=obj），不然不知道更新哪个数据
代码示例：ui

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()方法也没法直接提交保存。可是耦合的话使用场景一般局限用于小程序，写大程序就最好不用了。url