Django中的Form元件

一、form元件的主要功能：

• 生成頁面的HTML标簽及樣式
• 對使用者送出的資料進行校驗
• 自動生成錯誤資訊
• 保留上次輸入資訊

二、使用form元件實作注冊功能

1、在Django項目下建立一個檔案夾，在檔案夾中建立一個朋友檔案，名字随便起，之後在py檔案中寫一個RegisterForm類：

from django import forms
from django.core.validators import RegexValidator
from django.core.exceptions import ValidationError

class RegisterForm(forms.Form):#類必須繼承forms.Form
    # 使用者名
    username = forms.CharField(
        min_length=6,#設定最小長度
        max_length=12,#設定最大長度
        label="使用者名",#設定标簽名
        #錯誤資訊提示設定
        error_messages={
            "min_length": "使用者名不能少于6位",
            "max_length":'使用者名不能超過12位',
            "required": "使用者名不能為空"
        },
        #插件設定
        widget=forms.widgets.TextInput(
            attrs={"class": "form-control"}# 給生成的标簽添加屬性
        )
    )
    # 電話号碼
    phone = forms.CharField(
        label="手機号",
        error_messages={
            "required": "手機号不能為空"
        },
        # 調用Form元件中的驗證器來校驗手機号
        validators=[RegexValidator(r'1[1-9][0-9]{9}','手機号格式不正确')],
        widget=forms.widgets.TextInput(
            attrs={'class': 'form-control'},  # 給生成的标簽添加類屬性
        )
    )
    # 密碼
    password = forms.CharField(
        label="密碼",
        min_length=6,
        error_messages={
            "required": "密碼不能為空",
            'min_length':'密碼不能少于6位'
        },
        widget=forms.widgets.PasswordInput(
            attrs={'class': 'form-control'},  # 給生成的标簽添加屬性
            render_value=True  # 傳回報錯資訊的時候要不要展示密碼
        )
    )
    # 二次密碼校驗
    re_password = forms.CharField(
        label="确認密碼",
        min_length=6,
        error_messages={
            "required": "确認密碼不能為空",
            'min_length':'确認密碼不能少于六位'
        },
        widget=forms.widgets.PasswordInput(
            attrs={'class': 'form-control'},  # 給生成的标簽添加屬性
            render_value=True  # 傳回報錯資訊的時候要不要展示密碼
        )
    )
    # 郵箱
    email = forms.CharField(
        label="郵箱",
        error_messages={
            "required": "郵箱不能為空",
        },
        # 調用Form元件中的驗證器來校驗郵箱
        validators=[RegexValidator(r'^[a-zA-Z0-9_.-]+@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*\.[a-zA-Z0-9]{2,6}$', "郵箱格式不正确")],
        widget=forms.widgets.TextInput(
            attrs={'class': 'form-control'},  # 給生成的标簽添加屬性
        )
    )
    # 通過自定義一個clean_字段名的方法實作對Form表單特定字段的校驗
    def clean_username(self):
        # 從cleaned_data中取出想要的資料
        value = self.cleaned_data.get("username")
        if "金瓶梅" in value:
            # 錯誤就抛異常
            raise ValidationError("不符合社會主義核心價值觀！")
        else:
            return value

    # 通過Form表單的全局鈎子函數來驗證兩次輸入的密碼是否正确
    # 該clean方法， 在每個字段都校驗通過之後才調用執行
    def clean(self):
        password = self.cleaned_data.get('password')
        re_password = self.cleaned_data.get('re_password')
        if re_password and password == re_password:
            # 判斷正确就傳回校驗過後的資料
            return self.cleaned_data
        else:
            # 添加錯誤到add_error
            self.add_error('re_password','兩次密碼不一緻，請重新輸入')
            # 主動抛出異常
            raise ValidationError('兩次密碼不一緻，請重新輸入')

           

2、url的書寫：

url(r'^register/', views.Register.as_view())#CBV方式寫視圖函數,
           

3、views中的視圖函數：

from django.http import JsonResponse, HttpResponse
from django import views
from blog.myforms.forms import LoginForm, RegisterForm

