Django中的forms组件实例详解
程序员文章站
2023-11-11 13:05:22
form介绍
我们之前在html页面中利用form表单向后端提交数据时，都会写一些获取用户输入的标签并且用form标签把它们包起来。
与此同时我们在好多场景下都需要对用...
form介绍
我们之前在html页面中利用form表单向后端提交数据时，都会写一些获取用户输入的标签并且用form标签把它们包起来。
与此同时我们在好多场景下都需要对用户的输入做校验，比如校验用户是否输入，输入的长度和格式等正不正确。如果用户输入的内容有错误就需要在页面上相应的位置显示对应的错误信息.。
django form组件就实现了上面所述的功能。
总结一下，其实form组件的主要功能如下:
- 生成页面可用的html标签
- 对用户提交的数据进行校验
- 保留上次输入内容
先在应用目录下my_forms.py定义好一个userform类
from django import forms
from django.forms import widgets
class userform(forms.form):
username = forms.charfield(min_length=4, label='用户名',
widget=widgets.textinput(attrs={"class": "form-control"}),
error_messages={
"required": "用户名不能为空",
})
pwd = forms.charfield(min_length=4, label='密码',
error_messages={
"required": "密码不能为空",
},
widget=widgets.passwordinput(attrs={"class": "form-control"}))
r_pwd = forms.charfield(min_length=4, label='确认密码',
widget=widgets.passwordinput(attrs={"class": "form-control"}),
error_messages={
"required": "密码不能为空",
})
email = forms.emailfield(label='邮箱',
widget=widgets.emailinput(attrs={"class": "form-control"}),
error_messages={
"required": '邮箱不能为空',
"invalid": "邮箱格式错误",
})
tel = forms.charfield(label='手机号',
widget=widgets.textinput(attrs={"class": "form-control"}),
)
再写一个视图函数：
在写一个视图函数
def reg(request):
form = userform()
if request.method == "post":
print(request.post)
# 实例化form对象的时候，把post提交过来的数据直接传进去
form = userform(request.post) # form表单的name属性值应该与forms组件的字段名称一致
if form.is_valid():
print(form.cleaned_data)
return httpresponse('注册成功')
return render(request, 'reg.html', locals())
login.html
<!doctype html>
<html lang="zh_cn">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>注册</title>
</head>
<body>
<h3>传统form表单</h3>
<form action="" method="post">
{% csrf_token %}
<p>用户名：<input type="text" name="username"></p>
<p>密码：<input type="password" name="pwd"></p>
<p>确认密码：<input type="password" name="r_pwd"></p>
<p>邮箱：<input type="email" name="email"></p>
<p>手机号：<input type="tel" name="tel"></p>
<p><input type="submit" value="提交"></p>
</form>
<h3>forms组件渲染方式1</h3>
<form action="" method="post" novalidate>
{% csrf_token %}
<p>{{ form.username.label }}：{{ form.username }} <span>{{ form.username.errors.0 }}</span></p>
<p>密码：{{ form.pwd }}
<span>{{ form.pwd.errors.0 }}</span></p>
<p>确认密码：{{ form.r_pwd }}
<span>{{ form.r_pwd.errors.0 }}</span></p>
<p>邮箱：{{ form.email }}
<span>{{ form.email.errors.0 }}</span></p>
<p>手机号：{{ form.tel }}
<span>{{ form.tel.errors.0 }}</span></p>
<p><input type="submit" value="提交"></p>
</form>
<h3>forms组件渲染标签方式2</h3>
<form action="" method="post" novalidate>
{% csrf_token %}
{% for field in form %}
<div class="form-group clearfix">
<label for="">{{ field.label }}</label>
{{ field }}
<span style="color: red" class="pull-right">{{ field.errors.0 }}</span>
{% if field.name == 'r_pwd' %}
<span style="color: red" class="pull-right">{{ errors.0 }}</span>
{% endif %}
</div>
{% endfor %}
<input type="submit" value="注册" class="btn btn-default pull-right">
</form>
<h3>forms组件渲染标签方式3 不推荐使用</h3>
<form action="" method="post">
{% csrf_token %}
{{ form.as_p }}
<input type="submit" value="注册">
</form>
</body>
</html>
看网页效果发现 也验证了form的功能：
• 前端页面是form类的对象生成的 -->生成html标签功能
• 当用户名和密码输入为空或输错之后 页面都会提示 -->用户提交校验功能
• 当用户输错之后 再次输入 上次的内容还保留在input框 -->保留上次输入内容
form那些事儿
常用字段与插件
创建form类时，主要涉及到 【字段】 和 【插件】，字段用于对用户请求数据的验证，插件用于自动生成html;
initial
初始值，input框里面的初始值。
class loginform(forms.form):
username = forms.charfield(
min_length=8,
label="用户名",
initial="张三" # 设置默认值
)
pwd = forms.charfield(min_length=6, label="密码")
error_messages
重写错误信息。
class loginform(forms.form):
username = forms.charfield(
min_length=8,
label="用户名",
initial="张三",
error_messages={
"required": "不能为空",
"invalid": "格式错误",
"min_length": "用户名最短8位"
}
)
pwd = forms.charfield(min_length=6, label="密码")
password
class loginform(forms.form):
...
pwd = forms.charfield(
min_length=6,
label="密码",
widget=forms.widgets.passwordinput(attrs={'class': 'c1'}, render_value=true)
)
radioselect
单radio值为字符串
class loginform(forms.form):
username = forms.charfield(
min_length=8,
label="用户名",
initial="张三",
error_messages={
"required": "不能为空",
"invalid": "格式错误",
"min_length": "用户名最短8位"
}
)
pwd = forms.charfield(min_length=6, label="密码")
gender = forms.fields.choicefield(
choices=((1, "男"), (2, "女"), (3, "保密")),
label="性别",
initial=3,
widget=forms.widgets.radioselect()
)
单选select
class loginform(forms.form):
...
hobby = forms.fields.choicefield(
choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ),
label="爱好",
initial=3,
widget=forms.widgets.select()
)
多选select
class loginform(forms.form):
...
hobby = forms.fields.multiplechoicefield(
choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ),
label="爱好",
initial=[1, 3],
widget=forms.widgets.selectmultiple()
)
单选checkbox
class loginform(forms.form):
...
keep = forms.fields.choicefield(
label="是否记住密码",
initial="checked",
widget=forms.widgets.checkboxinput()
)
多选checkbox
class loginform(forms.form):
...
hobby = forms.fields.multiplechoicefield(
choices=((1, "篮球"), (2, "足球"), (3, "双色球"),),
label="爱好",
initial=[1, 3],
widget=forms.widgets.checkboxselectmultiple()
)
关于choice的注意事项：
在使用选择标签时，需要注意choices的选项可以从数据库中获取，但是由于是静态字段 ***获取的值无法实时更新***，那么需要自定义构造方法从而达到此目的。
方式一：
from django.forms import form
from django.forms import widgets
from django.forms import fields
class myform(form):
user = fields.choicefield(
# choices=((1, '上海'), (2, '北京'),),
initial=2,
widget=widgets.select
)
def __init__(self, *args, **kwargs):
super(myform,self).__init__(*args, **kwargs)
# self.fields['user'].choices = ((1, '上海'), (2, '北京'),)
# 或
self.fields['user'].choices = models.classes.objects.all().values_list('id','caption')
方式二：
from django import forms
from django.forms import fields
from django.forms import models as form_model
class finfo(forms.form):
authors = form_model.modelmultiplechoicefield(queryset=models.nnewtype.objects.all()) # 多选
# authors = form_model.modelchoicefield(queryset=models.nnewtype.objects.all()) # 单选
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内置字段
校验
方式一：
from django.forms import form
from django.forms import widgets
from django.forms import fields
from django.core.validators import regexvalidator
class myform(form):
user = fields.charfield(
validators=[regexvalidator(r'^[0-9]+$', '请输入数字'), regexvalidator(r'^159[0-9]+$', '数字必须以159开头')],
)
方式二：
import re
from django.forms import form
from django.forms import widgets
from django.forms import fields
from django.core.exceptions import validationerror
# 自定义验证规则
def mobile_validate(value):
mobile_re = re.compile(r'^(13[0-9]|15[012356789]|17[678]|18[0-9]|14[57])[0-9]{8}$')
if not mobile_re.match(value):
raise validationerror('手机号码格式错误')
class publishform(form):
title = fields.charfield(max_length=20,
min_length=5,
error_messages={'required': '标题不能为空',
'min_length': '标题最少为5个字符',
'max_length': '标题最多为20个字符'},
widget=widgets.textinput(attrs={'class': "form-control",
'placeholder': '标题5-20个字符'}))
# 使用自定义验证规则
phone = fields.charfield(validators=[mobile_validate, ],
error_messages={'required': '手机不能为空'},
widget=widgets.textinput(attrs={'class': "form-control",
'placeholder': u'手机号码'}))
email = fields.emailfield(required=false,
error_messages={'required': u'邮箱不能为空','invalid': u'邮箱格式错误'},
widget=widgets.textinput(attrs={'class': "form-control", 'placeholder': u'邮箱'}))
方式三：
def clean(self):
pwd = self.cleaned_data.get('pwd')
r_pwd = self.cleaned_data.get('r_pwd')
print(pwd, r_pwd)
if pwd and r_pwd:
if pwd == r_pwd:
return self.cleaned_data
raise validationerror('两次密码不一致')
else:
return self.cleaned_data
def clean_username(self):
val = self.cleaned_data.get('username')
user = userinfo.objects.filter(name=val)
if not user:
return val
else:
raise validationerror("用户名已注册")
def clean_tel(self):
val = self.cleaned_data.get('tel')
if len(val) == 11:
return val
raise validationerror('手机号格式错误')
总结：
'''
局部钩子:
1、is_valid()
2、self.errors
3、self.full_clean()
4、self._clean_fields() 校验每一个字段
5、for 循环每一个字段名、验证规则对象
6、
验证通过：
value = field.clean(value)
self.cleaned_data[name] = value 添加到clean_data中
利用反射、钩子自定义验证规则
hasattr(self, 'clean_%s' % name) 写自定义方法
value = getattr(self, 'clean_%s' % name)() 执行自定义方法
pass:
self.cleaned_data[name] = value 添加到clean_data中
no_pass:
raise validationerror(msg) 抛出异常
不通过：
raise validationerror(msg)
全局钩子:
1、is_valid()
2、self.errors
3、self.full_clean()
4、self._clean_form() 全部字段调用完成之后 调用
5、self.clean() 重写clean方法
6、全局钩子错误：forms.errors.get("__all__")
'''
总结
以上所述是小编给大家介绍的django中的forms组件实例详解，希望对大家有所帮助