欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Django ModelForm组件原理及用法详解

程序员文章站 2022-05-10 19:23:30
这是一个神奇的组件,通过名字我们可以看出来,这个组件的功能就是把model和form组合起来。先来一个简单的例子来看一下这个东西怎么用:  比如我们的数据库中有这样一张学生表,字段有姓名,年龄,爱好,...

  这是一个神奇的组件,通过名字我们可以看出来,这个组件的功能就是把model和form组合起来。先来一个简单的例子来看一下这个东西怎么用:

  比如我们的数据库中有这样一张学生表,字段有姓名,年龄,爱好,邮箱,电话,住址,注册时间等等一大堆信息,现在让你写一个创建学生的页面,你的后台应该怎么写呢?

首先我们会在前端一个一个罗列出这些字段,让用户去填写,然后我们从后天一个一个接收用户的输入,创建一个新的学生对象,保存起来。

  其实,重点不是这些,而是合法性验证,我们需要在前端判断用户输入是否合法,比如姓名必须在多少字符以内,电话号码必须是多少位的数字,邮箱必须是邮箱的格式这些。当然可以一点一点手动写限制,各种判断,这毫无问题,不过比较麻烦。

  我们现在有个更优雅(以后在python相关的内容里,要多用“优雅”这个词,并且养成习惯)的方法:modelform

  先来简单的,生硬的把它用上,再来加验证条件:

首先导入modelform

from django.forms import modelform

  在视图函数中,定义一个类,比如就叫studentlist,这个类要继承modelform,在这个类中再写一个原类meta(规定写法,并注意首字母是大写的)

在这个原类中,有以下属性(部分):

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(attrs={"class":"c1"}) #还可以自定义属性
    }
#labels,自定义在前端显示的名字

    labels= {
      "name":"用户名"
    }

如果想增加一个字段,就在class meta 之前写这个字段。然后在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 拿到错误信息,还有student.field,是拿到每个字段,如果这个字段是多对多字段,还能stuent.field.queryset,拿到所有关联的字段,还能stuent.field.queryset.model,拿到所有关联的字段的类。有了这些,我们就可以通过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-control样式,可以考虑在后台的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编辑数据

对于验证规则,很多浏览器都比较智能,会自动帮我们做一些验证,可以在form表单上加 novalidate 属性就可以不让浏览器为我们做验证

modelform还支持所有form的功能,比如钩子,所以我们就可以通过钩子来自定义验证规则

写法和forms的写法一样:

class authorform(forms.modelform):
  class meta:
    model = author
    fields = ('name', 'title')

  def clean_name(self):
    if ...
       return self.clean_data['name']
    else:
       raise validationerror(‘sdgsadga')
    ...

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。