forms组件
目录
-介绍
我们在前端用form标签向后端提交数据时，都会写一些获取用户输入的标签比如input等，
并且很多时候都需要进行用户输入的校验，比如用户登录时需要判断是否输入以及是否合法等，
然后给出相应的错误信息提示。但每次这种需求都需这样做就是反复造轮子
forms组件就可以解决上述重复的需求并且更加优化，forms组件就是实现上述特定功能的功能模块
-基本使用
比如一个注册功能：
先在views.py中定义一个自己的校验类：
from django import forms # 先导入forms，类似导入models # 写自己的类 class MyForms(forms.Form): # 继承Form类 # 以下写自己要参与到的字段 name = forms.CharField(min_length=3, max_length=8) # 最小为3，最长为8 password = forms.CharField(min_length= 3,max_length = 8) email = forms.EmailField() # 这的EmailField自动校验，必须符合邮箱格式
再写一个视图函数：
def register(request): form_obj = MyForms() if request.method == "POST": # 实例化form对象的时候，把post提交过来的数据直接传进去 form_obj = MyForms(request.POST) # 调用form_obj校验数据的方法 if form_obj.is_valid(): return HttpResponse("注册成功") return render(request, "register.html", locals())
register.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>自动提示错误信息</title> <link rel="stylesheet" href="/static/bootstrap-3.4.1-dist/css/bootstrap.min.css"> <script src="/static/bootstrap-3.4.1-dist/js/bootstrap.min.js"></script> <script src="/static/js/jQuery%203.6.0.js"></script> </head> <body> <form action="" novalidate method="post"> <p>User Login</p> {% for item in forms_obj %} <p> {{ item.label }}:{{ item }} <span style="color: red;">{{ item.errors.0 }}</span> </p> {% endfor %} <input type="submit"> </form> </body> </html>
-常用字段
label 字段名 error_messages 自定义报错信息 initial 默认值 help_text='' 帮助信息(在标签旁边显示) widget 设置input的type为text、password、单多选等，同时还能赋更多属性
widget使用示例
class LoginForm(forms.Form): ... pwd = forms.CharField( min_length=6, label="密码", widget=forms.widgets.PasswordInput(attrs={'class': 'c1'}, render_value=True) )
class LoginForm(forms.Form): username = forms.CharField(min_length=3, label="用户名") pwd = forms.CharField(min_length=6, label="密码") gender = forms.fields.ChoiceField( choices=((1, "男"), (2, "女"), (3, "保密")), label="性别", initial=3, widget=forms.widgets.RadioSelect() )
class LoginForm(forms.Form): ... hobby = forms.ChoiceField( choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ), label="爱好", initial=3, widget=forms.widgets.Select() )
class LoginForm(forms.Form): ... hobby = forms.MultipleChoiceField( choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ), label="爱好", initial=[1, 3], widget=forms.widgets.SelectMultiple() )
class LoginForm(forms.Form): ... keep = forms.ChoiceField( label="是否记住密码", initial="checked", widget=forms.widgets.CheckboxInput() )
class LoginForm(forms.Form): ... hobby = forms.MultipleChoiceField( choices=((1, "篮球"), (2, "足球"), (3, "双色球"),), label="爱好", initial=[1, 3], widget=forms.widgets.CheckboxSelectMultiple() )
choice字段使用注意
在使用选择标签时，需要注意choices的选项可以配置从数据库中获取，但是由于是静态字段 获取的值无法实时更新，需要重写构造方法从而实现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()) # 单选
--Django forms所有内置字段
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类型
-三大功能
forms组件主要可以用来实现数据校验、标签渲染和错误信息提示的主要功能
--数据校验
用forms组件生成对象校验数据时，将待校验数据以字典形式传入即可
除了前面的test.py可以测试代码外
针对Django项目在pycharm里还有个python console的测试环境
在python console 中书写↓： # 导入 >>>from app01 import views # 将待校验数据以字典形式传入 >>>forms_obj = MyForms({'name':'weer', 'password':'666', 'email':'888'}) # 判断是否合法，全合法才为True >>>forms_obj.is_valid() False # 查看所有校验通过符合要求的数据 >>>forms_obj.cleaned_data {'name': 'weer', 'password': '666'} # 查看所有不符合校验规则的数据及不符合原因 >>>forms_obj.errors {'email': ['Enter a valid email address.']} # 值是列表，说明规则可能不唯一
校验规则：
从类里面的数据字段逐一在待校验数据中查找校验，符合就加入cleaned_data中，不符合就加入errors中。
所以待校验数据中顺序不影响，且待校验数据中多传入类中没有的字段及值，多传入字段对校验结果无影响；
但当待校验数据中少传字段或对应值，结果为False，原因为'This field is required.'
---正则校验器
# 第一道关卡里还支持用RegexValidator写正则校验表达式 from django.core.validators import RegexValidator phone = forms.CharField(validators=[ RegexValidators(r'^[0-9]+$', “号码是数字！”), RegexValidators(r'^135[0-9]+$', “号码必须以135开头！”) ]) # 列表内可以写多个正则匹配式
--标签渲染
可以利用forms组件自动渲染获取用户输入的标签(input,password,select,textarea等)，减少代码书写，但不能自动生成提交按钮
1、后端先产生Form对象传给前端
def ab_forms_tags(request): # 1先产生空对象 forms_obj = MyForms() # 2传递给前端供其操作 return render(request, 'html10 forms标签渲染.html', locals())
2、前端支持三种渲染方式
<body> <form action=""> {# <p>第一种：代码书写少 封装程度高 不利于扩展 一般用于本地测试</p> #} {# {{ forms_obj.as_p }} #} {# {{ forms_obj.as_ul }} #} {# {{ forms_obj.as_table }} #} {# <p>第二种：可扩展性强 书写代码多</p> #} {# <p>{{ forms_obj.name.label }}:{{ forms_obj.name }}</p> #} {# <p>{{ forms_obj.password.label }}:{{ forms_obj.password }}</p> #} {# <p>{{ forms_obj.email.label }}:{{ forms_obj.email }}</p> #} <p>第三种：代码书写简单 可扩展性高</p> {% for item in forms_obj %} <p>{{ item.label }}:{{ item }}</p> {% endfor %} </form> </body>
--自动错误信息提示
用户表单输入数据提交后，利用forms组件可自动校验并对错误输入进行提示，提示信息展示在输入框右侧
from django import forms class MyForms(forms.Form): name = forms.CharField(min_length=3, max_length=8, label='用户名', error_messages={ 'min_length':'用户名最少为2', 'max_length':'用户名最多为8', 'required':'用户名不能为空' }) password = forms.CharField(min_length=3, max_length=8, label='密码', error_messages={ 'min_length': '密码最少为2', 'max_length': '密码最多为8', 'required': '密码不能为空' }) email = forms.EmailField(label='邮箱', error_messages={ 'invalid':'邮箱格式错误', 'required':'邮箱不能为空' })
# forms组件提示错误信息 def ab_forms_autoShowWrongMsgs(request): # 先产生空对象 forms_obj = MyForms() # post提交过来后错误信息校验 if request.method == "POST": # ∵request.POST结果本身就是字典数据，直接传给MyForms校验即可 forms_obj = MyForms(request.POST) if forms_obj.is_valid(): return HttpResponse('OK') return render(request, 'html11 展示错误信息.html', locals())
<body> <form action="" novalidate method="post"> <p>User Login</p> {% for item in forms_obj %} <p> {{ item.label }}:{{ item }} <span style="color: red;">{{ item.errors.0 }}</span> </p> {% endfor %} <input type="submit"> </form> </body>
"""
get请求和post请求传递的两个变量名forms_obj必须一样
用户输入提交后，会展示错误提示信息，并保留原先输入数据，更人性化
自定义错误提示信息用error_messages={}规定，自动判断(常用4个条件)并展示
"""
-钩子函数
用于辅助校验，当最初校验规则校验完后，才可以通过写钩子函数进行第二道关卡校验
类似于校验数据的第二道防线，并且是在里面自定义校验规则(匹配，正则，敏感字。。。)
钩子函数在类下里面书写，只有当原规则过了后才执行，没过就不执行
--局部钩子
eg：校验用户名name中不能出现"性"字 # 局部钩子 def clean_name(self): # 固定函数名clean_xxx # 获取用户名 name = self.cleaned_data.get('name') # 把已通过第一道关卡的name钩起来 if "性" in name: # 前端展示错误信息提示 # 第一个为字段，第二个为错误信息提示 self.add_error('name', '用户名不能含'性'字哦') # 将钩子钩起来的数据放回去 return name
--全局钩子
校验注册时两次设置密码是否一致 # 全局钩子 def clean(self): # 全局钩子统为clean # 获取数据 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
