Django--Form组件
一 . Form介绍
我们之前一下用form表单向后台提交数据, 里面写的是input标签. 我们在好多场景下需要对用户输入的内容进行校验,比如说注册信息.
Django form组件就实现了上述的功能
form组件主要功能:
生成页面可用HTML标签
对用户提交的数据进行校验
保留上次输入的内容
使用form组件实现注册功能
# views.py文件 from django import forms # 按照Django form组件的要求自己写一个类 class RegForm(forms.Form): username = forms.CharField(label="用户名") # 括号里面写一些校验规则,下面会介绍 password = forms.CharField(label="密码") # 类属性名字是什么,前端标签里面的name值就是什么, 现在的类属性就好比input标签里面的name=username,name=password
在写一个视图函数
def register(request):
form_obj = RegForm()
# print(request.POST)
if request.method == "POST":
# 实例化form对象的时候, 把post提交过来的数据直接传进去
form_obj = RegForm(data=request.POST) # 就好比request.POST.get('username') request.POST.get('password')
# print(form_obj.is_valid()) # 如果用户输入的有一个错误就是False,全对才是True
if form_obj.is_valid():
print(form_obj.cleaned_data) # 打印用户输入对的数据 这个清洗后的数据必须写在is_valid后面
# else:
# print(form_obj.errors.as_data()) # 拿错误信息
return render(request, 'register.html', {'form_obj':form_obj})
else:
return render(request, 'register.html', {'form_obj': form_obj})
register.html
{% load static %}
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
<!--bootstrap-->
<link href="{% static 'bootstrap/css/bootstrap.min.css' %}" rel="stylesheet">
</head>
<body>
<form action="{% url 'register' %}" method="post" novalidate>
{% csrf_token %}
{# <p>{{ form_obj.as_p }}</p>#} <!--拿所有的标签-->
<p>
{{ form_obj.username.label }}
{{ form_obj.username }}
<span style="color: red">
{{ form_obj.username.errors.0 }} <!--拿错误信息,errors拿到的是列表.所以用索引-->
</span>
</p>
<p>
{{ form_obj.password.label }}
{{ form_obj.password }}
<span style="color: red">
{{ form_obj.password.errors.0 }}
</span>
</p>
<p>
{{ form_obj.re_password.label }}
{{ form_obj.re_password }}
{{ form_obj.re_password.errors.0 }}
</p>
<p>
{{ form_obj.userinfo.label }} <!--由于是标签所以想要显示作者名字不能直接.name 要在models里面写def__str__(self)-->
{{ form_obj.userinfo }}
{{ form_obj.userinfo.errors.0 }}
</p>
<button class="btn btn-primary btn-lg btn-block">注 册</button>
</form>
</body>
</html>
二 . form表单的常用字段插件
initial
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位"
}
)
password
class LoginForm(forms.Form): ... pwd = forms.CharField( min_length=6, label="密码", widget=forms.PasswordInput(attrs={'class': 'c1'}, render_value=True) ) # 让密码变成密文 # attrs里面可以设置bootstrap样式
RadioSelect
class LoginForm(forms.Form):
username = forms.CharField( #其他选择框或者输入框,基本都是在这个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.RadioSelect() # 后面括号写不行都行
)
单选Select
class LoginForm(forms.Form):
...
hobby = forms.fields.ChoiceField(
choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ),
label="爱好",
initial=3,
widget=forms.Select
)
单选checkbox
class LoginForm(forms.Form):
...
keep = forms.fields.ChoiceField(
label="是否记住密码",
initial="checked",
widget=forms.CheckboxInput
)
多选checkbox
class LoginForm(forms.Form):
...
hobby = forms.fields.MultipleChoiceField(
choices=((1, "篮球"), (2, "足球"), (3, "双色球"),),
label="爱好",
initial=[1, 3],
widget=forms.widgets.CheckboxSelectMultiple
)
choice字段注意事项
在选择标签时, 需要注意choice的选项可以从数据库中拿, 但是由于是静态字段, 获取的值无法实时更新, 需要重写构造方法从而实现choice实时更新
方式一
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()) # 单选
三 . 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类型
四 . 字段校验
RegexValidator验证器
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): # 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): # 返回True or False
raise ValidationError('手机号码格式错误') #自定义验证规则的时候,如果不符合你的规则,需要自己发起错误
# 使用自定义验证规则
phone = fields.CharField(validators=[mobile_validate, ],
error_messages={'required': '手机不能为空'},
widget=widgets.TextInput(attrs={'class': "form-control",
'placeholder': u'手机号码'}))
五 . Hook钩子方法
进行进一步验证可以用钩子方法
局部钩子
我们在Form类中定义clean_字段名()方法,就能实现对特定的钩子进行校验.
class LoginForm(forms.Form):
username = forms.CharField(
min_length=8,
label="用户名",
initial="张三",
error_messages={
"required": "不能为空",
"invalid": "格式错误",
"min_length": "用户名最短8位"
},
widget=forms.widgets.TextInput(attrs={"class": "form-control"})
)
...
# 定义局部钩子,用来校验username字段,之前的校验股则还在,给你提供了一个添加一些校验功能的钩子
def clean_username(self):
value = self.cleaned_data.get("username")
if "666" in value:
raise ValidationError("光喊666是不行的")
else:
return value # 一定要return
全局钩子
我们在form类中定义clean()方法, 对全局进行校验, 字段校验玩,局部校验完, 最后执行全局校验.
class LoginForm(forms.Form):
...
password = forms.CharField(
min_length=6,
label="密码",
widget=forms.widgets.PasswordInput(attrs={'class': 'form-control'}, render_value=True)
)
re_password = forms.CharField(
min_length=6,
label="确认密码",
widget=forms.widgets.PasswordInput(attrs={'class': 'form-control'}, render_value=True)
)
...
# 定义全局的钩子,用来校验密码和确认密码字段是否相同,执行全局钩子的时候,cleaned_data里面肯定是有了通过前面验证的所有数据
def clean(self):
password_value = self.cleaned_data.get('password')
re_password_value = self.cleaned_data.get('re_password')
if password_value == re_password_value:
return self.cleaned_data #全局钩子要返回所有的数据
else:
self.add_error('re_password', '两次密码不一致') # 给哪个字段添加报错信息,直接add_error('字段名', '报错信息')
raise ValidationError('两次密码不一致') # 这个必须写
# 并且clean_data里面会自动清除这个re_password的值,所以打印clean_data的时候会看不到它
六 . ModelForm
如果需要验证的字段和models.py文件中的字段是紧密映射的表单,我们如果用form去一个一个得写,会显的冗余,这样我么就可以用ModelForm去写
ModelForm定义(form与model的终级结合)
from django import forms
from crm import models
class RegForm(forms.ModelForm):
# 如果Mate里面不能不能满足你需要的验证,要在外面写(如下),报错信息也要写在这里才能生效
password = forms.CharField(
widget=forms.PasswordInput,
label='密码',
min_length=6,
max_length=16,
error_messages={'min_length': '不能小于6位'}
)
class Meta:
model = models.UserProfile # 对应models中的类
fields = '__all__' # 拿到所有的字段
# print(fields)
exclude = ['is_active'] # 除了哪个字段
labels = {
'username': '用户名' # 前边的那个label改成'用户名',还有一种方法,就是在models里面写上verbose_name='用户名'.
}
# 下面的报错信息不会生效,因为在Mata中写的只对默认生成的字段有效
error_messages = {
'required': '不能为空',
}
# 批量添加样式,让所有的输入框都有class = form-control的属性
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
for field in self.fields.values():
field.widget.attrs.update({'class': 'form-control'})
class Mate下的常用参数
model = models.类名
fields = '__all__' # 拿到所有的字段
exclude = ['name','age'] #除了这两个字段剩下的全要
labels = {'username': '用户名'} # 把label的名字改成'用户名'
help_texts = '只能输入数字,字母,下划线' # 提示输入数字,字母,下划线
widgets = None # 自定义插件
error_messages = None # 自定义错误信息
save()方法
def register(request):
if request.method == 'GET':
form_obj = RegForm()
return render(request, 'register.html', {'form_obj': form_obj})
else:
form_obj = RegForm(request.POST)
# 对数据库进行校验
if form_obj.is_valid():
form_obj.save() # 把你提供的数据按照相应的位置插进去,有就插,没有就不插
return HttpResponse('ok')
# return redirect('login')
return render(request, 'register.html', {'form_obj': form_obj})