Django——forms 组件

Posted 2022-01-19 king-home

一、forms简介

我们之前在html页面中利用form表单向后端提交数据时，都会写一些获取用户输入的标签并且用form标签把它们包起来。

与此同时我们在好多场景下都需要对用户的输入做校验，比如校验用户是否输入，输入的长度和格式等正不正确。如果用户输入的内容有错误就需要在页面上相应的位置显示对应的错误信息.。

Django forms组件主要功能：

• 生成页面可用的HTML标签
• 对用户提交的 数据进行校验
• 保留上次输入的内容

二、如何使用Django forms

1、注册功能:

• 渲染前端标签获取用户输入 》》》 渲染标签
• 获取用户输入传递后端进行校验 》》》 检验数据
• 校验未通过展示展示错误信息 》》》 展示信息

2、检验数据：

# 第一步：需要form类
from django imort forms

class MyForm(forms.Form):
    name = forms.CharField(max_length=6)
	password = forms.CharField(max_length=8,min_length=3)
	email = forms.EmailField(required=True)
# 第二步：实例化form对象
form_obj = Myform()
# 第三步：查看数据是否检验是否合法
form_obj.is_valid()  # 只有当前所有的字段全部通过了才会返回True
# 第四步：查看检验错误信息
form_obj.errrors  # 存放所有的检验未通过的字段的错误信息
"""

‘name‘: [‘Ensure this value has at most 6 characters (it has 7).‘],
‘password‘: [‘Ensure this value has at least 3 characters (it has 2).‘],
‘email‘: [‘Enter a valid email address.‘]


"""
# 第五步：查看检验通过的数据
form_obj.cleaned_data  # 符合检验规则的数据都会被放到该对象中
# ps： form组件校验数据的规则是从上往下取值，依次校验
检验通过的放到cleaned_data
检验失败的放到errors

forms

注意:

• form中所有的字段默认都是必须传值的(required=True)
• 校验数据的时候可以都传(多传的数据不会做任何的校验>>>不会影响form校验规则)

3、渲染标签

html：三种渲染方式

第一种：

<h1>第一种渲染方式(可扩展性较差)</h1>
 form_obj.as_p 
 form_obj.as_ul 

第二种：

<h1>第二种渲染方式</h1>
<form action="">
    <p> form_obj.name.label  form_obj.name </p>
    <p> form_obj.password.label  form_obj.password </p>
    <p> form_obj.email.label  form_obj.email </p>
    <input type="submit">
</form>

第三种：

<h1>第三种渲染标签的方式</h1>
<form action="" method="post" novalidate>
    % for foo in form_obj %
        <p>
            foo.label foo
            <span> foo.errors.0 </span>
        </p>
    % endfor %
    <input type="submit">
</form>

注意点：

form组件提交数据如果数据不合法，页面上会保留之前用户输入的信息
在使用form组件对模型表进行数据校验的时候，只需要保证字段一致
那么在创建的对象的时候你就直接**form_obj.cleaned_data

<form action="" method="post" novalidate>
	% for foo in form_obj %
		<p>
		 foo.label  foo 
		<span> foo.errors.0 </span>
		</p>
		% endfor %
			<input type="submit">
</form>

看网页效果发现 也验证了form的功能：
? 前端页面是form类的对象生成的                                      -->生成HTML标签功能
? 当用户名和密码输入为空或输错之后 页面都会提示        -->用户提交校验功能
? 当用户输错之后 再次输入 上次的内容还保留在input框   -->保留上次输入内容

三、Form常用的功能：

1、常用字段和插件

创建Form类时，主要涉及到 【字段】 和 【插件】，字段用于对用户请求数据的验证，插件用于自动生成HTML;

# initial

初始值，input框里面的初始值。

class LoginForm(forms.Form):
    username = forms.CharField(
        min_length=8,
        label="用户名",
        initial="张三"  # 设置默认值
    )
    pwd = forms.CharField(min_length=6, label="密码")

# 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="密码")

# password

class LoginForm(forms.Form):
    ...
    pwd = forms.CharField(
        min_length=6,
        label="密码",
        widget=forms.widgets.PasswordInput(attrs=‘class‘: ‘c1‘, render_value=True)
    )

# radioselect：单radio

 

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="密码")
    gender = forms.fields.ChoiceField(
        choices=((1, "男"), (2, "女"), (3, "保密")),
        label="性别",
        initial=3,
        widget=forms.widgets.RadioSelect()
    )

# 单选Select

class LoginForm(forms.Form):
    ...
    hobby = forms.ChoiceField(
        choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ),
        label="爱好",
        initial=3,
        widget=forms.widgets.Select()
    )

# 多选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()
    )

# 单选checkbox

class LoginForm(forms.Form):
    ...
    keep = forms.ChoiceField(
        label="是否记住密码",
        initial="checked",
        widget=forms.widgets.CheckboxInput()
    )

# 多选checkbox

 

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())  # 单选

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、字段校验

# 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
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‘邮箱‘))

4、Hook方法（钩子）

除了上面两种方式，我们还可以在Form类中定义钩子函数，来实现自定义的验证功能。

# 局部钩子

我们在Fom类中定义 clean_字段名() 方法，就能够实现对特定字段进行校验。

def clean_name(self):
    name = self.cleaned_data.get(‘name‘)
    if ‘666‘ in name:
        self.add_error(‘name‘,‘光喊666是不行的，要有真实力!‘)
    return name  # return还是要加上的，兼容性考虑

# 全局钩子

我们在Fom类中定义 clean() 方法，就能够实现对字段进行全局校验。

def clean(self):
    password = self.cleaned_data.get(‘password‘)
    confirm_password = self.cleaned_data.get(‘confirm_password‘)
    if not password == confirm_password:
        self.add_error(‘confirm_password‘,"两次密码不一致，你这个dsb!")
    return self.cleaned_data