Django之Form组件
一、Form介绍
普通方式手写注册功能
-
views.py
def register(request): error_msg="" if request.method=="POST": username = request.POST.get("name") pwd = request.POST.get('pwd') #对注册信息做校验 if len(username)<6: error_msg="用户名长度不能小于6位" else: #可以用户名和密码存在数据库 return HttpResponse("注册成功") return render(request,"register.html",{'error_msg':error_msg}) -
register.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>注册页面</title> </head> <body> <form action="/reg/" method="post"> {% csrf_token %} <p> 用户名: <input type="text" name="name"> </p> <p> 密码： <input type="password" name="pwd"> </p> <p> <input type="submit" value="注册"> <p style="color: red">{{ error_msg }}</p> </p> </form> </body> </html>
使用form组件实现注册功能
-
views.py
第一步：先定义一个RegForm类 from django import forms #按照Django form组件的要求写一个类 class RegForm(forms.Form): name = forms.CharField(label="用户名") #form字段的名称写什么，前端生成input标签的时候，input标签的name属性的值就是什么 pwd = forms.CharField(label="密码") 第二步：写一个视图函数 def register(request): if request.method == "POST": #实例化form对象的时候，把post提交过来的数据直接传过去 form_obj = RegForm(data = request.POST) #既然传过来的input标签的name属性值和form类对应的字段名是一样的，所以接过来后，form就取出对应的form字段名相同的数据进行form校验 if form_obj.is_valid(): #返回的值是True或False return HttpResponse("注册成功") return render(request,'register.html',{'form_obj':form_obj}) -
register.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>注册2</title> </head> <body> <form action="/reg2/" method="post" novalidate autocomplete="off"> #novalidate 告诉前端form表单，不要对输入的内容做校验 {% csrf_token %} #{{ form_obj.as_p }} 直接写个这个，下面的用户名和密码的标签不自己写，你看看效果 <div> <label for="{{ form_obj.name.id_for_label }}">{{ form_obj.name.label }}</label> {{ form_obj.name }} {{ form_obj.name.errors.0 }} #errors是这个字段所有的错误，我就用其中一个错误提示就可以了，再错了再提示，并且不是给你生成ul标签了，单纯的是错误文本 {{ form_obj.errors }} #这是全局的所有错误，找对应字段的错误，就要form_obj.字段名 </div> <div> <label for="{{ form_obj.pwd.id_for_label }}">{{ form_obj.pwd.label }}</label> {{ form_obj.pwd }} {{ form_obj.pwd.errors.0 }} </div> <div> <input type="submit" class="btn btn-success" value="注册"> </div> </form> </body> </html>- 看网页效果发现，也验证了form的功能:
- 前端页面是form类的对象生成的 -->生成HTML标签功能
- 当用户名和密码输入为空或输错之后，页面都会提示 -->用户提交校验功能
- 当用户输错之后，再次输入，上次的内容还保留在input框中 -->保留上次输入内容
- 看网页效果发现，也验证了form的功能:
二、Form常用字段与插件
创建Form类时，主要涉及到【字段】和【插件】，字段名对于用户请求数据的验证，插件用于自动生成HTML
initial
-
初始值，input框里面的初始值
class LoginForm(forms.Form): username = forms.CharField( min_length=8, label="用户名", initial="小骚浩", #设置默认值为小骚浩 )
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.widgets.PasswordInput(attrs={'class':'c1'},render_value=True) ##这个密码字段和其他字段不一样，默认在前端输入数据错误的时候，点击提交之后，默认是不保存的原来数据的，但是可以通过这个render_value=True让这个字段在前端保留用户输入的数据 )
radioSelect
-
单rodio值为字符串
class LoginForm(forms.Form): sex = forms.fields.ChoiceField( choices = ((1,"男"),(2,"女"),(3,"保密")), label="性别", initial=3, #默认是保密 widget = forms.widgets.RadioSelect() )
单选Select
-
Select单选
class LoginForm(forms.Form): hobby=forms.fields.ChoiceField( choices=((1,'篮球'),(2,"足球"),(3,"乒乓球")), label="爱好", widget=forms.widgets.Select() )
多选Select
-
Select多选
class LoginForm(forms.Form): hobby=forms.fields.MultipleChoiceField( #多选框的时候用MultipleChoiceField，并且里面的插件用的是SelectMultiple，不然验证的时候会报错。 choices=((1,'篮球'),(2,"足球"),(3,"乒乓球")), label="爱好", widget=forms.widgets.SelectMultiple() )
单选checkbox
-
checkbox单选
class LoginForm(forms.Form): keep=forms.fields.ChoiceField( label="是否记住密码", initial='checked', widget=forms.widgets.CheckboxInput() ) -
示例：
#单选的checkbox class TestForm2(forms.Form): keep = forms.ChoiceField( choices=( ('True',1), ('False',0), ), label="是否7天内自动登录", initial="1", widget=forms.widgets.CheckboxInput(), ) 选中:'True' #form只是帮我们做校验,校验选择内容的时候,就是看在没在我们的choices里面,里面有这个值,表示合法,没有就不合法 没选中:'False' ---保存到数据库里面 keep:'True' if keep == 'True': session 设置有效期7天 else: pass
多选checkbox
-
checkbox多选
class LoginForm(forms.Form): hobby=forms.fields.MultipleChoiceField( choices=((1,'篮球'),(2,'足球'),(3,'乒乓球')), label="爱好", initial=[1,3], widget=forms.widgets.CheckboxSelectMultiple() )
date类型
-
date日期格式
from django import forms from django.forms import widgets class BookForm(forms.Form): date=forms.DateField( widget=widgets.TextInput(attrs={'type':'date'}) ) #必须指定type，不然不能渲染成选择时间的input框
choice字段注意事项
-
在使用选择标签时，需要注意choices的选项可以配置从数据库中获取，但是由于静态字段获取的值无法实时更新，需要重写构造方法从而实现choice实时更新。
-
方式一：
from django.forms import Form from django.forms import widgets from django.forms import fields from app01 import models 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) #注意重写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 from_model class FInfo(forms.Form): # 多选方式一 authors=forms.ModelMultipleChoiceField(queryset=models.NNewType.objects.all()) #多选 # 方式二 authors = form_model.ModelMultipleChoiceField(queryset=models.NNewType.objects.all()) #单选 方式一 authors=form_model.ModelChoiceField(queryset=models.NNewType.objects.all()) #单选 #单选 方式二 publish = forms.ModelChoiceField(queryset=models.Publish.objects.all(),widget=forms.widgets.Select) #单选 authors = forms.ModelMultipleChoiceField( queryset=models.Author.objects.all(), widget=forms.widgets.Select(attrs={'class':'form_control'}) ) #如果用这种方式，别忘了model表中，即创建model类定义一个__str__方法，不然选择框里面是一个个object对象
-
三、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,widgets,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 moblie_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'邮箱'}))
五、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
全局钩子
-
在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', '两次密码不一致') #在re_password这个字段的错误列表中加上一个错误，并且clean_data里面会自动清除这个re_password的值，所以打印clean_data的时候会看不到它 raise ValidationError('两次密码不一致')
