Django Form组件
Form介绍
在好多场景下都需要对用户的输入做校验，比如校验用户是否输入，输入的长度和格式等正不正确
form组件的主要功能如下:
- 生成页面可用的HTML标签
- 对用户提交的数据进行校验
- 保留上次输入内容
普通手写登录功能
views.py
from django.shortcuts import render
def register(request):
error_dict = {'username': '', 'password': ''}
if request.method == 'POST':
username = request.POST.get('username')
password = request.POST.get('password')
if '' in username:
error_dict['username'] = '你个老色批'
if not password:
error_dict['password'] = '密码不能为空，你个DSB'
return render(request, 'register.html', locals())
login.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>register</title>
</head>
<body>
<form action="" method="post">
<p>
username:<input type="text" name="username">
<span style="color: red">{{ error_dict.username }}</span>
</p>
<p>
password:<input type="text" name="password">
<span style="color: red">{{ error_dict.password }}</span>
</p>
<input type="submit">
</form>
</body>
</html>
这里我们做了这三件事：
- 手写获取用户输入的前端页面代码-------------------->渲染页面
- 后端获取用户数据并做合法性校验-------------------->校验数据
- 将校验之后的结果渲染到前端页面-------------------->展示信息
使用Form组件实现该功能
- 首先需要先写一个类
from django import forms
class MyRegForm(forms.Form):
# 规定用户名密码最少3位，最多10位
username = forms.CharField(max_length=10, min_length=3)
password = forms.CharField(max_length=10, min_length=3)
# email字段必须填写符合邮箱格式的数据
email = forms.EmailField()
除了之前的tests测试环境外，还可以使用Python Console来测试环境
# 传入待校验的数据，用上面写的类，传入字典格式的待校验数据
from app01 import views
form_obj = views.MyRegForm({'username': 'jason', 'password': '123', 'email':'123456'})
# 判断数据是否符合校验规则
form_obj.is_valid()
False
# 获取校验之后通过的数据
form_obj.cleaned_data
{'username': 'jason', 'password': '123'}
# 获取校验失败及失败的原因
form_obj.errors
{'email': ['Enter a valid email address.']}
注意：form组件默认所有的字段都必须传值，也就是说少传了肯定是不行的，但是多传的话，他只校验类里面写的字段，多传的直接忽略
- 其次，渲染页面
form组件只帮我们渲染获取用户输入的标签（输入、选择、下拉、文件），不渲染按钮和form表单标签，渲染出来的每一个input提示信息都是类中字段首字母大写
这里有三种渲染方式
<p>第一种渲染方式:多个P标签，本地测试方便，封装程度太高，不便于扩展</p>
{{ form_obj.as_p }}
{{ form_obj.as_ul }}
{{ form_obj.as_table }}
<p>第二种渲染方式：扩展性较高，书写较为繁琐</p>
<label for="{{ form_obj.username.id_for_label }}">{{ form_obj.username.label }}</label>
{{ form_obj.username.label }}{{ form_obj.username }}
{{ form_obj.password.label }}{{ form_obj.password }}
{{ form_obj.email.label }}{{ form_obj.email }}
<p>第三种渲染方式:(推荐使用，书写方便且扩展性高)</p>
{% for form in form_obj %}
<p>{{ form.label }}{{ form }}</p>
推荐使用第三种
渲染错误信息
前端
数据校验前后端都要有，但是前端的不严谨，可有可无，而后端的校验必须有且非常全面
form表单取消前端浏览器自动校验功能，在form表单中加 Novalidate参数，如下
<form action="" method="post" novalidate>
{% for form in form_obj %}
<p>
{{ form.label }}{{ form }}
<span>{{ form.errors.0 }}</span>
</p>
{% endfor %}
<input type="submit">
</form>
后端
def reg(request):
# 1.先生成一个空的类对象
form_obj = MyRegForm()
if request.method == 'POST':
# 获取用户数据并交给form组件校验
form_obj = MyRegForm(request.POST)
# 获取校验结果
if form_obj.is_valid():
return HttpResponse('No problem')
else:
# 获取校验失败的字段和提示信息
print(form_obj.errors)
# 2.直接将该对象传给前端页面
return render(request, 'reg.html', locals())
Form组件常用参数
| 常用参数 | 作用 |
|---|---|
| label | input的提示信息 |
| error_message | 自定义报错的提示信息 |
| required | 设置字段是否允许为空 |
| initial | 设置默认值 |
| widget | 控制type类型及属性 |
widget=forms.widgets.TextInput(attrs={'class': 'form-control'})
widget=forms.widgets.PasswordInput(attrs={'class': 'form-control'})
钩子函数
-
全局钩子（针对多个字段）
- 比如校验密码与确认密码是否一致
def clean(self): # 校验密码和确认密码是否一致 password = self.cleaned_data.get('password') confirm_password = self.cleaned_data.get('confirm_password') if not password == confirm_password: # 展示提示信息 self.add_error('confirm_password', '两次密码不一致') return self.cleaned_data -
局部钩子（针对单个字段）
- 比如用户名中并不能包含666
def clean_username(self): username = self.cleaned_data.get('username') if '666' in username: self.add_error('username', '用户名中不能有666')
如果想要同时操作多个字段的数据，就用全局钩子
如果想要操作单个字段的数据，就用局部钩子
- 正则校验
from django.core.validators import RegexValidator
phone = forms.CharField(validators=[
RegexValidator(r'^[0-9]+$', '请输入数字'),
RegexValidator(r'^13|15|16|17|18|19[0-9]+$', '手机号不符合规范')
])
其他字段渲染（需要拷贝即可）
radioSelect
单radio值为字符串
gender = forms.fields.ChoiceField(
choices=((1, "男"), (2, "女"), (3, "保密")),
label="性别",
initial=3,
widget=forms.widgets.RadioSelect()
)
单选Select
hobby = forms.ChoiceField(
choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ),
label="爱好",
initial=3,
widget=forms.widgets.Select()
)
多选Select
hobby = forms.MultipleChoiceField(
choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ),
label="爱好",
initial=[1, 3],
widget=forms.widgets.SelectMultiple()
)
单选checkbox
keep = forms.ChoiceField(
label="是否记住密码",
initial="checked",
widget=forms.widgets.CheckboxInput()
)
多选checkbox
hobby = forms.MultipleChoiceField(
choices=((1, "篮球"), (2, "足球"), (3, "双色球"),),
label="爱好",
initial=[1, 3],
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内置字段