class Register(views.View):  # 必須繼承views.View
    # get請求方式
    def get(self, request):
        # 用自定義的Form類執行個體化一個對象，用于前端頁面生成标簽
        register_obj = RegisterForm()
        return render(request, 'register.html', {'register_obj': register_obj})

    # post請求方式
    def post(self, request):
        # 前後端互動資訊
        res = {'code': 0}
        # 執行個體化form類，将前端得到的資料送出到執行個體中
        register_obj = RegisterForm(request.POST)
        # 利用form内置方法校驗前端得到的資料
        if register_obj.is_valid():
            # 從資料庫中查詢使用者輸入的使用者名，手機号，郵箱是否重複
            username = models.UserInfo.objects.filter(username=request.POST.get('username'))
            phone = models.UserInfo.objects.filter(phone=request.POST.get('phone'))
            email = models.UserInfo.objects.filter(email=request.POST.get('email'))
            if username:
                res['code'] = 1
                res['msg'] = '使用者名已存在，請重新輸入'
            elif phone:
                res['code'] = 2
                res['msg'] = '您輸入的手機号已存在，請重新輸入'
            elif email:
                res['code'] = 3
                res['msg'] = '您輸入的郵箱号已存在，請重新輸入'
            else:
                # 資料正确後剔除re_password中的資料
                register_obj.cleaned_data.pop("re_password")
                # 得到前端的頭像檔案，檔案和圖檔資料存放在request.FILES中
                avatar_file = request.FILES.get('avatar_file')
                # 通過資料庫操作建立user
                models.UserInfo.objects.create_user(**register_obj.cleaned_data, avatar=avatar_file)
                # 傳回前端頁面要跳轉的url
                res['msg'] = '/login/'
        else:
            res['code'] = 4
            # 錯誤資訊
            res['msg'] = register_obj.errors
        return JsonResponse(res)
           

4、register.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>使用者注冊</title>
    <link rel="stylesheet" href="/static/bootstrap/bootstrap-3.3.7/css/bootstrap.min.css">
    <link rel="stylesheet" href="/static/css/mycss.css">
</head>
<body>
<div class="container" style="margin-top: 50px">
    <div class="row">
        <div class="col-lg-6 col-lg-offset-3">
            <div class="panel panel-info" style="border: none">
                <div class="panel-heading text-center">
                    <h4>使用者注冊</h4>
                </div>
                <div class="panel-bady">
                    <form>
                        {% csrf_token %}
                        {% for field in register_obj %}
                            <div class="form-group">
                                <label class="letleft" for="field.id_for_label">{{ field.label }}</label>
                                {{ field }}
                                <span class="err-msg"></span>
                            </div>
                        {% endfor %}
                        <div class="form-group">
                            <label for="avatar">使用者頭像<img id="avatar-img" src="/media/avatars/default.png" alt="使用者頭像"
                                                         style="height: 80px;width: 80px;margin-left: 15px"></label>
                            <input type="file" accept="image/*" id="avatar" style="display: none;">
                            <button type="button" id="register-btn" class="btn btn-success letleft">送出</button>
                        </div>
                        <div id="popup-captcha"></div>
                    </form>
                </div>
            </div>
        </div>
    </div>
</div>

<script src="/static/js/jquery-3.3.1.js"></script>
<script>
    $(function () {
        $("#register-btn").click(function () {
            //ajax送出資料時，當有檔案或者圖檔時，需要借助FormData對象來實作資料前後端互動，FormData
            // 相當于是一個打包資料的工具，将需要傳輸的資料通過append方法以鍵值對的方式添加到FormData對象中
            let formdata = new FormData();
            formdata.append('username', $('#id_username').val());
            formdata.append('phone', $('#id_phone').val());
            formdata.append('password', $('#id_password').val());
            formdata.append('re_password', $('#id_re_password').val());
            formdata.append('email', $('#id_email').val());
            //設定csrftoken來防止跨站csrf攻擊
            formdata.append('csrfmiddlewaretoken', $("[name='csrfmiddlewaretoken']").val());
            //通過jquery對象擷取檔案需要将jquery對象轉化成js對象再調用js對象的files方法
            formdata.append('avatar_file', $("#avatar")[0].files[0]);
            $.ajax({
                url: '/register/',
                type: 'post',
                processData: false,   //不讓jQuery處理我的obj
                contentType: false,  // 不讓jQuery設定請求的内容類型
                data: formdata,
                success: function (res) {
                    if (res.code === 0) {
                        location.href = res.msg
                    }
                    if (res.code === 1) {
                        $('#id_username').next().text(res.msg)
                    }
                    if (res.code === 2) {
                        $('#id_phone').next().text(res.msg)
                    }
                    if (res.code === 3) {
                        $('#id_email').next().text(res.msg)
                    }
                    if (res.code === 4) {
                        $.each(res.msg, function (k, v) {
                            //添加錯誤提示樣式
                            $("#id_" + k).next().text(v[[0]]).parent().addClass('err-msg')

                        })
                    }
                }
            });
        });
        // 前端頁面實作頭像預覽
        // 當使用者選中檔案之後，也就是頭像的input标簽有值時觸發
        $("#avatar").change(function () {
            // 找到使用者選中的那個檔案
            let file = this.files[0];
            // 生成一個讀檔案的對象
            let fr = new FileReader();
            // 從檔案中讀取頭像檔案資料
            fr.readAsDataURL(file);
            // 等到讀完之後
            fr.onload = function () {
                // 将頭像img标簽的src屬性更換成我選中的那個檔案
                $("#avatar-img").attr("src", fr.result)
            }
        });

        //input标簽聚焦清空樣式
        $('input').focus(function () {
            $(this).next().text('').parent().removeClass('err-msg')
        });

    })
