Django之Form
一 Form介绍
我们之前在HTML页面中利用form表单向后端提交数据时,都会写一些获取用户输入的标签并且用form标签把它们包起来。
与此同时我们在好多场景下都需要对用户的输入做校验,比如校验用户是否输入,输入的长度和格式等正不正确。如果用户输入的内容有错误就需要在页面上相应的位置显示对应的错误信息.。
Django form组件就实现了上面所述的功能。
form组件的主要功能:
生成页面可用的HTML标签
对用户提交的数据进行校验
保留上次输入内容
普通方式手写注册功能
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: # 用户长度小于6位 error_msg = "用户名长度不能小于6位" else: # 将用户名和密码存到数据库 return HttpResponse("注册成功") return render(request, "register.html", {"error_msg": error_msg})
login.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
先定义好一个Form类:
from django import forms # 按照Django form组件的要求自己写一个类 class RegForm(forms.Form): name = forms.CharField(label="用户名") #form字段的名称写的是什么,那么前端生成input标签的时候,input标签的name属性的值就是什么 pwd = forms.CharField(label="密码",widget=forms.PasswordInput
)
再写一个视图函数:
# 使用form组件实现注册方式 def register2(request): form_obj = RegForm() if request.method == "POST": # 实例化form对象的时候,把post提交过来的数据直接传进去 form_obj = RegForm(data=request.POST) #既然传过来的input标签的name属性值和form类对应的字段名是一样的,所以接过来后,form就取出对应的form字段名相同的数据进行form校验 # 调用form_obj校验数据的方法 if form_obj.is_valid(): return HttpResponse("注册成功") return render(request, "register2.html", {"form_obj": form_obj})
html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>注册2</title> </head> <body> <form action="" 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类时,主要涉及到 【字段】 和 【插件】,字段用于对用户请求数据的验证,插件用于自动生成HTML;
password(密码)
class LoginForm(forms.Form): ... pwd = forms.CharField( min_length=6, label="密码", #widget=forms.PasswordInput widget=forms.PasswordInput(attrs={'class': 'c1'}, render_value=True) #这个密码字段和其他字段不一样,默认在前端输入数据错误的时候,点击提交之后,默认是不保存的原来数据的,但是可以通过这个render_value=True让这个字段在前端保留用户输入的数据 ) # widget=forms.widgets.PasswordInput(attrs={"class":"form-control"},render_value=True) #两种写法 )
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="密码")
initial(初始值)
初始值,input框里面的初始值。
class LoginForm(forms.Form):
username = forms.CharField(
min_length=8,
label="用户名",
initial="张三" # 设置默认值
)
pwd = forms.CharField(
min_length=6,
label="密码"
)
radioSelect
单点radio值为字符串
class LoginForm(forms.Form): gender=forms.ChoiceField( label='性别', choices=((1,'男'),(2,'女'),(3,'alex')), widget=forms.RadioSelect() # widget=forms.widgets.RadioSelect() )
单选select
class LoginForm(forms.Form): ... hobby = forms.ChoiceField( #注意,单选框用的是ChoiceField,并且里面的插件是Select,不然验证的时候会报错, Select a valid choice的错误。 choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ), label="爱好", initial=3, widget=forms.widgets.Select() )
多选Select
class LoginForm(forms.Form): ... hobby = forms.fields.MultipleChoiceField( #多选框的时候用MultipleChoiceField,并且里面的插件用的是SelectMultiple,不然验证的时候会报错。 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示例:
#单选的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
class LoginForm(forms.Form): ... hobby = forms.fields.MultipleChoiceField( choices=((1, "篮球"), (2, "足球"), (3, "双色球"),), label="爱好", initial=[1, 3], widget=forms.widgets.CheckboxSelectMultiple() )
date类型
第一种:需要导入widgets from django import forms from django.forms import widgets class BookForm(forms.Form): date = forms.DateField(widget=widgets.TextInput(attrs={'type':'date'})) #必须指定type,不然不能渲染成选择时间的input框 第二种写法 date =forms.DateField( label='时间', widget=forms.DateInput(attrs={'type':'date'}) )
Model(导入)
ModelChoiceField(数据库单选)
hobby=forms.ModelChoiceField( label='爱好', queryset=models.Hobby.objects.all(), widget=forms.widgets.Select(attrs={"class": "form-control"}), error_messages = { 'required': '不可为空' } )
ModelMultipleChoiceField(数据库多选)
hobby=forms.ModelMultipleChoiceField( label='爱好', queryset=models.Hobby.objects.all(), widget=forms.widgets.SelectMultiple(attrs={"class": "form-control"}), error_messages = { 'required': '不可为空' } )
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()) # 单选
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类型
from django.shortcuts import render,HttpResponse from django import forms class loginform(forms.Form): name=forms.CharField( min_length=3, #最小长度 required=True, #提交等于Trun,内容不能为空 label='名字', #标识 # initial='alex' #默认值 help_text='这里是不能太短', #上面就有提示 error_messages={'required':'不能为空!','min_length':'太短了!'} ) pwd=forms.CharField( min_length=1, max_length=4, label='密码', # widget=forms.widgets.PasswordInput(attrs={'class':'form-control'}),#bootstrap widget=forms.widgets.PasswordInput() ) def form(request): form_obj=loginform() if request.method=='GET': return render(request, 'form.html',{'form_obj':form_obj}) else: form_obj=loginform(request.POST) #request.POST获取验证数据 print(form_obj,1111) if form_obj.is_valid(): #查看是否符合校验条件返回Trun或False print(form_obj.cleaned_data) #获取所有数据,取到字典 print(login.changed_data) #获取字段名 return HttpResponse('OK') else: print('xxxx') print(form_obj.errors) return render(request,'form.html',{'form_obj':form_obj})
{% load static %} <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> <link rel="stylesheet" href="{% static 'bootstrap-3.3.7-dist\css\bootstrap.min.css' %}"> </head> <body> <form action="" method="post" novalidate> {# novalidate取消浏览器的提示 #} {% csrf_token %} <div> <label for="">{{ form_obj.name.label }}</label> {{ form_obj.name }} {{ form_obj.name.help_text }} <span style="color: red">{{ form_obj.name.errors.0 }}</span>{# 报错信息,红色#} </div> <div> <label for="">{{ form_obj.pwd.label }}</label> {{ form_obj.pwd }} <span style="color: red">{{ form_obj.pwd.errors.0 }}</span>{# 报错信息,红色#} </div> <input type="submit" id="but"> </form> </body> </html>
常用字段
CharField # input ChoiceField # select MultipleChoiceField # 多选 ModelMultipleChoiceField # 可选数据放入数据库
字段参数
initial 初始值
label 中文提示
error_messages 错误提示
min_length 最小长度
choices 可选择的值
widget 插件
模板
{{ form_obj.as_p }} # 展示所有的字段 {{ form_obj.user }} # input框 {{ form_obj.user.label }} # label标签的中文提示 {{ form_obj.user.id_for_label }} # input框的id {{ form_obj.user.errors }} # 一个字段的错误信息 {{ form_obj.user.errors.0 }} # 一个字段的第一个错误信息 {{ form_obj.errors }} # 所有字段的错误
校验
required
min_length
自定义校验
第一种写函数
views下
#自定义校验 from django.core.exceptions import ValidationError def check_user(value):
# 通过校验 不做任何操作
# 不通过校验 抛出ValidationError异常
if 'alex' in value: raise ValidationError('alex 滚蛋') class LoginForm(forms.Form): user =forms.CharField( label='用户名', validators=[check_user], #加入自定义函数
第二种使用内置的校验器
from django.core.validators import validate_email, RegexValidator # 点击validators,看更多内置方法 # RegexValidator,正则表达式 phone = forms.CharField(validators=[RegexValidator(r'^1[3-9]\d{9}$', '手机号格式不正确')])
钩子
钩子写在form class里
cleaned_data 取到的是字典{字段:内容}
局部钩子
from django.core.exceptions import ValidationError
def clean_user(self): # clean_字段名
v=self.cleaned_data.get('user') # get(字段名)
if v in 'alex': # 校验内容中是否含有alex
self.add_error('user', 'alex 滚') #不通过校验,抛异常 (字段,报错信息)
raise ValidationError('alex 滚') # raise
return self.cleaned_data # 通过校验 返回当前字段值
全局钩子
def clean(self): password=self.cleaned_data.get('password') pwd=self.cleaned_data.get('pwd') if password != pwd: self.add_error('pwd','两次密码不一致') raise ValidationError('两次密码不一致1') return self.cleaned_data