Django form表单

Form介绍

　　之前在HTML页面中利用form表单向后端提交数据时，都会写一些获取用户输入的标签并且用form标签把它们包起来。与此同时我们在好多场景下都需要对用户的输入做校验，比如校验用户是否输入，输入的长度和格式等正不正确，如果用户输入的内容有错误就需要在页面上相应的位置显示对应的错误消息。

　　Django form组建就实现了上面所述的功能。

　　总结一下，其实form组件的主要功能如下：

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

普通的登录

views.py

def login(request):

    error_msg = ""

    if request.method == "POST":

        username = request.POST.get("username")

        pwd = request.POST.get("pwd")

        if username == "Q1mi" and pwd == "":

            return HttpResponse("OK")

        else:

            error_msg = "用户名或密码错误"

    return render(request, "login.html", {"error_msg": error_msg})

<!DOCTYPE html>

<html lang="en">

<head>

  <meta charset="UTF-8">

  <meta http-equiv="x-ua-compatible" content="IE=edge">

  <meta name="viewport" content="width=device-width, initial-scale=1">

  <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">

  </p>

  <p>

    <label for="pwd">密码</label>

    <input type="password" name="pwd" id="pwd">

    <span class="error"></span>

  </p>

  <p>

    <input type="submit">

    <span class="error">{{ error_msg }}</span>

  </p>

</form>

</body>

</html>

使用form组件

views.py

先定义好一个LoginForm

from django import forms

class LoginForm(forms.Form):

    username = forms.CharField(min_length=8, label="用户名")

    pwd = forms.CharField(min_length=6, label="密码")

def login2(request):

    error_msg = ""

    form_obj = LoginForm()

    if request.method == "POST":

        form_obj = LoginForm(request.POST)

        if form_obj.is_valid():

            username = form_obj.cleaned_data.get("username")

            pwd = form_obj.cleaned_data.get("pwd")

            if username == "Q1mi" and pwd == "":

                return HttpResponse("OK")

            else:

                error_msg = "用户名或密码错误"

    return render(request, "login2.html", {"form_obj": form_obj, "error_msg": error_msg})

login2.html

<!DOCTYPE html>

<html lang="en">

<head>

  <meta charset="UTF-8">

  <meta http-equiv="x-ua-compatible" content="IE=edge">

  <meta name="viewport" content="width=device-width, initial-scale=1">

  <title>login</title>

  <style>

    .error {

      color: red;

    }

  </style>

</head>

<body>

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

  {% csrf_token %}

  <p>

    {{ form_obj.username.label }}

    {{ form_obj.username }}

    <span class="error">{{ form_obj.username.errors.0 }}</span>

  </p>

  <p>

    {{ form_obj.pwd.label }}

    {{ form_obj.pwd }}

    <span class="error">{{ form_obj.pwd.errors.0 }}</span>

  </p>

  <p>

    <input type="submit">

    <span class="error">{{ error_msg }}</span>

  </p>

</form>

</body>

</html>

看网页效果发现也验证了form的功能：

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

Form详解

常用字段演示

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,                             #默认选中  3

        widget=forms.widgets.RadioSelect

    )

单选Select

class LoginForm(forms.Form):

    ...

    hobby = forms.fields.ChoiceField(

        choices=((1, "篮球"), (2, "足球"), (3, "双色球"), ),

        label="爱好",

        initial=3,

        widget=forms.widgets.Select

    )

多选Select

class LoginForm(forms.Form):

    ...

    hobby = forms.fields.MultipleChoiceField(

        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

class LoginForm(forms.Form):

    ...

    hobby = forms.fields.MultipleChoiceField(

        choices=((1, "篮球"), (2, "足球"), (3, "双色球"),),

        label="爱好",

        initial=[1, 3],

        widget=forms.widgets.CheckboxSelectMultiple

    )

关于choice的注意事项：

　　在使用选择标签时，需要注意choices的选项可以从数据库中获取，但是由于是静态字段，获取的值无法实时更新，那么需要自定义构造方法从而达到此目的。

方式一：

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'].widget.choices = ((1, '上海'), (2, '北京'),)

        # 或

        self.fields['user'].widget.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())

Django form内置字段

Field

    required=True,               是否允许为空

    widget=None,                 HTML插件

    label=None,                  用于生成Label标签或显示内容

    initial=None,                初始值

    help_text='',                帮助信息(在标签旁边显示)

    error_messages=None,         错误信息 {'required': '不能为空', 'invalid': '格式错误'}

    show_hidden_initial=False,   是否在当前插件后面再加一个隐藏的且具有默认值的插件（可用于检验两次输入是否一直）

    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内置字段

校验

方式一：

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

form组件中的全局钩子和局部钩子

　　当需要对model_class中字段作进一步验证,作进一步的约束时,需要使用到钩子,即claan_xxx（xxx是定义的字段名称）——局部钩子和clean——全局钩子方法。

