Django-ModelForm

作者：武沛齐 
出处：Django之ModelForm组件

本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接。

ModelForm
    a.  class Meta:
            model,                           # 对应Model的
            fields=None,                     # 字段
            exclude=None,                    # 排除字段
            labels=None,                     # 提示信息
            help_texts=None,                 # 帮助提示信息
            widgets=None,                    # 自定义插件
            error_messages=None,             # 自定义错误信息（整体错误信息from django.core.exceptions import NON_FIELD_ERRORS）
            field_classes=None               # 自定义字段类 （也可以自定义字段）
            localized_fields=('birth_date',) # 本地化，如：根据不同时区显示数据
            如：
                数据库中
                    2016-12-27 04:10:57
                setting中的配置
                    TIME_ZONE = 'Asia/Shanghai'
                    USE_TZ = True
                则显示：
                    2016-12-27 12:10:57
    b. 验证执行过程
        is_valid -> full_clean -> 钩子 -> 整体错误
 
    c. 字典字段验证
        def clean_字段名(self):
            # 可以抛出异常
            # from django.core.exceptions import ValidationError
            return "新值"
    d. 用于验证
        model_form_obj = XXOOModelForm()
        model_form_obj.is_valid()
        model_form_obj.errors.as_json()
        model_form_obj.clean()
        model_form_obj.cleaned_data
    e. 用于创建
        model_form_obj = XXOOModelForm(request.POST)
        #### 页面显示，并提交 #####
        # 默认保存多对多
            obj = form.save(commit=True)
        # 不做任何操作，内部定义 save_m2m（用于保存多对多）
            obj = form.save(commit=False)
            obj.save()      # 保存单表信息
            obj.save_m2m()  # 保存关联多对多信息
 
    f. 用于更新和初始化
        obj = model.tb.objects.get(id=1)
        model_form_obj = XXOOModelForm(request.POST,instance=obj)
        ...
 
        PS: 单纯初始化
            model_form_obj = XXOOModelForm(initial={...})

一个实例：

1. models.py

from django.db import models

# Create your models here.


class UserInfo(models.Model):
    name = models.CharField(max_length=32)
    email = models.EmailField()
    nickName = models.CharField(max_length=32)
    group = models.ForeignKey('UserGroup', null=True, blank=True)
    role = models.ManyToManyField('Role', null=True, blank=True)

    def __str__(self):
        return self.name


class UserGroup(models.Model):
    name = models.CharField(max_length=32)
    info = models.TextField()

    def __str__(self):
        return self.name


class Role(models.Model):
    name = models.CharField(max_length=32)
    info = models.TextField()

    def __str__(self):
        return self.name

2. views.py

from django.shortcuts import render,HttpResponse
from django.forms import ModelForm
from django.forms import fields as dfields
from django.forms import widgets as dwidgets
from app01 import models


class TestModelForm(ModelForm):
    class Meta:
        model = models.UserInfo
        fields = '__all__'
        error_messages = {
            'name': {
                'required': '用户名不能为空',
            },
            'email': {
                'required': '邮箱不能为空',
                'invalid': '邮箱格式不正确',
            },
            'nickName': {
                'required': '昵称不能为空',
            }
        }
        labels = {
            'name': '用户名',
            'email': '邮箱',
            'nickName': '昵称',
            'group': '部门',
            'role': '角色',
        }
        widgets = {
            'name': dwidgets.Input(attrs={'class': 'form-control'}),
            'email': dwidgets.Input(attrs={'class': 'form-control'}),
            'nickName': dwidgets.Input(attrs={'class': 'form-control'}),
            'group': dwidgets.Select(attrs={'class': 'form-control'}),
            'role': dwidgets.SelectMultiple(attrs={'class': 'form-control'}),
        }

# Create your views here.


def test(request):
    content = {'form': None}
    if request.method == 'GET':
        form = TestModelForm()
        content['form'] = form
        return render(request, 'test.html', content)
    else:
        form = TestModelForm(request.POST)
        content['form'] = form
        if form.is_valid():
            print(form.cleaned_data)
            form.save()
            return HttpResponse('add success!')
        else:
            return render(request, 'test.html', content)


def edit(request, nid):
    obj = models.UserInfo.objects.filter(id=nid).first()
    content = {'form': None}
    if request.method == 'GET':
        form = TestModelForm(instance=obj)
        content['form'] = form
        return render(request, 'edit.html', content)
    else:
        form = TestModelForm(instance=obj, data=request.POST, files=request.FILES)
        if form.is_valid():
            form.save()
            return HttpResponse('edit success!')
        content['form'] = form
        return render(request, 'test.html', content)

3. templates

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <link rel="stylesheet" href="/static/plugins/bootstrap-3.3.7-dist/css/bootstrap.css">
    <title>Title</title>
</head>
<body>
<form method="post" novalidate>
    {% csrf_token %}
    <div class="form-group" style=" 300px; margin: 50px auto;">
        {{ form.as_p }}
        <input type="submit" value="提交">
    </div>
</form>

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

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <link rel="stylesheet" href="/static/plugins/bootstrap-3.3.7-dist/css/bootstrap.css">
    <title>Title</title>
</head>
<body>
<form method="post" novalidate>
    {% csrf_token %}
    <div class="form-group" style=" 300px; margin: 50px auto;">
        {{ form.as_p }}
        <input type="submit" value="提交">
    </div>
</form>

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