</script>

</body>
</html>
           

三、Form元件常用字段與插件介紹

建立Form類時，主要涉及到 【字段】 和 【插件】，字段用于對使用者請求資料的驗證，插件用于自動生成HTML;

1、initial

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

class LoginForm(forms.Form):
    username = forms.CharField(
        min_length=8,
        label="使用者名",
        initial="王飛"  # 設定預設值
    )
    pwd = forms.CharField(min_length=6, label="密碼")
           

2、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="密碼")
           

3、password

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

4、radioSelect（生成的是input标簽）

單radio值為字元串

class LoginForm(forms.Form):
    gender = forms.fields.ChoiceField(
        choices=((1, "男"), (2, "女"), (3, "保密")),
        label="性别",
        initial=3,//預設值
        widget=forms.widgets.RadioSelect()
    )
           

5、單選Select(生成select标簽)

class LoginForm(forms.Form):
    hobby = forms.fields.ChoiceField(
        choices=((1, "籃球"), (2, "足球"), (3, "雙色球"), ),
        label="愛好",
        initial=3,
        widget=forms.widgets.Select()
    )
           

6、多選Select（生成的是select标簽）

class LoginForm(forms.Form):
    hobby = forms.fields.MultipleChoiceField(
        choices=((1, "籃球"), (2, "足球"), (3, "雙色球"), ),
        label="愛好",
        initial=[1, 3],
        widget=forms.widgets.SelectMultiple()
    )
           

7、單選checkbox（生成的是input标簽）

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

8、多選checkbox(生成的是input标簽)

class LoginForm(forms.Form):
        hobby = forms.fields.MultipleChoiceField(
        choices=((1, "籃球"), (2, "足球"), (3, "雙色球"),),
        label="愛好",
        initial=[1, 3],
        widget=forms.widgets.CheckboxSelectMultiple()
    )
           

關于radioSelect、單選Select、多選Select、單選checkbox、多選checkbox生成的标簽的樣式差別如圖：

微信圖檔_20180823205102.png

注意：關于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'].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 MyForm(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類型
           

五、Form表單的使用者資料驗證方式：

方式一:内置的正則驗證：

導入方式：from django.core.validators import RegexValidator

基本格式：validators=[RegexValidator(正規表達式, "錯誤提示"),]

email = forms.CharField(
        label="郵箱",
        error_messages={
            "required": "郵箱不能為空",
        },
        # 調用Form元件中的驗證器來校驗郵箱
        validators=[RegexValidator(r'^[a-zA-Z0-9_.-]+@[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*\.[a-zA-Z0-9]{2,6}$', "郵箱格式不正确")],
        widget=forms.widgets.TextInput(
            attrs={'class': 'form-control'},  # 給生成的标簽添加屬性
        )
    )
           

方式二、自定義驗證

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):
 
    # 使用自定義驗證規則
    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'郵箱'}))
           

首先補充幾個變量含義，看了源碼了解到的兩個變量和一個方法：

• is_valid():校驗使用者
• cleaned_data --> 用來存放經過驗證資料的大字典
• add_error("字段名", "錯誤提示資訊")

方式三、局部鈎子驗證：

# 通過自定義一個clean_字段名的方法實作對Form表單特定字段的校驗
    def clean_username(self):
        # 從cleaned_data中取出想要的資料
        value = self.cleaned_data.get("username")
        if "金瓶梅" in value:
            # 錯誤就抛異常
            raise ValidationError("不符合社會主義核心價值觀！")
        else:
            return value
           

方式四、全局鈎子驗證：

# 通過Form表單的全局鈎子函數來驗證兩次輸入的密碼是否正确
    # 該clean方法， 在每個字段都校驗通過之後才調用執行
    def clean(self):
        password = self.cleaned_data.get('password')
        re_password = self.cleaned_data.get('re_password')
        if re_password and password == re_password:
            # 判斷正确就傳回校驗過後的資料
            return self.cleaned_data
        else:
            # 添加錯誤到add_error
            self.add_error('re_password','兩次密碼不一緻，請重新輸入')
            # 主動抛出異常
            raise ValidationError('兩次密碼不一緻，請重新輸入')
           

六、Form的進階騷操作

1、批量添加樣式：

通過重寫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'
            })
           

2、Django 内置的把ORM對象轉換成字典的工具函數：

from django.forms.models import model_to_dict

//book_obj為根據條件在資料庫中查到的對象
//obj_dict是book_obj對象再資料庫中對應的字段和值組成的鍵值對字典
obj_dict = model_to_dict(book_obj)
//form_obj通過initial設定初始化的值，例如，圖書管理系統中的編輯書籍功能，
//點選編輯後跳轉到編輯書籍頁面，跳轉後需要用要編輯的書籍資訊填充頁面對應資訊。
form_obj = forms.BookForm(initial=obj_dict)