Django之form组件
Django的form表单
我们之前在HTML页面中利用form表单向后端提交数据时，都会写一些获取用户输入的标签并且用form标签把它们包起来。
与此同时我们在好多场景下都需要对用户的输入做校验，比如校验用户是否输入，输入的长度和格式等正不正确。如果用户输入的内容有错误就需要在页面上相应的位置显示对应的错误信息.。
Django form组件就实现了上面所述的功能。
总结一下，其实form组件的主要功能如下:
- 生成页面可用的HTML标签
- 对用户提交的数据进行校验
- 保留上次输入内容
普通登录
app/views.py的代码
from django.shortcuts import render,HttpResponse from django.http import JsonResponse # Create your views here. def login(request): error_msg = "" info={'username':None, 'pwd':None} if request.method == "POST": username = request.POST.get("username") pwd = request.POST.get("pwd") if username == "admin" and pwd == "admin": return HttpResponse("OK") else: error_msg = "用户名或密码错误" info = {'username':username, 'pwd':pwd} return render(request, "login.html", {"error_msg": error_msg, 'info':info})
login.html的代码
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>login</title> <style> .error { color: red; } </style> </head> <body> <form action="/login/" method="post"> {% csrf_token %} <p> <label for="username">用户名:</label> <input type="text" name="username" id="username" value="{% if info.username %}{{ info.username }}{% endif %}"> </p> <p> <label for="pwd">密码:</label> <input type="password" name="pwd" id="pwd" value="{% if info.pwd %}{{ info.pwd }}{% endif %}"> <span class="error">{{ error_msg }}</span> </p> <p> <input type="submit"> </p> </form> </body> </html>
上面只写了视图和模板。还有路由系统没写，这个实现了我们输入密码如果正确会显示ok如果错误登录页面我们输入的用户名和密码都还在，同时密码的右边会提示用户名和密码错误。
使用form组件实现
app01/views.py 的代码
from django.shortcuts import render,HttpResponse from django import forms # 第一步 导入该组件 # Create your views here. # 第二步 定义一个form类 class RegForm(forms.Form): name = forms.CharField(max_length=8, label='用户名') pwd = forms.CharField(min_length=6, label='密码') def reg(request): error_msg = "" forms_obj = RegForm() # 实例化一个对象用于传递到模板语言中 if request.method == 'POST': forms_obj = RegForm(request.POST) # 让form帮我们做校验 if forms_obj.is_valid(): # 校验通过 name = forms_obj.cleaned_data.get('name') pwd = forms_obj.cleaned_data.get('pwd') if name == 'admin' and pwd == 'admin123': return HttpResponse('ok') else: error_msg = '用户名或密码错误' return render(request,'reg.html', {'error_msg':error_msg, 'forms_obj':forms_obj})
reg.html代码
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>reg</title> <style> .error{ color: red; } </style> </head> <body> <form action="/app01/reg/" method="post" novalidate> {% csrf_token %} {# <p>#} {# {{ forms_obj.as_p }} {# 第一种方式 全部一次性实现 #} {# </p>#} <p> {{ forms_obj.name.label }} {{ forms_obj.name }} </p> {# 这种方式是 一个一个的写 加上下面就是和上面等同效果#} <p> {{ forms_obj.pwd.label }} {{ forms_obj.pwd }} </p> <span class="error">{{ error_msg }}</span> <p><input type="submit"></p> </form> </body> </html>
form插件的知识
常用字段与插件
initial
初始值，input框里面的初始值。
class regForm(forms.Form): name = forms.CharField( min_length=16, label="用户名", initial="admin" # 设置默认值 ) pwd = forms.CharField(min_length=6, label="密码")
error_messages
重写错误信息。
class regForm(forms.Form): username = forms.CharField( max_length=16, label="用户名", initial="admin", error_messages={ "required": "不能为空", "invalid": "格式错误", "min_length": "用户名最长16位" } ) pwd = forms.CharField(min_length=6, label="密码")
password
这个当我们输入密码的时候就看不见密码了
需要导入:
from django.forms import widgets
class RegForm(forms.Form): name = forms.CharField( max_length=8, label='用户名', ) pwd = forms.CharField( min_length=6, label='密码', widget=widgets.PasswordInput(attrs={'class':"form-control"},render_value=True) )
radioSelect
单radio值为字符串
class regForm(forms.Form): gender = forms.fields.ChoiceField( choices=((1, "男"), (2, "女"), (3, "保密")), label="性别", initial=3, widget=forms.widgets.RadioSelect )
单选Select
class regForm(forms.Form): ... hobby = forms.fields.ChoiceField( choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ), label="爱好", initial=3, widget=forms.widgets.Select )
多选Select
class regForm(forms.Form): ... hobby = forms.fields.MultipleChoiceField( choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ), label="爱好", initial=[1, 3], widget=forms.widgets.SelectMultiple
单选checkbox
class regForm(forms.Form): ... keep = forms.fields.ChoiceField( label="是否记住密码", initial="checked", widget=forms.widgets.CheckboxInput )
多选checkbox
class regForm(forms.Form): ... hobby = forms.fields.MultipleChoiceField( choices=((1, "篮球"), (2, "足球"), (3, "双色球"),), label="爱好", initial=[1, 3], widget=forms.widgets.CheckboxSelectMultiple )
关于choice的注意事项：
我们可以这样写：choices=models.City.objects.all().values_list("id", "name"), 从数据库中取出来的是元素为元组的列表
在使用选择标签时，需要注意choices的选项可以从数据库中获取，但是由于是静态字段 ***获取的值无法实时更新***，那么需要自定义构造方法从而达到此目的。
推荐使用第二种
方式一：
from django.forms import Form from django.forms import widgets from django.forms import fields class RegForm(Form): city = forms.ChoiceField( choices=models.City.objects.all().values_list("id", "name"), label="城市", initial=1, widget=forms.widgets.Select ) # 重写父类的init方法 def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.fields["city"].widget.choices = models.City.objects.all().values_list("id", "name")
方式二：
from django import forms from django.forms import fields from django.forms import models as form_model class RegForm(forms.Form): authors = form_model.ModelMultipleChoiceField(queryset=models.NNewType.objects.all()) # 多选 # authors = form_model.ModelChoiceField(queryset=models.NNewType.objects.all()) # 单选
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类型
定制校验
方式一：
from django.forms import Form from django.forms import widgets from django.forms import fields from django.core.validators import RegexValidator class RegForm(Form): mobile = forms.CharField( label="手机", # 校验规则 validators=[ RegexValidator(r'^[0-9]+$', '手机号必须是数字'), RegexValidator(r'^1[3-9][0-9]{9}$', '手机格式有误') ], widget=widgets.TextInput(attrs={"class": "form-control"}), error_messages={ "required": "该字段不能为空", } )
方式二
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): 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): 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'邮箱'}))
检验用户名是否含有不该有的名字：
class RegForm(forms.Form): name = forms.CharField( # 校验规则相关 max_length=16, label="用户名", error_messages={ "required": "该字段不能为空", }, # widget控制的是生成html代码相关的 widget=widgets.TextInput(attrs={"class": "form-control"}) ) def clean_name(self): value = self.cleaned_data.get("name") if "xxx" in value: raise ValidationError("不符合社会主义核心价值观！") return value
在注册的时候如何把密码和确认密码这两项联系起来校验成功：
from django import forms from django.forms import widgets from django.core.validators import RegexValidator from django.core.exceptions import ValidationError class RegForm(forms.Form): name = forms.CharField( # 校验规则相关 max_length=16, label="用户名", error_messages={ "required": "该字段不能为空", }, # widget控制的是生成html代码相关的 widget=widgets.TextInput(attrs={"class": "form-control"}) ) pwd = forms.CharField( label="密码", min_length=6, max_length=10, widget=widgets.PasswordInput(attrs={"class": "form-control"}, render_value=True), error_messages={ "min_length": "密码不能少于6位！", "max_length": "密码最长10位！", "required": "该字段不能为空", } ) re_pwd = forms.CharField( label="确认密码", min_length=6, max_length=10, widget=widgets.PasswordInput(attrs={"class": "form-control"}, render_value=True), error_messages={ "min_length": "密码不能少于6位！", "max_length": "密码最长10位！", "required": "该字段不能为空", } ) # 重写父类的clean方法,把两次密码不一致加到re_pwd的错误里面 def clean(self): # 此时 通过检验的字段的数据都保存在 self.cleaned_data pwd = self.cleaned_data.get("pwd") re_pwd = self.cleaned_data.get("re_pwd") if pwd != re_pwd: self.add_error("re_pwd", ValidationError("两次密码不一致")) raise ValidationError("两次密码不一致") return self.cleaned_data def reg(request): form_obj = RegForm() if request.method == "POST": form_obj = RegForm(request.POST) # 让form帮我们做校验 if form_obj.is_valid(): # 校验通过 # 把数据存到数据库 # 所有经过校验的数据都保存在 form_obj.cleaned_data print(form_obj.cleaned_data) del form_obj.cleaned_data["re_pwd"] models.UserInfo.objects.create(**form_obj.cleaned_data) # models.UserInfo.objects.create_user(**form_obj.cleaned_data) # 上面的这个的作用就是我们使用UserInfo继承Django的user这样存储的密码是加了密的 return HttpResponse("注册成功！") return render(request, "reg.html", {"form_obj": form_obj})
批量添加样式
可通过重写form类的init方法来实现。
class LoginForm(forms.Form): username = forms.CharField( min_length=8, label="用户名", initial="张三", error_messages={ "required": "不能为空", "invalid": "格式错误", "min_length": "用户名最短8位" } ... def __init__(self, *args, **kwargs): super(LoginForm, self).__init__(*args, **kwargs) for field in iter(self.fields): self.fields[field].widget.attrs.update({ 'class': 'form-control' })
前段使用后面传入得form的实例
视图传入的form实例为form_obj，在前端我们使用{{form_obj.as_p}},所有的字段都出来了，可以用as_p显示全部，
也可以使用for form in form_obj把每一个字段循环一下，form可以直接显示input标签，可以使form.label拿到我们组件中的label，.errors.0拿取错误信息。
如下
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>欢迎注册</title> <link rel="stylesheet" href="/static/bootstrap/css/bootstrap.min.css"> <link rel="stylesheet" href="/static/mystyle.css"> </head> <body> <div class="container"> <div class="row"> <div class="col-md-6 col-md-offset-3"> <form novalidate autocomplete="off" action="/reg/" method="post" class="form-horizontal reg-form" enctype="multipart/form-data"> {% csrf_token %} {% for form in form_obj %} <div class="form-group"> <label for="{{ form.id_for_label }}" class="col-sm-2 control-label">{{ form.label }}</label> <div class="col-sm-8"> {{ form }} <span class="help-block">{{ form.errors.0 }}</span> </div> </div> {% endfor %} {# <div class="form-group">#} {# <label for="{{ form_obj.username.id_for_label }}"#} {# class="col-sm-2 control-label">{{ form_obj.username.label }}</label>#} {# <div class="col-sm-8">#} {# {{ form_obj.username }}#} {# <span class="help-block">{{ form_obj.username.errors.0 }}</span>#} {# </div>#} {# </div>#} {# <div class="form-group">#} {# <label for="{{ form_obj.password.id_for_label }}"#} {# class="col-sm-2 control-label">{{ form_obj.password.label }}</label>#} {# <div class="col-sm-8">#} {# {{ form_obj.password }}#} {# <span class="help-block">{{ form_obj.password.errors.0 }}</span>#} {# </div>#} {# </div>#} {##} {# <div class="form-group">#} {# <label for="{{ form_obj.re_password.id_for_label }}"#} {# class="col-sm-2 control-label">{{ form_obj.re_password.label }}</label>#} {# <div class="col-sm-8">#} {# {{ form_obj.re_password }}#} {# <span class="help-block">{{ form_obj.re_password.errors.0 }}</span>#} {# </div>#} {# </div>#} {##} {# <div class="form-group">#} {# <label for="{{ form_obj.email.id_for_label }}"#} {# class="col-sm-2 control-label">{{ form_obj.email.label }}</label>#} {# <div class="col-sm-8">#} {# {{ form_obj.email }}#} {# <span class="help-block">{{ form_obj.email.errors.0 }}</span>#} {# </div>#} {# </div>#} <div class="form-group"> <label class="col-sm-2 control-label">头像</label> <div class="col-sm-8"> <label for="id_avatar"><img id="avatar-img" src="/static/img/default.png" alt=""></label> <input accept="image/*" type="file" name="avatar" id="id_avatar" style="display: none"> <span class="help-block"></span> </div> </div> <div class="form-group"> <div class="col-sm-offset-2 col-sm-10 col-md-offset-3"> <button type="button" class="btn btn-success" id="reg-submit">注册</button> </div> </div> </form> </div> </div> </div> </body> </html>
上面的黄色部位可以是用来代替下面的注释部分的
