Django ModelForm組件原理及用法詳解

更新時(shí)間：2020年10月12日 15:31:08 作者：傻白甜++

這篇文章主要介紹了Django ModelForm組件原理及用法詳解,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下

　　這是一個(gè)神奇的組件，通過(guò)名字我們可以看出來(lái)，這個(gè)組件的功能就是把model和form組合起來(lái)。先來(lái)一個(gè)簡(jiǎn)單的例子來(lái)看一下這個(gè)東西怎么用：

　　比如我們的數(shù)據(jù)庫(kù)中有這樣一張學(xué)生表，字段有姓名，年齡，愛(ài)好，郵箱，電話(huà)，住址，注冊(cè)時(shí)間等等一大堆信息，現(xiàn)在讓你寫(xiě)一個(gè)創(chuàng)建學(xué)生的頁(yè)面，你的后臺(tái)應(yīng)該怎么寫(xiě)呢？

首先我們會(huì)在前端一個(gè)一個(gè)羅列出這些字段，讓用戶(hù)去填寫(xiě)，然后我們從后天一個(gè)一個(gè)接收用戶(hù)的輸入，創(chuàng)建一個(gè)新的學(xué)生對(duì)象，保存起來(lái)。

　　其實(shí)，重點(diǎn)不是這些，而是合法性驗(yàn)證，我們需要在前端判斷用戶(hù)輸入是否合法，比如姓名必須在多少字符以?xún)?nèi)，電話(huà)號(hào)碼必須是多少位的數(shù)字，郵箱必須是郵箱的格式這些。當(dāng)然可以一點(diǎn)一點(diǎn)手動(dòng)寫(xiě)限制，各種判斷，這毫無(wú)問(wèn)題，不過(guò)比較麻煩。

　　我們現(xiàn)在有個(gè)更優(yōu)雅（以后在Python相關(guān)的內(nèi)容里，要多用“優(yōu)雅”這個(gè)詞，并且養(yǎng)成習(xí)慣）的方法：ModelForm

　　先來(lái)簡(jiǎn)單的，生硬的把它用上，再來(lái)加驗(yàn)證條件：

首先導(dǎo)入ModelForm

from django.forms import ModelForm

　　在視圖函數(shù)中，定義一個(gè)類(lèi)，比如就叫StudentList，這個(gè)類(lèi)要繼承ModelForm，在這個(gè)類(lèi)中再寫(xiě)一個(gè)原類(lèi)Meta（規(guī)定寫(xiě)法，并注意首字母是大寫(xiě)的）

在這個(gè)原類(lèi)中，有以下屬性（部分）：

class StudentList(ModelForm):
  class Meta:
    model = models.Student #對(duì)應(yīng)的Model中的類(lèi)
    fields = "__all__"   #字段，如果是__all__,就是表示列出所有的字段
    exclude = None     #排除的字段
    labels = None      #提示信息
    help_texts = None    #幫助提示信息
    widgets = None     #自定義插件
    error_messages = None  #自定義錯(cuò)誤信息
#error_messages用法：
    error_messages = {
      'name':{'required':"用戶(hù)名不能為空",},
      'age':{'required':"年齡不能為空",},
    }

#widgets用法,比如把輸入用戶(hù)名的input框給為T(mén)extarea
#首先得導(dǎo)入模塊
    from django.forms import widgets as wid #因?yàn)橹孛?，所以起個(gè)別名
    widgets = {
      "name":wid.Textarea(attrs={"class":"c1"}) #還可以自定義屬性
    }
#labels，自定義在前端顯示的名字

　　　　labels= {
      "name":"用戶(hù)名"
    }

如果想增加一個(gè)字段，就在class Meta 之前寫(xiě)這個(gè)字段。然后在url對(duì)應(yīng)的視圖函數(shù)中實(shí)例化這個(gè)類(lèi)，把這個(gè)對(duì)象傳給前端。

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

