Django ModelForm組件原理及用法詳解
這是一個神奇的組件,通過名字我們可以看出來,這個組件的功能就是把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 > <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 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,redirectfrom django.forms import ModelForm# Create your views here.from app01 import modelsdef 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’) ...
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持好吧啦網。
相關文章:
