Django高级之-forms组件

1 forms组件前戏

不用ajax的情况下，用form表单获取用户输入，在后端进行校验，并在前端返回提示信息。

写一个注册功能，获取用户名和密码，利用form表单提交数据。在后端判断用户名和密码是否符合一定的条件，用户名中不能含有jpm，密码不能少于三位。如何符合条件需要你将提示信息展示到前端页面。

后端

def ab_form(request):
    back_dic = {'username':'','password':''}     # 定义一个没有值的字典，返回到前端页面，在span标签内取值{{ back_dic.username }}
    if request.method == 'POST':                 # get请求来的时候字典值都是空的，span标签没有文本，隐形占位
        username = request.POST.get('username')  # post请求，根据后端校验，对不符合要求的数据，给字典key赋值，返回到前端并用span标签展示出来
        password = request.POST.get('password')
        if 'jpm' in username:
            back_dic['username'] = '不符合社会主义核心价值观'
        if len(password) < 3:
            back_dic['password'] = '不能太短 不好!'
        else:
            # 将用户名和密码存到数据库
            return HttpResponse("注册成功")
    return render(request,'ab_form.html',locals())

 前端

<form action="" method="post">
    <p>username:
        <input type="text" name="username">
        <span style="color: red">{{ back_dic.username }}</span>
    </p>
    <p>password:
        <input type="text" name="password">
        <span style="color: red">{{ back_dic.password }}</span>
    </p>
    <input type="submit" class="btn btn-info">
</form>

手写版本

1.手动书写前端获取用户数据的html代码 ----> 渲染html代码
2.后端对用户数据进行校验 ----> 校验数据
3.对不符合要求的数据进行前端提示 ----> 展示提示信息

forms组件能够完成上述三件事。为什么数据校验非要去后端，不能在前端利用js直接完成呢？前端的校验是弱不禁风的，你可以直接修改或者利用爬虫程序绕过前端页面直接朝后端提交数据。

 

2 forms组件类书写

定义一个类，类似models中定义类，只不过在校验性组件，字段就必须严格按照参数限制。

views.py

from django import forms

class MyForm(forms.Form):
    username = forms.CharField(min_length=3,max_length=8)  # username字符串类型最小3位最大8位    
    password = forms.CharField(min_length=3,max_length=8)  # password字符串类型最小3位最大8位
    email = forms.EmailField()                              # email字段必须符合邮箱格式  xxx@xx.com

 

3 forms组件校验数据

from app01 import views
# 1 调用MyForm产生一个对象，将待校验的数据组织成字典的形式传入，参照定义类时的字段参数规则自动进行校验
form_obj = views.MyForm({'username':'jason','password':'123','email':'123'})

# 2 判断数据是否合法，注意该方法只有在所有的数据全部合法的情况下才会返回True
form_obj.is_valid()
>>>False

# 3 查看所有校验通过的数据，字典形式返回
form_obj.cleaned_data
>>>{'username': 'jason', 'password': '123'}

# 4 查看所有不符合校验规则以及不符合的原因,原因可能有多个，因此值用列表形式
form_obj.errors
>>>{'email': ['Enter a valid email address.']}

# 5 校验数据只校验类中出现的字段 多传不影响 多传的字段直接忽略
form_obj = views.MyForm({'username':'jason','password':'123','email':'123@qq.com','hobby':'study'})
form_obj.is_valid()
>>>True

# 6 校验数据 默认情况下 类里面所有的字段都必须传值,可以多传，不能少传
form_obj = views.MyForm({'username':'jason','password':'123'})
form_obj.is_valid()
>>>False
"""
也就意味着校验数据的时候 默认情况下数据可以多传但是绝不可能少传
"""

针对字段校验方法很多：

1、最简单的，在字段内通过参数设置规则

2、利用RegexValidator 正则校验器

3、钩子函数第二道关卡，复杂逻辑校验

---

 

4 forms组件渲染标签

有了forms组件，在from表单内所有获取用户输入的标签都不需要自己写了，forms组件能自动渲染生成标签。

forms组件只会自动帮你渲染获取用户输入的标签(input select radio checkbox)，不能帮你渲染提交按钮。

后端

def index(request):   
    form_obj = MyForm()                            # 1 先产生一个空对象
    return render(request,'index.html',locals())   # 2 直接将该空对象传递给html页面

前端利用空对象做操作

 <p>第一种渲染方式:代码书写极少，封装程度太高 不便于后续的扩展 一般情况下只在本地测试使用</p>
{{ form_obj.as_p }}       p标签样式
{{ form_obj.as_ul }}      ul列表样式
{{ form_obj.as_table }}   表格样式

<p>第二种渲染方式:可扩展性很强 但是需要书写的代码太多  一般情况下不用</p>
冒号左边是在渲染标签注释即字段名，右边是在渲染input框
username是字段对象，由username.label可以推导出，它有一个lable属性
label属性默认展示的是类中定义的字段首字母大写的形式，也可以自己修改 直接给字段对象加label属性即可
username = forms.CharField(min_length=3,max_length=8,label='用户名')
<p>{{ form_obj.username.label }}:{{ form_obj.username }}</p>
<p>{{ form_obj.password.label }}:{{ form_obj.password }}</p>
<p>{{ form_obj.email.label }}:{{ form_obj.email }}</p>

<p>第三种渲染方式(推荐使用):代码书写简单 并且扩展性也高</p>
{% for form in form_obj %}
    <p>{{ form.label }}:{{ form }}</p>
{% endfor %}

 

5 forms组件展示报错信息

浏览器会自动帮你校验数据，但是前端的校验弱不禁风，让浏览器不做校验

<form action="" method="post" novalidate>

后端

def index(request):
    # 1 先产生一个空对象
    form_obj = MyForm()
    if request.method == 'POST':
        # 获取用户数据并且校验
        """
        1.数据获取繁琐，request.POST.get('') 字段太多，手写繁琐
        2.校验数据需要构造成字典的格式传入才行
        ps: 但是request.POST获取的键值对可以看成就是一个字典，直接传入
        """
        # 3.校验数据
        form_obj = MyForm(request.POST)
        # 4.判断数据是否合法
        if form_obj.is_valid():
            # 5.如果合法 操作数据库存储数据
            return HttpResponse('OK')
        # 5.不合法 将报错信息展示到前端
    # 2 直接将该空对象传递给html页面
    return render(request,'index.html',locals())

前端

{% for form in form_obj %}
    <p>
        {{ form.label }}:{{ form }}
        <!--在渲染的from表单内加入span标签，没错误不显示>
        <!--form是字段对象，点errors方法拿到报错信息-->
        <!--错误信息是列表形式，会渲染成ul套li标签，加个0，只拿列表第一个错误信息，只生成普通文本-->
        <span style="color: red">{{ form.errors.0 }}</span>   
    </p>
{% endfor %}

forms组件效果

1、错误信息展示：后端校验后，前端form.errors直接渲染span标签
2、当你的数据不合法的情况下，会保存你上次的数据，让你基于之前的结果进行修改
    -get请求，form_obj传的空对象，前端渲染出来是空白的输入框
    -post请求输入数据后，合法则跳转了，不合法前端会展示错误信息，并且输入框内渲染出来的是输入的数据
    -get请求和post传给html页面对象变量名必须一样

 

6 常用字段与插件

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

6.1 重要参数

initial  #给字段加默认值，类似input框的value

error_messages{'错误类型', '报错信息'} #自定义报错信息

label  #给字段取名字

required #默认为True，字段必填，可以改为False

6.2 widget的应用

解决问题1： 标签是别人写的，无法用bootsrtap样式

# attrs={ }加入多个属性，可以是默认属性，也可以是自定义属性，多个属性值的话 直接空格隔开即可
widget=forms.widgets.PasswordInput(attrs={'class':'form-control btn btn-xs'})

解决问题2：针对不同类型的input如何修改

widget=forms.widgets.TextInput()      # 文本类型input
widget=forms.widgets.PasswordInput()  # 密文类型input
widget=forms.widgets.EmailInput()     # 邮箱类型input

6.3 其他类型input框渲染

# 单选radio
    gender = forms.ChoiceField(
        choices=((1, "男"), (2, "女"), (3, "保密")),
        label="性别",
        initial=3,
        widget=forms.widgets.RadioSelect()
    )
    
# 单选select
    hobby = forms.ChoiceField(
        choices=((1, "篮球"), (2, "足球"), (3, "双色球"),),
        label="爱好",
        initial=3,
        widget=forms.widgets.Select()
    )
    
# 多选select
    hobby1 = forms.MultipleChoiceField(
        choices=((1, "篮球"), (2, "足球"), (3, "双色球"),),
        label="爱好",
        initial=[1, 3],
        widget=forms.widgets.SelectMultiple()
    )
    
# 单选checkbox
    keep = forms.ChoiceField(
        label="是否记住密码",
        initial="checked",
        widget=forms.widgets.CheckboxInput()
    )
    