然后前端只需要 {{ student_list.as_p }} 一下，所有的字段就都出來(lái)了，可以用as_p顯示全部，也可以通過(guò)for循環(huán)這student_list，拿到的是一個(gè)個(gè)input框，現(xiàn)在我們就不用as_p，手動(dòng)把這些input框搞出來(lái)，as_p拿到的頁(yè)面太丑。

　　首先 for循環(huán)這個(gè)student_list，拿到student對(duì)象，直接在前端打印這個(gè)student，是個(gè)input框；student.label ，拿到數(shù)據(jù)庫(kù)中每個(gè)字段的verbose_name ，如果沒(méi)有設(shè)置這個(gè)屬性，拿到的默認(rèn)就是字段名；還可以通過(guò)student.errors.0 拿到錯(cuò)誤信息，還有student.field，是拿到每個(gè)字段，如果這個(gè)字段是多對(duì)多字段，還能stuent.field.queryset，拿到所有關(guān)聯(lián)的字段，還能stuent.field.queryset.model，拿到所有關(guān)聯(lián)的字段的類(lèi)。有了這些，我們就可以通過(guò)bootstrap，自己拼出來(lái)想要的樣式了

比如：

<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">
         {# 拿到數(shù)據(jù)字段的verbose_name,沒(méi)有就默認(rèn)顯示字段名 #}
          <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>

現(xiàn)在還缺一個(gè)input框的form-control樣式，可以考慮在后臺(tái)的widget里面添加。

比如這樣：

from django.forms import widgets as wid #因?yàn)橹孛?，所以起個(gè)別名
    widgets = {
      "name":wid.TextInput(attrs={'class':'form-control'}),
      "age":wid.NumberInput(attrs={'class':'form-control'}),
      "email":wid.EmailInput(attrs={'class':'form-control'})
    }

當(dāng)然也可以在js中，找到所有的input框，加上這個(gè)樣式，也行。

保存數(shù)據(jù)的時(shí)候，不用挨個(gè)取數(shù)據(jù)了，只需要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})

編輯數(shù)據(jù)：

如果不用ModelForm，編輯的時(shí)候得顯示之前的數(shù)據(jù)吧，還得挨個(gè)取一遍值，如果ModelForm，只需要加一個(gè)instance=obj（obj是要修改的數(shù)據(jù)庫(kù)的一條數(shù)據(jù)的對(duì)象）就可以得到同樣的效果。

保存的時(shí)候要注意，一定要注意有這個(gè)對(duì)象（instance=obj），否則不知道更新哪一個(gè)數(shù)據(jù)。

代碼示例：

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 #對(duì)應(yīng)的Model中的類(lèi)
    fields = "__all__"   #字段，如果是__all__,就是表示列出所有的字段
    exclude = None     #排除的字段
    labels = None      #提示信息
    help_texts = None    #幫助提示信息
    widgets = None     #自定義插件
    error_messages = None  #自定義錯(cuò)誤信息
#error_messages用法：
    error_messages = {
      'name':{'required':"用戶(hù)名不能為空",},
      'age':{'required':"年齡不能為空",},
    }

#widgets用法,比如把輸入用戶(hù)名的input框給為T(mén)extarea
#首先得導(dǎo)入模塊
    from django.forms import widgets as wid #因?yàn)橹孛?，所以起個(gè)別名
    widgets = {
      "name":wid.Textarea
    }
#labels，自定義在前端顯示的名字
    labels= {
      "name":"用戶(hù)名"
    }
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編輯數(shù)據(jù)

對(duì)于驗(yàn)證規(guī)則，很多瀏覽器都比較智能，會(huì)自動(dòng)幫我們做一些驗(yàn)證，可以在form表單上加 novalidate 屬性就可以不讓瀏覽器為我們做驗(yàn)證

ModelForm還支持所有form的功能，比如鉤子，所以我們就可以通過(guò)鉤子來(lái)自定義驗(yàn)證規(guī)則

寫(xiě)法和forms的寫(xiě)法一樣：

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'）
    ...

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: