Django 之 ModelForm

時間 2019-12-08

原文原文鏈接

一 Django的form組件

二 Django的model form組件

這是一個神奇的組件，經過名字咱們能夠看出來，這個組件的功能就是把model和form組合起來，先來一個簡單的例子來看一下這個東西怎麼用：好比咱們的數據庫中有這樣一張學生表，字段有姓名，年齡，愛好，郵箱，電話，住址，註冊時間等等一大堆信息，如今讓你寫一個建立學生的頁面，你的後臺應該怎麼寫呢？首先咱們會在前端一個一個羅列出這些字段，讓用戶去填寫，而後咱們從後天一個一個接收用戶的輸入，建立一個新的學生對象，保存其實，重點不是這些，而是合法性驗證，咱們須要在前端判斷用戶輸入是否合法，好比姓名必須在多少字符之內，電話號碼必須是多少位的數字，郵箱必須是郵箱的格式這些固然能夠一點一點手動寫限制，各類判斷，這毫無問題，除了麻煩咱們如今有個更優雅（之後在Python相關的內容裏，要多用「優雅」這個詞，而且養成習慣）的方法：ModelForm先來簡單的，生硬的把它用上，再來加驗證條件。前端

2.1 建立modelform

# 首先導入ModelForm
from django.forms import ModelForm
from django import forms
from django.core.exceptions import ValidationError

# 在視圖函數中，定義一個類，好比就叫StudentListModelForm，這個類要繼承ModelForm，在這個類中再寫一個原類Meta（規定寫法，並注意首字母是大寫的）
# 在這個原類中，有如下屬性（部分）：

class StudentListModelForm(ModelForm):
    confirm_password = forms.CharField(label='確認密碼')  # 若是要增長顯示字段，在這裏增長

    class Meta:
        model = Student  # 對應的Model中的類
        fields = "__all__"  # 字段，若是是__all__,就是表示列出全部的字段。不然用['title', 'icon']指定字段
        exclude = None  # 排除的字段
        # error_messages用法：
        error_messages = {
            'name': {'required': "用戶名不能爲空", },
            'age': {'required': "年齡不能爲空", },
        }
        # widgets用法,好比把輸入用戶名的input框改成Textarea
        from django.forms import widgets as wid  # 首先得導入模塊由於重名，因此起個別名
        widgets = {"name": wid.Textarea(attrs={"class": "c1"})}  # 還能夠自定義屬性
        labels = {"name": "用戶名"}  # labels，自定義在前端顯示的名字
        help_texts = None  # 幫助提示信息

    def __init__(self, *args, **kwargs):  # 給每一個標籤添加屬性
        super().__init__(*args, **kwargs)
        for field in self.fields.values():
            field.widget.attrs['class'] = 'form-control'

    def clean_confirm_password(self):  # 鉤子函數
        """
        檢測密碼是否一致
        :return:
        """
        password = self.cleaned_data['password']
        confirm_password = self.cleaned_data['confirm_password']
        if password != confirm_password:
            raise ValidationError('兩次密碼輸入不一致')
        return confirm_password

而後在url對應的視圖函數中實例化這個類，把這個對象傳給前端python

def student(request):
    if request.method == 'GET':
        student_list = StudentList()
        return render(request,'student.html',{'student_list':student_list})

而後前端只須要 {{ student_list.as_p }} 一下，全部的字段就都出來了，能夠用as_p顯示所有，也能夠經過for循環這student_list，拿到的是一個個input框，如今咱們就不用as_p，手動把這些input框搞出來，as_p拿到的頁面太醜。
首先 for循環這個student_list，拿到student對象，直接在前端打印這個student，是個input框student.label ，拿到數據庫中每一個字段的verbose_name ,若是沒有設置這個屬性，拿到的默認就是字段名，還能夠經過student.errors.0 拿到錯誤信息有了這些，數據庫

咱們就能夠經過bootstrap，本身拼出來想要的樣式了，好比：django

<body>
<div class="container">
    <h1>student</h1>
    <form method="POST" novalidate>
        {% csrf_token %}
        {# {{ student_list.as_p }}#}
        {% for student in student_list %}
            <div class="form-group col-md-6">
                {# 拿到數據字段的verbose_name,沒有就默認顯示字段名 #}
                <label class="col-md-3 control-label">{{ student.label }}</label>
                <div class="col-md-9" style="position: relative;">{{ student }}</div>
            </div>
        {% endfor %}
        <div class="col-md-2 col-md-offset-10">
            <input type="submit" value="提交" class="btn-primary">
        </div>
    </form>
</div>
</body>

如今還缺一個input框的form-contral樣式，能夠考慮在後臺的widget裏面添加
好比這樣：bootstrap

from django.forms import widgets as wid #由於重名，因此起個別名
widgets = {
"name":wid.TextInput(attrs={'class':'form-control'}),
"age":wid.NumberInput(attrs={'class':'form-control'}),
"email":wid.EmailInput(attrs={'class':'form-control'})
}

固然也能夠在js中，找到全部的input框，加上這個樣式，也行。小程序

2.2 添加紀錄

保存數據的時候，不用挨個取數據了，只須要save一下函數

def student(request):

    if request.method == 'GET':
         student_list = StudentList()
         return render(request,'student.html',{'student_list':student_list})
    else:
         student_list = StudentList(request.POST)
         if student_list.is_valid():
         student_list.save()
         return redirect(request,'student_list.html',{'student_list':student_list})

2.3 編輯數據

若是不用ModelForm，編輯的時候得顯示以前的數據吧，還得挨個取一遍值，若是ModelForm，只須要加一個instance=obj（obj是要修改的數據庫的一條數據的對象）就能夠獲得一樣的效果
保存的時候要注意，必定要注意有這個對象（instance=obj），不然不知道更新哪個數據
代碼示例：ui

def student_edit(request,pk):
    obj = models.Student.objects.filter(pk=pk).first()
    if not obj:
        return redirect('test')
    if request.method == "GET":
        student_list = StudentList(instance=obj)
        return render(request,'student_edit.html',{'student_list':student_list})
    else:
        student_list = StudentList(request.POST,instance=obj)
        if student_list.is_valid():
            student_list.save()
            return render(request,'student_edit.html',{'student_list':student_list})

總結： ModelForm用起來是很是方便的，好比增長修改之類的操做。可是也帶來額外很差的地方，model和form之間耦合了。若是不耦合的話，mf.save()方法也沒法直接提交保存。可是耦合的話使用場景一般侷限用於小程序，寫大程序就最好不用了。url

相關標籤/搜索

modelform

django

model&form&modelform

python3+pycharm+django+django

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。