主要内容:
- 1.form组件概述
- 2.示例:使用form组件实现注册功能
- 3.form相关
1. form组件概述
(1)form组件
- 当在HTML页面中利用form表单向后端提交数据时，都会写一些获取用户输入的标签并且用form标签把它们包起来。
- 与此同时我们在好多场景下都需要对用户的输入做校验，比如校验用户是否输入，输入的长度和格式等正不正确。如果用户输入的内容有错误就需要在页面上相应的位置显示对应的错误信息.。
(2) form组件功能
- 生成页面可用的HTML标签
- 对用户提交的数据进行校验
- 保留上次输入内容
2.示例:使用form组件实现注册功能
- forms.py
from django import forms from django.core.exceptions import ValidationError from django.core.validators import RegexValidator def check(value): if '苍老师' in value: raise ValidationError('敏感词汇,不能使用') #按照django form组件的要求自己写一个类 class RegForm(forms.Form): user = forms.CharField( label='用户名', required=True, min_length=8, max_length=12, # initial='username', validators=[], error_messages={ 'required':'不能为空', 'min_length':'长度不能小于8' } ) email = forms.EmailField() pwd = forms.CharField( label='密码', widget=forms.PasswordInput, validators=[RegexValidator(r'^[A-Za-z]+[0-9]+[A-Za-z0-9]*|[0-9]+[A-Za-z]+[A-Za-z0-9]*$','密码必须由6-16个英文字母和数字的字符串组成！')] ) re_pwd = forms.CharField( label='确认密码', widget=forms.PasswordInput, validators=[RegexValidator(r'^[A-Za-z]+[0-9]+[A-Za-z0-9]*|[0-9]+[A-Za-z]+[A-Za-z0-9]*$', '密码必须由6-16个英文字母和数字的字符串组成！')] ) gender = forms.ChoiceField( choices=((1,'男'),(2,'女'),(3,'不详')), widget=forms.RadioSelect() ) phone = forms.CharField( label='phone_number', validators=[RegexValidator(r'^1[3-9]d{9}$','格式不正确')] ) hobby = forms.ChoiceField( choices=((1, "篮球"), (2, "足球"), (3, "双色球"),), widget=forms.SelectMultiple ) def clean_user(self): value = self.cleaned_data.get('user') if '苍老师' in value: raise ValidationError('敏感词汇,不能使用') return value 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','两次密码不一致') return self.cleaned_data
- views.py
from django.shortcuts import render,HttpResponse from app01.forms import RegForm #写视图函数 def register(request): # 实例化一个form对象 form_obj = RegForm() #判断请求方式为POST if request.method == 'POST': #实例化form对象的时候,把post提交过来的数据直接传进去 form_obj = RegForm(data=request.POST) #调用form_obj校验数据的方法 if form_obj.is_valid(): #将数据保存到数据库中 #cleand_data 表示经过校验的合格的数据 return HttpResponse('注册成功') return render(request,'register.html',{'form_obj':form_obj})
- html 代码
<body> <form action="" method ='post' novalidate> {% csrf_token %} {# {{ form_obj.as_p }}#} {# {{ form_obj.errors }}#} <P> <label for="{{ form_obj.user.id_for_label }}">{{ form_obj.user.label }}</label> {{ form_obj.user }} {{ form_obj.user.errors.0}} </P> <P> <label for="{{ form_obj.email.id_for_label }}">{{ form_obj.email.label }}</label> {{ form_obj.email }} {{ form_obj.email.errors.0}} </P> <P> <label for="{{ form_obj.pwd.id_for_label }}">{{ form_obj.pwd.label }}</label> {{ form_obj.pwd }} {{ form_obj.pwd.errors.0}} </P> <P> <label for="{{ form_obj.re_pwd.id_for_label }}">{{ form_obj.re_pwd.label }}</label> {{ form_obj.re_pwd }} {{ form_obj.re_pwd.errors.0}} </P> <P> <label for="{{ form_obj.gender.id_for_label }}">{{ form_obj.gender.label }}</label> {{ form_obj.gender }} {{ form_obj.gender.errors.0}} </P> <P> <label for="{{ form_obj.phone.id_for_label }}">{{ form_obj.phone.label }}</label> {{ form_obj.phone }} {{ form_obj.phone.errors.0}} </P> <P> <label for="{{ form_obj.hobby.id_for_label }}">{{ form_obj.hobby.label }}</label> {{ form_obj.hobby }} {{ form_obj.hobby.errors.0}} </P> <button>注册</button> </form>
3. form相关
3.1常用字段与插件
(1)radioSelect,单radio值为字符串
gender = forms.fields.ChoiceField( choices=((1, "男"), (2, "女"), (3, "保密")), label="性别", initial=3, widget=forms.widgets.RadioSelect() )
(2) 单选Selsect
hobby = forms.fields.ChoiceField( choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ), label="爱好", initial=3, widget=forms.widgets.Select() )
(3)多选Select
hobby = forms.fields.MultipleChoiceField( choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ), label="爱好", initial=[1, 3], widget=forms.widgets.SelectMultiple() )
(4)单选checkbox
keep = forms.fields.ChoiceField( label="是否记住密码", initial="checked", widget=forms.widgets.CheckboxInput() )
关于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()) # 单选
3.2 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内置字段
3.3 校验
(1)内置校验
#例如 required=True,min_length=8,max_length=12,
(2)自定义校验
- 定义函数
from django.core.exceptions import ValidationError #可以自定义一个函数 def check(value): if 'alex' in value: raise ValidationError('敏感词汇，不符合社会职业核心价值观') #在字段中 validators =[] 中添加函数名的方式 validators=[check]
- 引入
from django.core.validators import RegexValidator #同样在字段中的validators =[]中添加 validators=[RegexValidator(r'^1[3-9]d{9}$', '格式不正确')] #关于 RegexValidator 一般写正则 ,以及错误message就可以 class RegexValidator(object): regex = '' message = _('Enter a valid value.') code = 'invalid' inverse_match = False flags = 0 def __init__(self, regex=None, message=None, code=None, inverse_match=None, flags=None):
3.4 校验流程
3.4.1 在 views.py中
if form_obj.is_valid(): #将数据保存到数据库中 #cleand_data 表示经过校验的合格的数据 print(form_obj.cleaned_data) return HttpResponse('注册成功')
form_obj.is_valid() --> 表示通过校验
源码部分解析:
- full_clean 方法:
# 以下是full_clean方法中的部分代码,可以看到在此方法中 def full_clean(self): """ Cleans all of self.data and populates self._errors and self.cleaned_data. """ #定义了一个存方所有错误的字典 self._errors = ErrorDict() if not self.is_bound: # Stop further processing. return #同样定义了一个存放通过清晰字段的字典 self.cleaned_data = {}
- 接下来执行 _clean_fields 方法
# 这是 _clean_fields 的代码 def _clean_fields(self): #此时的fields是一个包含所有字段对象的字典,对其进行遍历 for name, field in self.fields.items(): #若这个字段是不可以编辑 if field.disabled: # 将initial的设定值赋值给value value = self.get_initial_for_field(field, name) else: #否则将你填入框中的值赋值给value value = field.widget.value_from_datadict(self.data, self.files, self.add_prefix(name)) # 这部分是一些判断规则 try: if isinstance(field, FileField): initial = self.get_initial_for_field(field, name) value = field.clean(value, initial) else: #执行clean方法 value = field.clean(value) #将通过清洗的字段的值即value添加到cleaned_data字典中 self.cleaned_data[name] = value if hasattr(self, 'clean_%s' % name): value = getattr(self, 'clean_%s' % name)() self.cleaned_data[name] = value except ValidationError as e: self.add_error(name, e)
- clean 方法
def clean(self, value): #一些操作将value值变为python环境下 value = self.to_python(value) #执行校验方法一 self.validate(value) #清洗校验二 self.run_validators(value) return value
# 校验方法一,也即内置校验,出错就抛出异常 def validate(self, value): if value in self.empty_values and self.required: raise ValidationError(self.error_messages['required'], code='required') #校验方式二 也即自定义校验,此时会将报错添加到error_list中 def run_validators(self, value): if value in self.empty_values: return errors = [] for v in self.validators: try: v(value) except ValidationError as e: if hasattr(e, 'code') and e.code in self.error_messages: e.message = self.error_messages[e.code] errors.extend(e.error_list) if errors: raise ValidationError(errors)
- 当clean完毕 回到
try: if isinstance(field, FileField): initial = self.get_initial_for_field(field, name) value = field.clean(value, initial) else: #执行clean方法 value = field.clean(value) #通过clean方法,此时的value就是通过了内置校验和自定义的校验 #将通过清洗的字段的值即value添加到cleaned_data字典中 self.cleaned_data[name] = value #此处会查找是否有 有clean_xxx定义的校验方法 if hasattr(self, 'clean_%s' % name): #能找到通过反射执行,如果报错会被 try 捕捉并将 ValidationError通过add_error方法弹出 value = getattr(self, 'clean_%s' % name)() self.cleaned_data[name] = value except ValidationError as e: self.add_error(name, e)
- add_error 方法:
#该方法的参数是字段名,以及 ,报错内容 def add_error(self, field, error): #其余部分代码 #我们自己定义的clean_xxx方法(xxx为字段名)此时在cleaned_data中 if field in self.cleaned_data: #将它从字典里删除 del self.cleaned_data[field]
- 到此引出 局部钩子 (HOOK) 也即我们定义的方法
#________局部钩子格式______________
from django.core.exceptions import ValidationError # 方法名必须为 clean_(字段名),参数只有一个self def clean_user(self): # 此时的value值是存在于cleaned_data中的 value = self.cleaned_data.get('user') #定义逻辑 if '苍老师' in value: #并且 抛出的异常名必须为 ValidationError raise ValidationError('敏感词汇,不能使用') #同样必须将值返回 return value
- 到此执行 _clean_form(self)
def _clean_form(self): try: #对cleaned_data中的value执行一个clean方法 cleaned_data = self.clean() except ValidationError as e: self.add_error(None, e) else: if cleaned_data is not None: self.cleaned_data = cleaned_data
- 到此执行 _clean_form(self) 后续的clean方法
def clean(self): """ Hook for doing any extra form-wide cleaning after Field.clean() has been called on every field. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field named '__all__'. """ return self.cleaned_data
- 到此引出 全局钩子 (HOOK)
#________全局钩子格式______________
- 定义一个放法 clean（self）的方法，如果不通过校验规则，要抛出异常ValidationError，还可以自己使用self.add_error('re_pwd', '两次密码不一致!!@!')添加错误信息。如果通过校验规则，返回所有通过校验的值
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', '两次密码不一致!!@!') raise ValidationError('两次密码不一致') return self.cleaned_data