一.form介紹
需要對用戶的輸入做校驗,比如校驗用戶是否輸入,輸入的長度和格式等正不正確。如果用戶輸入的內容有錯誤就需要在頁面上相應的位置顯示對應的錯誤信息.。
Django form組件就實現了上面所述的功能。
總結一下,其實form組件的主要功能如下:
- 生成頁面可用的HTML標籤
- 對用戶提交的數據進行校驗
- 保留上次輸入內容
二.Form常用字段與插件
創建Form類時,主要涉及到 【字段】 和 【插件】,字段用於對用戶請求數據的驗證,插件用於自動生成HTML
TextInput
默認是TextInput,如果想加樣式可以在括號裏面寫。
name = forms.CharField(
label='用戶名', #標籤
min_length=6, #最小長度
max_length=12, #最大長度
widget=forms.widgets.TextInput(attrs={'class':'form-control'}) #增加樣式
)
PasswordInput
password = forms.CharField(
min_length=6,
max_length=8,
widget=forms.widgets.PasswordInput(attrs={'class':'form-control'}) #加密輸入
)
日期
date_local = forms.CharField(
widget=forms.widgets.TextInput(attrs={'type':'date'})
)
錯誤信息和幫助文本
password = forms.CharField(
min_length=6,
max_length=8,
error_messages={'min_length':'最小6位','max_length':'最大8位'}, #提示錯誤信息
help_text='輸入密碼!', #幫助文本
widget=forms.widgets.PasswordInput(attrs={'class':'form-control'}) #加密輸入
)
RadioSelect
# 單選input框
sex = forms.ChoiceField(
label='性別',
choices=[('1','女'),('2','男'),('3','保密')], #選項列表
initial=3, #默認選中
widget=forms.widgets.RadioSelect(),
)
Select
# 單選下拉框
hobby = forms.ChoiceField(
label='愛好',
choices=[('1','羽毛球'),('2','籃球'),('3','網球')],
widget=forms.widgets.Select()
)
SelectMultiple
# 多選下拉框
city = forms.MultipleChoiceField(
label='城市',
choices=[('1','北京'),('2','上海'),('3','南京'),('4','廣州')],
widget=forms.widgets.SelectMultiple(),
)
CheckboxSelectMultiple
# 多選checkbox
label_tag = forms.MultipleChoiceField(
label='標籤',
choices=[('1', 'IE'), ('2', 'firefox'), ('3', 'chrome'), ('4', 'opera')],
widget=forms.widgets.CheckboxSelectMultiple(),
)
CheckboxInput
# 單選checkbox
status = forms.ChoiceField(
choices=[('1','True'),('2','False')],
widget=forms.widgets.CheckboxInput(),
)
html文件:
{% load static %}
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
<link rel="stylesheet" href="{% static 'bootstrap-3.3.7-dist/css/bootstrap.min.css' %}">
</head>
<body>
<h1>form</h1>
<form action="" method="post" novalidate>
{% csrf_token %}
<div>
<label for="">{{ forms_obj.name.label }}</label>
{{ forms_obj.name }}
</div>
<div>
<label for="">{{ forms_obj.password.label }}</label>
{{ forms_obj.password }}
</div>
<div>
<label for="">{{ forms_obj.date_local.label }}</label>
{{ forms_obj.date_local }}
</div>
<div>
<label for="">{{ forms_obj.status.label }}</label>
{{ forms_obj.status }}
</div>
<div>
<label for="">{{ forms_obj.sex.label }}</label>
{{ forms_obj.sex }}
</div>
<div>
<label for="">{{ forms_obj.city.label }}</label>
{{ forms_obj.city }}
</div>
<div>
<label for="">{{ forms_obj.hobby.label }}</label>
{{ forms_obj.hobby }}
</div>
<div>
<label for="">{{ forms_obj.label_tag.label }}</label>
{{ forms_obj.label_tag }}
</div>
<input type="submit">
</form>
</body>
</html>
頁面展示:
三.Form所有內置字段
Field
required=True, 是否允許爲空
widget=None, HTML插件
label=None, 用於生成Label標籤或顯示內容
initial=None, 初始值
help_text='', 幫助信息(在標籤旁邊顯示)
error_messages=None, 錯誤信息 {'required': '不能爲空', 'invalid': '格式錯誤'}
validators=[], 自定義驗證規則
localize=False, 是否支持本地化
disabled=False, 是否可以編輯
label_suffix=None Label內容後綴
CharField(Field)
max_length=None, 最大長度
min_length=None, 最小長度
strip=True 是否移除用戶輸入空白
IntegerField(Field)
max_value=None, 最大值
min_value=None, 最小值
FloatField(IntegerField)
...
DecimalField(IntegerField)
max_value=None, 最大值
min_value=None, 最小值
max_digits=None, 總長度
decimal_places=None, 小數位長度
BaseTemporalField(Field)
input_formats=None 時間格式化
DateField(BaseTemporalField) 格式:2015-09-01
TimeField(BaseTemporalField) 格式:11:12
DateTimeField(BaseTemporalField)格式:2015-09-01 11:12
DurationField(Field) 時間間隔:%d %H:%M:%S.%f
...
RegexField(CharField)
regex, 自定製正則表達式
max_length=None, 最大長度
min_length=None, 最小長度
error_message=None, 忽略,錯誤信息使用 error_messages={'invalid': '...'}
EmailField(CharField)
...
FileField(Field)
allow_empty_file=False 是否允許空文件
ImageField(FileField)
...
注:需要PIL模塊,pip3 install Pillow
以上兩個字典使用時,需要注意兩點:
- form表單中 enctype="multipart/form-data"
- view函數中 obj = MyForm(request.POST, request.FILES)
URLField(Field)
...
BooleanField(Field)
...
NullBooleanField(BooleanField)
...
ChoiceField(Field)
...
choices=(), 選項,如:choices = ((0,'上海'),(1,'北京'),)
required=True, 是否必填
widget=None, 插件,默認select插件
label=None, Label內容
initial=None, 初始值
help_text='', 幫助提示
ModelChoiceField(ChoiceField)
... django.forms.models.ModelChoiceField
queryset, # 查詢數據庫中的數據
empty_label="---------", # 默認空顯示內容
to_field_name=None, # HTML中value的值對應的字段
limit_choices_to=None # ModelForm中對queryset二次篩選
ModelMultipleChoiceField(ModelChoiceField)
... django.forms.models.ModelMultipleChoiceField
TypedChoiceField(ChoiceField)
coerce = lambda val: val 對選中的值進行一次轉換
empty_value= '' 空值的默認值
MultipleChoiceField(ChoiceField)
...
TypedMultipleChoiceField(MultipleChoiceField)
coerce = lambda val: val 對選中的每一個值進行一次轉換
empty_value= '' 空值的默認值
ComboField(Field)
fields=() 使用多個驗證,如下:即驗證最大長度20,又驗證郵箱格式
fields.ComboField(fields=[fields.CharField(max_length=20), fields.EmailField(),])
MultiValueField(Field)
PS: 抽象類,子類中可以實現聚合多個字典去匹配一個值,要配合MultiWidget使用
SplitDateTimeField(MultiValueField)
input_date_formats=None, 格式列表:['%Y--%m--%d', '%m%d/%Y', '%m/%d/%y']
input_time_formats=None 格式列表:['%H:%M:%S', '%H:%M:%S.%f', '%H:%M']
FilePathField(ChoiceField) 文件選項,目錄下文件顯示在頁面中
path, 文件夾路徑
match=None, 正則匹配
recursive=False, 遞歸下面的文件夾
allow_files=True, 允許文件
allow_folders=False, 允許文件夾
required=True,
widget=None,
label=None,
initial=None,
help_text=''
GenericIPAddressField
protocol='both', both,ipv4,ipv6支持的IP格式
unpack_ipv4=False 解析ipv4地址,如果是::ffff:192.0.2.1時候,可解析爲192.0.2.1, PS:protocol必須爲both才能啓用
SlugField(CharField) 數字,字母,下劃線,減號(連字符)
...
UUIDField(CharField) uuid類型
四.字段校驗
def test1_register(request):
forms_obj = Register_Model()
if request.method == 'GET':
return render(request,'formtest/test_register1.html',{'forms_obj':forms_obj})
else:
forms_obj = Register_Model(request.POST)
if forms_obj.is_valid():
print(forms_obj.cleaned_data)
return HttpResponse('ok')
else:
print(forms_obj.errors)
return render(request, 'formtest/test_register1.html', {'forms_obj': forms_obj})
解釋:
1.is_valid:數據全部正確會返回一個True 反之False
2.cleaned_data:所有校驗正確的數據都在這個裏面
3.errors:所有的錯誤信息 是一個li標籤,他認爲你字段會有多個錯誤(長度、不能爲空等)
4.forms_obj = Register_Model(request.POST):將用戶傳進來的數據交給我們的form類進行校驗
5.爲什麼校驗錯誤之後又重新把頁面返回給前端,第二次forms_obj是帶有錯誤信息的頁面,返回給前端進行展示
6.forms_obj = Register_Model() 將forms_obj傳給前端是爲了給我們生成標籤用的
前端:
{% load static %}
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
<link rel="stylesheet" href="{% static 'bootstrap-3.3.7-dist/css/bootstrap.min.css' %}">
</head>
<body>
<h1>form</h1>
<form action="" method="post" novalidate>
{% csrf_token %}
<div>
<label for="">{{ forms_obj.name.label }}</label>
{{ forms_obj.name }}
<span style="color: red;font-size: 14px">{{ forms_obj.name.errors.0 }}</span>
</div>
<div>
<label for="">{{ forms_obj.password.label }}</label>
{{ forms_obj.password }}
<span style="color: red;font-size: 14px">{{ forms_obj.password.errors.0 }}</span>
</div>
<input type="submit">
</form>
</body>
</html>
解釋:
1. forms_obj.name.label:name是CharField實例化的對象,對象調用裏面的label標籤
2. forms_obj.name:字段名稱
3. forms_obj.name.errors.0:name有可能是多個錯誤,比方說爲空,長度大了或小了,這裏是0 就是取第一個錯誤,如果只寫errors就會把所有的錯誤信息展示出來
name = forms.CharField(
required=True, #默認就是True
validators=[RegexValidator(r'^123','必須123開頭!!'),RegexValidator(r'456$','必須456結尾!!')], #校驗器
error_messages={'min_length': '最小6位', 'max_length': '最大8位','required':'不能爲空'}, # 提示錯誤信息
widget=forms.widgets.TextInput(attrs={'class':'form-control'})
)
效果:
自定義校驗器:
# 自定義校驗器
def mobile_validate_phone(value):
mobile_re = re.compile(r'^139[0-9]{8}')
if not mobile_re.match(value):
raise ValidationError('手機號碼格式不正確')
class Register_Model(forms.Form):
name = forms.CharField(
label='用戶名', #標籤
validators=[mobile_validate_phone], #直接寫函數名
widget=forms.widgets.TextInput(attrs={'class':'form-control'})
)
結果:
五.Hook鉤子方法
除了上面定義的校驗方法和校驗函數外,我們還可以在Form類中定義鉤子函數,來實現自定義的驗證功能。
局部鉤子:
def clean_name(self):
value = self.cleaned_data['name']
if '123' in value:
raise ValidationError('含有敏感詞:123!!')
else:
return value
解釋:
1.clean_字段名稱
2.如果沒有錯誤需要把數據返回,放回cleaned_data裏面
3.ValidationError 異常
全局鉤子:
判斷兩次密碼輸入是否一致。
def clean(self):
value = self.cleaned_data
p1 = value['password']
p2 = value['r_password']
if p1 == p2:
return value
else:
self.add_error('r_password','兩次輸入密碼不一致!!!')
raise ValidationError('兩次輸入密碼不一致!!!')
解釋:
1.self.add_error:需要給那個字段添加錯誤信息
2.raise ValidationError('兩次輸入密碼不一致!!!'):需要把錯誤信息給拋出來
3.全局鉤子定義:def clean() 後面不跟字段名
結果:
六 .校驗流程源碼分析
data就是我們傳進去的數據forms_obj = Register_Model(request.POST),所以self.is_bound肯定是爲真的,下面就看self.errors裏面的規則:
先看self._clean_fields():
最後執行self._clean_form()方法:
執行流程:
請求過來進入is_valid進行校驗,self.is_bound和self.errors同事成立會返回True,則數據校驗成功,第一步首先看self.is_bound中有沒有數據,如果沒有數據則返回False,則數據校驗失敗返回給用戶,如果self.is_bound中有數據,下一步進入self.errors中進行判斷,看self._errors是不是爲None,這個肯定爲None上面__init__初始化中已經定義爲None了,所以條件肯定成立,成立就走self.full_clean(),裏面會有兩個字典,一個是錯誤信息的字典,一個是數據校驗成功後的字典,首先執行self._clean_fields(),循環我們自定義類中的所有字段和校驗規則,下面用反射是獲取我們類中有沒有定義局部鉤子如果有就執行我們的局部鉤子,並把數據放到cleaned_data中,如果有異常就將異常添加到error_dict中,最後執行我們的全局鉤子。