Django学习：ModelForm的使用与定制

Django学习：ModelForm的使用与定制

引用

51CTO

1.

https://blog.51cto.com/u_12440558/12800004

Django中的ModelForm是一个非常方便的工具，用于从模型（Model）自动生成表单。ModelForm可以让你避免手动编写表单字段，而是通过指定模型类，Django会根据模型的字段自动生成表单。本文将详细介绍ModelForm的基本使用、定制方法以及其他高级功能。

Django中的ModelForm

Django中的ModelForm是一个非常方便的工具，用于从模型（Model）自动生成表单。ModelForm可以让你避免手动编写表单字段，而是通过指定模型类，Django会根据模型的字段自动生成表单。

1. 基本使用

1.1 创建模型（Model）

首先，你需要有一个模型类（Model），表示你的数据库表格。例如，创建一个简单的Book模型：

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)
    published_date = models.DateField()
    isbn = models.CharField(max_length=13)
    
    def __str__(self):
        return self.title

1.2 创建ModelForm

接下来，创建一个ModelForm类，它会自动为Book模型生成表单：

from django import forms
from .models import Book

class BookForm(forms.ModelForm):
    class Meta:
        model = Book  # 指定表单绑定的模型
        fields = ['title', 'author', 'published_date', 'isbn']  # 指定表单显示的字段

在这里，Meta类是ModelForm的配置类。model指定你要生成表单的模型，fields指定需要显示的模型字段。如果你想显示所有字段，可以使用__all__：

class BookForm(forms.ModelForm):
    class Meta:
        model = Book
        fields = '__all__'  # 显示模型中的所有字段

1.3 在视图中使用ModelForm

在视图中，你可以使用BookForm来显示和处理表单。例如，在views.py中，创建一个视图来处理Book对象的创建：

from django.shortcuts import render, redirect
from .forms import BookForm

def create_book(request):
    if request.method == 'POST':
        form = BookForm(request.POST)
        if form.is_valid():
            form.save()  # 保存表单数据到数据库
            return redirect('book_list')  # 重定向到书籍列表页面
    else:
        form = BookForm()
    
    return render(request, 'create_book.html', {'form': form})

1.4 在模板中渲染表单

在create_book.html模板中，渲染表单：

<form method="post">
    {% csrf_token %}
    {{ form.as_p }}  <!-- 渲染表单 -->
    <button type="submit">提交</button>
</form>

2. 定制表单

有时，你可能希望定制表单字段的显示方式或行为，ModelForm提供了一些方法来完成这些定制。

2.1 添加自定义字段验证

你可以在ModelForm中添加自定义的字段验证逻辑。例如，验证ISBN字段是否唯一：

from django.core.exceptions import ValidationError

class BookForm(forms.ModelForm):
    class Meta:
        model = Book
        fields = '__all__'
    
    def clean_isbn(self):
        isbn = self.cleaned_data.get('isbn')
        if Book.objects.filter(isbn=isbn).exists():
            raise ValidationError("ISBN已经存在")
        return isbn

2.2 设置字段属性

你可以使用widgets来设置字段的显示样式，例如设置日期字段为日期选择器，或者设置文本字段的placeholder。

class BookForm(forms.ModelForm):
    class Meta:
        model = Book
        fields = '__all__'
        widgets = {
            'published_date': forms.DateInput(attrs={'type': 'date'}),  # 使用日期选择器
            'isbn': forms.TextInput(attrs={'placeholder': '请输入13位ISBN'})
        }

2.3 自定义表单字段

有时你可能需要在ModelForm中添加额外的字段。比如，你想在表单中添加一个选择框：

class BookForm(forms.ModelForm):
    is_published = forms.BooleanField(initial=True, required=False, label='是否已出版')
    class Meta:
        model = Book
        fields = '__all__'

2.4 修改字段标签和帮助文本

你可以修改字段的标签（label）和帮助文本（help_text）：

class BookForm(forms.ModelForm):
    class Meta:
        model = Book
        fields = ['title', 'author', 'published_date', 'isbn']
        labels = {
            'title': '书名',
            'author': '作者'
        }
        help_texts = {
            'isbn': '请输入13位ISBN代码'
        }

3. 使用ModelForm的其他功能

3.1 表单实例的验证

ModelForm提供了is_valid()方法来检查表单是否有效。如果表单有效，你可以通过save()方法保存表单数据到数据库。

form = BookForm(request.POST)
if form.is_valid():
    form.save()

3.2 保存和更新模型实例

ModelForm不仅可以用来创建新的模型实例，还可以用来更新已有的实例。你可以通过传递一个模型实例给ModelForm来更新它：

book = Book.objects.get(id=1)
form = BookForm(request.POST, instance=book)
if form.is_valid():
    form.save()  # 更新现有的book实例

4. 总结

ModelForm是Django中非常强大的工具，自动化了从模型生成表单的过程，并且支持很多定制化的功能。你可以用它来简化表单的创建、验证和数据保存的过程，同时也可以根据需求自定义表单字段和验证逻辑。