# 多选checkbox
    hobby2 = forms.MultipleChoiceField(
        choices=((1, "篮球"), (2, "足球"), (3, "双色球"),),
        label="爱好",
        initial=[1, 3],
        widget=forms.widgets.CheckboxSelectMultiple()
    )

6.4 Django Form所有内置字段

code

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类型

 

7 字段校验

7.1 RegexValidator验证器

第一道关卡里面还支持正则校验，字段内加入参数validators，列表中可以放入多个正则表达式，依次判断

from django.core.validators import RegexValidator   #导入正则校验器模块

validators=[
            RegexValidator(r'^[0-9]+$', '请输入数字'),
            RegexValidator(r'^159[0-9]+$', '数字必须以159开头')
        ]

7.2 自定义验证函数

code

 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'邮箱'}))

 

8 forms组件钩子函数(hook)

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

什么是钩子函数？

在特定的节点自动触发完成响应操作

钩子函数在forms组件中就类似于第二道关卡，能够让我们自定义校验规则

第一道关卡是我们的字段校验规则，只有在第一道关卡通过后，才会触发第二道关卡

在forms组件中有两类钩子
1.局部钩子
    当你需要给单个字段增加校验规则的时候可以使用
2.全局钩子
    当你需要给多个字段增加校验规则的时候可以使用

 8.1 局部钩子

我们在Fom类中定义 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")     #获取字段值，self是当前字段对象，点cleanede_data获取所有校验通过的数据，即过了第一关卡的数据
        if "666" in value:                            #自定义校验规则，可以结合re模块做复杂校验
            self.add_error('username', '用户名不能包含666')  #添加错误信息供前端展示，第一个参数是错误字段，第二个参数是错误信息
        return value   #将钩子函数取出来的数据再放回去

8.2 全局钩子

我们在Fom类中定义 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)
    )

    # 定义全局的钩子，用来校验密码和确认密码字段是否相同
    def clean(self):
        password_value = self.cleaned_data.get('password')
        re_password_value = self.cleaned_data.get('re_password')
        if not password_value == re_password_value:
            self.add_error('re_password', '两次密码不一致')  # 添加错误信息
        return self.cleaned_data                             # 钩出来的所有数据全部放回去

 

9 ModelForm

通常在Django项目中，我们编写的大部分都是与Django 的模型紧密映射的表单。 举个例子，你也许会有个Book 表模型，并且你还想创建一个form表单用来添加和编辑书籍信息到这个模型中。 在这种情况下，在form表单中定义字段将是冗余的，因为我们已经在表模型中定义了那些字段。

基于这个原因，Django 提供一个辅助类来让我们可以从Django 的模型创建Form，这就是ModelForm。

9.1 modelForm定义

class BookForm(forms.ModelForm):

    class Meta:
        model = models.Book
        fields = "__all__"
        labels = {
            "title": "书名",
            "price": "价格"
        }
        widgets = {
            "password": forms.widgets.PasswordInput(attrs={"class": "c1"}),
        }

9.2 class Meta下常用参数

model = models.Book    # 对应的Model中的类
fields = "__all__"     # 字段，如果是__all__,就是表示列出所有的字段
exclude = None         # 排除的字段
labels = None          # 提示信息
help_texts = None      # 帮助提示信息
widgets = None         # 自定义插件
error_messages = None  # 自定义错误信息

9.3 ModelForm的验证

与普通的Form表单验证类型类似，ModelForm表单的验证在调用is_valid() 或访问errors 属性时隐式调用。

我们可以像使用Form类一样自定义局部钩子方法和全局钩子方法来实现自定义的校验规则。

如果我们不重写具体字段并设置validators属性的化，ModelForm是按照模型中字段的validators来校验的。

9.4 save()方法

每个ModelForm还具有一个save()方法。 这个方法根据表单绑定的数据创建并保存数据库对象。 ModelForm的子类可以接受现有的模型实例作为关键字参数instance；如果提供此功能，则save()将更新该实例。 如果没有提供，save() 将创建模型的一个新实例：

>>> from myapp.models import Book
>>> from myapp.forms import BookForm

# 根据POST数据创建一个新的form对象
>>> form_obj = BookForm(request.POST)

# 创建书籍对象
>>> new_ book = form_obj.save()

# 基于一个书籍对象创建form对象
>>> edit_obj = Book.objects.get(id=1)
# 使用POST提交的数据更新书籍对象
>>> form_obj = BookForm(request.POST, instance=edit_obj)
>>> form_obj.save()