钩子方法是form组件中给我们提供的自定义接口，可以自定义其他验证信息，还可以自定义输出显示的错误信息。比如一下例子：

# 使用form表单实现修改密码功能

class ResetForm(forms.Form):

    username = forms.CharField(

        widget=widgets.TextInput(attrs={'class': 'form-control', 'autocomplete': "off", 'placeholder': "请输入用户名"}),

        label='用户名')

    telephone = forms.CharField(

        widget=forms.TextInput(attrs={'class': 'form-control', 'autocomplete': "off", 'placeholder': "请输入电话号"}),

        label='手机号', )

    new_password = forms.CharField(

        widget=forms.PasswordInput(attrs={'class': 'form-control', 'placeholder': "请输入新的密码"}),

        label='新密码')

    repeat_new_password = forms.CharField(

        widget=forms.PasswordInput(attrs={'class': 'form-control', 'placeholder': "请再次输入新的密码"}),

        label='确认新密码')

    # 定义局部钩子，验证用户名是否已经被注册

    def clean_username(self):

        username = self.cleaned_data.get('username')

        if len(username) < 8:

            raise ValidationError('用户名必须不小于8位（您现在的是{}位）!'.format(len(username)))

        else:

            ret = UserInfo.objects.filter(username=username)

            if not ret:

                raise ValidationError('该用户名还没有被注册!')

            return username

    # 定义局部钩子，验证手机号是否已存在

    def clean_telephone(self):

        telephone = self.cleaned_data.get('telephone')

        if len(telephone) != 11:

            raise ValidationError('手机号必须是11位的（您现在是{}位）!'.format(len(telephone)))

        else:

            username = self.cleaned_data.get('username')

            ret = UserInfo.objects.filter(username=username, telephone=telephone)

            if ret:

                return telephone

            else:

                raise ValidationError('该用户名对应的手机号不存在!')

    # 定义局部钩子，验证密码位数

    def clean_new_password(self):

        new_password = self.cleaned_data.get('new_password')

        if len(new_password) < 8:

            raise ValidationError('密码必须不小于8位（您现在的是{}位）!'.format(len(new_password)))

        else:

            return new_password

    # 定义局部钩子，验证确认密码位数

    def clean_repeat_new_password(self):

        repeat_new_password = self.cleaned_data.get('repeat_new_password')

        if len(repeat_new_password) < 8:

            raise ValidationError('密码必须不小于8位（您现在的是{}位）!'.format(len(repeat_new_password)))

        else:

            return repeat_new_password

    # 定义全局钩子，验证两次密码是否相同

    def clean(self):

        if self.cleaned_data.get('new_password') == self.cleaned_data.get('repeat_new_password'):

            return self.cleaned_data

        else:

            raise ValidationError('两次输入的密码不一致!')

form组件实现的登陆验证和自定义钩子验证方法例子

使用form组件时，可以在app中单独建一个py文件存放form组件相关的代码，在views.py中导入即可。

补充进阶

应用Bootstrap样式

<!DOCTYPE html>

<html lang="en">

<head>

  <meta charset="UTF-8">

  <meta http-equiv="x-ua-compatible" content="IE=edge">

  <meta name="viewport" content="width=device-width, initial-scale=1">

  <link rel="stylesheet" href="/static/bootstrap/css/bootstrap.min.css">

  <title>login</title>

</head>

<body>

<div class="container">

  <div class="row">

    <form action="/login2/" method="post" novalidate class="form-horizontal">

      {% csrf_token %}

      <div class="form-group">

        <label for="{{ form_obj.username.id_for_label }}"

               class="col-md-2 control-label">{{ form_obj.username.label }}</label>

        <div class="col-md-10">

          {{ form_obj.username }}

          <span class="help-block">{{ form_obj.username.errors.0 }}</span>

        </div>

      </div>

      <div class="form-group">

        <label for="{{ form_obj.pwd.id_for_label }}" class="col-md-2 control-label">{{ form_obj.pwd.label }}</label>

        <div class="col-md-10">

          {{ form_obj.pwd }}

          <span class="help-block">{{ form_obj.pwd.errors.0 }}</span>

        </div>

      </div>

      <div class="form-group">

      <label class="col-md-2 control-label">{{ form_obj.gender.label }}</label>

        <div class="col-md-10">

          <div class="radio">

            {% for radio in form_obj.gender %}

              <label for="{{ radio.id_for_label }}">

                {{ radio.tag }}{{ radio.choice_label }}

              </label>

            {% endfor %}

          </div>

        </div>

      </div>

      <div class="form-group">

        <div class="col-md-offset-2 col-md-10">

          <button type="submit" class="btn btn-default">注册</button>

        </div>

      </div>

    </form>

  </div>

</div>

<script src="/static/jquery-3.2.1.min.js"></script>

<script src="/static/bootstrap/js/bootstrap.min.js"></script>

</body>

</html>

Django form应用Bootstrap样式简单示例

批量添加样式

可通过重写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'

            })

批量添加样式