Django的Form表單
Django Form
Form介紹
Form 表單是在前端向後端送出資料最常用的方式，同時在好多場景下都需要對使用者的輸入進行校驗。
以注冊為例，Form 需要的三件事：
-
要有一個注冊的頁面，頁面裡面要有form表單
生成HTML代碼
-
form表單要能送出資料到後端，後端要做有效性校驗
資料有效性校驗
-
要把校驗的提示資訊展示在頁面上
校驗資訊傳回并展示，儲存原來填寫的内容
普通方式的注冊功能
視圖函數
# 注冊
def register(request):
error_msg = ""
if request.method == "POST":
username = request.POST.get("name")
pwd = request.POST.get("pwd")
# 對注冊資訊做校驗
if len(username) < :
# 使用者長度小于6位
error_msg = "使用者名長度不能小于6位"
else:
# 将使用者名和密碼存到資料庫
return HttpResponse("注冊成功")
return render(request, "register.html", {"error_msg": error_msg})
模闆
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>注冊頁面</title>
</head>
<body>
<form action="/reg/" method="post">
{% csrf_token %}
<p>
使用者名:
<input type="text" name="name">
</p>
<p>
密碼：
<input type="password" name="pwd">
</p>
<p>
<input type="submit" value="注冊">
<p style="color: red">{{ error_msg }}</p>
</p>
</form>
</body>
</html>
Django 的 Form 元件
是以，Django 的 Form 元件對應上面所提三件事：
- 生成頁面可用的HTML标簽
- 對使用者送出的資料進行校驗
- 保留上次輸入内容
建立 Form 類
建立 Form 類時，主要涉及到 【字段】 和 【插件】，字段用于對使用者請求資料的驗證，插件用于自動生成 HTML;
要導入的包：
-
from django import forms
這是 Form 元件的父類，用于建立 Form 類
-
from django.forms import widgets
用于對每個字段指定樣式
字段與插件
initial 初始值
初始值，input 框裡面的初始值
class RegForm(forms.Form):
username = forms.CharField(
min_length=,
label="使用者名",
initial="張三"# 設定預設值
)
pwd = forms.CharField(min_length=, label="密碼")
error_messages
重寫錯誤資訊。
class RegForm(forms.Form):
name = forms.CharField(
# 校驗規則相關
max_length=,
label="使用者名",
error_messages={
"required": "該字段不能為空",
"invalid": "格式錯誤",
"man_length": "使用者名最長16位"
},
# widget控制的是生成HTML代碼相關的規則
widget=widgets.TextInput(attrs={"class": "form-control"})
)
password
- render_value=True 送出後輸入框内容依然存在
class RegForm(forms.Form):
……
pwd = forms.CharField(
label="密碼",
min_length=,
max_length=,
# render_value=True 送出後輸入框内容依然存在
widget=widgets.PasswordInput(attrs={"class": "form-control"}, render_value=True),
error_messages={
"min_length": "密碼不能少于6位！",
"max_length": "密碼最長10位！",
"required": "該字段不能為空！"
}
)
radioSelect
單radio值為字元串
class RegForm(forms.Form):
……
gender = forms.fields.ChoiceField(
choices=((, "男"), (, "女"), (, "保密")),
label="性别",
initial=,
widget=forms.widgets.RadioSelect()
)
單選 Select
class RegForm(forms.Form):
...
hobby = forms.fields.ChoiceField(
choices=((, "籃球"), (, "足球"), (, "雙色球"), ),
label="愛好",
initial=,
widget=forms.widgets.Select()
)
多選 Select
class RegForm(forms.Form):
...
hobby = forms.fields.MultipleChoiceField(
choices=((, "籃球"), (, "足球"), (, "雙色球"), ),
label="愛好",
initial=[, ],
widget=forms.widgets.SelectMultiple()
)
單選 checkbox
class RegForm(forms.Form):
...
keep = forms.fields.ChoiceField(
label="是否記住密碼",
initial="checked",
widget=forms.widgets.CheckboxInput()
)
多選 checkbox
class RegForm(forms.Form):
...
hobby = forms.fields.MultipleChoiceField(
choices=((, "籃球"), (, "足球"), (, "雙色球"),),
label="愛好",
initial=[, ],
widget=forms.widgets.CheckboxSelectMultiple()
)
Django 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類型
Django Form内置字段
生成 HTML 頁面
方式一：自動填寫
在模闆檔案 form 中，加入
{{ form_obj.as_p }}
就可以自動生成了。
優點：友善
缺點：不能添加 CSS 樣式
<form action="/reg/" method="post" novalidate>
{% csrf_token %}
{{ form_obj.as_p }}
<input type="submit" value="送出">
</form>
方式二：逐個手寫
優點：能夠為各個标簽添加 CSS 樣式類，也可以使用 Bootstrap 樣式類等
缺點：代碼量較大
<link rel="stylesheet" href="/static/bootstrap/css/bootstrap.min.css">
{#方式二：逐個填充，可以填充樣式#}
<div class="container">
<div class="row">
<div class="col-md-6 col-md-offset-3">
<form action="/reg/" method="post" novalidate>
{% csrf_token %}
<div class="form-group {% if form_obj.name.errors.0 %} has-error {% endif %}">
{{ form_obj.name.label }}
{{ form_obj.name }}
<span class="help-block">{{ form_obj.name.errors.0 }}</span>
</div>
<div class="form-group {% if form_obj.pwd.errors.0 %} has-error {% endif %}">
{{ form_obj.pwd.label }}
{{ form_obj.pwd }}
<span class="help-block">{{ form_obj.pwd.errors.0 }}</span>
</div>
<div class="form-group {% if form_obj.re_pwd.errors.0 %} has-error {% endif %}">
{{ form_obj.re_pwd.label }}
{{ form_obj.re_pwd }}
<span class="help-block">{{ form_obj.re_pwd.errors.0 }}</span>
</div>
<div class="form-group {% if form_obj.email.errors.0 %} has-error {% endif %}">
{{ form_obj.email.label }}
{{ form_obj.email }}
<span class="help-block">{{ form_obj.email.errors.0 }}</span>
</div>
<div class="form-group {% if form_obj.mobile.errors.0 %} has-error {% endif %}">
{{ form_obj.mobile.label }}
{{ form_obj.mobile }}
<span class="help-block">{{ form_obj.mobile.errors.0 }}</span>
</div>
<div class="form-group {% if form_obj.city.errors.0 %} has-error {% endif %}">
{{ form_obj.city.label }}
{{ form_obj.city }}
<span class="help-block">{{ form_obj.city.errors.0 }}</span>
</div>
<div class="form-group">
<input type="submit" class="btn btn-default">
</div>
</form>
</div>
</div>
</div>
form2
校驗
做校驗
通過函數 is_valid 做校驗，校驗後的各種字段資料會儲存在 form_obj.clean_data 中。
if request.method == "POST":
# 更新form_obj的内容
form_obj = RegForm(request.POST)
# form自己可以做校驗
if form_obj.is_valid():
# 1. form_obj.cleaned_data存儲form校驗後的内容，需要在is-valid函數後使用
del form_obj.cleaned_data["re_pwd"]
在模闆頁面，使用
Form執行個體.字段名.errors.0
的方式來顯示後端發來的校驗資訊。
<div class="form-group {% if form_obj.name.errors.0 %} has-error {% endif %}">
{{ form_obj.name.label }}
{{ form_obj.name }}
<span class="help-block">{{ form_obj.name.errors.0 }}</span>
</div>
Form 類自帶校驗字段
Form 類設定的各種字段的值自動包含所要校驗的内容，而校驗結果顯示的資訊放在 error_messages 字段中。
re_pwd = forms.CharField(
label="确認密碼",
min_length=,
max_length=,
widget=widgets.PasswordInput(attrs={"class": "form-control"}, render_value=True),
error_messages={
"min_length": "密碼不能少于6位！",
"max_length": "密碼最長10位！",
"required": "該字段不能為空！"
}
)
Form 自帶的正則校驗
除了 Form 類中的字段能夠校驗外，還需要根據需求自定義校驗，其中，正則校驗就是一個比較常用的校驗方式， Form 類中自帶正則校驗方法。
from django import forms
from django.forms import widgets
from django.core.validators import RegexValidator
from django.core.exceptions import ValidationError
mobile = forms.CharField(
label="手機",
# 自己定制校驗規則
validators=[
RegexValidator(r'^[0-9]+$',"手機号必須是數字"),
RegexValidator(r'^1[3-9][0-9]{9}$', "手機格式不正确")
],
widget=widgets.TextInput(attrs={"class": "form-control"}),
error_messages={
"required": "該字段不能為空"
}
)
具體字段的自定義校驗方法
在 Form 類中加上 clean_XX 函數，可在其中自定義對 XX 字段的校驗。這種方法隻能使用此字段。
在此函數中，
- 如果校驗出錯，通過
raise ValidationError("錯誤提示資訊")
- 函數的最後，即校驗成功，傳回該字段，
return XX
def clean_name(self):
name = self.cleaned_data.get("name")
if "中國" in name:
raise ValidationError("不要臉")
return name
全局的自定義校驗方法
在 Form 類中，重寫 clean 函數，可以實作對多個字段的自定義校驗。
添加提示資訊的方法：
self.add_error("要添加到哪個字段的錯誤資訊", ValidationError("提示的錯誤資訊"))
驗完成的最後都要将校驗字典傳回：
return self.cleaned_data
在模闆頁面中，依然可以直接用所添加到字段的錯誤資訊變量：
form_obj.name.errors.0
示例：
def clean(self):
pwd = self.cleaned_data.get("pwd")
re_pwd = self.cleaned_data.get("re_pwd")
if pwd != re_pwd:
self.add_error("re_pwd", ValidationError("兩次密碼不一緻！"))
# raise ValidationError("兩次密碼不一緻")
return self.cleaned_data
Form 與資料庫
有時候會遇到這樣的需求：前端頁面中，Form 表單裡的資料是從資料庫中取出來顯示出來，此時如果向資料庫中添加新的資料，前端頁面不會顯示出新添加的資料，隻有在重新開機後端服務後才能重新從資料庫中取出資料，便包含了新添加的資料。
解決方法：
在對 Form 類中要從資料庫中取資料的字段來說，在該字段進行取資料，是以需要在每次執行個體化類的時候都重新對該字段進行指派。
city = forms.ChoiceField(
choices=models.City.objects.all().values_list("id", "name"),
label="所在城市",
initial=,
widget=widgets.Select(attrs={"class": "form-control"})
)
# 重寫父類的初始化方法, 每次執行個體化類的時候都調用
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
# 每次執行個體化類的時候都重新給choices指派，保證更新資料庫時資料同步更新
self.fields["city"].widget.choices = models.City.objects.all().values_list("id", "name")
參考：https://www.cnblogs.com/liwenzhou/p/8747872.html
GitHub位址：https://github.com/protea-ban/oldboy/tree/master/s9day73/ajaxdemo
轉載于:https://www.cnblogs.com/banshaohuan/p/9531807.html